Tag Archives: [:ja]アップグレード[:en]upgrade[:]

Exceptions I Bumped into on Upgrading from Cells 3 to Cells 4


Here are some exceptions I bumped into on upgrading from Cells 3 gem to Cells 4. ここにある対処法は、 それぞれの Cell クラス に対して行ってもいいですが、 it is easier to create the parent class, ApplicationCell.

対処した最終結果は Rails: Cells 3 から Cells 4 へのアップグレード に記載しています。

Exception: undefined method helper_method

The following error was raised in lib/devise/controllers/helpers.rb. The version of device gem I used at that time was 3.5.2.

undefined method `helper_method’ for XyzCell:Class

Add the following code to Cell class.

It is empty method but there’s no problem. With Cells 3, we have to call self.helper_method but with Cells 4 we don’t have to do that and its method was removed.

Reference: apotonick/cells Issue Not working with react-rails

Exception in dom_class

The following exception may occur.

undefined method `dom_class’ for #<XyzCell:0x007ff36d4fecb0>

Add the following code to Cell class.

Reference: apotonick/cells Troubleshooting

Exception concerns number_with_delimiter is raised

Add include ActionView::Helpers::NumberHelper to Cell class.

Exception because of select tag can’t be used

The following message will be shown.

private method `select’ called for #<XyzCell:0x007ff48f4febe8>

Add include ActionView::Helpers::FormOptionsHelper to Cell class.

Reference: apotonick/cells Issue select form_helper doesn’t work in cells 4


Rails: Upgrade Cells 3 to Cells 4


In Rails, I upgraded Cells gem from 3.11.3 to 4.0.2. And I upgraded Rails from 4.1.9 to 4.2.4 together. Here, I wrote what I did about Cells upgrade.

Basic instruction is in From Cells 3 to Cells 4 Upgrading Guide. It’s not easy to upgrade it.

Environment

  • Ruby 2.2.3
  • Template Engine: Slim

Story

ある人が外注に出していたプログラムを なぜか私がデザイン、マークアップ含めて更新することになり、 Rails と Gem のバージョンを更新した。

その Rails のアプリケーションにテストコードは一切なかった。

リリース前のプログラムに対して変更を行いました。

What I did

  1. Create ApplicationCell
  2. Change helper to include
  3. Change render_cell to cell
  4. Change file name
  5. Change partial view rendering way

Create ApplicationCell

If you use functions relates to device or form tags, the application will stop working after upgrading to Cells 4. Then I created ApplicationCell as a parent class of all Cell class.

アプリケーションを見ながら 次のような ApplicationCell を作りました。 include で取り込んでいるモジュールは、 エラーが出る度に順次取り込んでいったものです。

self.helper_method is called by devise, so it is necessary. Cells では 既に意味のないメソッドになっているので、 何も処理は行いません。

Change helper to include

In each cell class, there was a line “helper ApplicationHelper“.

Webrick を実行してページを開くと undefined method と表示されました。 Then, change helper statement to include statement with sed command.

Change render_cell to cell

Cells 4 から メソッドが変わりました。 ビューの中で使用されている render_cellcell に書き換えました。

いままで書いていた人がコードを綺麗に保っていたので、 sedコマンドを使って簡単に変更できました。 書き方が何通りもある場合は、簡単にはいきません。

Before

After

Change file name

There were cell templates named like method_name.html.slim, but Cells 4 method cell(:cell_name).(:method_name) search template named method_name.slim. It caused exception.

In cells/lib/cell/view_model.rb of Cells 4, find_template method generates template name. Generated template name by that method doesn’t contain the string 'html'.

I removed “html” from template file name.

Change partial view rendering way

I know what I did is quick and dirty way.

In old code, cell template renders partial view app/views/shared/something.html.slim.

Before

But it doesn’t work in Cells 4.

cells/lib/cell/templates.rbcells/lib/cell/view_model.rb を見ながら次のようにコードを変更しました。

After

I had not only to create prefixes and view value, but change view value.

app/views内のテンプレートを呼び出す際のメソッドを ApplicationCell に作ったほうがよかったかもしれません。

Cell の中に self.view_paths += ['app/views'] を加えると、 app/views/cell_name の中でテンプレートを探すようになります。 つまり、次のように変更しても動くようになります。

Alternative