更新日: 2014年2月11日
Rails

Rails4 で lib ディレクトリの自作ライブラリを autoload

Rails4 アプリで lib ディレクトリに作った自作のライブラリ等を自動的に読み込むたい場合、以下の設定を行い、ディレクトリ・ファイル構成の規約、命名規約に従う。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

autoload のパスを追加

まず config/application.rb に autoload 用の設定を行います。

config/application.rb

# to auto load lib/ directory
config.autoload_paths += %W(#{config.root}/lib)

1 2	# to auto load lib/ directory config.autoload_paths += %W(#{config.root}/lib)

これで、lib ディレクトリ以下のファイル（ファイルに書かれたモジュール・クラス）が、以降に説明するディレクトリ・ファイル構成と命名の規約に従うと、自動的に読み込まれるようになります。

lib ディレクトリ以下のファイル

ファイル名は小文字、単語の区切りは _（アンダースコア）にする。クラス名はアンダースコアの区切りでキャメルケースにする。

lib/hoge_fuga.rb

class HogeFuga
  def hello
    puts "HogeFuga#hello"
  end
end

class HogeFuga

def hello

puts "HogeFuga#hello"

end


pry(main)> HogeFuga.new.hello
HogeFuga#hello
=> nil

pry(main)> HogeFuga.new.hello

HogeFuga#hello

=> nil

lib/hoge ディレクトリにファイルを置く場合。

lib/hoge/fuga.rb

module Hoge
  class Fuga
    def hello
      puts "Hoge::Fuga#hello"
    end
  end
end

module Hoge

class Fuga

def hello

puts "Hoge::Fuga#hello"

end


pry(main)> Hoge::Fuga.new.hello
Hoge::Fuga#hello
=> nil

pry(main)> Hoge::Fuga.new.hello

Hoge::Fuga#hello

=> nil

または、以下の様にクラスを書く。

class Hoge::Fuga
  def hello
    puts "Hoge::Fuga#hello"
  end
end

class Hoge::Fuga

def hello

puts "Hoge::Fuga#hello"

end


pry(main)> Hoge::Fuga.new.hello
Hoge::Fuga#hello
=> nil

pry(main)> Hoge::Fuga.new.hello

Hoge::Fuga#hello

=> nil

以上です。

– 参考リンク –
Auto-loading lib files in Rails 4 – Stack Overflow

パーフェクト Ruby on Rails は、最近読んだ Rails 本の中では一番役に立った本です。Chef や Capistrano など Rails と共によく使用される技術にも触れてあります。Ruby on Rails 4 アプリケーションプログラミングは、入門的な内容で Rails の機能全体を網羅されています。

パーフェクト Ruby on Rails

Ruby on Rails 4 アプリケーションプログラミング