inum 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13fa0a53e7d738142a3ada77e6ae500e1be64b74
-  data.tar.gz: 0f69ba1695638ee4b501353e98da80bc8f48842c
+  metadata.gz: 781689678af4d4332e501ba581e4fcb3ce02e238
+  data.tar.gz: c9d80cf8f71ac711992dc776f6d5d9db2dd462f3
 SHA512:
-  metadata.gz: b4c68d473c6edee840eb3e49e55e78c1e3cd8477f44fb8afec1afee047b4bf4c59cb881c834875701065cd04cdbecb4f29d7bb042a7f35fcdc383fc6904b4e92
-  data.tar.gz: 18298d6d00e8b4c06312dbc8c33e9eab8081c7c2b1a028f8babddbea6ad170892a1c3abc2ebc3dfc17210f740738fc840f806b5a4b542df032837a3dc2580857
+  metadata.gz: b90ff4e1a44db7c92ed86c758c93bea51241acd42e541fa2b7a42c10ca1188db30a4e223ac0089d679dc7cced45e5cf726a358f8bf33b3bd64b83865b7c1fac8
+  data.tar.gz: f8300442ef7814585669a34ce6bb85acacfede154c663ff5b686b5ded203c1d0e6fe83661ceb7abe672da1fa3bc598c10c227b11f425ba2b21b3e0f78de29c56

data/lib/inum/base.rb

@@ -10,17 +10,15 @@ module Inum
   #   end
   class Base
    
-    attr_accessor :value
     private_class_method :new
 
     # initialize Inum::Base with value.
-    # @note Inum::Base can't call new method.
+    # @note The instance of Enum Member is singleton.
     #
+    # @param label [Symbol]  label of Enum.
     # @param value [Integer] value of Enum.
-    def initialize(value)
-      unless self.class.defined_enums.has_value?(value)
-        raise ArgumentError, "unknown value #{value}!"
-      end
+    def initialize(label, value)
+      @label = label
       @value = value
     end
     
@@ -57,11 +55,18 @@ module Inum
 
     # Enum to String.
     #
-    # @return [String] string value of Enum.
+    # @return [String] string value(label) of Enum.
     def to_s
-      self.class.defined_enums.key(@value).to_s
+      @label.to_s
     end
 
+    # get all labels of Enum.
+    #
+    # @return [Array<Symbol>] all labels of Enum.
+    def self.labels
+      defined_enums.keys
+    end
+    
     # get Enum length.
     #
     # @return [Integer] count of Enums.
@@ -71,14 +76,14 @@ module Inum
     
     # return array of Enums.
     #
-    # @return [Array<Array<String, Integer>>] sorted array of Enums.
+    # @return [Array<Array<Symbol, Integer>>] sorted array of Enums.
     def self.to_a
-      defined_enums.map{|k,v| [k.to_s,v] }.sort{|a,b| a[1] <=> b[1] }
+      defined_enums.flatten(0).sort{|a,b| a[1] <=> b[1] }
     end
     
     # return hash of Enums.
     #
-    # @return [Hash] hash of Enums.
+    # @return [Hash<Symbol, Integer>] hash of Enums.
     def self.to_h
       defined_enums.dup
     end
@@ -101,17 +106,26 @@ module Inum
           raise ArgumentError, "#{object} is nani?"
       end
     end
+    
+    # get all values of Enum.
+    #
+    # @return [Array<Integer>] all values of Enum.
+    def self.values
+      defined_enums.values
+    end
 
     private
     # Define Enum in called class.
     #
-    # @param name  [String, Symbol] name of Enum.
-    # @param value [Integer,Fixnum] value of Enum.(default:autoincrement for 0.)
-    def self.define_enum(name, value = defined_enums.size)
-      validate_enum_args!(name, value)
+    # @param label [Symbol]  label of Enum.
+    # @param value [Integer] value of Enum.(default:autoincrement for 0.)
+    def self.define_enum(label, value = defined_enums.size)
+      value = value.to_i
+      
+      validate_enum_args!(label, value)
 
-      defined_enums[name] = value
-      self.const_set(name, new(value))
+      defined_enums[label] = value
+      self.const_set(label, new(label, value))
     end
     
     # get hash of :DEFINED_ENUMS.
@@ -127,27 +141,23 @@ module Inum
     
     # Validate enum args, and raise exception.
     # 
-    # @param name  [Object]  name of Enum.
-    # @param value [Object] value of Enum.
-    def self.validate_enum_args!(name, value)
-      unless name.instance_of?(String) or name.instance_of?(Symbol)
-        raise ArgumentError, "#{name}<#{name.class}> isn't String or Symbol."
-      end
-      
-      unless value.instance_of?(Integer) or value.instance_of?(Fixnum)
-        raise ArgumentError, "#{value}<#{value.class}> isn't Integer or Fixnum."
+    # @param label [Object]  label of Enum.
+    # @param value [Integer] value of Enum.
+    def self.validate_enum_args!(label, value)
+      unless label.instance_of?(Symbol)
+        raise ArgumentError, "The label(#{label}!) isn't instance of Symbol."
       end
       
-      if name == :DEFINED_ENUMS
-        raise ArgumentError, "#{name} is keyword."
+      if label == :DEFINED_ENUMS
+        raise ArgumentError, "The label(#{label}!) is keyword."
       end
 
