selectable_attr 0.3.14 → 0.3.15

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby
+  - ree
+

data/Gemfile

@@ -3,12 +3,18 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
+gem 'i18n'
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem "rspec", "~> 2.6.0"
+  gem "yard", "~> 0.7.2"
+  gem "bundler", "~> 1.0.18"
+  gem "jeweler", "~> 1.6.4"
+  # gem "rcov", ">= 0"
+  gem "simplecov", "~> 0.5.3"
   gem "autotest"
+
+  gem 'rdiscount'
 end

data/README.md

@@ -0,0 +1,331 @@
+# SelectableAttr [![Build Status](https://secure.travis-ci.org/akm/selectable_attr.png)](http://travis-ci.org/akm/selectable_attr)
+
+## Introduction
+selectable_attr は、コードが割り振られるような特定の属性について*コード*、*プログラム上での名前*、
+*表示するための名前*などをまとめて管理するものです。
+http://github.com/akm/selectable_attr/tree/master
+
+Railsで使用する場合、selectable_attr_railsと一緒に使うことをオススメします。
+http://github.com/akm/selectable_attr_rails/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
+
+### 2. 非Railsで使う場合
+#### a. gem install
+    [sudo] gem install akimatter-selectable_attr -s http://gems.github .com
+
+
+
+## Tutorial
+
+### シンプルなパターン
+    require 'rubygems'
+    require 'selectable_attr'
+
+    class Person
+      include ::SelectableAttr::Base
+
+      selectable_attr :gender do
+        entry '1', :male, '男性'
+        entry '2', :female, '女性'
+        entry '9', :other, 'その他'
+      end
+    end
+
+上記のようなクラスがあった場合、以下のようなクラスメソッドを使うことが可能です。
+
+    irb(main):020:0> Person.gender_ids
+    => ["1", "2", "9"]
+    irb(main):021:0> Person.gender_keys
+    => [:male, :female, :other]
+    irb(main):022:0> Person.gender_names
+    => ["男性", "女性", "その他"]
+    irb(main):023:0> Person.gender_options
+    => [["男性", "1"], ["女性", "2"], ["その他", "9"]] # railsでoptions_for_selectメソッドなどに使えます。
+    irb(main):024:0> Person.gender_key_by_id("1")
+    => :male
+    irb(main):025:0> Person.gender_name_by_id("1")
+    => "男性"
+    irb(main):026:0> Person.gender_id_by_key(:male) # 特定のキーから対応するidを取得できます。
+    => "1"
+    irb(main):027:0> Person.gender_name_by_key(:male)
+    => "男性"
+
+また使用可能なインスタンスメソッドには以下のようなものがあります。
+ 
+    irb> person = Person.new
+    => #<Person:0x133b9d0>
+    irb> person.gender_key
+    => nil
+    irb> person.gender_name
+    => nil
+    irb> person.gender = "2"
+    => "2"
+    irb> person.gender_key
+    => :female
+    irb> person.gender_name
+    => "女性"
+    irb> person.gender_key = :other
+    => :other
+    irb> person.gender
+    => "9"
+    irb> person.gender_name
+    => "その他"
+
+genderに加えて、gender_keyも代入可能となりますが、gender_nameには代入できません。
+
+### 複数の値を取りうるパターン
+    require 'rubygems'
+    require 'selectable_attr'
+
+    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
+
+multi_selectable_attrを使った場合に使用できるクラスメソッドは、selectable_attrの場合と同じです。
+
+    irb> room_search = RoomSearch.new
+    => #<RoomSearch:0x134a070>
+    irb> room_search.room_type_ids
+    => []
+    irb> room_search.room_type_keys
+    => []
+    irb> room_search.room_type_names
+    => []
+    irb> room_search.room_type_selection
+    => [false, false, false, false]
+    irb> room_search.room_type_keys = [:twin, :double]
+    => [:twin, :double]
+    irb> room_search.room_type
+    => ["02", "03"]
+    irb> room_search.room_type_names
+    => ["ツイン", "ダブル"]
+    irb> room_search.room_type_ids
+    => ["02", "03"]
+    irb> room_search.room_type = ["01", "04"]
+    => ["01", "04"]
+    irb> room_search.room_type_keys
+    => [:single, :triple]
+    irb> room_search.room_type_names
+    => ["シングル", "トリプル"]
+    irb> room_search.room_type_selection
+    => [true, false, false, true]
+    irb> room_search.room_type_hash_array
+    => [{:select=>true, :key=>:single, :name=>"シングル", :id=>"01"}, {:select=>false, :key=>:twin, :name=>"ツイン", :id=>"02"}, {:select=>false, :key=>:double, :name=>"ダブル", :id=>"03"}, {:select=>true, :key=>:triple, :name=>"トリプル", :id=>"04"}]
+    irb> room_search.room_type_hash_array_selected
+    => [{:select=>true, :key=>:single, :name=>"シングル", :id=>"01"}, {:select=>true, :key=>:triple, :name=>"トリプル", :id=>"04"}]
+
+
+
+### Entry
+#### エントリの取得
+エントリは様々な拡張が可能です。例えば以下のようにid、key、name以外の属性を設定することも可能です。
+
+    require 'rubygems'
+    require 'selectable_attr'
+
+    class Site
+      include ::SelectableAttr::Base
+
+      selectable_attr :protocol do
+        entry '01', :http , 'HTTP'      , :port => 80
+        entry '02', :https, 'HTTPS'     , :port => 443
+        entry '03', :ssh  , 'SSH'       , :port => 22
+        entry '04', :svn  , 'Subversion', :port => 3690
+      end
+    end
+ 
+クラスメソッドで各エントリを取得することが可能です。
+    entry = Site.protocol_entry_by_key(:https)
+    entry = Site.protocol_entry_by_id('02')
+
+インスタンスメソッドでは以下のように取得できます。
+    site = Site.new
+    site.protocol_key = :https
+    entry = site.protocol_entry
+
+#### エントリの属性
+id, key, nameもそのままメソッドとして用意されています。
+    irb>  entry.id
+    => "02"
+    irb>  entry.key
+    => :https
+    irb>  entry.name
+    => "HTTPS"
+
+またオプションの属性もHashのようにアクセス可能です。
+    irb> entry[:port]
+    => 443
+
+to_hashメソッドで、id, key, nameを含むHashを作成します。
+    irb> entry.to_hash
+    => {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}
+
+matchメソッドでid,key,nameを除くオプションの属性群と一致しているかどうかを判断可能です。
+
+    irb> entry.match?(:port => 22)
+    => false
+    irb> entry.match?(:port => 443)
+    => true
+
+ここではオプションの属性として:portしか設定していないので、matchに渡すHashのキーと値の組み合わせも一つだけですが、
+複数ある場合にmatch?がtrueとなるためには、完全に一致している必要があります。
+
+
+#### クラスメソッドでのエントリの扱い
+クラスメソッドでエントリを取得する方法として、xxx_entry_by_id, xxx_entry_by_keyを紹介しましたが、
+全てのエントリで構成される配列を取得するメソッドが xxx_entriesです。
+
+    irb> entries = Site.protocol_entries
+    irb> entries.length
+    => 4
+
+また、各エントリをto_hashでHashに変換した配列を xxx_hash_arrayメソッドで取得することも可能です。
+    irb> Site.protocol_hash_array
+    => [
+     {:key=>:http, :port=>80, :name=>"HTTP", :id=>"01"}, 
+     {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}, 
+     {:key=>:ssh, :port=>22, :name=>"SSH", :id=>"03"}, 
+     {:key=>:svn, :port=>3690, :name=>"Subversion", :id=>"04"} 
+    ]
+
+
+### Enum
+あまり表にでてきませんが、エントリをまとめる役割のオブジェクトがEnumです。
+これはクラスメソッドxxx_enumで取得することができます。
+
+    irb> enum = Site.protocol_enum
+
+Enumには以下のようなメソッドが用意されています。
+    irb> enum.entries
+    irb> enum.entries.map{|entry| entry[:port]}
+    => [80, 443, 22, 3690]
+ 
+EnumはEnumerableをincludeしているため、以下のように記述することも可能です。
+    irb> enum.map{|entry| entry[:port]}
+    => [80, 443, 22, 3690]
+
+    irb>  enum.entry_by_id("03")
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum.entry_by_key(:ssh)
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum.entry_by_id_or_key(:ssh)
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum.entry_by_id_or_key('03')
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum.entry_by_hash(:port => 22)
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+ 
+また、これらのメソッドが面倒と感じるようであれば、以下のような簡単なアクセスも可能です。
+    irb>  enum['03']
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum[:ssh]
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+    irb>  enum[:port => 22]
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+
+またクラスメソッドで紹介したようなxxx_ids, xxx_keys, xxx_namesや、xxx_key_by_idなどのメソッドも用意されています。
+    irb> enum.ids
+    => ["01", "02", "03", "04"]
+    irb> enum.keys
+    => [:http, :https, :ssh, :svn]
+    irb> enum.names
+    => ["HTTP", "HTTPS", "SSH", "Subversion"]
+    irb> enum.options
+    => [["HTTP", "01"], ["HTTPS", "02"], ["SSH", "03"], ["Subversion", "04"]]
+    irb> enum.key_by_id('04')
+    => :svn
+    irb> enum.id_by_key(:svn)
+    => "04"
+    irb> enum.name_by_id('04')
+    => "Subversion"
+    irb> enum.name_by_key(:svn)
+    => "Subversion"
+    irb> enum.to_hash_array
+    => [
+      {:key=>:http, :port=>80, :name=>"HTTP", :id=>"01"}, 
+      {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}, 
+      {:key=>:ssh, :port=>22, :name=>"SSH", :id=>"03"}, 
+      {:key=>:svn, :port=>3690, :name=>"Subversion", :id=>"04"}
+    ]
+
+id, key以外でエントリを特定したい場合はfindメソッドが使えます。 
+    irb>  enum.find(:port => 22)
+    => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
+ 
+findメソッドにはブロックを渡すこともできます。
+    irb>  enum.find{|entry| entry[:port] > 1024}
+    => #<SelectableAttr::Enum::Entry:1352a04 @id="04", @key=:svn, @name="Subversion", @options={:port=>3690}
+
+
+### Entryへのメソッド定義
+entryメソッドにブロックを渡すとエントリのオブジェクトにメソッドを定義することが可能です。
+
+    require 'rubygems'
+    require 'selectable_attr'
+
+    class Site
+      include ::SelectableAttr::Base
+
+      selectable_attr :protocol do
+        entry '01', :http , 'HTTP', :port => 80 do
+          def accept?(model)
+            # httpで指定された場合はhttpsも可、という仕様
+            model.url =~ /^http[s]{0,1}\:\/\//
+          end
+        end
+
+        entry '02', :https, 'HTTPS', :port => 443 do
+          def accept?(model)
+            model.url =~ /^https\:\/\//
+          end
+        end
+
+        entry '03', :ssh  , 'SSH', :port => 22 do
+          def accept?(model)
+            false
+          end
+        end
+
+        entry '04', :svn  , 'Subversion', :port => 3690 do
+          def accept?(model)
+            model.url =~ /^svn\:\/\/|^svn+ssh\:\/\//
+          end
+        end
+
+      end
+    end
+
+    enum = Site.protocol_enum
+
+    class Project
+      attr_accessor :url
+    end
+    project = Project.new
+    project.url = "http://github.com/akm/selectable_attr/tree/master"
+
+    irb>  enum[:http].accept?(project)
+    => 0
+    irb>  enum[:https].accept?(project)
+    => nil
+
+ というようにentryメソッドに渡したブロックは、生成されるエントリオブジェクトのコンテキストでinstance_evalされるので、そのメソッドを定義することが可能です。
+
+
+## Credit
+Copyright (c) 2008 Takeshi AKIMA, released under the MIT lice nse

