enumattr-ext 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enumattr-ext.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 aisuii
+
+MIT License
+
+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.ja.md

@@ -0,0 +1,87 @@
+# Enumattr::Ext
+
+enumattr (https://github.com/aisuii/enumattr) のエクステンションです。
+
+## 導入
+
+bundler を利用しているなら、Gemfile に以下の行を加え、
+
+    gem 'enumattr-ext'
+
+以下のコマンドを実行します。
+
+    $ bundle
+
+あるいは自身でインストールすることもできます。
+
+    $ gem install enumattr-ext
+
+## 使い方
+
+### 例:
+
+Ruby のコードで以下のように書いて、
+
+    class User
+      include Enumattr::Base
+      include Enumattr::Ext::Name
+
+      attr_accessor :status
+
+      enumattr :status do
+        enum :active,   1
+        enum :inactive, 2
+        enum :deleted,  3
+      end
+
+      def initialize(status)
+        @status = status
+      end
+    end
+
+I18n の locales を以下のように用意して、
+
+    ja:
+      enumattr:
+        User:
+          status:
+            active:   有効
+            inactive: 無効
+            deleted:  削除
+
+I18n のロードパスにいれます。
+(Rails なら置くべきところに置いて、Rails から見えるようになっていればよい)
+
+    I18n.load_path = ['path/to/locales.yml']
+    I18n.locale = :ja
+
+すると、以下のようなクラスメソッドとインスタンスメソッドが定義されます。
+
+    User.status_names
+    # => ["有効", "無効", "削除"]
+
+    User.status_name(:active)
+    # => "有効"
+
+    User.status_options
+    #=> [["有効", 1], ["無効", 2], ["削除", 3]]
+
+    user = User.new(1)
+    user.status_name
+    # => "有効"
+
+素の enumattr で既に用意されているものについては https://github.com/aisuii/enumattr/blob/master/README.ja.md を参照してください。
+
+## その他の例
+
+_examples/*.rb_ と _spec/enumattr-ext/*.rb_ を参照してください。
+
+## ご意見・ご指導
+
+ご意見やご指導よろしくおねがいします。
+
+1. Fork して
+2. feature branch を作って (`git checkout -b my-new-feature`)
+3. コミットして (`git commit -am 'Added some feature'`)
+4. branch を push して (`git push origin my-new-feature`)
+5. Pull Request してください

data/README.md

@@ -0,0 +1,80 @@
+# Enumattr::Ext
+
+enumattr (https://github.com/aisuii/enumattr) extensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumattr-ext'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumattr-ext
+
+## Usage
+
+### example:
+
+Ruby code:
+
+    class User
+      include Enumattr::Base
+      include Enumattr::Ext::Name
+
+      attr_accessor :status
+
+      enumattr :status do
+        enum :active,   1
+        enum :inactive, 2
+        enum :deleted,  3
+      end
+
+      def initialize(status)
+        @status = status
+      end
+    end
+
+I18n locales:
+
+    ja:
+      enumattr:
+        User:
+          status:
+            active:   有効
+            inactive: 無効
+            deleted:  削除
+
+and
+
+    I18n.load_path = ['path/to/locales.yml']
+    I18n.locale = :ja
+
+then
+
+    User.status_names
+    # => ["有効", "無効", "削除"]
+
+    User.status_name(:active)
+    # => "有効"
+
+    User.status_options
+    #=> [["有効", 1], ["無効", 2], ["削除", 3]]
+
+    user = User.new(1)
+    user.status_name
+    # => "有効"
+
+see also: https://github.com/aisuii/enumattr
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)

data/enumattr-ext.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/enumattr-ext/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["aisuii"]
+  gem.email         = ["aisuiiaisuii@gmail.com"]
+  gem.description   = %q{enumattr extensions}
+  gem.summary       = %q{add enumattr features}
+  gem.homepage      = "https://github.com/aisuii/enumattr-ext"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "enumattr-ext"
+  gem.require_paths = ["lib"]
+  gem.version       = Enumattr::Ext::VERSION
+
+  gem.add_runtime_dependency('enumattr', '>= 0.0.5')
+  gem.add_runtime_dependency('i18n', '>= 0.6.0')
+  gem.add_runtime_dependency('activesupport', '>= 3.2.3')
+
+  gem.add_development_dependency('rspec')
+end

data/examples/admin_user.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+class AdminUser
+  include Enumattr::Base
+  include Enumattr::Ext::Name
+
+  attr_accessor :status
+
+  enumattr :status do
+    enum :active,   1, 'activated'
+    enum :inactive, 2, 'disabled'
+    enum :deleted,  3, 'deleted'
+  end
+
+  def initialize(status)
+    @status = status
+  end
+end

data/examples/anonymous.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+class Anonymous
+  include Enumattr::Base
+  include Enumattr::Ext::Name
+
+  attr_accessor :status
+
+  enumattr :status do
+    enum :active,   1
+    enum :inactive, 2
+    enum :deleted,  3
+  end
+
+  def initialize(status)
+    @status = status
+  end
+end

data/examples/locales/en.yml

@@ -0,0 +1,9 @@
+# -*- encoding: utf-8 -*-
+
+en:
+  enumattr:
+    User:
+      status:
+        active:   activated status
+        inactive: inacitive status
+        deleted:  deleted status

data/examples/locales/ja.yml

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+ja:
+  enumattr:
+    User:
+      status:
+        active:   有効
+        inactive: 無効
+        deleted:  削除

data/examples/user.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+class User
+  include Enumattr::Base
+  include Enumattr::Ext::Name
+
+  attr_accessor :status
+
+  enumattr :status do
+    enum :active,   1, 'activated'
+    enum :inactive, 2, 'disabled'
+    enum :deleted,  3, 'deleted'
+  end
+
+  def initialize(status)
+    @status = status
+  end
+end

data/lib/enumattr-ext.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+require "active_support/core_ext"
+require "enumattr"
+require "enumattr-ext/version"
+
+module Enumattr
+  module Ext
+    autoload :Name, 'enumattr-ext/name'
+  end
+end

data/lib/enumattr-ext/name.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+module Enumattr
+  module Ext
+    module Name
+      extend ActiveSupport::Concern
+
+      included do
+        Enumattr::Enums::Enum.send :include, Decorator
+        class << self
+          alias_method_chain :define_enumattr_class_methods,    :name
+          alias_method_chain :define_enumattr_instance_methods, :name
+        end
+      end
+
+      module ClassMethods
+        def define_enumattr_class_methods_with_name(enumattr_name)
+          define_enumattr_class_methods_without_name(enumattr_name)
+
+          method_prefix = "#{enumattr_name}_"
+          class_eval(<<-METHOD, __FILE__, __LINE__)
+            def self.#{method_prefix}names
+              enumattrs[:#{enumattr_name}].enums.map(&:name)
+            end
+
+            def self.#{method_prefix}name(key)
+              enum = enumattrs[:#{enumattr_name}].enum_by_key(key)
+              enum && enum.name
+            end
+
+            def self.#{method_prefix}options
+              enumattrs[:#{enumattr_name}].enums.map do |enum|
+                [ enum.name, enum.value ]
+              end
+            end
+          METHOD
+        end
+
+        def define_enumattr_instance_methods_with_name(enumattr_name)
+          define_enumattr_instance_methods_without_name(enumattr_name)
+
+          enums = enumattrs[enumattr_name]
+          method_prefix = "#{enumattr_name}_"
+
+          class_eval(<<-METHOD, __FILE__, __LINE__)
+            def #{method_prefix}name
+              enum = #{method_prefix}enum
+              enum && enum.name
+            end
+          METHOD
+        end
+      end
+
+      module Decorator
+        def name
+          default = @extras.first || key.to_s
+          scope = ["enumattr.#{@container.base.name}.#{@container.enumattr}"]
+          I18n.translate(key, :scope => scope, :default => default)
+        end
+      end
+    end
+  end
+end

data/lib/enumattr-ext/version.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+module Enumattr
+  module Ext
+    VERSION = "0.0.1"
+  end
+end

data/spec/enumattr-ext/name_spec.rb

@@ -0,0 +1,138 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+require 'user'
+require 'admin_user'
+require 'anonymous'
+
+describe Enumattr::Ext::Name do
+  context "use I18n name when locale file and enum :keyword, value, name" do
+    before do
+      I18n.load_path = Dir[File.join(File.dirname(__FILE__), '../../examples/locales/*.yml')]
+    end
+
+    describe "class methods" do
+      subject { User }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_names) { should == ["有効", "無効", "削除"] }
+        its(:status_options) { should == [["有効", 1], ["無効", 2], ["削除", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "有効"' do
+            subject.status_name(:active).should == "有効"
+          end
+        end
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_names) { should == ["activated status", "inacitive status", "deleted status"] }
+        its(:status_options) { should == [["activated status", 1], ["inacitive status", 2], ["deleted status", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "activated status"' do
+            subject.status_name(:active).should == "activated status"
+          end
+        end
+      end
+    end
+
+    describe "instance methods" do
+      subject { User.new(User.status_value(:active)) }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_name) { should == "有効" }
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_name) { should == "activated status" }
+      end
+    end
+  end
+
+  context "use enum name when no locale file and enum :keyword, value, name" do
+    describe "class methods" do
+      subject { AdminUser }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_names) { should == ['activated', 'disabled', 'deleted'] }
+        its(:status_options) { should == [["activated", 1], ["disabled", 2], ["deleted", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "activated"' do
+            subject.status_name(:active).should == "activated"
+          end
+        end
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_names) { should == ['activated', 'disabled', 'deleted'] }
+        its(:status_options) { should == [["activated", 1], ["disabled", 2], ["deleted", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "activated"' do
+            subject.status_name(:active).should == "activated"
+          end
+        end
+      end
+    end
+
+    describe "instance methods" do
+      subject { AdminUser.new(AdminUser.status_value(:active)) }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_name) { should == 'activated' }
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_name) { should == 'activated' }
+      end
+    end
+  end
+
+  context "use keyword.to_s when no locale file and enum :keyword, value" do
+    describe "class methods" do
+      subject { Anonymous }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_names) { should == ['active', 'inactive', 'deleted'] }
+        its(:status_options) { should == [["active", 1], ["inactive", 2], ["deleted", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "active"' do
+            subject.status_name(:active).should == "active"
+          end
+        end
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_names) { should == ['active', 'inactive', 'deleted'] }
+        its(:status_options) { should == [["active", 1], ["inactive", 2], ["deleted", 3]] }
+        describe 'status_name(:active)' do
+          it 'should == "active"' do
+            subject.status_name(:active).should == "active"
+          end
+        end
+      end
+    end
+
+    describe "instance methods" do
+      subject { Anonymous.new(Anonymous.status_value(:active)) }
+
+      context "locale :ja" do
+        before { I18n.locale = :ja }
+        its(:status_name) { should == 'active' }
+      end
+
+      context "locale :en" do
+        before { I18n.locale = :en }
+        its(:status_name) { should == 'active' }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'examples'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'enumattr-ext'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: enumattr-ext
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- aisuii
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: enumattr
+  requirement: &82199750 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *82199750
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &82199500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *82199500
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &82199250 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *82199250
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &82199040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82199040
+description: enumattr extensions
+email:
+- aisuiiaisuii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.ja.md
+- README.md
+- Rakefile
+- enumattr-ext.gemspec
+- examples/admin_user.rb
+- examples/anonymous.rb
+- examples/locales/en.yml
+- examples/locales/ja.yml
+- examples/user.rb
+- lib/enumattr-ext.rb
+- lib/enumattr-ext/name.rb
+- lib/enumattr-ext/version.rb
+- spec/enumattr-ext/name_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aisuii/enumattr-ext
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: add enumattr features
+test_files:
+- spec/enumattr-ext/name_spec.rb
+- spec/spec_helper.rb