タグ別アーカイブ: Rails

関西Ruby会議に行ってきた


話を聞いていたから、ほとんどメモはなかった。
すごいざっくりとした感じ。。
久々にこういう大きめのカンファレンスに出て、気持ち的なモチベーションは上がった!!

関西Ruby会議2017

フリーソフトウェア開発

Rubygem開発の流儀

‘何か考えて形にしてリリースする’ ということにハードルがある

  • 困っていることを正確に把握する
    • なんのせいで不便になっているのか
  • 開発に関わる手間が少ない方がいい
  • 運用コストが低い方がいい
  • 原動力
    • 日常の怒りや不満を言語化すること
    • 何がツライのかを説明できること
  • 引き出しを増やすこと
    • 頭のインデックスに引っ掛けるようにする
    • リファレンスマニュアル
    • 抽象化にはデザパタの知識は役に立つ
    • 既存のソースコードからパクる(ライセンスは確認)

CoderDojoを支えるRailsCMS活用事例

CMSのツールとしてよさそうだなぁー

18年でRubyから学んだこと

伽藍とバザール

[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]
省略

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を使っているようです。

Mac で Ruby環境構築(rbenv でのインストールから rbenv-gemset )


【追記】 2014/03/17

rbenv-aliases というrbenvのプラグインを入れておくと、 .ruby-version で指定するときに ruby2.0.0p… などの p… 以降を指定せずに 2.0.0 などで指定しておけば p… 以降はよしなに判断して最新のものを適用してくれる。

【追記】2013/12/18

‘-k (–keep)’ オプションを使うことでrbenv配下のディレクトリにRuby本体のソースもダウンロードしてくれる。
そして、pry-docをインストールするとpry上からRubyのソース(C実装)を確認できる。
pry-docでカジュアルにRubyのソースコードを読む

% RUBY_CONFIGURE_OPTS="--with-readline-dir=`brew --prefix readline` --with-openssl-dir=`brew --prefix openssl`" rbenv install -k 2.0.0-p353

【追記】 2013/05/23

Ruby2.0 以上をrbenv + ruby-buildでビルドするときに日本語環境とSSL環境を有効にする方法。
1.9までは「CONFIGURE_OPTS」だったのに「RUBY_CONFIGURE_OPTS」という環境変数で指定してあげないとダメみたい。

% RUBY_CONFIGURE_OPTS="--with-readline-dir=$(brew --prefix readline) --with-openssl-dir=$(brew --prefix openssl)" rbenv install 2.0.0-p195 

参考:MacにRubyをインストールする時のメモ


以前に書いた記事でも
Ruby環境構築(Mac rbenv編)
rbenvによる環境構築を書いたのですが、新たにマシンをセットアップするということで改めてまとめてみました。
OSは Mountain Lion です!!

rbenvなどのインストールからちょっと中断まで

基本的な流れは以前の記事と同じです。

% brew install rbenv
% brew install ruby-build
% eval "$(rbenv init -)" >> ~/.zshenv

% brew install openssl
% brew install readline 

## 以前は成功した、「brew link」コマンド何故か以下のWarning。。。
% brew link openssl
Warning: openssl is keg-only and must be linked with --force
Note that doing so can interfere with building software.

% brew link readline
Warning: readline is keg-only and must be linked with --force
Note that doing so can interfere with building software.

「brew link」ではreadline, opensslを /usr/local/bin にリンクを張るために行なっているのですが、「keg-only」のWarningが出てしまう。「–force」を使えばLinkは通るけど「brew doctor」ではまたWarningが出る。

homebrewについてはこのへん参考
一旦保留ということにしておこう。


rbenvでRubyをインストール

【参考】
* rbenvでのビルドに再挑戦(成功)
* rbenv & ruby-build の使い方メモ

上記で「brew link」ができなかったので明示的に「brew –prefix FORMULA」でパスを指定してインストールする。

しかし、またまたエラー。。。GCC周りがおかしいようです。AppleはGCCの仕様が変わってコンパイルできなくなることが多いなー。。

% CONFIGURE_OPTS="--with-readline-dir=$(brew --prefix readline) --with-openssl-dir=$(brew --prefix openssl)" rbenv install 1.9.3-p286

