ruby-enum 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c0c38cc0b3edc3052b171b5dc3aacdee8a3e2f0
-  data.tar.gz: e561a122f1dcdc6b5657d1d004d37d37a00e8108
+  metadata.gz: 4fc128cc7839208ced2d3cf393b21c82f3ebdfe6
+  data.tar.gz: ce5e04b5b1d5e9756a4b4f761bb1d8f127d9e24c
 SHA512:
-  metadata.gz: 474384b04e35b3ab7e0fb5145cb07c545c12f8dd37df44c1c0c75d465439df575f4aeeb82e0ca2cc71b55dea25af610c08b2b57fcb8760abb5b9cfc40e9ca6ab
-  data.tar.gz: e98254d96a8f3f1af22f1ee3c34ca5d2de116724a2cae4f4ab8ba337a05cd2bf78397a6ae3bbf0a2771f3b76a915865b1cbf8ccdd3b8cfe97ffe84bbae7abe92
+  metadata.gz: 56ad33d14d0cf9e59f2237387e79422ce7b4cfbaf65fa47162bf1d60e6e3efeb843e321b0fa56f69059bfcef0506f4b6f3faab5d0168cdc756f8ef6ca760f291
+  data.tar.gz: 4a5a8d5bf5b64eeb155f9d3f8b20d271e8d752dc52287e9623efff4db795ed23424cf084545946220b89724c3ac7882205c38bb604b98f79e0bf160f0e82455a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 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).
+
 ### 0.5.0 (11/20/2015)
 
 * [#8](https://github.com/dblock/ruby-enum/pull/8): Added `Ruby::Enum#key`, `Ruby::Enum#value`, `Ruby::Enum#key?`, and `Ruby::Enum#value?` - [@dmolesUC3](https://github.com/dmolesUC3).

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.5.0)
+    ruby-enum (0.6.0)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.1.0)
+    ast (2.3.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
     diff-lcs (1.2.5)
     i18n (0.7.0)
-    parser (2.2.3.0)
-      ast (>= 1.1, < 3.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
     powerpack (0.1.1)
-    rainbow (2.0.0)
-    rake (10.3.1)
+    rainbow (2.1.0)
+    rake (11.3.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
+    rspec-core (3.4.4)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.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)
@@ -37,7 +37,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       tins (<= 1.6.0)
-    ruby-progressbar (1.7.5)
+    ruby-progressbar (1.8.1)
     tins (1.6.0)
 
 PLATFORMS
@@ -50,4 +50,4 @@ DEPENDENCIES
   ruby-enum!
 
 BUNDLED WITH
-   1.10.6
+   1.13.6

data/README.md

@@ -120,6 +120,33 @@ Colors.key('yellow')
 # => nil
 ```
 
+
+## 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`.
+The following declarations will both raise an exception:
+
+```ruby
+  class Colors
+    include Ruby::Enum
+
+    define :RED, "red"
+    define :RED, "my red" # will raise a DuplicateKeyError exception
+  end
+
+  # The following will raise a DuplicateValueError
+  class Colots
+    include Ruby::Enum
+
+    define :RED, 'red'
+    define :SOME, 'red' # Boom
+  end
+```
+
+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')`
+
 ## Contributing
 
 You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md) for details.

data/lib/config/locales/en.yml

@@ -12,3 +12,11 @@ en:
             \_\_\_include Ruby::Enum\n
             \_\_\_define %{key}, 'value'\n
             \_\_end"
+          duplicate_key:
+            message: 'Duplicate key.'
+            summary: "The constant %{name}::%{key} has already been defined."
+            resolution: "The enumerated key is already defined in class %{name}%. Please use a different name to declare it."
+          duplicate_value:
+            message: 'Duplicate value found.'
+            summary: "The value %{value} has already been defined in %{name}%."
+            resolution: "The enumerated value %{value} is already defined in class %{name}%. Please use a different value."

data/lib/ruby-enum.rb

@@ -7,3 +7,5 @@ I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml
 
 require 'ruby-enum/errors/base'
 require 'ruby-enum/errors/uninitialized_constant_error'
+require 'ruby-enum/errors/duplicate_key_error'
+require 'ruby-enum/errors/duplicate_value_error'

data/lib/ruby-enum/enum.rb

@@ -21,11 +21,27 @@ module Ruby
       def define(key, value)
         @_enum_hash ||= {}
         @_enums_by_value ||= {}
+
+        validate_key!(key)
+        validate_value!(value)
+
         new_instance = new(key, value)
         @_enum_hash[key] = new_instance
         @_enums_by_value[value] = new_instance
       end
 
+      def validate_key!(key)
+        return unless @_enum_hash.key?(key)
+
+        fail 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
+      end
+
       def const_missing(key)
         if @_enum_hash[key]
           @_enum_hash[key].value

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

@@ -0,0 +1,12 @@
+module Ruby
+  module Enum
+    module Errors
+      # Error raised when a duplicate enum key is found
+      class DuplicateKeyError < Base
+        def initialize(attrs)
+          super(compose_message('duplicate_key', attrs))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ruby
+  module Enum
+    module Errors
+      # Error raised when a duplicate enum value is found
+      class DuplicateValueError < Base
+        def initialize(attrs)
+          super(compose_message('duplicate_value', attrs))
+        end
+      end
+    end
+  end
+end

data/lib/ruby-enum/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module Enum
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/spec/ruby-enum/enum_spec.rb

@@ -109,4 +109,24 @@ describe Ruby::Enum do
       expect(Colors.to_h).to eq(RED: 'red', GREEN: 'green')
     end
   end
+
+  context 'on duplicate keys' do
+    it 'raises DuplicateKeyError' do
+      expect do
+        Colors.class_eval do
+          define :RED, 'some'
+        end
+      end.to raise_error Ruby::Enum::Errors::DuplicateKeyError, /The constant Colors::RED has already been defined./
+    end
+  end
+
+  context 'on duplicate values' do
+    it 'raises a DuplicateValueError' do
+      expect do
+        Colors.class_eval do
+          define :Other, 'red'
+        end
+      end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /The value red has already been defined./
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -42,11 +42,11 @@ files:
 - lib/ruby-enum.rb
 - lib/ruby-enum/enum.rb
 - lib/ruby-enum/errors/base.rb
+- lib/ruby-enum/errors/duplicate_key_error.rb
+- lib/ruby-enum/errors/duplicate_value_error.rb
 - lib/ruby-enum/errors/uninitialized_constant_error.rb
 - lib/ruby-enum/version.rb
 - lib/ruby_enum.rb
-- pkg/ruby-enum-0.3.0.gem
-- pkg/ruby-enum-0.4.0.gem
 - ruby-enum.gemspec
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enum-like behavior for Ruby.