inum 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781689678af4d4332e501ba581e4fcb3ce02e238
-  data.tar.gz: c9d80cf8f71ac711992dc776f6d5d9db2dd462f3
+  metadata.gz: 0a45543edcaeff37b2532ff978a90bd3eb773bc2
+  data.tar.gz: 357be60fffc7baec45c791aebd39c9da9990a2cb
 SHA512:
-  metadata.gz: b90ff4e1a44db7c92ed86c758c93bea51241acd42e541fa2b7a42c10ca1188db30a4e223ac0089d679dc7cced45e5cf726a358f8bf33b3bd64b83865b7c1fac8
-  data.tar.gz: f8300442ef7814585669a34ce6bb85acacfede154c663ff5b686b5ded203c1d0e6fe83661ceb7abe672da1fa3bc598c10c227b11f425ba2b21b3e0f78de29c56
+  metadata.gz: 82e42a428ed15ef2f98b434c72fcaf56fe6a5431d23faa81e0f16632e39792ae26e029ce3d67ec9f381624b887f56f44f3067d5d39ceec6f915d3c6ef7721c58
+  data.tar.gz: 7e7301e5e39d9032efe85e7fd49e817d10ccea32ae2b8ff890aa366c8502ec809c36bf481c8fa81b2159fdc5e56bf3a59ea5a8abc94b6d2b568e6eba51742515

data/README.md

@@ -1,6 +1,7 @@
 # Inum
 
 Inum(enumerated type of Integer) provide a Java-enum-like Enum.
+Inum has a function to localize by i18n.
 
 ## Installation
 
@@ -42,6 +43,7 @@ How to use Enum(Inum).
 ``` ruby
 p AnimeType::EVANGELION       # => EVANGELION
 p AnimeType::EVANGELION.to_i  # => 0
+p AnimeType::EVANGELION.to_t  # => エヴァンゲリオン (i18n find `anime_type.evangelion`.)
 
 # parse object to instance of AnimeType.
 # object can use class of Symbol or String or Integer or Self.
@@ -53,7 +55,11 @@ p AnimeType::HARUHI.eql?('HARUHI')   # => true (eql? can compare all parsable ob
 p AnimeType::HARUHI + 1   # => NYARUKO
 p AnimeType::NYARUKO - 1  # => HARUHI
 
+# can use each method.
+AnimeType::each {|enum| p enum }
+
 ```