-      if defined_enums.has_key?(name)
-        raise ArgumentError, "name(#{name}!) already exists!!"
+      if defined_enums.has_key?(label)
+        raise ArgumentError, "The label(#{label}!) already exists!!"
       end
       
       if defined_enums.has_value?(value)
-        raise ArgumentError, "value(#{value}!) already exists!!"
+        raise ArgumentError, "The value(#{value}!) already exists!!"
       end
     end
   end

data/lib/inum/define_check_method.rb

@@ -10,6 +10,8 @@ module Inum
   #   end
   #
   module DefineCheckMethod
+    require 'inum/utils'
+    
     # Define compare method in class.
     #
     # @param variable_name [String]     name of variable.
@@ -17,7 +19,7 @@ module Inum
     def define_check_method(variable_name, enum_class)
       self.class_eval do
         enum_class::DEFINED_ENUMS.each_key do |enum_name|
-          define_method("#{enum_name.downcase}?") do
+          define_method("#{Inum::Utils::underscore(enum_name)}?") do
             enum_class::parse(enum_name).eql?(send(variable_name))
           end
         end

data/lib/inum/utils.rb

@@ -0,0 +1,22 @@
+module Inum
+  # Utils of Inum.
+  class Utils
+    
+    # convert a camel cased word to a underscore word.
+    #
+    # @param camel_cased_word [String] camel cased word.
+    # @return [String, Symbol] underscore word.
+    def self.underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      
+      word.downcase!
+      
+      word
+    end
+    
+  end
+end

data/lib/inum/version.rb

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

data/spec/inum/base_spec.rb

@@ -6,8 +6,7 @@ describe Inum::Base do
   it 'define_method validate correct' do
     # correct.
     expect{
-      Class.new(Inum::Base) { define_enum :REDBULL,  0 } 
-      Class.new(Inum::Base) { define_enum 'REDBULL', 0 } 
+      Class.new(Inum::Base) { define_enum :REDBULL,  0 }  
       Class.new(Inum::Base) { define_enum :REDBULL,  0.to_i }
       Class.new(Inum::Base) { 
         define_enum :REDBULL, 0 
@@ -101,14 +100,24 @@ describe Inum::Base do
       expect( @enum::MONSTER.to_s ).to eq('MONSTER')
     end
     
+    it 'labels return Array<Symbol>.' do
+      expect(@enum::labels.length).to eq(3) 
+      expect(@enum::labels.instance_of?(Array)).to     be_true
+      expect(@enum::labels[0].instance_of?(Symbol)).to be_true      
+    end
+    
     it 'length return count of enum.' do
       expect(@enum::length).to eq(3)
     end
     
-    it 'to_a return Array' do
-      expect(@enum::to_a.instance_of?(Array)).to be_true
+    it 'to_a return Array<Array<Symbol,Integer>>.' do
       expect(@enum::to_a.length).to eq(3)
-      expect(@enum::to_a[0][0]).to  eq('REDBULL')
+      expect(@enum::to_a.instance_of?(Array)).to        be_true
+      expect(@enum::to_a[0].instance_of?(Array)).to     be_true
+      expect(@enum::to_a[0][0].instance_of?(Symbol)).to be_true
+      expect(@enum::to_a[0][1].integer?).to             be_true
+      
+      expect(@enum::to_a[0][0]).to eq(:REDBULL)
       (0..2).each{|i| expect(@enum::to_a[i][1]).to eq(i) }
     end
     
@@ -133,5 +142,11 @@ describe Inum::Base do
     it 'parse return instance from self instance.' do
       expect( @enum::parse(@enum::REDBULL) ).to eq( @enum::REDBULL )
     end
+    
+    it 'values return Array<Integer>.' do
+      expect(@enum::values.length).to eq(3) 
+      expect(@enum::values.instance_of?(Array)).to be_true
+      expect(@enum::values[0].integer?).to         be_true      
+    end
   end
 end

data/spec/inum/utils_spec.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'spec_helper'
+
+describe Inum::Utils do
+
+  it 'underscore can convert CamelCasedWord to underscore_word.' do
+    expect(Inum::Utils::underscore('camelcase')).to     eq('camelcase')
+    expect(Inum::Utils::underscore('CamelCase')).to     eq('camel_case')
+    expect(Inum::Utils::underscore('CamelCaseWord')).to eq('camel_case_word')
+    
+    expect(Inum::Utils::underscore('Came1Case')).to eq('came1_case')
+  end
+  
+  it 'underscore can convert Symbol to underscore_word.' do
+    expect(Inum::Utils::underscore(:CamelCase)).to eq('camel_case')
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 require 'inum/base'
 require 'inum/define_check_method'
+require 'inum/utils'
 
 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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - alfa-jpn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,9 +82,11 @@ files:
 - lib/inum.rb
 - lib/inum/base.rb
 - lib/inum/define_check_method.rb
+- lib/inum/utils.rb
 - lib/inum/version.rb
 - spec/inum/base_spec.rb
 - spec/inum/define_check_method_spec.rb
+- spec/inum/utils_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alfa-jpn/inum
 licenses:
@@ -113,5 +115,6 @@ summary: Inum(enumerated type of Integer) provide a java-Enum-like.
 test_files:
 - spec/inum/base_spec.rb
 - spec/inum/define_check_method_spec.rb
+- spec/inum/utils_spec.rb
 - spec/spec_helper.rb
 has_rdoc: