const_enum 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem 'activerecord', '~> 3.0.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 2.8.0'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.8.3'
+  gem 'simplecov'
+  gem 'activerecord', '~> 3.0.0'
+  gem 'sqlite3-ruby', :require => 'sqlite3'
+  gem 'database_cleaner'
+end

data/LICENSE.txt

@@ -0,0 +1,30 @@
+Copyright (c) 2012, Synergy Marketing, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+Neither the name of the Synergy Marketing, Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

data/README.rdoc

@@ -0,0 +1,201 @@
+= const_enum
+
+ActiveRecordの定数クラス、定数名アクセサ、NamedScope、定数値判定メソッド等を簡単なDSLで作成するためのプラグイン。
+rails3.xに対応しています。
+
+
+== 設定
+
+=== 定数のラベル定義ファイルを作成
+  # config/local/ja/labels.yml
+   labels:
+     user:
+       status:
+         disable: "無効"
+         enable:  "有効"
+
+=== constメソッドのブロック内で定数を定義
+  class User < ActiveRecord::Base
+    const :STATUS do
+      ENABLE    1
+      DISABLE   0
+    end
+  end
+  
+== 使用例
+
+=== 定数値へのアクセス
+  User::STATUS::ENABLE  # 1
+  User::STATUS::DISABLE # 0
+
+=== ActiveRecordの拡張
+  # データを作成
+  taro   = User.create(:name => 'taro'  , :status => Hoge::STATUS::ENABLE)
+  hanako = User.create(:name => 'hanako', :status => Hoge::STATUS::DISABLE)
+  
+  # {ATTR}_labelメソッドが定義される
+  taro.status_label   # "有効"
+  hanako.status_label # "無効"
+  
+  # {ATTR}_{CONST}?メソッドが定義される
+  taro.status_enable?  # true
+  taro.status_disable? # false
+  
+  # {ATTR}_was_{CONST}? ,  #{ATTR}_{CONST}_wasメソッドが定義される
+  taro.status = User::STATUS::DISABLE
+  taro.status_enable?      # false
+  taro.was_status_enable?  # true
+  taro.status_label_was?   # 有効
+  
+  # named_scopeが定義される
+  User.status_enable.all
+  
+=== Validationでの利用
+  
+constメソッドで定義される定数クラスはinclude?メソッドを実装しているため、
+validates :inclusionで利用することができる。
+  
+  class User < ActiveRecord::Base
+    const :STATUS do
+      ENABLE    1
+      DISABLE   0
+    end
+    validates :status, :inclusion => STATUS
+  end
+  
+=== Viewでの利用
+  
+constメソッドで定義される定数クラスはEnumerableモジュールをインクルードしているため、
+collection_selectにそのまま渡すことができる。
+値はvalue、ラベル名labelメソッドを指定する。
+  
+  form_for newhoge do |f|
+    f.collection_select(:status, User::STATUS, :value, :label)
+  end
+
+=== 定数オブジェクトへのアクセス
+
+{Class}::{ATTR}[value]で各定数オブジェクトにアクセス可能
+
+  User::STATUS[1].class # User::STATUS
+  User::STATUS[1].value # 1
+  User::STATUS[1].label # "有効"
+
+== ActiveRecord::Base.constメソッドのオプション
+
+=== prefix: NamedScope、属性値テストメソッドの名前を変更する
+
+constメソッドにprefixオプションを与えることで、作成されるNamedScope、属性値検証メソッドの
+名前（プレフィクス）を変更することができる。
+定数値名がモデル内で衝突しない場合は、prefixに空文字を与えるのが使いやすい。
+
+  class User < ActiveRecord::Base
+    const :STATUS, :prefix => '' do
+      ENABLE    1
+      DISABLE   0
+    end
+  end
+  
+  user = User.enable.first
+  user.enable?  # true
+  user.disable? # false
+
+
+=== scope: NamedScopeを作成しない
+
+値が直接DBにない場合、scopeオプションにfalseを与え、
+定数値を返すメソッドを定義することで各種メソッドを利用できる。
+
+  class Entry < ActiveRecord::Base
+    # 公開状態[予約、公開、終了]
+    const :STATUS, :scope => false, :prefix => '' do
+      SCHEDULED 1
+      OPENED    2
+      FINISHED  3
+    end
+    
+    scope :scheduled ,lambda {time = Time.now; where('start_at > ? ', time) }
+    scope :opened,    lambda {time = Time.now; where('start_at <= ? AND end_at > ?', time, time) }
+    scope :finished,  lambda {time = Time.now; where('end_at <= ? ', time) }
+
+    # 公開状態
+    def status
+      now = Time.now
+      case
+      when start_at > now
+        STATUS::SCHEDULED
+      when (end_at >= now and start_at <= now)
+        STATUS::OPENED
+      else
+        STATUS::FINISHED
+      end
+    end
+    
+    # 変更前公開状態
+    # status_label_wasやwas_opened?などを使わない場合は不要
+    def status_was
+      now = Time.now
+      case
+      when start_at_was > now
+        STATUS::SCHEDULED
+      when (end_at_was >= now and start_at_was <= now)
+        STATUS::OPENED
+      else
+        STATUS::FINISHED
+      end
+    end
+  end
+
+  entry = Entry.create(:start_at => Time.now, :end_at => Time.now + 10.days)
+  entry.status_label
+  entry.active?
+
+=== predicate: 属性値テストメソッドを作成しない
+
+predicateにfalseを与えると、属性値テストメソッドの作成が行われない。
+
+
+=== extensions: 定数オブジェクトに追加のメソッドを定義する
+
+ブロック内にメソッド定義を書くと、STAUTS[]やSTATUS.eachの際に取得できる定数オブジェクトに対してメソッドが定義される。
+collection_selectの際に表示したいラベル名を複数パターン用意する場合などに利用可能。
+
+  class User < ActiveRecord::Base
+    const :STATUS do
+      ENABLE    1
+      DISABLE   0
+      # 定数オブジェクトには以下のメソッドが存在するため、これらのメソッドを自由に呼び出すことができる
+      # key   名前空間（クラス、モジュール名）を含まない各定数名のシンボル
+      # label ラベル名
+      # value 定数値
+      def code
+        '%05d'%value
+      end
+      # I18nを使ってみる。
+      def label2
+        I18n.t(key.to_s.downcase, :scope=> 'label2.modelname')
+      end
+    end
+  end
+
+  # 選択肢に上で定義したcodeメソッドの値を使用する
+  form_for enable_piyo do |f|
+    f.collection_select(:status, User::STATUS, :value, :code)
+    f.collection_select(:status, User::STATUS, :value, :label2)
+  end
+
+== その他
+
+=== ラベル名を取得するメソッド名を変更する
+
+ConstEnum::ActiveRecord.label_suffixオプションを設定することで、
+ラベル名を取得すためのメソッドの名前（サフィックス）を変更することができる。
+
+  # config/initializers/const_enum.rb
+  require 'const_enum.rb'
+  ConstEnum::ActiveRecord.label_suffix = '_name' # ラベル名を返すメソッドにつけるサフィックスの指定
+
+
+== Copyright
+
+Copyright (c) 2012 SynergyMarketing.inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "const_enum"
+  gem.homepage = "http://github.com/techscore/const_enum"
+  gem.license = "BSD"
+  gem.summary = %Q{define ActiveRecord constants with DSL.}
+  gem.description = %Q{define ActiveRecord constants with DSL.and more!}
+  gem.email = "info@techscore.com"
+  gem.authors = ["yuki teraoka"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "const_enum #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/const_enum.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "const_enum"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["yuki teraoka"]
+  s.date = "2012-07-19"
+  s.description = "define ActiveRecord constants with DSL.and more!"
+  s.email = "info@techscore.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "const_enum.gemspec",
+    "lib/const_enum.rb",
+    "lib/const_enum/active_record.rb",
+    "lib/const_enum/base.rb",
+    "lib/const_enum/kernel.rb",
+    "lib/const_enum/with_i18n.rb",
+    "spec/active_record/active_record_spec.rb",
+    "spec/const_enum_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/database_cleaner.rb",
+    "spec/support/models.rb"
+  ]
+  s.homepage = "http://github.com/techscore/const_enum"
+  s.licenses = ["BSD"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "define ActiveRecord constants with DSL."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+  end
+end
+

data/lib/const_enum.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+require "const_enum/base"
+require "const_enum/kernel"
+require "const_enum/active_record"
+require "const_enum/with_i18n"

data/lib/const_enum/active_record.rb

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+module ConstEnum
+  module ActiveRecord
+    
+    mattr_accessor :label_suffix, :i18n
+    # ラベル名メソッドに付与するサフィックス
+    self.label_suffix = '_label'
+    # ラベル名にi18nを使用するかどうか
+    self.i18n = true
+
+    module ClassMethods
+      # 定数クラス、定数ラベルアクセサ、named_scope、predicate methodを作成します
+      # 
+      # = arguments
+      # mod_name: 定義されるクラスの名前です
+      # options: 
+      #  :scope         named_scopeを定義します。default: true
+      #  :predicate     属性値の検証メソッドを定義します。default: true
+      #  :prefix        scope, predicate を作成する際のprefixを指定します。default: "#{mod_name.downcase}_"
+      #
+      # = exapmle
+      # 
+      # class Hoge < ActiveRecord::Base
+      #   const :STATUS do
+      #     ENABLE    1, '有効'
+      #     DISABLE   0, '無効'
+      #     def code
+      #       '%05d'%value
+      #     end
+      #   end
+      # end
+      # 
+      # Hoge::STATUS::ENABLE # 1
+      # Hoge::STATUS.ENABLE.value # 1
+      # Hoge::STATUS.ENABLE.label # "有効"
+      # Hoge::STATUS.ENABLE.code # 00001
+      # Hoge.crate(:name => '有効なHOGE', :status => Hoge::STATUS::ENABLE)
+      # Hoge.crate(:name => '無効なHOGE', :status => Hoge::STATUS::DISABLE)
+      # enable_hoge = Hoge.status_enable.first
+      # enable_hoge.name # "有効なHOGE"
+      # enable_hoge.status_label # "有効"
+      # newhoge = Hoge.new(:name => '新しいHOGE', :status => Hoge::STATUS::ENABLE)
+      # newhoge.status_enable? # true
+      # newhoge.status_disable? # false
+      # form_for newhoge do |f|
+      #   f.collection_select(:status, Hoge::STATUS, :value, :label)
+      #   f.collection_select(:status, Hoge::STATUS, :value, :code)
+      # end
+      #
+      def const(clazz_name, options = {}, &block)
+        clazz_name = clazz_name.to_s
+        default = {:label_suffix => ConstEnum::ActiveRecord.label_suffix,:scope => true, :predicate => true, :attr=>clazz_name.downcase, :prefix => "#{clazz_name.downcase}_", :validation => false, :allow_blank => true, :i18n => true}
+        options = default.merge(options.symbolize_keys)
+        attr = options[:attr]
+        if ConstEnum::ActiveRecord.i18n and options[:i18n]
+          clazz = const_enum do
+            include ConstEnum::WithI18n
+            class_eval(&block)
+          end
+          clazz.i18n_options[:key] = [clazz.i18n_options[:key], self.name.underscore, attr].join('.')
+          clazz.i18n_options.merge!(ConstEnum::ActiveRecord.i18n) if Hash === ConstEnum::ActiveRecord.i18n
+          clazz.i18n_options.merge!(options[:i18n]) if Hash === options[:i18n]
+        else
+          clazz = const_enum(&block)
+        end
+        
+        const_set(clazz_name, clazz)
+        if options[:label_suffix]
+          class_eval <<-"EOS", __FILE__, __LINE__
+            def #{attr}#{options[:label_suffix]}
+              #{clazz_name}[#{attr}].try(:label)
+            end
+            def #{attr}#{options[:label_suffix]}_was
+              #{clazz_name}[#{attr}_was].try(:label)
+            end
+          EOS
+        end
+        if options[:scope]
+          clazz.each do |obj|
+            key =  clazz.key(obj.value).to_s
+            class_eval <<-"EOS", __FILE__, __LINE__
+              scope :#{options[:prefix]}#{key.downcase}, lambda { {:conditions => {'#{attr}' => #{clazz_name}::#{key} } }}
+            EOS
+          end
+        end
+        if options[:predicate]
+          clazz.each do |obj|
+            key = clazz.key(obj.value).to_s
+            class_eval <<-"EOS", __FILE__, __LINE__
+              def #{options[:prefix]}#{key.downcase}?
+                #{attr} == #{clazz_name}::#{key}
+              end
+              def was_#{options[:prefix]}#{key.downcase}?
+                #{attr}_was == #{clazz_name}::#{key}
+              end
+            EOS
+          end
+        end
+        if options[:validation]
+          validates attr.to_sym, :inclusion => {:in => clazz}, :allow_blank => (!!options[:allow_blank])
+        end
+        clazz
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send :extend,  ConstEnum::ActiveRecord::ClassMethods
+end

data/lib/const_enum/base.rb

@@ -0,0 +1,121 @@
+# coding: utf-8
+require "active_support/core_ext/module"
+require "active_support/core_ext/array"
+
+module ConstEnum
+  class Base
+    attr_reader :attributes, :key
+    delegate :from, :to, :first, :second, :third, :fourth, :fifth, :last, :forty_two, :to => :attributes
+    
+    def initialize(key, *attributes)
+      @key = key
+      @attributes = attributes
+      @attributes.freeze
+    end
+    
+    def [](pos)
+      @attributes[pos]
+    end
+    
+    def value
+      @attributes.first
+    end
+    
+    def label
+      @attributes.second
+    end
+    
+    def inspect
+      "#{@attributes.first.inspect}:#{(@attributes[2 .. -1]||[]).unshift(label).map(&:inspect).join(', ')}"
+    end
+    
+    def to_s
+      "#{@attributes.first.inspect}:#{(@attributes[2 .. -1]||[]).unshift(label).map(&:inspect).join(', ')}"
+    end
+    
+    class << self
+      include Enumerable
+      def inherited(clazz)
+        hash_class = RUBY_VERSION < '1.9' ? ActiveSupport::OrderedHash : Hash 
+        clazz.instance_variable_set(:@instances, hash_class.new)
+        clazz.instance_variable_set(:@keys, hash_class.new)
+      end
+      
+      def include?(value)
+        (ConstEnum === value) ? @instances.include?(value) : @instances.key?(value)
+      end
+      
+      def [](value)
+        @instances[value]
+      end
+      
+      def label(value)
+        @instances[value].label
+      end
+      
+      def key(value)
+        @keys[value]
+      end
+      
+      def keys
+        @keys.values
+      end
+      
+      def values
+        @instances.keys
+      end
+      
+      def labels
+        @instances.values.map(&:label)
+      end
+      
+      def size
+        @instances.size
+      end
+      
+      def each
+        return Enumerator.new(self) unless block_given?
+        @instances.each {|value, obj| yield obj }
+      end
+      
+      def each_key
+        return Enumerator.new(self, :each_key) unless block_given?
+        keys.each {|key| yield key }
+      end
+      
+      def each_value
+        return Enumerator.new(self, :each_value) unless block_given?
+        values.each {|value| yield value }
+      end
+      
+      def each_label
+        return Enumerator.new(self, :each_label) unless block_given?
+        labels.each {|label| yield label }
+      end
+      
+      def inspect
+        to_s
+      end
+
+      def to_s
+        return super if ConstEnum::Base == self
+        elems = []
+        @keys.each do |value, key|
+          elems << "#{key}[#{@instances[value]}]"
+        end
+        super << " { #{elems.join(', ')} }"
+      end
+
+      protected
+      def define_const(key, value, *args)
+        raise "already initialized constant value #{value}. name: #{key} defined_name: #{@keys[value]}"if @instances.key? value
+        const_set(key, value)
+        obj = self.new(key, value, *args)
+        singleton_class.__send__(:define_method, key) { obj }
+        obj.freeze
+        @instances[value] = obj
+        @keys[value] = key
+      end
+    end
+  end
+end

data/lib/const_enum/kernel.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+module Kernel
+  # 無名の定数クラスを作成して返します
+  # 与えたブロック内で以下のように記述することで定数とラベルを定義できます
+  # CLAZZNAME = const_enum do
+  #   HOGE 1, "ほげ"
+  #   FUGA 2, "ふが"
+  #   PIYO 3, "ぴよ"
+  # end
+  # puts CLAZZNAME::HOGE # 1
+  # puts CLAZZNAME[2] # ふが
+  def const_enum(&block)
+    clazz = Class.new(ConstEnum::Base)
+    clazz.singleton_class.__send__(:define_method, :method_missing) do |name, *args|
+      /\A[A-Z][a-zA-Z_0-9]*\z/ === name.to_s ? define_const(name, *args) : super
+    end
+    clazz.class_eval &block
+    clazz.singleton_class.__send__(:remove_method, :method_missing)
+    clazz
+  end
+end

data/lib/const_enum/with_i18n.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+require "active_support/concern"
+
+module ConstEnum
+  module WithI18n
+    extend ActiveSupport::Concern
+
+    DEFAULT_OPTIONS = { :key => 'labels'}
+    
+    included do
+      self.i18n_options = DEFAULT_OPTIONS.dup
+    end
+    
+    module InstanceMethods
+      def label
+        I18n.t(build_key(@attributes.second || key.to_s.downcase))
+      end
+      
+      private
+      def build_key(key)
+        "#{self.class.i18n_options[:key]}.#{key}"
+      end
+    end
+  
+    module ClassMethods
+      def i18n_options
+        @i18n_options
+      end
+      
+      def i18n_options=(options)
+        @i18n_options = options
+      end
+    end
+    
+  end
+end

data/spec/active_record/active_record_spec.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ConstEnum do
+  describe "ActiveRecord::Base.const" do
+    before do
+      User.create(:name=> "user1", :status=> 1, :gender => 'male'  , :role=> 2)
+      User.create(:name=> "user2", :status=> 1, :gender => 'female', :role=> 1)
+      User.create(:name=> "user3", :status=> 2, :gender => 'male'  , :role=> 1)
+      User.create(:name=> "user4", :status=> 2, :gender => 'male'  , :role=> 1)
+    end
+    
+    it do
+      active_user   = User.status_active.first
+      resigned_user = User.status_resigned.first
+      
+      active_user.status.should   == User::STATUS::ACTIVE
+      resigned_user.status.should == User::STATUS::RESIGNED
+      
+      active_user.status_label.should   == "Active"
+      resigned_user.status_label.should == "Resigned"
+      
+      active_user.should   be_status_active
+      resigned_user.should be_status_resigned
+      active_user.should_not   be_status_resigned
+      resigned_user.should_not be_status_active
+      
+      active_user.status = User::STATUS::RESIGNED
+      active_user.should     be_status_resigned
+      active_user.should     be_was_status_active
+      active_user.should_not be_was_status_resigned
+      active_user.status_label_was.should == "Active"
+      
+      male_user   = User.male.first
+      female_user = User.female.first
+      
+      male_user.gender_name.should   == "Male"
+      female_user.gender_name.should == "Female"
+      
+      User::GENDER[male_user.gender  ].symbole_mark.should == "man"
+      User::GENDER[female_user.gender].symbole_mark.should == "woman"
+      
+      User.male.count.should   == 3
+      User.female.count.should == 1
+      
+      male_user.gender = 'femala'
+      male_user.should be_invalid
+      male_user.gender = 'female'
+      male_user.should be_valid
+      
+      member  = User.scoped_by_role(User::ROLE::MEMBER).first
+      admin   = User.scoped_by_role(User::ROLE::ADMIN).first
+      lambda{ User.role_admin      }.should raise_error(NoMethodError)
+      lambda{ admin.role_label     }.should raise_error(NoMethodError)
+      lambda{ admin.role_label_was }.should raise_error(NoMethodError)
+      lambda{ admin.role_admin?    }.should raise_error(NoMethodError)
+      lambda{ admin.was_role_admin?}.should raise_error(NoMethodError)
+    end
+  end
+end
+

data/spec/const_enum_spec.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ConstEnum do
+  describe "const_enum" do
+    before do
+      @enum1 = const_enum do
+        CONST1 1, "label1", "1_opt1", "1_opt2"
+        CONST2 2, "label2", "2_opt1", "2_opt2"
+        CONST3 3, "label3", "3_opt1", "3_opt2"
+        CONST4 4, "label4", "4_opt1", "4_opt2"
+        CONST5 5, "label5", "5_opt1", "5_opt2"
+        
+        def upper_label
+          label.upcase
+        end
+      end
+    end
+    
+    context "constant class methods" do
+      it do
+        @enum1.should     be_include(1)
+        @enum1.should     be_include(2)
+        @enum1.should_not be_include(0)
+        @enum1.should_not be_include(6)
+        @enum1.should_not be_include("1")
+        @enum1.label(3).should == "label3"
+        @enum1.key(3).should   == :CONST3
+        @enum1.values.should   == (1..5).to_a
+        @enum1.labels.should   == (1..5).map{|i| "label#{i}"}
+        @enum1.keys.should     == (1..5).map{|i| :"CONST#{i}"}
+        @enum1.size.should     == 5
+      end
+    end
+    
+    context "constant values" do
+      it do
+        @enum1::CONST1.should == 1
+        @enum1::CONST2.should == 2
+        @enum1::CONST3.should == 3
+        @enum1::CONST4.should == 4
+        @enum1::CONST5.should == 5
+      end
+    end
+    
+    context "each constants" do
+      it do
+        @enum1.each_with_index do |obj, i|
+          n = i+1
+          @enum1[obj.value].should equal obj
+          obj.key.should   == :"CONST#{n}"
+          obj.value.should == n
+          obj.label.should == "label#{n}"
+          obj[0].should    == i+1
+          obj[1].should    == "label#{n}"
+          obj[2].should    == "#{n}_opt1"
+          obj[3].should    == "#{n}_opt2"
+          obj.upper_label.should == "LABEL#{n}"
+          obj.should be_frozen
+        end
+      end
+    end
+    
+    context "each items" do
+      it do
+        @enum1.each_key.to_a.should   == @enum1.map(&:key)
+        @enum1.each_label.to_a.should == @enum1.map(&:label)
+        @enum1.each_value.to_a.should == @enum1.map(&:value)
+      end
+    end
+    
+    context "define constant without block" do
+      it do
+        lambda{@enum1.FAILUER(10, "aaa")}.should raise_error(NoMethodError)
+        lambda{@enum1.define_const(:FAILUER, 10, "aaa")}.should raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/vendor/'
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'const_enum'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/database_cleaner.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+require 'database_cleaner'
+
+DatabaseCleaner[:active_record].strategy = :transaction if defined? ActiveRecord
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+require 'active_record'
+ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ':memory:')
+
+class User < ActiveRecord::Base
+  
+  const :STATUS do
+    ACTIVE   1
+    RESIGNED 2
+  end
+  
+  const :GENDER, :prefix => '', :label_suffix => "_name", :i18n => false, :validation => true, :allow_blank => true do
+    MALE   'male',   'Male'   , 'man'
+    FEMALE 'female', 'Female' , 'woman'
+    
+    def symbole_mark
+      third
+    end
+    
+  end
+  
+  const :ROLE, :scope => false, :label_suffix =>false, :predicate => false do
+    MEMBER   1
+    ADMIN    2
+  end
+  
+end
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) {|t| t.string :name; t.integer :status; t.string :gender; t.integer :role}
+  end
+end
+
+I18n.backend = I18n::Backend::KeyValue.new({})
+I18n.backend.store_translations :en, :labels =>{:user =>{:status => { :active => "Active", :resigned => "Resigned" }}}
+
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: const_enum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- yuki teraoka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &12500920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *12500920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12500240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *12500240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &12499600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *12499600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &12498720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *12498720
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &12497660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *12497660
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &14946220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14946220
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &14943420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *14943420
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &14941100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14941100
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &14104560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14104560
+description: define ActiveRecord constants with DSL.and more!
+email: info@techscore.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- const_enum.gemspec
+- lib/const_enum.rb
+- lib/const_enum/active_record.rb
+- lib/const_enum/base.rb
+- lib/const_enum/kernel.rb
+- lib/const_enum/with_i18n.rb
+- spec/active_record/active_record_spec.rb
+- spec/const_enum_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb
+homepage: http://github.com/techscore/const_enum
+licenses:
+- BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3828944335919537987
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: define ActiveRecord constants with DSL.
+test_files: []