ruby-enum 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fc128cc7839208ced2d3cf393b21c82f3ebdfe6
-  data.tar.gz: ce5e04b5b1d5e9756a4b4f761bb1d8f127d9e24c
+  metadata.gz: 971c1b5b0f1efc517293ebe5adfaed75bd2ef8cd
+  data.tar.gz: a7d4f6c03985bcd6ddee0e09938b4cd8dc860d1e
 SHA512:
-  metadata.gz: 56ad33d14d0cf9e59f2237387e79422ce7b4cfbaf65fa47162bf1d60e6e3efeb843e321b0fa56f69059bfcef0506f4b6f3faab5d0168cdc756f8ef6ca760f291
-  data.tar.gz: 4a5a8d5bf5b64eeb155f9d3f8b20d271e8d752dc52287e9623efff4db795ed23424cf084545946220b89724c3ac7882205c38bb604b98f79e0bf160f0e82455a
+  metadata.gz: 20ac5e36b84f00a29ae233b6e100747ae18e06264037ef98223d4026b900614f5522e7afc97dce9b8e4c9b2828b2c4de610ece759fb688d452df32b07b113d4c
+  data.tar.gz: e00bdf6c6296e281285da12c1bd92eb5a293adae78fe3e8faf24db098b237db9ab353fe6076f1cee4302107f5d0e1a6f72d14486825cdf279c762a1a3f5bda93

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.7.0 (21/2/2017)
+
+* [#3](https://github.com/dblock/ruby-enum/pull/13): Adds support for sub classing an Enum - [@laertispappas](https://github.com/laertispappas).
+
 ### 0.6.0 (12/5/2016)
 
 * [#12](https://github.com/dblock/ruby-enum/pull/12): A `Ruby::Enum::Errors::DuplicateKeyError` or a `Ruby::Enum::Errors::DuplciateKeyValyeError` will now be raised when duplicate keys / values are defined - [@laertispappas](https://github.com/laertispappas).

data/Gemfile

@@ -2,6 +2,6 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'rspec', '~> 3.4.0'
 gem 'rake'
-gem 'rubocop', '0.35.1'
+gem 'rspec', '~> 3.4.0'
+gem 'rubocop', '0.47.1'

data/Gemfile.lock

@@ -1,22 +1,20 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.6.0)
+    ruby-enum (0.7.0)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
     ast (2.3.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    parser (2.3.3.1)
+    diff-lcs (1.3)
+    i18n (0.8.0)
+    parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
-    rainbow (2.1.0)
-    rake (11.3.0)
+    rainbow (2.2.1)
+    rake (10.5.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -30,15 +28,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.35.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.3.0, < 3.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
-      tins (<= 1.6.0)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    tins (1.6.0)
+    unicode-display_width (1.1.3)
 
 PLATFORMS
   ruby
@@ -46,8 +43,8 @@ PLATFORMS
 DEPENDENCIES
   rake
   rspec (~> 3.4.0)
-  rubocop (= 0.35.1)
+  rubocop (= 0.47.1)
   ruby-enum!
 
 BUNDLED WITH
-   1.13.6
+   1.14.4

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2015 Daniel Doubrovkine.
+Copyright (c) 2013-2016 Daniel Doubrovkine.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -121,10 +121,10 @@ Colors.key('yellow')
 ```
 
 
-## Duplicate enumerator keys or duplicate values
+### Duplicate enumerator keys or duplicate values
 
 Defining duplicate enums will raise a `Ruby::Enum::Errors::DuplicateKeyError`. Moreover a duplicate
-value is not allowed. Defining a duplicate value will raise a `Ruby::Enum::Errors::DuplicateKeyError`.
+value is not allowed. Defining a duplicate value will raise a `Ruby::Enum::Errors::DuplicateValueError`.
 The following declarations will both raise an exception:
 
 ```ruby
@@ -136,7 +136,7 @@ The following declarations will both raise an exception:
   end
 
   # The following will raise a DuplicateValueError
-  class Colots
+  class Colors
     include Ruby::Enum
 
     define :RED, 'red'
@@ -145,7 +145,12 @@ The following declarations will both raise an exception:
 ```
 
 The `DuplicateValueError` exception is thrown to be consistent with the unique key constraint.
-Since keys are unique there is no way to map values to keys using `Colors.key('red')`
+Since keys are unique there is no way to map values to keys using `Colors.value('red')`
+
+### Inheritance behavior
+
+Inheriting from a `Ruby::Enum` class, all defined enums in the parent class will be accessible in sub classes as well.
+Sub classes can also provide extra enums as usual.
 
 ## Contributing
 
@@ -153,7 +158,7 @@ You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md)
 
 ## Copyright and License
 
-Copyright (c) 2013-2015, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
+Copyright (c) 2013-2016, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).
 

data/lib/ruby-enum/enum.rb

@@ -10,6 +10,8 @@ module Ruby
     def self.included(base)
       base.extend Enumerable
       base.extend ClassMethods
+
+      base.private_class_method(:new)
     end
 
     module ClassMethods
@@ -33,20 +35,23 @@ module Ruby
       def validate_key!(key)
         return unless @_enum_hash.key?(key)
 
-        fail Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
+        raise Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
       end
 
       def validate_value!(value)
         return unless @_enums_by_value.key?(value)
 
-        fail Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
+        raise Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
       end
 
       def const_missing(key)
-        if @_enum_hash[key]
+        enum_instance = @_enum_hash && @_enum_hash[key]
+        if enum_instance
           @_enum_hash[key].value
+        elsif superclass.instance_variable_get(:@_enum_hash)
+          superclass.send(:const_missing, key)
         else
-          fail Ruby::Enum::Errors::UninitializedConstantError, name: name, key: key
+          raise Ruby::Enum::Errors::UninitializedConstantError, name: name, key: key
         end
       end
 

data/lib/ruby-enum/errors/base.rb

@@ -26,7 +26,7 @@ module Ruby
 
         private
 
-        BASE_KEY = 'ruby.enum.errors.messages' #:nodoc:
+        BASE_KEY = 'ruby.enum.errors.messages'.freeze #:nodoc:
 
         # Given the key of the specific error and the options hash, translate the
         # message.

data/lib/ruby-enum/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module Enum
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'.freeze
   end
 end

data/spec/ruby-enum/enum_spec.rb

@@ -7,7 +7,38 @@ class Colors
   define :GREEN, 'green'
 end
 
+class FirstSubclass < Colors
+  define :ORANGE, 'orange'
+end
+
+class SecondSubclass < FirstSubclass
+  define :PINK, 'pink'
+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'
@@ -129,4 +160,13 @@ describe Ruby::Enum do
       end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /The value red has already been defined./
     end
   end
+
+  describe 'Given a class that has not defined any enums' do
+    class EmptyEnums
+      include Ruby::Enum
+    end
+    it do
+      expect { EmptyEnums::ORANGE }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
+    end
+  end
 end

data/tags

@@ -0,0 +1,54 @@
+!_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -47,10 +47,12 @@ 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
 - 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
@@ -71,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Enum-like behavior for Ruby.