selectable_attr_rails 0.3.7

data/.gitignore

@@ -0,0 +1,5 @@
+/*.gem
+/coverage
+/pkg
+/rdoc
+/selectable_attr_test.sqlite3.db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Takeshi AKIMA
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,198 @@
+= SelectableAttrRails
+
+== Introduction
+selectable_attr_railsは、selectable_attrをRailsで使うときに便利なヘルパーメソッドを提供し、
+エントリをDBから取得したり、I18n対応するものです。
+http://github.com/akm/selectable_attr_rails/tree/master
+
+selectable_attr は、コードが割り振られるような特定の属性について*コード*、*プログラム上での名前*、
+*表示するための名前*などをまとめて管理するものです。
+http://github.com/akm/selectable_attr/tree/master
+
+
+== Install
+=== 1. Railsプロジェクトで使う場合
+==== a. plugin install
+ ruby script/plugin install git://github.com/akm/selectable_attr.git
+ ruby script/plugin install git://github.com/akm/selectable_attr_rails.git
+
+==== b. gem install
+ [sudo] gem install akimatter-selectable_attr akimatter-selectable_attr_rails -s http://gems.github .com
+
+== チュートリアル
+
+=== selectヘルパーメソッド
+以下のようなモデルが定義してあった場合
+ class Person < ActiveRecord::Base
+   include ::SelectableAttr::Base
+   
+   selectable_attr :gender do
+     entry '1', :male, '男性'
+     entry '2', :female, '女性'
+     entry '9', :other, 'その他'
+   end
+ end
+
+ビューでは以下のように選択肢を表示することができます。
+ <% form_for(:person) do |f| %>
+   <%= f.select :gender %>
+ <% end %>
+
+form_for、fields_forを使用しない場合でも、オブジェクト名を設定して使用可能です。
+ <%= select :person, :gender %>
+
+また以下のように複数の値を取りうる場合にもこのメソドを使用することが可能です。
+ class RoomSearch
+   include ::SelectableAttr::Base
+   
+   multi_selectable_attr :room_type do
+     entry '01', :single, 'シングル'
+     entry '02', :twin, 'ツイン'
+     entry '03', :double, 'ダブル'
+     entry '04', :triple, 'トリプル'
+   end
+ end
+
+ <% form_for(:room_search) do |f| %>
+   <%= f.select :room_type %>
+ <% end %>
+
+この場合、出力されるselectタグのmultiple属性が設定されます。
+
+
+
+=== radio_button_groupヘルパーメソッド
+ 一つだけ値を選択するUIの場合、selectメソッドではなく<input type="radio".../>を出力することも可能です。
+ 上記Personモデルの場合
+
+ <% form_for(:person) do |f| %>
+   <%= f.radio_button_group :gender %>
+ <% end %>
+
+ この場合、<input type="radio" .../><label for="xxx">... という風に続けて出力されるので、改行などを出力したい場合は
+ 引数を一つ取るブロックを渡して以下のように記述します。
+  
+ <% form_for(:person) do |f| %>
+   <% f.radio_button_group :gender do |b| %>
+     <% b.each do %>
+       <%= b.radio_button %>
+       <%= b.label %>
+       <br/>
+     <% end %>
+   <% end %>
+ <% end %>
+
+ f.radio_button_groupを呼び出しているERBのタグが、<%= %>から<% %>に変わっていることにご注意ください。
+
+
+=== check_box_groupヘルパーメソッド
+ 複数の値を選択するUIの場合、selectメソッドではなく<input type="checkbox".../>を出力することも可能です。
+ 上記RoomSearchクラスの場合
+
+ <% form_for(:room_search) do |f| %>
+   <%= f.check_box_group :room_type %>
+ <% end %>
+
+ この場合、<input type="checkbox" .../><label for="xxx">... という風に続けて出力されるので、改行などを出力したい場合は
+ 引数を一つ取るブロックを渡して以下のように記述します。
+  
+ <% form_for(:person) do |f| %>
+   <% f.check_box_group :gender do |b| %>
+     <% b.each do %>
+       <%= b.check_box %>
+       <%= b.label %>
+       <br/>
+     <% end %>
+   <% end %>
+ <% end %>
+
+ f.check_box_groupを呼び出しているERBのタグが、<%= %>から<% %>に変わっていることにご注意ください。
+
+
+== DBからのエントリの更新／追加
+各エントリの名称を実行時に変更したり、項目を追加することが可能です。
+
+ class RoomPlan < ActiveRecord::Base
+   include ::SelectableAttr::Base
+   
+   selectable_attr :room_type do
+     update_by "select room_type, name from room_types"
+     entry '01', :single, 'シングル'
+     entry '02', :twin, 'ツイン'
+     entry '03', :double, 'ダブル'
+     entry '04', :triple, 'トリプル'
+   end
+ end
+
+というモデルと
+
+  create_table "room_types" do |t|
+    t.string   "room_type", :limit => 2
+    t.string   "name", :limit => 20
+  end
+
+というマイグレーションで作成されるテーブルがあったとします。
+
+=== エントリの追加
+room_typeが"05"、nameが"４ベッド"というレコードがINSERTされた後、
+RoomPlan#room_type_optionsなどのselectable_attrが提供するメソッドで
+各エントリへアクセスすると、update_byで指定されたSELECT文が実行され、
+エントリとしては、
+     entry '05', :entry_05, '４ベッド'
+が定義されている状態と同じようになります。
+
+このようにコードで定義されていないエントリは、DELETEされると、エントリもなくなります。
+
+=== エントリの名称の更新
+実行時に名称を変えたい場合には、そのidに該当するレコードを追加／更新します。
+例えば、
+room_typeが"04"、nameが"３ベッド"というレコードがINSERTされると、その後は
+04のエントリはの名称は"３ベッド"に変わり、また別の名称にUPDATEすると、それに
+よってエントリの名称も変わります。
+
+このようにコードによってエントリが定義されている場合は、DELETEされてもエントリは削除されず、
+DELETE後は、名称が元に戻ります。 
+
+
+== I18n対応
+エントリのロケールにおける名称をRails2.2からの機能である、I18nを内部的にしようして取得できます。
+
+上記RoomPlanモデルの場合、
+
+config/locales/ja.yml
+ja:
+  selectable_attrs:
+    room_types:
+      single: シングル
+      twin: ツイン
+      double: ダブル
+      triple: トリプル
+      
+config/locales/en.yml
+en:
+  selectable_attrs:
+    room_types:
+      single: Single
+      twin: Twin
+      double: Double
+      triple: Triple
+      
+というYAMLを用意した上で、モデルを以下のように記述します。
+
+ class RoomPlan < ActiveRecord::Base
+   include ::SelectableAttr::Base
+   
+   selectable_attr :room_type do
+     i18n_scope(:selectable_attrs, :room_types)
+     entry '01', :single, 'シングル'
+     entry '02', :twin, 'ツイン'
+     entry '03', :double, 'ダブル'
+     entry '04', :triple, 'トリプル'
+   end
+ end
+
+これで、I18n.localeに設定されているロケールに従って各エントリの名称が変わります。
+
+
+== Credit
+Copyright (c) 2008 Takeshi AKIMA, released under the MIT lice nse

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+gem 'rspec', '>= 1.1.4'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+ 
+desc 'Default: run unit tests.'
+task :default => :spec
+ 
+task :pre_commit => [:spec, 'coverage:verify']
+ 
+desc 'Run all specs under spec/**/*_spec.rb'
+Spec::Rake::SpecTask.new(:spec => 'coverage:clean') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c", "--diff"]
+  t.rcov = true
+  t.rcov_opts = ["--include-file", "lib\/*\.rb", "--exclude", "spec\/"]
+end
+ 
+desc 'Generate documentation for the selectable_attr_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SelectableAttrRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+ 
+namespace :coverage do
+  desc "Delete aggregate coverage data."
+  task(:clean) { rm_f "coverage" }
+ 
+  desc "verify coverage threshold via RCov"
+  RCov::VerifyTask.new(:verify => :spec) do |t|
+    t.threshold = 100.0 # Make sure you have rcov 0.7 or higher!
+    t.index_html = 'coverage/index.html'
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "selectable_attr_rails"
+    s.summary  = "selectable_attr_rails makes possible to use selectable_attr in rails application"
+    s.description  = "selectable_attr_rails makes possible to use selectable_attr in rails application"
+    s.email    = "akima@gmail.com"
+    s.homepage = "http://github.com/akm/selectable_attr_rails/"
+    s.authors  = ["Takeshi Akima"]
+    s.add_dependency("activesupport", ">= 2.0.2")
+    s.add_dependency("activerecord", ">= 2.0.2")
+    s.add_dependency("actionpack", ">= 2.0.2")
+    s.add_dependency("akm-selectable_attr", ">= 0.3.5")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 3
+:patch: 7
+:major: 0

data/init.rb

@@ -0,0 +1,5 @@
+require 'selectable_attr'
+require 'selectable_attr_i18n'
+require 'selectable_attr_rails'
+
+SelectableAttrRails.add_features_to_rails

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/selectable_attr_i18n.rb

@@ -0,0 +1,38 @@
+if defined?(I18n)
+  module SelectableAttr
+    class Enum
+      def self.i18n_export
+        result = {}
+        instances.each do |instance|
+          unless instance.i18n_scope
+            # puts "no i18n_scope of #{instance.inspect}"
+            next 
+          end
+          paths = instance.i18n_scope.dup
+          current = result
+          paths.each do |path|
+            current = current[path.to_s] ||= {}
+          end
+          instance.entries.each do |entry|
+            current[entry.key.to_s] = entry.name
+          end
+        end
+        result
+      end
+
+      def i18n_scope(*path)
+        @i18n_scope = path unless path.empty?
+        @i18n_scope
+      end
+    
+      class Entry
+        def name
+          I18n.locale.nil? ? @name :
+            @enum.i18n_scope.blank? ? @name :
+            I18n.translate(key, :scope => @enum.i18n_scope, :default => @name)
+        end
+      end
+
+    end
+  end
+end

data/lib/selectable_attr_rails/db_loadable.rb