data/Rakefile

@@ -40,12 +40,5 @@ end
 task :default => :spec
 task :test => :spec # for rubygems-test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "selectable_attr #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.3.14
+0.3.15

data/lib/selectable_attr/enum.rb

@@ -105,7 +105,7 @@ module SelectableAttr
     def to_hash_array
       entries.map do |entry|
         result = entry.to_hash
-        yield(result) if defined? yield
+        yield(result) if block_given?
         result
       end
     end
@@ -128,7 +128,11 @@ module SelectableAttr
         self.instance_eval(&block) if block
       end
 
-      attr_reader :name
+      def name
+        I18n.locale.nil? ? @name :
+          @enum.i18n_scope.nil? ? @name :
+          I18n.translate(key, :scope => @enum.i18n_scope, :default => @name)
+      end
 
       def [](option_key)
         BASE_ATTRS.include?(option_key) ? send(option_key) :

data/selectable_attr.gemspec

@@ -4,22 +4,23 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{selectable_attr}
-  s.version = "0.3.14"
+  s.name = "selectable_attr"
+  s.version = "0.3.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takeshi Akima"]
-  s.date = %q{2011-02-19}
-  s.description = %q{selectable_attr generates extra methods dynamically for attribute which has options}
-  s.email = %q{akm2000@gmail.com}
+  s.date = "2011-11-03"
+  s.description = "selectable_attr generates extra methods dynamically for attribute which has options"
+  s.email = "akm2000@gmail.com"
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
     ".gemtest",
