ruby-enum 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff88e3a9dd8dc2188f929ad3e84cc86a0fd313c3
-  data.tar.gz: 66f8dd956d3eeb27fd2457c56f76a144c30a1518
+  metadata.gz: 47e52bdfbc7d70944470141e18c1629d058326c0
+  data.tar.gz: 3992c7e739aea0799d6adc820e03b6bba5f17357
 SHA512:
-  metadata.gz: 8b4196088d70c8cfabf6e2adfe15a99744343dabc8b4275b26340314186a755375efac54900d1b4e61957ed13d7e818fcac860fd7dac6a04350efdbbf479f79d
-  data.tar.gz: 409a290aa4ed199c6ec84fba971b33b4e176625c400ba313de111d7dacb3180f32a5ba83ace957f7e01875483b00de50ea7c9f884483f6df0b1d4d6c295c9685
+  metadata.gz: 79c51dec06a07ccb4b6bcbbfd18101798e885674bf0d3f6e95e7833f70c8d99485a87739d6e6b644f3f7d34e8488417b116aa3a6d4c2311343cb8fdd597eca46
+  data.tar.gz: a532c64b93a9ec0a44b68db66a81f6b206ee9d65c40f156ce91da89fd00a6124a61e2b59a1bc902ace03580cb79a74b4a09fdb77a4e5c0a2172c8f7dca81c035

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.7.2 (15/3/2017)
+
+* [#18](https://github.com/dblock/ruby-enum/pull/18): Adds support for non constant definition - [@laertispappas](https://github.com/laertispappas).
+
 ### 0.7.1 (23/2/2017)
 
 * [#16](https://github.com/dblock/ruby-enum/pull/16): Replaces const_missing method in favor of const_set - [@laertispappas](https://github.com/laertispappas).

data/Gemfile.lock

@@ -1,20 +1,23 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.7.1)
+    ruby-enum (0.7.2)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.3.0)
-    diff-lcs (1.3)
-    i18n (0.8.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.2.5)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     powerpack (0.1.1)
-    rainbow (2.2.1)
-    rake (10.5.0)
+    rainbow (2.2.2)
+      rake
+    rake (11.3.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -34,8 +37,8 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    unicode-display_width (1.1.3)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -47,4 +50,4 @@ DEPENDENCIES
   ruby-enum!
 
 BUNDLED WITH
-   1.14.4
+   1.15.3

data/README.md

@@ -10,6 +10,10 @@ Enum-like behavior for Ruby, heavily inspired by [this](http://www.rubyfleebie.c
 
 ## Usage
 
+Enums can be defined and accessed either as constants or class methods. For example below we have two Ruby::Enum classes
+where the first one (Colors) defines its enums and references them as constants. The second class (State) defines and
+references its enums as class methods.
+
 ``` ruby
 class Colors
   include Ruby::Enum
@@ -17,6 +21,14 @@ class Colors
   define :RED, "red"
   define :GREEN, "green"
 end
+
+# or for versions >= 0.7.2
+class State
+  include Ruby::Enum
+
+  define :created, 'Created'
+  define :published, 'Published'
+end
 ```
 
 ### Referencing
@@ -28,6 +40,13 @@ Colors::UNDEFINED # raises Ruby::Enum::Errors::UninitializedConstantError
 Colors.keys # [ :RED, :GREEN ]
 Colors.values # [ "red", "green" ]
 Colors.to_h # { :RED => "red", :GREEN => "green" }
+
+State.created # "Created"
+State.published # "Published"
+State.undefined # NoMethodError is raised
+State.keys # [ :created, :published ]
+State.values # ["Created", "Published"]
+State.to_h # { :created => 'Created', :published => 'Published' }
 ```
 
 ### All `Enumerable` methods are supported.

data/lib/ruby-enum/enum.rb

@@ -27,23 +27,19 @@ module Ruby
         validate_key!(key)
         validate_value!(value)
 
-        new_instance = new(key, value)
-        @_enum_hash[key] = new_instance
-        @_enums_by_value[value] = new_instance
-
-        const_set key, value
-      end
-
-      def validate_key!(key)
-        return unless @_enum_hash.key?(key)
+        store_new_instance(key, value)
 
-        raise Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
+        if upper?(key.to_s)
+          const_set key, value
+        else
+          define_singleton_method(key) { value }
+        end
       end
 
-      def validate_value!(value)
-        return unless @_enums_by_value.key?(value)
-
-        raise Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
+      def store_new_instance(key, value)
+        new_instance = new(key, value)
+        @_enum_hash[key] = new_instance
+        @_enums_by_value[value] = new_instance
       end
 
       def const_missing(key)
@@ -128,6 +124,24 @@ module Ruby
           [key, enum.value]
         end]
       end
+
+      private
+
+      def upper?(s)
+        !/[[:upper:]]/.match(s).nil?
+      end
+
+      def validate_key!(key)
+        return unless @_enum_hash.key?(key)
+
+        raise Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
+      end
+
+      def validate_value!(value)
+        return unless @_enums_by_value.key?(value)
+
+        raise Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
+      end
     end
   end
 end

data/lib/ruby-enum/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module Enum
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.7.2'.freeze
   end
 end

data/spec/ruby-enum/enum_spec.rb

@@ -16,29 +16,6 @@ class SecondSubclass < FirstSubclass
 end
 
 describe Ruby::Enum do
-  describe 'Subclass behavior' do
-    it 'contains the enums defined in the parent class' do
-      expect(FirstSubclass::GREEN).to eq 'green'
-      expect(FirstSubclass::RED).to eq 'red'
-    end
-
-    it 'contains its own enums' do
-      expect(FirstSubclass::ORANGE).to eq 'orange'
-    end
-    it 'parent class should not have enums defined in child classes' do
-      expect { Colors::ORANGE }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
-    end
-    context 'Given a 2 level depth subclass' do
-      subject { SecondSubclass }
-      it 'contains its own enums and all the enums defined in the parent classes' do
-        expect(subject::RED).to eq 'red'
-        expect(subject::GREEN).to eq 'green'
-        expect(subject::ORANGE).to eq 'orange'
-        expect(subject::PINK).to eq 'pink'
-      end
-    end
-  end
-
   it 'returns an enum value' do
     expect(Colors::RED).to eq 'red'
     expect(Colors::GREEN).to eq 'green'
@@ -177,4 +154,46 @@ describe Ruby::Enum do
 
     it { expect(Colors::RED).to eq 'red' }
   end
+
+  describe 'Subclass behavior' do
+    it 'contains the enums defined in the parent class' do
+      expect(FirstSubclass::GREEN).to eq 'green'
+      expect(FirstSubclass::RED).to eq 'red'
+    end
+
+    it 'contains its own enums' do
+      expect(FirstSubclass::ORANGE).to eq 'orange'
+    end
+    it 'parent class should not have enums defined in child classes' do
+      expect { Colors::ORANGE }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
+    end
+    context 'Given a 2 level depth subclass' do
+      subject { SecondSubclass }
+      it 'contains its own enums and all the enums defined in the parent classes' do
+        expect(subject::RED).to eq 'red'
+        expect(subject::GREEN).to eq 'green'
+        expect(subject::ORANGE).to eq 'orange'
+        expect(subject::PINK).to eq 'pink'
+      end
+    end
+  end
+
+  describe 'non constant definitions' do
+    class States
+      include Ruby::Enum
+      define :created, 'Created'
+      define :published, 'Published'
+    end
+    subject { States }
+    it 'behaves like an enum' do
+      expect(subject.created).to eq 'Created'
+      expect(subject.published).to eq 'Published'
+
+      expect(subject.key?(:created)).to be true
+      expect(subject.key('Created')).to eq :created
+
+      expect(subject.value?('Created')).to be true
+      expect(subject.value(:created)).to eq 'Created'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -47,13 +47,11 @@ files:
 - lib/ruby-enum/errors/uninitialized_constant_error.rb
 - lib/ruby-enum/version.rb
 - lib/ruby_enum.rb
-- pkg/ruby-enum-0.7.0.gem
-- pkg/ruby-enum-0.7.1.gem
+- pkg/ruby-enum-0.6.0.gem
 - ruby-enum.gemspec
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
 - spec/spec_helper.rb
-- tags
 homepage: http://github.com/dblock/ruby-enum
 licenses:
 - MIT
@@ -74,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Enum-like behavior for Ruby.

data/tags

@@ -1,54 +0,0 @@
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
-!_TAG_PROGRAM_NAME	Exuberant Ctags	//
-!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
-!_TAG_PROGRAM_VERSION	5.9~svn20110310	//
-Base	lib/ruby-enum/errors/base.rb	/^      class Base < StandardError$/;"	c	class:Ruby.Enum.Errors
-ClassMethods	lib/ruby-enum/enum.rb	/^    module ClassMethods$/;"	m	class:Ruby.Enum
-Colors	spec/ruby-enum/enum_spec.rb	/^class Colors$/;"	c
-DuplicateKeyError	lib/ruby-enum/errors/duplicate_key_error.rb	/^      class DuplicateKeyError < Base$/;"	c	class:Ruby.Enum.Errors
-DuplicateValueError	lib/ruby-enum/errors/duplicate_value_error.rb	/^      class DuplicateValueError < Base$/;"	c	class:Ruby.Enum.Errors
-EmptyEnums	spec/ruby-enum/enum_spec.rb	/^    class EmptyEnums$/;"	c
-Enum	lib/ruby-enum/enum.rb	/^  module Enum$/;"	m	class:Ruby
-Enum	lib/ruby-enum/errors/base.rb	/^  module Enum$/;"	m	class:Ruby
-Enum	lib/ruby-enum/errors/duplicate_key_error.rb	/^  module Enum$/;"	m	class:Ruby
-Enum	lib/ruby-enum/errors/duplicate_value_error.rb	/^  module Enum$/;"	m	class:Ruby
-Enum	lib/ruby-enum/errors/uninitialized_constant_error.rb	/^  module Enum$/;"	m	class:Ruby
-Enum	lib/ruby-enum/version.rb	/^  module Enum$/;"	m	class:Ruby
-Errors	lib/ruby-enum/errors/base.rb	/^    module Errors$/;"	m	class:Ruby.Enum
-Errors	lib/ruby-enum/errors/duplicate_key_error.rb	/^    module Errors$/;"	m	class:Ruby.Enum
-Errors	lib/ruby-enum/errors/duplicate_value_error.rb	/^    module Errors$/;"	m	class:Ruby.Enum
-Errors	lib/ruby-enum/errors/uninitialized_constant_error.rb	/^    module Errors$/;"	m	class:Ruby.Enum
-FirstSubclass	spec/ruby-enum/enum_spec.rb	/^class FirstSubclass < Colors$/;"	c
-Ruby	lib/ruby-enum/enum.rb	/^module Ruby$/;"	m
-Ruby	lib/ruby-enum/errors/base.rb	/^module Ruby$/;"	m
-Ruby	lib/ruby-enum/errors/duplicate_key_error.rb	/^module Ruby$/;"	m
-Ruby	lib/ruby-enum/errors/duplicate_value_error.rb	/^module Ruby$/;"	m
-Ruby	lib/ruby-enum/errors/uninitialized_constant_error.rb	/^module Ruby$/;"	m
-Ruby	lib/ruby-enum/version.rb	/^module Ruby$/;"	m
-SecondSubclass	spec/ruby-enum/enum_spec.rb	/^class SecondSubclass < FirstSubclass$/;"	c
-UninitializedConstantError	lib/ruby-enum/errors/uninitialized_constant_error.rb	/^      class UninitializedConstantError < Base$/;"	c	class:Ruby.Enum.Errors
-compose_message	lib/ruby-enum/errors/base.rb	/^        def compose_message(key, attributes = {})$/;"	f	class:Ruby.Enum.Errors.Base
-const_missing	lib/ruby-enum/enum.rb	/^      def const_missing(key)$/;"	f	class:Ruby.Enum.ClassMethods
-create_problem	lib/ruby-enum/errors/base.rb	/^        def create_problem(key, attributes)$/;"	f	class:Ruby.Enum.Errors.Base
-create_resolution	lib/ruby-enum/errors/base.rb	/^        def create_resolution(key, attributes)$/;"	f	class:Ruby.Enum.Errors.Base
-create_summary	lib/ruby-enum/errors/base.rb	/^        def create_summary(key, attributes)$/;"	f	class:Ruby.Enum.Errors.Base
-define	lib/ruby-enum/enum.rb	/^      def define(key, value)$/;"	f	class:Ruby.Enum.ClassMethods
-each	lib/ruby-enum/enum.rb	/^      def each(&block)$/;"	f	class:Ruby.Enum.ClassMethods
-included	lib/ruby-enum/enum.rb	/^    def self.included(base)$/;"	F	class:Ruby.Enum
-initialize	lib/ruby-enum/enum.rb	/^    def initialize(key, value)$/;"	f	class:Ruby.Enum
-initialize	lib/ruby-enum/errors/duplicate_key_error.rb	/^        def initialize(attrs)$/;"	f	class:Ruby.Enum.Errors.DuplicateKeyError
-initialize	lib/ruby-enum/errors/duplicate_value_error.rb	/^        def initialize(attrs)$/;"	f	class:Ruby.Enum.Errors.DuplicateValueError
-initialize	lib/ruby-enum/errors/uninitialized_constant_error.rb	/^        def initialize(attrs)$/;"	f	class:Ruby.Enum.Errors.UninitializedConstantError
-key	lib/ruby-enum/enum.rb	/^      def key(v)$/;"	f	class:Ruby.Enum.ClassMethods
-key?	lib/ruby-enum/enum.rb	/^      def key?(k)$/;"	f	class:Ruby.Enum.ClassMethods
-keys	lib/ruby-enum/enum.rb	/^      def keys$/;"	f	class:Ruby.Enum.ClassMethods
-parse	lib/ruby-enum/enum.rb	/^      def parse(k)$/;"	f	class:Ruby.Enum.ClassMethods
-to_h	lib/ruby-enum/enum.rb	/^      def to_h$/;"	f	class:Ruby.Enum.ClassMethods
-translate	lib/ruby-enum/errors/base.rb	/^        def translate(key, options)$/;"	f	class:Ruby.Enum.Errors.Base
-validate_key!	lib/ruby-enum/enum.rb	/^      def validate_key!(key)$/;"	f	class:Ruby.Enum.ClassMethods
-validate_value!	lib/ruby-enum/enum.rb	/^      def validate_value!(value)$/;"	f	class:Ruby.Enum.ClassMethods
-value	lib/ruby-enum/enum.rb	/^      def value(k)$/;"	f	class:Ruby.Enum.ClassMethods
-value?	lib/ruby-enum/enum.rb	/^      def value?(v)$/;"	f	class:Ruby.Enum.ClassMethods
-values	lib/ruby-enum/enum.rb	/^      def values$/;"	f	class:Ruby.Enum.ClassMethods