@@ -0,0 +1,65 @@
+module SelectableAttrRails
+  module DbLoadable
+    def update_by(*args, &block)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options = {:when => :first_time}.update(options)
+      @sql_to_update = block_given? ? block : args.first
+      @update_timing = options[:when]
+      self.extend(InstanceMethods) unless respond_to?(:update_entries)
+    end
+    
+    module Entry
+      attr_accessor :name_from_db
+      def name
+        @name_from_db || super
+      end
+    end
+    
+    module InstanceMethods
+      def entries
+        update_entries if must_be_updated?
+        @entries
+      end
+      
+      def must_be_updated?
+        return false if @update_timing == :never
+        return true if @update_timing == :everytime
+      end
+      
+      def update_entries
+        unless @original_entries
+          @original_entries = @entries.dup
+          @original_entries.each do |entry|
+            entry.extend(SelectableAttrRails::DbLoadable::Entry)
+          end
+        end
+        records = nil
+        if @sql_to_update.respond_to?(:call)
+          records = @sql_to_update.call
+        else
+          @connection ||= ActiveRecord::Base.connection
+          records = @connection.select_rows(@sql_to_update)
+        end
+        
+        new_entries = []
+        records.each do |r|
+          if entry = @original_entries.detect{|entry| entry.id == r.first}
+            entry.name_from_db = r.last unless r.last.blank?
+            new_entries << entry
+          else
+            entry = SelectableAttr::Enum::Entry.new(self, r.first, "entry_#{r.first}".to_sym, r.last)
+            new_entries << entry
+          end
+        end
+        @original_entries.each do |entry|
+          unless new_entries.include?(entry)
+            entry.name_from_db = nil
+            new_entries << entry if entry.defined_in_code
+          end
+        end
+        @entries = new_entries
+      end
+    end
+    
+  end
+end

data/lib/selectable_attr_rails/helpers/abstract_selection_helper.rb

@@ -0,0 +1,55 @@
+module SelectableAttrRails::Helpers
+  class AbstractSelectionBuilder
+    attr_reader :entry_hash
+    
+    def initialize(object, object_name, method, options, template)
+      @object, @object_name, @method = object, object_name, method
+      @base_name = @object.class.enum_base_name(method.to_s)
+      @template = template
+      @entry_hash = nil
+      @options = options || {}
+      @entry_hash_array = @options[:entry_hash_array]
+    end
+
+    def enum_hash_array_from_object
+      base_name = @object.class.enum_base_name(@method.to_s)
+      @object.send("#{base_name}_hash_array")
+    end
+    
+    def enum_hash_array_from_class
+      base_name = @object.class.enum_base_name(@method.to_s)
+      @object.class.send("#{base_name}_hash_array")
+    end
+
+    def tag_id(tag)
+      result = nil
+      tag.scan(/ id\=\"(.*?)\"/){|s|result = s}
+      return result
+    end
+    
+    def add_class_name(options, class_name)
+      (options ||= {}).stringify_keys!
+      (options['class'] ||= '') << ' ' << class_name
+      options
+    end
+    
+    def camelize_keys(hash, first_letter = :lower)
+      result = {}
+      hash.each{|key, value|result[key.to_s.camelize(first_letter)] = value}
+      result
+    end
+    
+    def update_options(dest, *options_array)
+      result = dest || {}
+      options_array.each do |options|
+        next unless options
+        if class_name = options.delete(:class)
+          add_class_name(result, class_name)
+        end
+        result.update(options)
+      end
+      result
+    end
+  
+  end
+end