using jQuery in Rails

公開日時 okkez Sat, 20 Feb 2010 02:00:00 GMT

最近 Rails で作っているウェブアプリケーションでは jQuery を使うようにしている。 なんとなくこうすれば良さそう、というのがわかってきたので書いておく。

google の jsapi を使う。 どこかのブログで見つけたコード片をちょっと変更したやつ。

module ApplicationHelper

  def google_jsapi_tag
    '<script type="text/javascript" src="http://www.google.com/jsapi"></script>'
  end

  def google_load_tag(name, version)
    %Q|<script type="text/javascript">google.load("#{name}", "#{version}");</script>|
  end

end

layout では以下のようにする。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
  <head>
    <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
    <meta http-equiv="Content-Script-Type" content="text/javascript" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <%= google_jsapi_tag %>
    <%= google_load_tag 'jquery', '1.3' %>
    <%= google_load_tag 'jqueryui', '1.7' %>
    <%= javascript_include_tag 'application' %>
    <%= yield :head %>
    <%- javascript_tag do -%>
      jQuery(function($){
        if (navigator.cookieEnabled) {
          $("#cookie_check").hide();
        } else {
          $("#cookie_check").show();
        }
        <%= yield :script %>
      });
    <%- end -%>
    <%= stylesheet_link_tag 'application' %>
    <%= stylesheet_link_tag 'jquery-ui-1.7.2.custom' %>
    <title><%= @title %></title>
  </head>
  <body>
    <!-- 略 -->
  </body>
</html>

こうしておくと view では以下のように書くことができる。

<%- content_for :script do -%>
$("a#hoge").click(function(event){ /* なんか処理 */});
<%- end -%>

global な名前空間を汚さないし、割と短く書けるし気に入っている。

Posted in ,  | タグ , , ,  | コメントはありません | トラックバックはありません

prawn with Rails2.3.5

公開日時 okkez Fri, 12 Feb 2010 04:00:00 GMT

prawn を Rails2.3.5 で使おうと思って調べてみたら、prawnto が使えなくなっていた。

仕方が無いので prawn 単体を Rails で使う方法を考えてみたので書いておく。

以下のコードをそれぞれのファイルに書く。

# config/environment.rb
config.gem "prawn"
config.gem "prawn-layout", :lib => "prawn/layout"
config.gem "prawn-security", :lib => "prawn/security"

config.gem “prawn” だけだと prawn/{layout,security} がちゃんと読み込まれないので別の場所で require する必要がある。

# config/initializers/mime_types.rb
Mime::Type.register "application/pdf", :pdf
# 適当なヘルパー
  def render_pdf
    pdf = Prawn::Document.new(:page_size => "A4")
    # フォントは環境に合わせる
    pdf.font "/usr/share/fonts/truetype/vlgothic/VL-Gothic-Regular.ttf"
    yield pdf
    pdf.render
  end

以上を追加したら、割と簡単に PDF を出力することができるようになる。

コントローラーでこんな風に書いて、