Downloading yaml-0.1.4.tar.gz...
-> http://dqw8nmjcqpjn7.cloudfront.net/36c852831d02cf90508c29852361d01b
Installing yaml-0.1.4...
Installed yaml-0.1.4 to /Users/takaesu-m/.rbenv/versions/1.9.3-p286

Downloading ruby-1.9.3-p286.tar.gz...
-> http://dqw8nmjcqpjn7.cloudfront.net/e2469b55c2a3d0d643097d47fe4984bb
Installing ruby-1.9.3-p286...

BUILD FAILED

Inspect or clean up the working tree at /var/folders/yx/11hj2qx50z56bw5dx05_ggvm0000gn/T/ruby-build.20130211111658.95876
Results logged to /var/folders/yx/11hj2qx50z56bw5dx05_ggvm0000gn/T/ruby-build.20130211111658.95876.log

Last 10 log lines:
compiling regenc.c
compiling regerror.c
compiling regexec.c
compiling regparse.c
regparse.c:582:15: error: implicit conversion loses integer precision: 'st_index_t' (aka 'unsigned long') to 'int' [-Werror,-Wshorten-64-to-32]
    return t->num_entries;
    ~~~~~~ ~~~^~~~~~~~~~~
1 error generated.
make: *** [regparse.o] Error 1
make: *** Waiting for unfinished jobs....
  34.95s user 13.27s system 102% cpu 47.008 total

ググってみるとこの記事を発見。ページ下部の部分に参考になる内容が!!
Cannot compile ruby 1.9.3

Ruby環境 rbenv mac

「brew tap」コマンドはhomebrew に参照するリポジトリを追加するものです。
この内容でやっていることは

  1. berwをアップデート
  2. 「homebrew/dups」をhomebrewで参照するリポジトリとして追加
  3. 「apple-gcc42」をインストール。
  4. 「apple-gcc42」を環境変数の CC としてExport
  5. brewを使ってrubyをインストール

4番目のExportまで行ったら、再度以下のコマンドでRubyをインストール

% CONFIGURE_OPTS="--with-readline-dir=$(brew --prefix readline) --with-openssl-dir=$(brew --prefix openssl)" rbenv install 1.9.3-p286

無事インストール出来ました!!

なお、「rbenv install」の前にCONFIGURE_OPTSをつけるのはMacOSXのみのようです。
brew linkができていたら、readlineやopensslを個別に指定しなくても、以下のようにできるようです。

CONFIGURE_OPTS="--with-opt-dir=/usr/local" rbenv install 1.9.3-p286  

rbenv-gemsetの設定

インストールなど
% brew install rbenv-gemset
所定のディレクトリで試してみる
% cd ~/workspace

rbenv gemset create [version] [gemset名] でgemsetを作成
% rbenv gemset create 1.9.3-p286 commands

gemsets作成確認
% rbenv gemset list
1.9.3-p286:
  commands

この設定で以下のディレクトリにgemsetができる
% ls -l ~/.rbenv/versions/1.9.3-p385/gemsets
total 0
drwxr-xr-x  7 takaesu-m  staff  238  3 12 11:27 commands

gemsetsを利用するため「.rbenv-gemsets」を作成する(内容は commands と使用したいgemset名を入れる)
該当ディレクトリより下位はcommandsというgemsetsを利用する
% echo commands > .rbenv-gemset

アクティブなを確認する
% rbenv gemset active
commands

mechanizeというgemをインストールしてみる
% gem install mechanize

gemインストール確認
% gem list
*** LOCAL GEMS ***

domain_name (0.5.7)
mechanize (2.5.1)
mime-types (1.21)
net-http-digest_auth (1.2.1)
net-http-persistent (2.8)
nokogiri (1.5.6)
ntlm-http (0.1.1)
rbenv-rehash (0.3)
unf (0.0.5)
unf_ext (0.0.6)
webrobots (0.1.0)

これでひと通り
rbenv + rbenv-gemset の インストール手順完了です。

関係のない一言

  • 「rbenv local」便利らしい!!