typesafe_enum 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dca44bfdc19636b439aea18d0a5bbb195150fcf
-  data.tar.gz: ae8b31bcd16f05536e1bb2ffd9346fbd395465e7
+  metadata.gz: 5b0677a4297fd6de2704786aa65b16b10a3a89de
+  data.tar.gz: ae7122293d92ba5417e684ae9746fa798f9d6f47
 SHA512:
-  metadata.gz: d8c40232f8fa100c7de8f49d830e20bce082126d951a69a4e53294a89134647c6cf2d0244034efe47bb88348a70352d4b3c061c5ff6c6a0d19f296e4a4de154d
-  data.tar.gz: 24543c5f5b1b72dbf554662275d47c918ef3807e723648aebe34552b217b52e82a91f9a20f35d9a7569ace4279dcdebefb00df0b136099a2f802fb66ac6c9812
+  metadata.gz: 44ec4665cb20ee046932e909d91738273c1591c06f9dd103693a2f38fb9082b160c0ab1e4941e6dc5901a5a3a70bcb4b7205f5a732d9f17d166b47e00e254d48
+  data.tar.gz: 069df54602db3f496024d3d99d1a8d400f204ba4bbf4d6f1cc8e1d3e0b717ae6036279208a8e3eeb577b49eb1f9a5b85ee0e6978e8cb5e826fcbcf8576196574

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 0.1.4
+
+- Exact duplicate instances (e.g. due to multiple `requires`) are now ignored with a warning,
+  instead of causing a `NameError`. Duplicate keys with different values, and duplicate values
+  with different keys, still raise a `NameError`.
+- `NameErrors` due to invalid keys or values no longer cause the enum class to be undefined.
+  However, the invalid instances will still not be registered and no constants created for them.
+
 ## 0.1.3
 
 - Fixed issue where invalid classes weren't properly removed after duplicate name declarations,

data/README.md