class ReportsController < ApplicationController
  def show
    @report = Report.find(params[:id]
    respond_to do |format|
      format.html # show.html.erb
      format.pdf # show.pdf.erb
    end
  end
end

ビューでこう書けばよい。

# show.pdf.erb
<%=
render_pdf do |pdf|
  pdf.text "Hello, PDF world!"
end
%>

追記

本家(github)をよく見たら別の方法が書いてあった。 * Using Prawn in Rails - prawn - GitHub

どっちが良い方法なんだろう。 github に書いてある方法だとちゃんとダウンロードするファイル名を指定できるのが良い。

自分が書いた方法だと、view なので view で使用するデータの受け渡しが楽だけどファイル名の指定とかが面倒。 あと Emacs で適切なモードになってくれないのが気にくわない。

Posted in  | タグ ,  | 2 comments | トラックバックはありません

Rails の generator gem のテスト方法

公開日時 okkez Fri, 18 Dec 2009 14:39:00 GMT

自分で Rails の generator gem のテストを書いてみたんだけど、どうもしっくり来ない。

参考にしたのはここ。

作ってた engines はこれ。

やりたかったことは以下のとおり。

  • Rails Engines なので基本的には Rails アプリケーションとしてテストしたい
  • generator は engines として使うときに必要なファイルを生成するためのものなので独立してテストしたい
  • rake test でちゃんとテスト出来れば OK

で、冒頭の Rails Guides を参考にテストを書いてみたけどちゃんと動かなかったので Rails のソースを読んでみた。 読んでみて分かったのは以下のこと。

  • Rails::Generator::Scripts::Generate#run でファイルを生成する先は指定できる
  • けど、generator をどこから探してくるかは指定できない
  • RAILS_ROOT が定義されていると RAILS_ROOT/lib/generators や RAILS_ROOT/vendor/generators などから探してくれる
  • 他には既にインストール済みの generator からも探してくれる
  • RAILS_ROOT/generators は見てくれない

作っているのは engines gem なのだから RAILS_ROOT/generators も見てほしいんだけど、それはやってないらしいので、ここでは RAILS_ROOT/lib/generators に symlink を張ることにした。 一応、これでちゃんと動いているみたいなのだけど、setup で symlink 作成して teardown で symlink を削除したりしてるのがちょっと気持ち悪い。

Rails Guides にも書いてあったとおり generator を提供している多くの Gem は generator 自体のテストは書いていない。(cucumber や rspec を参考にしたかったんだけど書いてなかった。)

もう一回やりたかったことをまとめるとこうなる。

  • Rails Engines なので基本的には Rails アプリケーションとしてテストしたい
  • generator は engines として使うときに必要なファイルを生成するためのものなので独立してテストしたい
  • 既存の generator を読み込まずにテストしたい (開発中の Gem と同名の Gem が入っていてもいいように)
  • rake test でちゃんとテスト出来れば OK

あ、コードは github に全部上がっているので見てください。

みんな generator のテストはあんまり書かないものなのかなぁ?

Posted in ,  | タグ ,  | コメントはありません | トラックバックはありません

Rails Engines なプラグインを書いてみた

公開日時 okkez Fri, 18 Dec 2009 14:38:00 GMT

Rails Engines なプラグインを書いてみたら、いくつかハマったポイントがあったので未来の自分のために記録しておく。

  1. スタイルシートや画像などが読めない
  2. マイグレーションファイルをどうしよう
  3. プラグインがロードできない
  4. Engine 側で使っている Gem を rake gems などで扱いたい

大体この四つくらいかと。それ以外は普通にアプリケーションを作れば OK

スタイルシートや画像などが読めない

これは簡単で、本家でも解説されてた。 Rake タスクを作ってコピーするだけ。

マイグレーションファイルをどうしよう

これも簡単。本家では、プラグイン側のマイグレーションを実行する方法がまだ無いから仕方ないと書かれていた。 Rake タスクを作ってコピーすればいい。タイムスタンプなマイグレーションを使っている場合はこれで問題ないはず。

プラグインがロードできない

これは調べるのに時間がかかったけど分かってみれば簡単だった。 plugin_root/init.rb や plugin_root/rails/init.rb では Rails::Initializer.run のブロックパラメータの config が見える ので(正確には違うけど)それ経由で以下のようにしておくとよいみたい。

plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
config.plugin_paths << File.join(plugin_root, 'vendor/plugins')

Engine 側で使っている Gem を rake gems などで扱いたい

プラグインと同様、init.rb 内で config.gem すれば良い。

Posted in ,  | タグ ,  | コメントはありません | トラックバックはありません

そろそろるりまを使ってみませんか?

公開日時 okkez Fri, 18 Dec 2009 13:32:00 GMT

この記事は Ruby Advent Calendar jp: 2009 : ATND の 18 日目です。前日は @tad さん でした。

愛用しているものの一つに るりま があります。 みなさんはもうお使いですか?

まだの人は以下の説明を読んでぜひ使ってみてください。

利用方法はいくつかあるので順番に紹介していきます。

web ブラウザを使って見る方法

http://doc.okkez.net/ にアクセスします。3 カラムになっていて左から順番に、BitClust, Static HTML, Download となっています。BitClust はるりまプロジェクトで作ったリファレンスマニュアルを見るためのウェブアプリケーションです。 doc.okkez.net では nginx + thin で動かしています。nginx がキャッシュするようにしているのでまあまあの速さで動くと思います。

Static HTML はあらかじめプログラムで生成した HTML ファイルを置いています。ウェブアプリケーション版とは少しレイアウトが異なりますが内容は同じです。参照したいクラスやメソッドが既に決まっている場合に使うと高速に参照することができます。ウェブブラウザのページ内検索機能を使用すると快適に閲覧できるでしょう。

Download は月一回肉の日(毎月29日)に作成したスナップショットを置いています。http://www.ruby-lang.org/ja/man/archive/ にも同じものを置かせていただいています。

ダウンロードしたアーカイブを使用する方法

  • http://www.ruby-lang.org/ja/man/archive/
  • http://doc.okkez.net/archives/

どちらかから、ダウンロードしたアーカイブを適当な場所に展開します。 アーカイブの中には以下のようなものがあります。

  • bitclust/ ライブラリ
  • db-1_8_7/ Ruby1.8.7 向けのデータベース
  • db-1_9_1/ Ruby1.9.1 向けのデータベース
  • readme.html このアーカイブの説明
  • refe-1_8_7 Ruby1.8.7向けの refe
  • refe-1_8_7.cmd Windows 用の Ruby1.8.7 向けの refe
  • refe-1_9_1 Ruby1.9.1 向けの refe
  • refe-1_9_1.cmd Windows 用の Ruby1.9.1 向けの refe
  • server.exe Windows 用の実行ファイル
  • server.exy server.exe を作るための exerb のレシピファイル
  • server.rb *nix などで使用するスクリプト

データベースというのは、指定したバージョン向けに前処理を施したテキストファイル群のことです。

このディレクトリにパスを通して使うのが一番簡単ですが、適当なスクリプトを書いたりするのもいいでしょう。例えば、以下のような感じで書くといいのではないでしょうか。

#! /bin/sh
DOC_BASE=$HOME/ruby-refm
exec ruby -Ke -I $DOC_BASE/bitclust/lib bitclust/bin/refe.rb -d $DOC_BASE/db-1_8_7 "$@"

Windows な人は *.cmd を参考にしてバッチファイルを書くといいのではないでしょうか。

また server.exe というファイルがありますが、Windows を使っている人はこれをダブルクリックすると、ローカルで web server が起動して、自動的にウェブブラウザが起動してリファレンスマニュアルを表示します。ローカルで動いているのでネットワークにつながっていないときでも使用できます。

ダウンロードした chm ファイルを使う方法

  • http://www.ruby-lang.org/ja/man/archive/
  • http://doc.okkez.net/archives/

先ほどと同様に、ダウンロードします。 chm はバージョン別になっているので自分が使いたい方をダウンロードすればいいでしょう。1.8.7, 1.9.1 以外のバージョンを使いたい人は、自分で chm ファイルを作るといいでしょう。(ここでは説明しません)

Windows Vista 以降の人は、ダウンロードしたファイルをダブルクリックしたときに出てくる警告ダイアログのチェックボックスを外すとちゃんと見られるはずです。

Windows を使っていない人はそれぞれ自分の好きな chm viewer をインストールして使ってください。意外と色々あります。

まとめ

個人的におすすめなのはコマンドラインから使用する refe です。すごく速いです。 とりあえず使ってみてください。古いリファレンスには書いていないこともたくさん書いてあります。 足りない部分はありますが、古いリファレンスよりはかなり進化しています。使わないと損です。 そして、使ってフィードバックをください。みなさんのご協力をお待ちしています。

明日は、たこ焼き仮面の中の人ではないかと噂されているあの人が書きます!

Posted in  | タグ ,  | コメントはありません | トラックバックはありません

Hikifarm on Rack

公開日時 okkez Wed, 25 Nov 2009 12:48:00 GMT

Hikifarm on Rack の対応をしてみました。

  • https://svn.sourceforge.jp/svnroot/hiki/hiki/branches/rack

やっと Hikifarm on Rack を実装出来たので rack ブランチにコミットしてみました。 まだ足りない部分はいくつかありますが、余裕のある人は試してみてください。 コードやファイル名についてもコメントをください。

使い方

  • misc/hikifarm/hikifarm_conf.rb を Hiki のインストールディレクトリにコピーする
  • hikifarm_conf.rb を環境に応じて書き換える
  • 必要っぽいディレクトリを作成しておく
  • 以下のコマンドを実行する
 $ rackup hikifarm.ru

注意

  • Hikifarm, Hiki ともにデフォルトで UTF-8 で動作します
  • 古い misc/hikifarm/index.cgi は変更してませんが使えないと思います

主な変更点

  • misc/hikifarm/index.cgi から hiki/farm.rb, hiki/farm/{config,dispatcher,manager,page,wiki}.rb に分離
  • Hikifarm の内部的にコードを整理した
  • Hiki::Config.new に hikiconf.rb のパスを指定できるようにした
  • UTF-8 化

TODO (把握してるものだけ)

  • Hikifarm の RSS 出力
  • 複数の wiki を作成したときの動作確認
  • attach の動作確認を行う
  • テストを書く
  • リファクタリング

Posted in ,  | タグ ,  | コメントはありません | トラックバックはありません

annotate_models_with_index

公開日時 okkez Wed, 04 Nov 2009 15:14:00 GMT

annotate_modelsにindexの情報を付加する - Hello, world! - s21g

こちらで公開されてたものに少し気になるところがあったので修正してみたのが以下。

okkez’s annotate_models_with_index at master - GitHub

修正ポイントは

  • trailing spaces を書き込まないようにした
  • magic comment を保存するようにした

です。

よかったら使ってみてください。

Posted in  | タグ ,  | コメントはありません | トラックバックはありません

Rails の fixtures の書き方を整理してみる

公開日時 okkez Wed, 26 Aug 2009 12:45:00 GMT

ほとんど以下に書いてあるけど、最近 fixtures の整理をしてるので書いてみる。

  • http://railsapi.com/doc/rails-v2.3.3.1/files/activerecord/lib/active_record/fixtures_rb.html

CSV とか single file とか色々あるけれどここでは YAML fixtures について書きます。

ラベルで参照する

pirates.yml
### in pirates.yml reginald: id: 1 name: Reginald the Pirate monkey_id: 1 ### in monkeys.yml george: id: 1 name: George the Monkey pirate_id: 1

上記のようなものが以下のように書けます。

  ### in pirates.yml

  reginald:
    name: Reginald the Pirate
    monkey: george

  ### in monkeys.yml

  george:
    name: George the Monkey
    pirate: reginald

polymorphic belongs_to

今日一番の収穫がこれ。

  ### in fruit.rb
  class Fruit < ActiveRecord::Base
    belongs_to :eater, :polymorphic => true
  end

  ### in fruits.yml

  apple:
    id: 1
    name: apple
    eater_id: 1
    eater_type: Monkey

こんな風に書いていたのが、こう書けます。

  ### in fruits.yml
  apple:
    eater: george (Monkey)

今、修正している Rails アプリではポリモーフィック関連をたくさん使っているのでこれはすごく便利です。

belongs_to 応用

こんなモデル定義がある場合にはちょっと変わった書き方ができます。

# in expense.rb
class Expense < ActiveRecord::Base
  has_many :expense_details
end
# in expense_detail.rb
class ExpenseDetail < ActiveRecord::Base
  belongs_to :header, :class_name => 'Expense', :foreign_key => 'expense_id'
end

普通は belongs_to :expense と書きますが、上のように書くことで header と書けるようになります。

### expenses.yml
hawaii:
  title: hawaii trip!

### expense_details.yml
chocorate:
  name: chocorate
  header: hawaii

nested set を使っているとき

nested set を使っている時はこう書けます。

### menus.yml
root:
  name: root
  parent_id:
menu_1:
  name: menu_1
  parent_id: <%= Fixtures.identify(:root) %>

$LABEL

$LABEL を使うと上の menus.yml がこうなります。

### menus.yml
root:
  name: $LABEL
  parent_id:
menu_1:
  name: $LABEL
  parent_id: <%= Fixtures.identify(:root) %>

他にもまだまだ便利な書き方はたくさんありそうです。

Posted in ,  | タグ  | コメントはありません | トラックバックはありません

Hiki on Rack again

公開日時 okkez Mon, 24 Aug 2009 15:41:00 GMT

Hiki の Rack 対応のために Hiki の svn リポジトリに rack ブランチを切りました。 一応、ページの編集はできます。

動作確認してないのは

  • XML-RPC
  • ほとんどのプラグイン

です。

で、ローカルでの開発には git-svn を使っています。 使ってみた感じでは、いい感じだったのでちょっと手順をメモしておきます。

branches/rack は先に svn cp で作っておきました。 Hiki は svn の 標準的なディレクトリ構成になっているので -s オプションでいけました。

$ git svn clone --prefix svn/ -s https://svn.sourceforge.jp/svnroot/hiki/hiki/ hiki-git
$ git br -a
  svn/hitoshi
  svn/rack
  svn/tags/V0_4_2a
........ (tags/ なブランチが多いので略)
  svn/tags/v0_8_8
  svn/tags/v0_8_8_1
  svn/trunk
  svn/v0_5_branch
  svn/v0_6
  svn/v0_8_8
$ git br
* master
$ git svn info
Path: .
URL: https://svn.sourceforge.jp/svnroot/hiki/hiki/trunk
Repository Root: https://svn.sourceforge.jp/svnroot/hiki
Repository UUID: 684b846f-27f2-41ea-b66a-77a1bafa84c1
Revision: 1006
Node Kind: directory
Schedule: normal
Last Changed Author: fdiary
Last Changed Rev: 1006
Last Changed Date: 2009-08-24 14:53:26 +0900 (月, 24  8月 2009)

最初にできる master ブランチで git svn info を実行してみて URL が trunk じゃなかったら master を作り直した方が いいと思います。こんな感じです。

$ git co -b master2 remotes/svn/trunk
$ git br -D master
$ git br -m master2 master
$ git svn info
Path: .
URL: https://svn.sourceforge.jp/svnroot/hiki/hiki/trunk
Repository Root: https://svn.sourceforge.jp/svnroot/hiki
Repository UUID: 684b846f-27f2-41ea-b66a-77a1bafa84c1
Revision: 1006
Node Kind: directory
Schedule: normal
Last Changed Author: fdiary
Last Changed Rev: 1006
Last Changed Date: 2009-08-24 14:53:26 +0900 (月, 24  8月 2009)

この状態で master ブランチを編集して git svn dcommit すると svn の trunk に反映されます。 次に svn の rack ブランチをローカルでいじるためのブランチを用意します。

$ git co -b rack remotes/svn/rack
$ git svn info
Path: .
URL: https://svn.sourceforge.jp/svnroot/hiki/hiki/branches/rack
Repository Root: https://svn.sourceforge.jp/svnroot/hiki
Repository UUID: 684b846f-27f2-41ea-b66a-77a1bafa84c1
Revision: 1007
Node Kind: directory
Schedule: normal
Last Changed Author: okkez
Last Changed Rev: 1007
Last Changed Date: 2009-08-25 00:33:07 +0900 (火, 25  8月 2009)

URL が変わっていることに注意してください。 これでこのブランチをいじって git svn dcommit すると svn の rack ブランチに反映されます。

trunk の変更を rack ブランチに取り込む場合は git merge を使うのではなく、 git format-patch と git am を使うと綺麗に出来るようです。

trunk への変更が一つの場合。

$ git co master 
$ git format-patch HEAD^
(0001-xxx.patch というファイルが作成される)
$ git co rack
$ git am <さっきのファイル> # 複数ある場合は複数指定可能。ちゃんと順番にパッチをあててくれる。
$ git svn dcommit

複数の変更を取り込む場合は、git format-patch HEAD^ とかやるといいです。 パッチの数が多くなるときは -o オプションで出力先ディレクトリを分けておくと便利かもしれません。

Posted in ,  | タグ , ,  | コメントはありません | トラックバックはありません

RubyKaigi2009 Day 3

公開日時 okkez Tue, 21 Jul 2009 14:10:00 GMT

三日目。

案の定、朝起きられなかったので遅刻。 てくてく歩いていたら Kanasan と南木さんに遭遇してびっくり。

会場ではいろんな発表をつまみ食いしてました。 やっぱり、どの発表が大体何時から何時まであるのか分かりづらいのは大変だった。

途中、少し抜けて Hiki のパッチを整理してた。

  • HIKI_VESION などの定数を Hiki モジュールに移動
  • :: でクラスメソッドを呼び出すのをドットで呼び出すように変更

まずはこの辺から。rack 対応もしたいけどちょっと調査が必要なのでまた今度。近いうちにやる。

お昼のあとは yhara さんのセッションへ。 質疑で「るりま」の宣伝をしておいた。 tDiary のセッションは途中まで聞いてから「ひげの山男」のセッションへ移動した。 予想通り、ウケ狙いしつつ真面目な発表をしていたのがおもしろかった。

N○K もいいかと思ったけど、やっぱり電波を浴びたかったので角谷さんのセッションを聞きに行った。 良い電波を浴びられた。

最後は基調講演。ネットワークにちゃんと繋がったので IRC でツッコミつつ。 基調講演中と closing のときのテンションの違いにびっくりした。和服++

新幹線の時間が迫っていたので RejectKaigi には参加せずに撤収。

Posted in  | タグ  | コメントはありません | トラックバックはありません