[rails]Rakeタスクでのtask定義の「:environment」引数について


Railsのジェネレータで生成したタスクのrbファイルを見ているとRakeタスクを定義するところで少し疑問に思ったことがあった。

railsのジェネレーターで以下のとおりにタスクを作成する。

% rails generate TASK_FILE_NAME TASK_NAME

例)
% rails generate hoge test

例)のように実行すると lib/tasks/hoge.rb ができて testというタスクが定義される

namespace :hoge do
  desc "TODO"
  task test: :environment do
  end
end

タスク定義のところで「:environment」 という引数が渡されているが、どういうこのことなのかを調べてみた。

「RailsでオリジナルRakeタスク作成からRSpecテストまで」 の記事の中に以下の一文があったので実際に試してみる。

:environment は モデルにアクセスするのに必須

引用:RailsでオリジナルRakeタスク作成からRSpecテストまで


lib/tasks/hoge.rb を以下のように変更する。

(Userモデルのデータは別途用意していることが前提)

  1. testタスク :environmentの引数を渡さない
  2. test_twoタスク :environmentの引数を渡す
namespace :hoge do
  desc "does not huve environment args"
  task :test do
    puts User.first
  end

  desc "has environment args"
  task test_two: :environment do
    puts User.first
  end
end

それぞれを実行する

  • 1.testタスク :environmentの引数を渡さない
% rake hoge:test
rake aborted!
uninitialized constant User
…省略

=> なんか「uninitialized constant User」という例外でエラーになる。


  • 2.test_twoタスク :environmentの引数を渡す
% rake hoge:test_two
# <User:0x007fadd5f68a80>

=> ちゃんとユーザを取得できている

まとめ

RailsでRakeタスクを使ってActiveRecordのモデルなどを扱うときは 「:environment」引数を渡して上げると良い!

さらに、実行時にもenvironmentを呼ぶことが出来るようだ

rakeタスク実行時に environment をよんでから hoge:test を呼ぶ

% rake environment hoge:test

コードは読んでなく検証しただけなので、もっと詳しくは調べないとなー

Rails向けプリローダ spring1.0 で Rubygemsのバージョンアップが必要な件


rbenvでインストールしたrubyでRails向けプリローダのspringが1.0にメジャーアップしていたので、
使ってみたら、RubyGemsのバージョンが低いというWarningが出る。。。

Warning: You're using Rubygems 2.0.14 with Spring. Upgrade to at least Rubygems 2.1.0 and run `gem pristine --all` for better startup performance.
Version: 1.0.0

そこで、RubyGemsのアップデート方法を以下に書きます。(ずっとBundlerを使っていたので、急にRubyGems本体のアップデートとかやろうと思っても分からなかったので、、、)

アップデート手順

参考:
新しいgemのアップデート方法(rubygems-update)
本当有難うございます。まんまの手順でした。。

1.rubygems-updateをインストールする

% gem install rubygems-update

2.アップデート前確認

アップデート前にRubygemsのバージョンを確認しておく

% gem environment
RubyGems Environment:
  - RUBYGEMS VERSION: 2.0.14
  - RUBY VERSION: 2.0.0 (2013-11-22 patchlevel 353) [x86_64-darwin12.5.0]
省略

3.アップデート実行

% update_rubygems

4.アップデート後確認

% gem environment
RubyGems Environment:
  - RUBYGEMS VERSION: 2.1.11
  - RUBY VERSION: 2.0.0 (2013-11-22 patchlevel 353) [x86_64-darwin12.5.0]
省略

空のディレクトリをgit管理下に入れるワンライナー(empty directories)


背景

chefを利用する機会が増えてきて汎用的な社内クックブックを作る状況が増えてきた昨今、

knife コマンドでクックブックをジェネレートするコマンドを実行すると

$ knife cookbook create COOKBOOK_NAME -o site-cook-books

バババっと以下のように基本的なディレクトリ構成で出力されるが、幾つか のディレクトリがある。

COOKBOOK_NAME
├── CHANGELOG.md
├── README.md
├── attributes
├── definitions
├── files
│   └── default
├── libraries
├── metadata.rb
├── providers
├── recipes
│   └── default.rb
├── resources
└── templates
    └── default
        └── sudoers.erb
attributes/, definitions/, files/default/, libraries/, proiders/, resources/ がそれぞれ空のディレクトリになっている

gitは空のディレクトリを管理下に置けないので、Railsに習って .keep という空ファイルを置くことにした。
(全てのリポジトリでディレクトリ構成の見た目を変えたくなかったので空のディレクトリもgit管理下に置くことにした。)


空のディレクトリに.keepを作るシェルのワンライナー

参考:
find/xargsを使った検索に便利なコマンド一覧

findで空のディレクトリを検索して、空のディレクトリに対して.keepという空ファイルをtouchで作成する。
Redhat系とUNIX(BSD)系では使えるオプションが違うようなので以下の用プラットフォームに合わせて実行する。

  • Redhat系
    -i オプションを指定することで ‘{}’で xargsに渡される値を取得できる
$ find . -type d -empty -print0 |xargs -0 -i touch '{}'/.keep
  • Unix系(MacOS)
    -Iオプションで % という文字列を xargsに渡される値として参照できるようにする
