2 minutes
古い ember-rails App で一部ファイルを ES6 Module 化
これは何?
ember-rails を古いスタイルで書いておいてそれをモダン化していく企画の第一弾の記事。
何をしたのか
今回は ES6 module を使ってない ember-rails アプリケーションで一部のファイルだけ ES6 Module にしてみた。
何が嬉しい?
今回扱ってるアプリケーションのサイズはとても小さいのでまとめて置き換えることも可能というか、ぶっちゃけ 古いスタイルに書き換えた PR を revert するだけで ES6 Module 化できたりする。
しかし、世の中に潜んでいる、レガシー化した ember-rails のプロジェクトでは全部まとめて ES6 Module にするのはファイル数が多過ぎて困難かと考え、敢えて一部のファイルだけ ES6 Module 化する方法を探してみた。
どうやったらできるの?
簡単に言うと ES6 Module 形式で書いたやつを import して Ember.js Application の Namespace に放り込めばいいだけ。
Example
まずはコンポーネントなどを
app/assets/javascripts/ember-app/components/foo.module.es6
ってファイル名で
import Ember from 'ember';
export default Ember.Component.extend({});
のように書いておく。拡張子が .module.es6
というのがポイントで、そうしておくと
ember-es6_template という Gem が自動的に ES6 の module として判定してくれるようになっている
https://github.com/tricknotes/ember-es6%5Ftemplate/blob/c1c7b8d23be7669a0aa6c5f9c71b916a3799f9a6/lib/ember/es6%5Ftemplate/sprockets.rb#L10
そして app/assets/javascripts/ember-app/application.js.es6
の末尾にでも
import FooComponent from 'ember-app/components/foo';
EmberApp.FooComponent = FooComponent;
のように書いたら、一応 module 形式で書けるし、それを window.EmberApp で用意した Ember.js Application で使えるって感じ。
ファイルの数と同じ量の import 書くの?
だるいよね。なので import 処理は
app/assets/javascripts/ember-app/import-modules.js.es6.erb
という erb template でも分離して
<% module_dir = Rails.root.join('app/assets/javascripts/ember-app/modules') %>
<% Dir.each_child(module_dir) do |dir| %>
<% next unless FileTest.directory?("#{module_dir}/#{dir}") %>
<% Dir.glob('*.module.es6', base: "#{module_dir}/#{dir}") do |module_file| %>
<% module_name = File.basename(module_file, '.module.es6') %>
<% klass_name = "#{module_name.underscore.camelize}#{dir.underscore.singularize.camelize}" %>
import <%= klass_name %> from 'ember-app/modules/<%= dir %>/<%= module_name %>';
EmberApp.<%= klass_name %> = <%= klass_name %>;
<% end %>
<% end %>
とでも書いておけば全部いい感じに読んでくれる。
関連 PR
実際に動くコードは以下の PR で用意した。 https://github.com/mugijiru/ember-rails-todo-app/pull/8 https://github.com/mugijiru/ember-rails-todo-app/pull/9
最初の PR で modules
フォルダにさらに components フォルダを掘ってその中にファイルを配置している。
その方が全部移行できた後にまるっと置き換えするのに楽そうだからだ。
また import して Namespace に放り込む処理も別ファイルに追い出している。これも、完全移行が済んだら不要になるファイルなので消しやすさを重視して分割しておいた。
さらに後続の PR で、複数のタイプが来ても対応できるように書き換えている。 Model は対応できてないけど、ま、Model は移行してないのでとりあえず放置。
CI でテストも通しているしバッチリだと思う。デプロイできるようにはしてないからサーバで動くかは確認してないけど、ま、大丈夫だろ