@@ -69,6 +69,76 @@ Scale::KILO.value
 # => 1000
 ```
 
+Declaring two instances with the same key will produce an error:
+
+```ruby
+class Suit < TypesafeEnum::Base
+  new :CLUBS
+  new :DIAMONDS
+  new :HEARTS
+  new :SPADES
+  new :SPADES, '♠'
+end
+```
+
+```
+typesafe_enum/lib/typesafe_enum/base.rb:88:in `valid_key_and_value': Suit::SPADES already exists (NameError)
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:98:in `register'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:138:in `block in initialize'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:137:in `class_exec'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:137:in `initialize'
+	from ./scratch.rb:11:in `new'
+	from ./scratch.rb:11:in `<class:Suit>'
+	from ./scratch.rb:6:in `<main>'
+```
+
+Likewise two instances with the same value but different keys:
+
+```ruby
+class Tarot < TypesafeEnum::Base
+  new :CUPS, 'Cups'
+  new :COINS, 'Coins'
+  new :WANDS, 'Wands'
+  new :SWORDS, 'Swords'
+  new :STAVES, 'Wands'
+end
+```
+
+```
+/typesafe_enum/lib/typesafe_enum/base.rb:92:in `valid_key_and_value': A Tarot instance with value 'Wands' already exists (NameError)
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:98:in `register'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:138:in `block in initialize'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:137:in `class_exec'
+	from /Users/dmoles/Work/Stash/typesafe_enum/lib/typesafe_enum/base.rb:137:in `initialize'
+	from ./scratch.rb:11:in `new'
+	from ./scratch.rb:11:in `<class:Tarot>'
+	from ./scratch.rb:6:in `<main>'
+```
+
+However, declaring an identical key/value pair will be ignored with a warning, to avoid unnecessary errors
+when, e.g., a declaration file is accidentally `required` twice.
+
+```ruby
+class Tarot < TypesafeEnum::Base
+  new :CUPS, 'Cups'
+  new :COINS, 'Coins'
+  new :WANDS, 'Wands'
+  new :SWORDS, 'Swords'
+end
+
+class Tarot < TypesafeEnum::Base
+  new :CUPS, 'Cups'
+  new :COINS, 'Coins'
+  new :WANDS, 'Wands'
+  new :SWORDS, 'Swords'
+end
+
+# => ignoring redeclaration of Tarot::CUPS with value: Cups
+# => ignoring redeclaration of Tarot::COINS with value: Coins
+# => ignoring redeclaration of Tarot::WANDS with value: Wands
+# => ignoring redeclaration of Tarot::SWORDS with value: Swords
+```
+
 ## Ordering
 
 Enum instances have an ordinal value corresponding to their declaration

data/lib/typesafe_enum/base.rb

@@ -59,51 +59,40 @@ module TypesafeEnum
 
       private
 
-      attr_accessor :by_key
-      attr_accessor :by_value
-      attr_accessor :as_array
-
-      def parent
-        parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
-        parent_name ? Object.const_get(parent_name) : Object
-      end
-
-      def undefine_class
-        class_value = name.split('::').last || ''
-        parent.send(:remove_const, class_value)
+      def by_key
+        @by_key ||= {}
       end
 
-      def register(instance)
-        ensure_registries
-        key, value = valid_key_and_value(instance)
-
-        by_key[key] = instance
-        by_value[value] = instance
-        as_array << instance
-        const_set(key.to_s, instance)
+      def by_value
+        @by_value ||= {}
       end
 
-      def ensure_registries
-        self.by_key ||= {}
-        self.by_value ||= {}
-        self.as_array ||= []
+      def as_array
+        @as_array ||= []
       end
 
       def valid_key_and_value(instance)
         key = instance.key
         value = instance.value
-
-        begin
-          fail NameError, "#{name}::#{key} already exists" if find_by_key(key)
+        if (found = find_by_key(key))
+          fail NameError, "#{name}::#{key} already exists" unless value == found.value
+          warn("ignoring redeclaration of #{name}::#{key} with value: #{value}")
+          nil
+        else
           fail NameError, "A #{name} instance with value '#{value}' already exists" if find_by_value(value)
-        rescue NameError => e
-          undefine_class
-          raise e
+          [key, value]
         end
-
-        [key, value]
       end
 
+      def register(instance)
+        key, value = valid_key_and_value(instance)
+        return unless key && value
+
+        const_set(key.to_s, instance)
+        by_key[key] = instance
+        by_value[value] = instance
+        as_array << instance
+      end
     end
 
     # The symbol key for the enum instance

data/lib/typesafe_enum/module_info.rb

@@ -3,7 +3,7 @@ module TypesafeEnum
   NAME = 'typesafe_enum'
 
   # The version of this gem
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 
   # The copyright notice for this gem
   COPYRIGHT = 'Copyright (c) 2015 The Regents of the University of California'

data/spec/unit/typesafe_enum/base_spec.rb

@@ -1,27 +1,27 @@
 # coding: UTF-8
 require 'spec_helper'
 
-class ::Suit < TypesafeEnum::Base
+class Suit < TypesafeEnum::Base
   new :CLUBS
   new :DIAMONDS
   new :HEARTS
   new :SPADES
 end
 
-class ::Tarot < TypesafeEnum::Base
+class Tarot < TypesafeEnum::Base
   new :CUPS, 'Cups'
   new :COINS, 'Coins'
   new :WANDS, 'Wands'
   new :SWORDS, 'Swords'
 end
 
-class ::RGBColor < TypesafeEnum::Base
+class RGBColor < TypesafeEnum::Base
   new :RED, :red
   new :GREEN, :green
   new :BLUE, :blue
 end
 
-class ::Scale < TypesafeEnum::Base
+class Scale < TypesafeEnum::Base
   new :DECA, 10
   new :HECTO, 100
   new :KILO, 1_000
@@ -39,40 +39,64 @@ module TypesafeEnum
 
       it 'insists symbols be symbols' do
         expect do
-          class ::Cheat < Base
+          class ::StringKeys < Base
             new 'spades', 'spades'
           end
         end.to raise_error(TypeError)
+        expect(::StringKeys.to_a).to be_empty
       end
 
       it 'insists symbols be uppercase' do
         expect do
-          class ::Cheat < Base
+          class ::LowerCaseKeys < Base
             new :spades, 'spades'
           end
         end.to raise_error(NameError)
+        expect(::LowerCaseKeys.to_a).to be_empty
       end
 
-      it 'disallows duplicate symbols' do
+      it 'disallows duplicate symbols with different values' do
         expect do
-          class ::Cheat < Base
+          class ::DuplicateSymbols < Base
             new :SPADES, 'spades'
             new :SPADES, 'more spades'
           end
         end.to raise_error(NameError)
-
-        expect { ::Cheat.class }.to raise_error(NameError)
+        expect(::DuplicateSymbols.to_a).to eq([::DuplicateSymbols::SPADES])
+        expect(::DuplicateSymbols::SPADES.value).to eq('spades')
+        expect(::DuplicateSymbols.find_by_value('more spades')).to be_nil
       end
 
-      it 'disallows duplicate values' do
+      it 'disallows duplicate values with different symbols' do
         expect do
-          class ::Cheat < Base
+          class ::DuplicateValues < Base
             new :SPADES, 'spades'
             new :ALSO_SPADES, 'spades'
           end
         end.to raise_error(NameError)
+        expect(::DuplicateValues.to_a).to eq([::DuplicateValues::SPADES])
+        expect(::DuplicateValues::SPADES.value).to eq('spades')
+        expect(::DuplicateValues.find_by_key(:ALSO_SPADES)).to be_nil
+      end
 
-        expect { ::Cheat.class }.to raise_error(NameError)
+      it 'disallows nil keys' do
+        expect do
+          class ::NilKeys < Base
+            new nil, 'nil'
+          end
+        end.to raise_error(TypeError)
+        expect(::NilKeys.to_a).to be_empty
+      end
+
+      it 'allows, but ignores redeclaration of identical instances' do
+        class ::IdenticalInstances < Base
+          new :SPADES, 'spades'
+        end
+        expect(::IdenticalInstances).to receive(:warn).with('ignoring redeclaration of IdenticalInstances::SPADES with value: spades')
+        class ::IdenticalInstances < Base
+          new :SPADES, 'spades'
+        end
+        expect(::IdenticalInstances.to_a).to eq([::IdenticalInstances::SPADES])
       end
 
       it 'defaults the value to a lower-cased version of the symbol' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesafe_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler