アソシエーションで定義された属性の名前を取得する

テーブル列である属性を取得するには ActiveRecord::Base#attribute_names で取得できるけど、has_many などで定義された属性名は取得できない。
アソシエーションで定義された属性は ActiveRecord::Base#reflections 経由で取得できる。

	user = User.first
	# association で定義された属性の名前を取得
	user.reflections.keys
	# belongs_to で定義された属性の名前を取得
	user.reflections.select { |_, ref| ref.macro == :belongs_to }.keys
	# through 経由で定義された属性の名前を取得
	user.reflections.select { |_, ref| ref.is_a?(ActiveRecord::Reflection::ThroughReflection) }.keys

view raw get_associated_attribute_names.rb hosted with ❤ by GitHub

ActiveRecord::Base#attribute_names は文字列の配列を返すけど、こっちはシンボルの配列を返す。

更新ないけど維持はしてるよ

少し前ですがRails4.0.9と4.1.5がリリースされたので、自作の Rails 関連の gem がちゃんと動くかな？と Travis の Job を動かしてみたら、まあ無事に全部通ったんです。
travis-ci.org に行って、Restart ボタンを押すだけの簡単なお仕事。
それはいいんだけど、Ruby や Rails 界隈では更新のない gem は使わない、使用を控える、同じ機能なら新しい方、開発が活発な方という指針が一部あって（そんな気がする）、せっかく最新バージョンでも動くのにバグフィックスや機能追加がない、つまり更新がないだけで使われない gem も出てくるわけです。
さすがにあまりないだろうけど、更新がないだけで後発の同じ機能を持つ車輪の再発明 gem の方を優先されたら作者としては悔しいわけです。動くのに。
でも「travis-ci.org に行って、Restart ボタンを押すだけの簡単なお仕事」だけだと、Github にも Rubygems.org にも維持してる証拠が残らないんですよね。
gem の選別してる時に、Github で最終更新日や README.md に載ってる CI のバッジでの最終ビルド結果は見ても、そこから CI のサイトで、最新の Rails や Ruby のバージョンでビルドしてることまで見るんだろうか？
自分は毎回そこまで見ていない気がするし、そうしてくれたら嬉しいけど、そこまでを分化としていくのは難しい気がする。
となると、やはり何らかの証拠を作者が残すしかない。

1. バージョン上げる

確実だし、Github にも Rubygems.org にも証拠が残る。
自分の基本的なバージョン指針は「0.0.1 が開発中、たまに 0.5.x とか 0.9.x で Pre-release や RC を経て、最初の想定していた機能ができたら、1.0.0 としてリリースし、その後は、機能追加でマイナーバージョンをあげて、バグフィックスなどの機能を追加しない修正はリビジョン(tiny)を上げる」というものなんだけど、この場合リビジョン上げるていいのかどうか悩む。
ソースコードに変更がないのにいたずらにバージョンを上げるべきじゃないと思うし、バージョンあげてしまうと利用者全員に自分と同じような作業が発生する可能性がある。なのでバージョンは上げたくない。

2. CIを空コミットで回す

Github には証拠が残る。Rubygems.org はそのまんま。
コミットメッセージに「Railsバージョンアップによる確認のための空コミットだよ」みたいなコメントを残しておけばわかりやすい。

3. README.mdにログを残す

Github には証拠が残る。Rubygems.org はそのまんま。
基本的に Changelog は書いてるので、そこに追記するか、Change してねーだろってんなら Activity log みたいなセクションを設けて記述する。
Github まで行って README.md 読まない奴はあまりおらんだろうという想定。
ファイルの最終更新まで変更されるし自動的にコミットも伴うから、空コミットより訪問者にわかりやすい。
しかし、普通そういうログは確認後に残すものだから Travis 回して確認 → ログ書いて commit, push はめんどくさい。

まあ、普通に考えたら 2 かな？というわけで、空コミットするお仕事に戻ります。

rails-froutes という gem をリリースした

Summary

Rails の routes を peco りたかったんで rails-froutes という gem を作りました。
Github: pinzolo/rails-froutes
RubyGems.org: rails-froutes

How?

インストールして、rake routes FILL_NAME=yesと呼び出すと、従来は

    blog_posts GET    /blogs/:blog_id/posts(.:format)          posts#index
               POST   /blogs/:blog_id/posts(.:format)          posts#create
 new_blog_post GET    /blogs/:blog_id/posts/new(.:format)      posts#new
edit_blog_post GET    /blogs/:blog_id/posts/:id/edit(.:format) posts#edit
     blog_post GET    /blogs/:blog_id/posts/:id(.:format)      posts#show
               PUT    /blogs/:blog_id/posts/:id(.:format)      posts#update
               DELETE /blogs/:blog_id/posts/:id(.:format)      posts#destroy
         blogs GET    /blogs(.:format)                         blogs#index
               POST   /blogs(.:format)                         blogs#create
      new_blog GET    /blogs/new(.:format)                     blogs#new
     edit_blog GET    /blogs/:id/edit(.:format)                blogs#edit
          blog GET    /blogs/:id(.:format)                     blogs#show
               PUT    /blogs/:id(.:format)                     blogs#update
               DELETE /blogs/:id(.:format)                     blogs#destroy

こうだった rake routes の結果が、

    blog_posts GET    /blogs/:blog_id/posts(.:format)          posts#index
    blog_posts POST   /blogs/:blog_id/posts(.:format)          posts#create
 new_blog_post GET    /blogs/:blog_id/posts/new(.:format)      posts#new
edit_blog_post GET    /blogs/:blog_id/posts/:id/edit(.:format) posts#edit
     blog_post GET    /blogs/:blog_id/posts/:id(.:format)      posts#show
     blog_post PUT    /blogs/:blog_id/posts/:id(.:format)      posts#update
     blog_post DELETE /blogs/:blog_id/posts/:id(.:format)      posts#destroy
         blogs GET    /blogs(.:format)                         blogs#index
         blogs POST   /blogs(.:format)                         blogs#create
      new_blog GET    /blogs/new(.:format)                     blogs#new
     edit_blog GET    /blogs/:id/edit(.:format)                blogs#edit
          blog GET    /blogs/:id(.:format)                     blogs#show
          blog PUT    /blogs/:id(.:format)                     blogs#update
          blog DELETE /blogs/:id(.:format)                     blogs#destroy

こうなります。

Why?

ほら routes.rb みれば大体わかるとはいえ、ちょっと規模が大きくなると **_path, とか **_url を頭の中でごにょごにょするのはタルいわけです。

% rake routes | peco | awk '{print $1}' | pbcopy

とかできたら便利じゃないですかね？
でも、通常の rake routes だと名前があったりなかったりで欲しいものが取れないので、こんな gem を作りました。
まあ現実だと rake routes はもっさりなので

% rake routes FILL_NAME=yes > .routes

ってあらかじめしておいて、

% cat .routes | peco | awk '{print $1}' | pbcopy

ってところですかね。
私はこれを proutes として .zshrc に登録しました。
guard で routes.rb 監視して、更新したら吐き出すようにしておくのもいいかもしれません。
そこまで routes.rb を頻繁にいじるかどうかはわかりませんが。

2014-08-16 追記:
改行が入るのは使いづらいのでコマンドを改良した。

% cat .routes | peco | awk '{print $1}' | tr -d '\n' | pbcopy

おまけ

こんなふうに出力するオプションって rake routes にないの？って思ってコード読んでたら、こんなの発見した。

rake routes CONTROLLER=books とすれば books_controller に関する routes だけが取れる。知らなかった。パイプ使って grep してた #rails

— pinzolo (@pinzolo) 2014, 8月 13

いや〜知らんかった。

Windowsで解凍できるZIPファイルをRubyで作成する

Windowsで解凍できるZIPファイルを Ruby で作る必要があったのでメモ。
利用したのは rubyzip/rubyzip の v1.1.6

	require 'zip'
	class ZipForWin
	def zip_files(directory)
	Zip::File.open("#{directory}.zip", Zip::File::CREATE) do |zipfile|
	# 再帰的にサブディレクトリも格納する
	Dir[File.join(directory, '**', '**')].each do |entry|
	# 相対パスで格納
	entry_path = entry.sub(directory, '')
	# windows で解凍できるように Shift_JIS へ変換
	sjis_entry_path = entry_path.encode(Encoding::CP932, invalid: :replace, undef: :replace)
	zipfile.add(sjis_entry_path, entry)
	end
	end
	end
	end

view raw zip_for_win.rb hosted with ❤ by GitHub

概ね、rubyzip/README.md at master · rubyzip/rubyzip の通りなんだけど、Windows で解凍できるようにするには Shift_JIS に変換したパスで格納してあげる必要がある。
実際に使用する際には、外部から Shift_JIS か UTF8 かを選べるようにするのがいいかもね。

Redmineプラグイン開発における ActiveModel 使用上の注意点

先のエントリ: tail -f pinzo.log: ActiveSupport::Concern の included と ClassMethods の順序 に関連してます。

Redmine のプラグインでちょっと凝ったことをしようとすると、ActiveModel を使いたくなることがある。
ActiveModel のメリットの一つに ActiveRecord と同様のバリデーションを手軽に定義できることがある。
しかし、Redmine 本体の locales/ja.yml には ActiveModel の設定は入っていないので、プラグインの locales/ja.yml に書くことになる。
その際、たいてい Redmine 本体の locales/ja.yml から ActiveRecord 用の設定をコピーしてくることになりがち。

	ja:
	activemodel:
	errors:
	messages:
	inclusion: "は一覧にありません。"
	exclusion: "は予約されています。"
	invalid: "は不正な値です。"
	confirmation: "が一致しません。"
	accepted: "を受諾してください。"
	empty: "を入力してください。"
	blank: "を入力してください。"
	too_long: "は%{count}文字以内で入力してください。"
	too_short: "は%{count}文字以上で入力してください。"
	wrong_length: "は%{count}文字で入力してください。"
	taken: "はすでに存在します。"
	not_a_number: "は数値で入力してください。"
	not_a_date: "は日付を入力してください。"
	greater_than: "は%{count}より大きい値にしてください。"
	greater_than_or_equal_to: "は%{count}以上の値にしてください。"
	equal_to: "は%{count}にしてください。"
	less_than: "は%{count}より小さい値にしてください。"
	less_than_or_equal_to: "は%{count}以下の値にしてください。"
	odd: "は奇数にしてください。"
	even: "は偶数にしてください。"