+can use Enumerable and Comparable.
 
 - more detail is [Class::Base](http://rubydoc.info/github/alfa-jpn/inum/Inum/Base)
 
@@ -87,6 +93,16 @@ p anime.haruhi? # => true
 
 ```
 
+### Localize(i18n)
+to_t methods localize enum by i18n.
+default i18n key is name_space.class_name.enum_member_label.
+If change default, Override i18n_key class method.
+``` ruby
+# default i18n_key.
+def self.i18n_key(label)
+  Inum::Utils::underscore("#{self.class.name}::#{label}")
+end
+```
 
 ## API DOCUMENT
 
@@ -99,3 +115,5 @@ p anime.haruhi? # => true
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+# I have poor English. Please help meeeeeeeee!!!!

data/inum.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
+
+  spec.add_dependency "i18n", "~> 0.6.5"
 end

data/lib/inum/base.rb

@@ -1,4 +1,7 @@
 module Inum
+  require 'i18n'
+  require 'inum/utils'
+
   # InumBase class.
   #
   # @abstract Inum class should be a inheritance of Inum::Base.
@@ -9,7 +12,9 @@ module Inum
   #     define_enum :ORANGE, 2
   #   end
   class Base
-   
+    extend Enumerable
+    include Comparable
+
     private_class_method :new
 
     # initialize Inum::Base with value.
@@ -20,8 +25,18 @@ module Inum
     def initialize(label, value)
       @label = label
       @value = value
+
+      @localized_enum = I18n.t(self.class.i18n_key(label))
     end
-    
+
+    # Compare object.
+    #
+    # @param object [Object] parsable object.
+    # @return [Integer] same normal <=>.
+    def <=> (object)
+      @value <=> self.class.parse(object).to_i
+    end
+
     # plus object.
     #
     # @param value [Integer] plus value.(call to_i in this method.)
@@ -60,6 +75,21 @@ module Inum
       @label.to_s
     end
 
+    # Translate Enum to localized string.(use i18n)
+    # @note find default `Namespace.Classname.EnumMember`
+    #
+    # @return [String] localized string of Enum.
+    def to_t
+      @localized_enum
+    end
+
+    # Execute the yield(block) with each member of enum.
+    #
+    # @yield [enum] instance of enum.
+    def self.each
+      defined_enums.each_key {|key| yield parse(key.to_s)}
+    end
+
     # get all labels of Enum.
     #
     # @return [Array<Symbol>] all labels of Enum.
@@ -133,6 +163,16 @@ module Inum
       self.const_get(:DEFINED_ENUMS)
     end
 
+    # get key for I18n.t method.
+    # @note default: Namespace.Classname.Label(label of enum member.)
+    #
+    # @param label [Symbol] label of enum member.
+    # @return [String] key for I18n.t method.
+    # @abstract If change key from the default.
+    def self.i18n_key(label)
+      Inum::Utils::underscore("#{self.class.name}::#{label}")
+    end
+
     # call after inherited.
     # @note Define hash of :DEFINED_ENUMS in child.
     def self.inherited(child)

data/lib/inum/utils.rb

@@ -9,6 +9,7 @@ module Inum
     def self.underscore(camel_cased_word)
       word = camel_cased_word.to_s.dup
       
+      word.gsub!('::', '.')
       word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
       word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
       word.tr!('-', '_')

data/lib/inum/version.rb

@@ -1,3 +1,3 @@
 module Inum
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/inum/base_spec.rb

@@ -2,8 +2,8 @@ require 'rspec'
 require 'spec_helper'
 
 describe Inum::Base do
-  
-  it 'define_method validate correct' do
+
+  it 'define_enum validate correct' do
     # correct.
     expect{
       Class.new(Inum::Base) { define_enum :REDBULL,  0 }  
@@ -40,8 +40,8 @@ describe Inum::Base do
       }
     }.to raise_error
   end
-  
-  it 'define_method called without value, value is autoincrement.' do
+
+  it 'define_enum called without value, value is autoincrement.' do
     enum = Class.new(Inum::Base) do
       define_enum :REDBULL
       define_enum :MONSTER
@@ -52,9 +52,18 @@ describe Inum::Base do
     expect(enum::MONSTER.to_i).to eq(1)
     expect(enum::BURN.to_i).to    eq(2)
   end
-  
+
+  it 'i18n.t called when call define_enum.' do
+    I18n.should_receive(:t).with('class.redbull')
+
+    Class.new(Inum::Base) do
+      define_enum :REDBULL
+    end
+  end
+
   context 'define class of extended Inum::Base,' do
     before(:each) do
+      I18n.stub(:t).and_return('Good drink!')
       @enum = Class.new(Inum::Base) do
         define_enum :REDBULL,  0
         define_enum :MONSTER,  1
@@ -76,7 +85,13 @@ describe Inum::Base do
     it 'A enum instance is equal instance.' do
       expect( @enum::BURN.equal?(@enum::BURN )).to be_true
     end
-    
+
+    it '<=> return a correct value.' do
+      expect( (@enum::REDBULL <=> 1) < 0 ).to be_true
+      expect( (@enum::REDBULL <=> 0) == 0 ).to be_true
+      expect( (@enum::MONSTER <=> 0) > 0 ).to be_true
+    end
+
     it '+ return a correct Inum.' do
       expect(@enum::REDBULL + 1).to eq(@enum::MONSTER)
       expect(@enum::REDBULL + @enum::MONSTER).to eq(@enum::MONSTER)
@@ -86,7 +101,11 @@ describe Inum::Base do
       expect(@enum::BURN - 1).to eq(@enum::MONSTER)
       expect(@enum::BURN - @enum::MONSTER).to eq(@enum::MONSTER)
     end
-    
+
+    it 'Comparable module enable.' do
+      expect(@enum::REDBULL.between?(0,1)).to be_true
+    end
+
     it 'eql? return a correct result.' do
       expect( @enum::REDBULL.eql?(0) ).to be_true
       expect( @enum::REDBULL.eql?(1) ).to be_false
@@ -99,7 +118,26 @@ describe Inum::Base do
     it 'to_s return string.' do
       expect( @enum::MONSTER.to_s ).to eq('MONSTER')
     end
-    
+
+    it 'to_t return localized string.' do
+      expect( @enum::REDBULL.to_t ).to eq('Good drink!')
+    end
+
+    it 'each can execute block with enum' do
+      count = 0
+      expect{
+        @enum::each do |enum|
+          expect(enum.instance_of?(@enum)).to be_true
+          count += 1
+        end
+      }.to change{count}.by(3)
+    end
+
+    it 'Enumerable module enable.' do
+      expect(@enum::count).to eq(3)
+      expect(@enum::include?(@enum::REDBULL)).to be_true
+    end
+
     it 'labels return Array<Symbol>.' do
       expect(@enum::labels.length).to eq(3) 
       expect(@enum::labels.instance_of?(Array)).to     be_true

data/spec/inum/utils_spec.rb

@@ -9,6 +9,12 @@ describe Inum::Utils do
     expect(Inum::Utils::underscore('CamelCaseWord')).to eq('camel_case_word')
     
     expect(Inum::Utils::underscore('Came1Case')).to eq('came1_case')
+
+    expect(Inum::Utils::underscore('UNDER_SCORE')).to eq('under_score')
+    expect(Inum::Utils::underscore('under_score')).to eq('under_score')
+
+    expect(Inum::Utils::underscore('name::space')).to eq('name.space')
+    expect(Inum::Utils::underscore('Name::Space')).to  eq('name.space')
   end
   
   it 'underscore can convert Symbol to underscore_word.' do

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler/setup'
 require 'inum/base'
 require 'inum/define_check_method'
 require 'inum/utils'
+require 'i18n'
 
 RSpec.configure do |config|
   config.mock_framework = :rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inum
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - alfa-jpn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.5
 description: Inum(enumerated type of Integer) provide a java-Enum-like.
 email:
 - a.nkmr.ja@gmail.com