$ find . -type d -empty -print0 |xargs -0 -I % touch %/.keep

シェルのreadlineについて改めて調べてみた


ターミナルで作業していると、よくカーソルを行頭・行末へ一気に移動したいとか
入力した文字列をコピーしておきたいとか。。。などなど、色々やりたくなります。

そこで、、、readline だ!!!ということで色々とショートカットを調べてみました。

よく利用するショートカット達

C-a  行頭へ
C-e  行末へ
C-j  改行

C-b  一文字戻る
C-f  一文字進む

C-h  Backspace
C-d  delete

C-k  現在のカーソルから行末までをyank
C-u  現在のカーソルから行頭までをyank
C-w  単語単位でバックスペースでyankする
C-y  ペースト

C-l  画面をクリア

C-p  コマンドヒストリを戻る
C-n  コマンドヒストリを進める

C-r  コマンドヒストリをインクリメントサーチ(向きバック)
C-s  コマンドヒストリをインクリメントサーチ(向きフォワード)

注意)

  • man readline でその他のコマンドが調べられます。
  • 自分はzshの環境を使って実際に動かして試したので、各々の環境で少し違う点が出てくるかもしれません。

Rails3.2系でStrongParametersを有効にする方法


ゴール

Rails4系でデフォルトに組み込まれたStrongParameterをRails3.2系で使えるようにする。
Rails3.2系では3.1系から組み込まれた Model クラスに対して「attr_accessible」を定義することでMassAssignmentできるWhiteListの属性を指定しているが、この機能(attr_accessible)を無効化して、ControllerでparamsのWhiteListを指定するStrongParameterを利用できるようにさせる。


手順

(github README)strong_parametersについて

Ⅰ. モデルでのMassAssignment対策を無効

attr_accessibleの定義がなくても通るようになる

  1. config/application.rb 内 「config.active_record.whitelist_attributes」 を false にする
  2. Modelにあるattr_accessibleを削除
    attr_accessible があると config.active_record.whitelist_attributes の設定にかかわらずモデルでのMassAssignment対策が有効になる)

以上でモデルでのMassAssignment対策が無効化される( attr_accessible が無効)

Ⅱ. StrongParameters インストール

  • Gemfile に strong_parametersの定義を追加して bundle install
gem "strong_parameters"

Ⅲ. StrongParameters を有効にするための設定

これには今のところ2つの方法がある。適宜利用する方法を選択します。

1.各モデルに定義する

  • strong−parameter を有効にしたいModelに「include ActiveModel::ForbiddenAttributesProtection」を定義する
    メリット:各Modelごとに定義するので、Model毎で設定を入れるか入れないかを定義できる。
class AppVersion < ActiveRecord::Base
  include ActiveModel::ForbiddenAttributesProtection
  …省略
end

2.イニシャライザを新規作成して、そこに定義する

  • 独自のイニシャライザ (strong_parameter.rb)を作成して、その中に「ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)」の定義を入れる。
    メリット:一括で設定できるので全てのModelでStrongParametersを有効にしたいときは手間が省ける。
  # StrongParameterエラー時の挙動 :raise OR :log
  ActionController::Parameters.action_on_unpermitted_parameters = :raise
  
  # ActiveRecordの各ModelにStrongParameterをIncludeする
  ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)

以上で、通常のRailsコントトーラでStrongParametersを有効にする方法が完了です。
さらっと、2つ目のイニシャライザ作成のところで「ActionController::Parameters.action_on_unpermitted_parameters = :raise」 の設定を書いていますが、StrongParameters でUnpermittedParameters というExceptionが発生するときの挙動を定義しています。ここでは raise するようにします。


ActiveAdmin の対応

1.まずはコードから、、、

ここではデフォルトで作成される admin_userモデルについて書いています。

ActiveAdmin.register AdminUser do 
…省略

  controller do
    def permitted_params
      return {} if request.get?
      {admin_user: params.require(:admin_user)
        .permit(:email, :password, :password_confirmation)}
      # params.permit!     #<= 無条件にparamsを許可する場合
    end
end

■ コードの説明

  • 実装の概要
    controller do ブロックを作ってActiveAdminで採用されている inherited_resourcespermitted_params を定義して、paramsをpermitしたハッシュを返します。

  • return {} if request.get?」について
    HTTP Method の GETの時はぬけるようにして、新規作成(new) の時は除外する(GETの時はparamsにデータがないので)
    How to get ActiveAdmin to work with Strong Parameters?

  • params.permit!」について
    params を無条件ですべてpermitする場合に用いる、ここでは条件を指定してpermitさせている。

2.その他、Tips

[Tips1] Rails3.2系のActiveAdminでは admin_comment がStrongParametersに対応していないようです。

参考コード(active_admin/orm/active_record/comments.rb)
そのため、admin_commentって個人的には使わないし、以下のように無効にしています。

ActiveAdmin.setup do |config|
…省略
  config.allow_commetns = false
…省略
end

[Tips2] ActiveAdmin と言うか devise StrongParametersの対応方法についての参考情報

ActiveAdminでも採用されている 認証Gem devise では StrongParameters の対応方法にbefore_filterを使っているようです。