view raw locales_ja.yml hosted with ❤ by GitHub

こんな感じに。

ここまではいい。

問題は、ここからちょいと修正を入れてしまうことにある。
ちょっと文言をいじってしまうと ActiveModel のデフォルトの文言を上書きするということになる。
これを複数プラグインでやってしまった場合、さてあなたのプラグインではどんなエラーが表示されるだろう？
これらの辞書ファイルはマージされるので、ロード順や入れてあるプラグインの状態により変わってしまい想定できなくなる。
文言をテストで使用していたりしたら、テストが失敗してしまう。
それを避けるためにも、先のエントリで書いたようなテクニックを利用して、自分のプラグインの ActiveModel が使用するセクションを独立させてあげよう。

	module MyPlugin::Model
	extend ActiveSupport::Concern
	included do
	__send__(:include, ActiveModel::Conversion)
	__send__(:include, ActiveModel::Validations)
	extend ActiveModel::Naming
	extend ActiveModel::Translation
	class << self
	alias_method_chain :i18n_scope, :my_plugin_model
	end
	end
	module ClassMethods
	def i18n_scope_with_my_plugin_model
	:my_plugin_model
	end
	end
	def persisted?
	false
	end
	end

view raw my_plugin_model.rb hosted with ❤ by GitHub

	ja:
	my_plugin_model:
	errors:
	messages:
	inclusion: "は一覧にありません。"
	exclusion: "は予約されています。"
	invalid: "は不正な値です。"
	confirmation: "が一致しません。"
	accepted: "を受諾してください。"
	empty: "を入力してください。"
	blank: "を入力してください。"
	too_long: "は%{count}文字以内で入力してください。"
	too_short: "は%{count}文字以上で入力してください。"
	wrong_length: "は%{count}文字で入力してください。"
	taken: "はすでに存在します。"
	not_a_number: "は数値で入力してください。"
	not_a_date: "は日付を入力してください。"
	greater_than: "は%{count}より大きい値にしてください。"
	greater_than_or_equal_to: "は%{count}以上の値にしてください。"
	equal_to: "は%{count}にしてください。"
	less_than: "は%{count}より小さい値にしてください。"
	less_than_or_equal_to: "は%{count}以下の値にしてください。"
	odd: "は奇数にしてください。"
	even: "は偶数にしてください。"

view raw locales_ja_fixed.yml hosted with ❤ by GitHub

こんな感じに。(my_plugin 部分にはあなたのプラグインの一意な識別子を指定しましょう。)

それでは、今日もよい日曜開発を

ActiveSupport::Concern の included と ClassMethods の順序

前置き

最初に書いておきます、Rails3.2系の記事です。
Rails4だと ActiveModel::Model を使うだろうから、サンプルコードはずいぶん変わると思います。

ActiveModel を利用したモデルで独自の i18n のセクションを利用したい

まあとある事情で、通常 activemodel.errors.messages.xxx な i18n のキーを my_model.errors.messages.xxx とかにしたかった。
そんな場合は i18n_scope をオーバーライドしてやるんだけど、全モデルクラスに書くのは嫌なので、インクルードするだけの共通モジュールを書くことに。

最初にこんなのを書いた

	module MyModel
	extend ActiveSupport::Concern
	included do
	__send__(:include, ActiveModel::Conversion)
	__send__(:include, ActiveModel::Validations)
	extend ActiveModel::Naming
	extend ActiveModel::Translation
	end
	module ClassMethods
	def i18n_scope
	:my_model
	end
	end
	def persisted?
	false
	end
	end

view raw invalid_mymodel.rb hosted with ❤ by GitHub

しかし、これではうまくいかない。

問題点

ActiveSupport::Concern は ClassMethods モジュールを反映させてから included のブロックを実行するので、再度デフォルトで上書きしてしまう。

解決策

こんな風に alias_method_chain を使うなどして extend ActiveModel::Translation の後にオーバーライドしてやればいい。

	module MyModel
	extend ActiveSupport::Concern
	included do
	__send__(:include, ActiveModel::Conversion)
	__send__(:include, ActiveModel::Validations)
	extend ActiveModel::Naming
	extend ActiveModel::Translation
	class << self
	alias_method_chain :i18n_scope, :my_model
	end
	end
	module ClassMethods
	def i18n_scope_with_my_model
	:my_model
	end
	end
	def persisted?
	false
	end
	end

view raw valid_mymodel.rb hosted with ❤ by GitHub