+    ".travis.yml",
     "Gemfile",
     "MIT-LICENSE",
-    "README",
+    "README.md",
     "Rakefile",
     "VERSION",
     "init.rb",
@@ -31,44 +32,48 @@ Gem::Specification.new do |s|
     "selectable_attr.gemspec",
     "spec/selectable_attr_base_alias_spec.rb",
     "spec/selectable_attr_enum_spec.rb",
+    "spec/selectable_attr_i18n_spec.rb",
     "spec/spec_helper.rb",
     "tasks/selectable_attr_tasks.rake",
     "uninstall.rb"
   ]
-  s.homepage = %q{http://github.com/akm/selectable_attr/}
+  s.homepage = "http://github.com/akm/selectable_attr/"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{selectable_attr generates extra methods dynamically}
-  s.test_files = [
-    "spec/selectable_attr_base_alias_spec.rb",
-    "spec/selectable_attr_enum_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.rubygems_version = "1.8.10"
+  s.summary = "selectable_attr generates extra methods dynamically"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.18"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.5.3"])
       s.add_development_dependency(%q<autotest>, [">= 0"])
+      s.add_development_dependency(%q<rdiscount>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.18"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<simplecov>, ["~> 0.5.3"])
       s.add_dependency(%q<autotest>, [">= 0"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.18"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<simplecov>, ["~> 0.5.3"])
     s.add_dependency(%q<autotest>, [">= 0"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
   end
 end
 

data/spec/selectable_attr_enum_spec.rb

@@ -128,11 +128,11 @@ describe SelectableAttr::Enum do
 
   describe :inspect do
     it "NULL" do
-      SelectableAttr::Enum::Entry::NULL.inspect.should =~ /\#<SelectableAttr::Enum::Entry:[0-9a-f]+\ @id=nil,\ @key=nil,\ @name=nil,\ @options=nil>/
+      SelectableAttr::Enum::Entry::NULL.inspect.should =~ /\#<SelectableAttr::Enum::Entry:[\.0-9a-f]+\ @id=nil,\ @key=nil,\ @name=nil,\ @options=nil>/
     end
 
     it "valid" do
-      InetAccess[1].inspect.should =~ /\#<SelectableAttr::Enum::Entry:[0-9a-f]+\ @id=1,\ @key=:email,\ @name="Eメール",\ @options=\{:protocol=>"mailto:"\}>/
+      InetAccess[1].inspect.should =~ /\#<SelectableAttr::Enum::Entry:[\.0-9a-f]+\ @id=1,\ @key=:email,\ @name="Eメール",\ @options=\{:protocol=>"mailto:"\}>/
     end
   end
 

data/spec/selectable_attr_i18n_spec.rb

@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+require 'i18n'
+
+describe SelectableAttr::Enum do
+
+  before(:all) do
+    @default_locale_backup = I18n.default_locale
+    @locale_backup = I18n.locale
+  end
+
+  after(:all) do
+    I18n.locale = @locale_backup
+    I18n.default_locale = @default_locale_backup
+  end
+
+  before(:each) do
+    I18n.backend = I18n::Backend::Simple.new
+    I18n.backend.store_translations 'en', 'selectable_attrs' => {'enum1' => {
+        'entry1' => 'entry one',
+        'entry2' => 'entry two',
+        'entry3' => 'entry three'
+      } }
+    I18n.backend.store_translations 'ja', 'selectable_attrs' => {'enum1' => {
+        'entry1' => 'エントリ壱',
+        'entry2' => 'エントリ弐',
+        'entry3' => 'エントリ参'
+      } }
+  end
+
+  EnumI18n1 = SelectableAttr::Enum.new do
+    i18n_scope(:selectable_attrs, :enum1)
+    entry 1, :entry1, "エントリ1"
+    entry 2, :entry2, "エントリ2"
+    entry 3, :entry3, "エントリ3"
+  end
+
+  it 'test_enum1_i18n' do
+    I18n.locale = nil
+    I18n.locale.should == :en
+    EnumI18n1.name_by_key(:entry1).should == "entry one"
+    EnumI18n1.name_by_key(:entry2).should == "entry two"
+    EnumI18n1.name_by_key(:entry3).should == "entry three"
+    EnumI18n1.names.should == ["entry one", "entry two", "entry three"]
+
+    I18n.locale = 'ja'
+    EnumI18n1.name_by_key(:entry1).should == "エントリ壱"
+    EnumI18n1.name_by_key(:entry2).should == "エントリ弐"
+    EnumI18n1.name_by_key(:entry3).should == "エントリ参"
+    EnumI18n1.names.should == ["エントリ壱", "エントリ弐", "エントリ参"]
+
+    I18n.locale = 'en'
+    EnumI18n1.name_by_key(:entry1).should == "entry one"
+    EnumI18n1.name_by_key(:entry2).should == "entry two"
+    EnumI18n1.name_by_key(:entry3).should == "entry three"
+    EnumI18n1.names.should == ["entry one", "entry two", "entry three"]
+  end
+
+  class EnumBase
+    include ::SelectableAttr::Base
+  end
+
+  class SelectableAttrMock1 < EnumBase
+    selectable_attr :attr1, :default => 2 do
+      i18n_scope(:selectable_attrs, :enum1)
+      entry 1, :entry1, "エントリ1"
+      entry 2, :entry2, "エントリ2"
+      entry 3, :entry3, "エントリ3"
+    end
+  end
+
+  it 'test_attr1_i18n' do
+    I18n.locale = :en
+    I18n.default_locale = 'ja'
+    I18n.locale = :ja
+    I18n.locale.should == :ja
+    SelectableAttrMock1.attr1_name_by_key(:entry1).should == "エントリ壱"
+    SelectableAttrMock1.attr1_name_by_key(:entry2).should == "エントリ弐"
+    SelectableAttrMock1.attr1_name_by_key(:entry3).should == "エントリ参"
+    SelectableAttrMock1.attr1_options.should == [["エントリ壱",1], ["エントリ弐",2], ["エントリ参",3]]
+
+    I18n.locale = 'ja'
+    SelectableAttrMock1.attr1_name_by_key(:entry1).should == "エントリ壱"
+    SelectableAttrMock1.attr1_name_by_key(:entry2).should == "エントリ弐"
+    SelectableAttrMock1.attr1_name_by_key(:entry3).should == "エントリ参"
+    SelectableAttrMock1.attr1_options.should == [["エントリ壱",1], ["エントリ弐",2], ["エントリ参",3]]
+
+    I18n.locale = 'en'
+    SelectableAttrMock1.attr1_name_by_key(:entry1).should == "entry one"
+    SelectableAttrMock1.attr1_name_by_key(:entry2).should == "entry two"
+    SelectableAttrMock1.attr1_name_by_key(:entry3).should == "entry three"
+    SelectableAttrMock1.attr1_options.should == [["entry one",1], ["entry two",2], ["entry three",3]]
+  end
+
+  class SelectableAttrMock2 < EnumBase
+    selectable_attr :enum1, :default => 2 do
+      i18n_scope(:selectable_attrs, :enum1)
+      entry 1, :entry1, "エントリ1"
+      entry 2, :entry2, "エントリ2"
+      entry 3, :entry3, "エントリ3"
+    end
+  end
+
+  it 'test_enum1_i18n' do
+    I18n.default_locale = 'ja'
+    I18n.locale = nil
+    I18n.locale.should == :ja
+    SelectableAttrMock2.enum1_name_by_key(:entry1).should == "エントリ壱"
+    SelectableAttrMock2.enum1_name_by_key(:entry2).should == "エントリ弐"
+    SelectableAttrMock2.enum1_name_by_key(:entry3).should == "エントリ参"
+    SelectableAttrMock2.enum1_options.should == [["エントリ壱",1], ["エントリ弐",2], ["エントリ参",3]]
+
+    I18n.locale = 'ja'
+    SelectableAttrMock2.enum1_name_by_key(:entry1).should == "エントリ壱"
+    SelectableAttrMock2.enum1_name_by_key(:entry2).should == "エントリ弐"
+    SelectableAttrMock2.enum1_name_by_key(:entry3).should == "エントリ参"
+    SelectableAttrMock2.enum1_options.should == [["エントリ壱",1], ["エントリ弐",2], ["エントリ参",3]]
+
+    I18n.locale = 'en'
+    SelectableAttrMock2.enum1_name_by_key(:entry1).should == "entry one"
+    SelectableAttrMock2.enum1_name_by_key(:entry2).should == "entry two"
+    SelectableAttrMock2.enum1_name_by_key(:entry3).should == "entry three"
+    SelectableAttrMock2.enum1_options.should == [["entry one",1], ["entry two",2], ["entry three",3]]
+  end
+
+end

metadata

@@ -1,106 +1,117 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: selectable_attr
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 14
-  version: 0.3.14
+version: !ruby/object:Gem::Version
+  version: 0.3.15
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Takeshi Akima
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-19 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70212118591780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70212118591780
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70212118591220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70212118591220
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70212118590740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
-        version: 2.3.0
+      - !ruby/object:Gem::Version
+        version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70212118590740
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70212118590260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: 1.0.18
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70212118590260
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70212118583700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
+      - !ruby/object:Gem::Version
+        version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70212118583700
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70212118583180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70212118583180
+- !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70212118582660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-description: selectable_attr generates extra methods dynamically for attribute which has options
+  version_requirements: *70212118582660
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70212118582180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212118582180
+description: selectable_attr generates extra methods dynamically for attribute which
+  has options
 email: akm2000@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - .gemtest
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - VERSION
 - init.rb
@@ -112,43 +123,36 @@ files:
 - selectable_attr.gemspec
 - spec/selectable_attr_base_alias_spec.rb
 - spec/selectable_attr_enum_spec.rb
+- spec/selectable_attr_i18n_spec.rb
 - spec/spec_helper.rb
 - tasks/selectable_attr_tasks.rake
 - uninstall.rb
-has_rdoc: true
 homepage: http://github.com/akm/selectable_attr/
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 1731479098653498359
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 2029545021179331232
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: selectable_attr generates extra methods dynamically
-test_files: 
-- spec/selectable_attr_base_alias_spec.rb
-- spec/selectable_attr_enum_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/README

@@ -1,334 +0,0 @@
-= SelectableAttr
-== Introduction
-selectable_attr は、コードが割り振られるような特定の属性について*コード*、*プログラム上での名前*、
-*表示するための名前*などをまとめて管理するものです。
-http://github.com/akm/selectable_attr/tree/master
-
-Railsで使用する場合、selectable_attr_railsと一緒に使うことをオススメします。
-http://github.com/akm/selectable_attr_rails/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
-
-=== 2. 非Railsで使う場合
-==== a. gem install
- [sudo] gem install akimatter-selectable_attr -s http://gems.github .com
-
-
-
-== Tutorial
-
-=== シンプルなパターン
- require 'rubygems'
- require 'selectable_attr'
-
- class Person
-   include ::SelectableAttr::Base
-   
-   selectable_attr :gender do
-     entry '1', :male, '男性'
-     entry '2', :female, '女性'
-     entry '9', :other, 'その他'
-   end
- end
-
-上記のようなクラスがあった場合、以下のようなクラスメソッドを使うことが可能です。
-
- irb(main):020:0> Person.gender_ids
- => ["1", "2", "9"]
- irb(main):021:0> Person.gender_keys
- => [:male, :female, :other]
- irb(main):022:0> Person.gender_names
- => ["男性", "女性", "その他"]
- irb(main):023:0> Person.gender_options
- => [["男性", "1"], ["女性", "2"], ["その他", "9"]] # railsでoptions_for_selectメソッドなどに使えます。
- irb(main):024:0> Person.gender_key_by_id("1")
- => :male
- irb(main):025:0> Person.gender_name_by_id("1")
- => "男性"
- irb(main):026:0> Person.gender_id_by_key(:male) # 特定のキーから対応するidを取得できます。
- => "1"
- irb(main):027:0> Person.gender_name_by_key(:male)
- => "男性"
-
-また使用可能なインスタンスメソッドには以下のようなものがあります。
- 
- irb> person = Person.new
- => #<Person:0x133b9d0>
- irb> person.gender_key
- => nil
- irb> person.gender_name
- => nil
- irb> person.gender = "2"
- => "2"
- irb> person.gender_key
- => :female
- irb> person.gender_name
- => "女性"
- irb> person.gender_key = :other
- => :other
- irb> person.gender
- => "9"
- irb> person.gender_name
- => "その他"
-
-genderが代入可能なことはもちろん、gender_keyも代入可能です。
-# ただし、gender_nameには代入できません。
-
-
-=== 複数の値を取りうるパターン
- require 'rubygems'
- require 'selectable_attr'
-
- 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
-
-multi_selectable_attrを使った場合に使用できるクラスメソッドは、selectable_attrの場合と同じです。
-
- irb> room_search = RoomSearch.new
- => #<RoomSearch:0x134a070>
- irb> room_search.room_type_ids
- => []
- irb> room_search.room_type_keys
- => []
- irb> room_search.room_type_names
- => []
- irb> room_search.room_type_selection
- => [false, false, false, false]
- irb> room_search.room_type_keys = [:twin, :double]
- => [:twin, :double]
- irb> room_search.room_type
- => ["02", "03"]
- irb> room_search.room_type_names
- => ["ツイン", "ダブル"]
- irb> room_search.room_type_ids
- => ["02", "03"]
- irb> room_search.room_type = ["01", "04"]
- => ["01", "04"]
- irb> room_search.room_type_keys
- => [:single, :triple]
- irb> room_search.room_type_names
- => ["シングル", "トリプル"]
- irb> room_search.room_type_selection
- => [true, false, false, true]
- irb> room_search.room_type_hash_array
- => [{:select=>true, :key=>:single, :name=>"シングル", :id=>"01"}, {:select=>false, :key=>:twin, :name=>"ツイン", :id=>"02"}, {:select=>false, :key=>:double, :name=>"ダブル", :id=>"03"}, {:select=>true, :key=>:triple, :name=>"トリプル", :id=>"04"}]
- irb> room_search.room_type_hash_array_selected
- => [{:select=>true, :key=>:single, :name=>"シングル", :id=>"01"}, {:select=>true, :key=>:triple, :name=>"トリプル", :id=>"04"}]
-
-
-
-=== Entry
-==== エントリの取得
-エントリは様々な拡張が可能です。例えば以下のようにid、key、name以外の属性を設定することも可能です。
-
- require 'rubygems'
- require 'selectable_attr'
-
- class Site
-   include ::SelectableAttr::Base
-   
-   selectable_attr :protocol do
-     entry '01', :http , 'HTTP'      , :port => 80
-     entry '02', :https, 'HTTPS'     , :port => 443
-     entry '03', :ssh  , 'SSH'       , :port => 22
-     entry '04', :svn  , 'Subversion', :port => 3690
-   end
- end
- 
-クラスメソッドで各エントリを取得することが可能です。
- entry = Site.protocol_entry_by_key(:https)
- entry = Site.protocol_entry_by_id('02')
-
-インスタンスメソッドでは以下のように取得できます。
- site = Site.new
- site.protocol_key = :https
- entry = site.protocol_entry
-
-==== エントリの属性
-id, key, nameもそのままメソッドとして用意されています。
- irb>  entry.id
- => "02"
- irb>  entry.key
- => :https
- irb>  entry.name
- => "HTTPS"
-
-またオプションの属性もHashのようにアクセス可能です。
- irb> entry[:port]
- => 443
-
-to_hashメソッドで、id, key, nameを含むHashを作成します。
- irb> entry.to_hash
- => {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}
-
-matchメソッドでid,key,nameを除くオプションの属性群と一致しているかどうかを判断可能です。
-
- irb> entry.match?(:port => 22)
- => false
- irb> entry.match?(:port => 443)
- => true
-
- # ここではオプションの属性として:portしか設定していないので、matchに渡すHashのキーと値の組み合わせも一つだけですが、
- # 複数ある場合にmatch?がtrueとなるためには、完全に一致している必要があります。
-
-
-==== クラスメソッドでのエントリの扱い
-クラスメソッドでエントリを取得する方法として、xxx_entry_by_id, xxx_entry_by_keyを紹介しましたが、
-全てのエントリで構成される配列を取得するメソッドが xxx_entriesです。
-
- irb> entries = Site.protocol_entries
- irb> entries.length
- => 4
-
-また、各エントリをto_hashでHashに変換した配列を xxx_hash_arrayメソッドで取得することも可能です。
- irb> Site.protocol_hash_array
- => [
-  {:key=>:http, :port=>80, :name=>"HTTP", :id=>"01"}, 
-  {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}, 
-  {:key=>:ssh, :port=>22, :name=>"SSH", :id=>"03"}, 
-  {:key=>:svn, :port=>3690, :name=>"Subversion", :id=>"04"} 
- ]
-
-
-=== Enum
-あまり表にでてきませんが、エントリをまとめる役割のオブジェクトがEnumです。
-これはクラスメソッドxxx_enumで取得することができます。
-
- irb> enum = Site.protocol_enum
-
-Enumには以下のようなメソッドが用意されています。
- irb> enum.entries
- irb> enum.entries.map{|entry| entry[:port]}
- => [80, 443, 22, 3690]
- 
-EnumはEnumerableをincludeしているため、以下のように記述することも可能です。
- irb> enum.map{|entry| entry[:port]}
- => [80, 443, 22, 3690]
-
- irb>  enum.entry_by_id("03")
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum.entry_by_key(:ssh)
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum.entry_by_id_or_key(:ssh)
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum.entry_by_id_or_key('03')
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum.entry_by_hash(:port => 22)
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- 
-また、これらのメソッドが面倒と感じるようであれば、以下のような簡単なアクセスも可能です。
- irb>  enum['03']
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum[:ssh]
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- irb>  enum[:port => 22]
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
-
-またクラスメソッドで紹介したようなxxx_ids, xxx_keys, xxx_namesや、xxx_key_by_idなどのメソッドも用意されています。
- irb> enum.ids
- => ["01", "02", "03", "04"]
- irb> enum.keys
- => [:http, :https, :ssh, :svn]
- irb> enum.names
- => ["HTTP", "HTTPS", "SSH", "Subversion"]
- irb> enum.options
- => [["HTTP", "01"], ["HTTPS", "02"], ["SSH", "03"], ["Subversion", "04"]]
- irb> enum.key_by_id('04')
- => :svn
- irb> enum.id_by_key(:svn)
- => "04"
- irb> enum.name_by_id('04')
- => "Subversion"
- irb> enum.name_by_key(:svn)
- => "Subversion"
- irb> enum.to_hash_array
- => [
-   {:key=>:http, :port=>80, :name=>"HTTP", :id=>"01"}, 
-   {:key=>:https, :port=>443, :name=>"HTTPS", :id=>"02"}, 
-   {:key=>:ssh, :port=>22, :name=>"SSH", :id=>"03"}, 
-   {:key=>:svn, :port=>3690, :name=>"Subversion", :id=>"04"}
- ]
-
-id, key以外でエントリを特定したい場合はfindメソッドが使えます。 
- irb>  enum.find(:port => 22)
- => #<SelectableAttr::Enum::Entry:1352a54 @id="03", @key=:ssh, @name="SSH", @options={:port=>22}
- 
-findメソッドにはブロックを渡すこともできます。
- irb>  enum.find{|entry| entry[:port] > 1024}
- => #<SelectableAttr::Enum::Entry:1352a04 @id="04", @key=:svn, @name="Subversion", @options={:port=>3690}
-
-
-=== Entryへのメソッド定義
-entryメソッドにブロックを渡すとエントリのオブジェクトにメソッドを定義することが可能です。
-
- require 'rubygems'
- require 'selectable_attr'
-
- class Site
-   include ::SelectableAttr::Base
-   
-   selectable_attr :protocol do
-     entry '01', :http , 'HTTP', :port => 80 do
-       def accept?(model)
-         # httpで指定された場合はhttpsも可、という仕様
-         model.url =~ /^http[s]{0,1}\:\/\//
-       end
-     end
-
-     entry '02', :https, 'HTTPS', :port => 443 do
-       def accept?(model)
-         model.url =~ /^https\:\/\//
-       end
-     end
-
-     entry '03', :ssh  , 'SSH', :port => 22 do
-       def accept?(model)
-         false
-       end
-     end
-
-     entry '04', :svn  , 'Subversion', :port => 3690 do
-       def accept?(model)
-         model.url =~ /^svn\:\/\/|^svn+ssh\:\/\//
-       end
-     end
-
-   end
- end
-
- enum = Site.protocol_enum
- 
- class Project
-   attr_accessor :url
- end
- project = Project.new
- project.url = "http://github.com/akm/selectable_attr/tree/master"
- 
- irb>  enum[:http].accept?(project)
- => 0
- irb>  enum[:https].accept?(project)
- => nil
-
- というようにentryメソッドに渡したブロックは、生成されるエントリオブジェクトのコンテキストでinstance_evalされるので、そのメソッドを定義することが可能です。
-
-
-
-
-== Credit
-Copyright (c) 2008 Takeshi AKIMA, released under the MIT lice nse