enumerated_type 0.4.0 → 0.4.1

data/README.md

@@ -195,6 +195,13 @@ JobStatus.by(:display, "pending-1") # => #<JobStatus:pending>
 ```
 If more than one instance of your `EnumeratedType` matches, the first match will be returned, in the order the types were `declared`.
 
+If you pass a bock to .by, it will be executed and its value returned (just like Hash#fetch). This is useful for defining a default value or a custom error message.
+
+```ruby
+JobStatus.by(:display, "does-not-exist") { JobStatus::FAILURE }  # => #<JobStatus:failure>
+JobStatus.by(:display, "does-not-exist") { |v| raise("I have no idea what to do with #{v.inspect}") } # => raises an exception
+```
+
 ## Development
 
 To run the tests (assuming you have already run `gem install bundler`):

data/lib/enumerated_type.rb

@@ -1,7 +1,29 @@
 require "enumerated_type/version"
 
 module EnumeratedType
-  class ByCache
+  # In the unfortunate case where there are thousands of elements in an
+  # enumerated type, an iteration based strategy for EnumeratedType.by is slow.
+  # Particularly, since declare does .by(:name, name) to detect name
+  # collisions, EnumeratedType.declare is O(n^2) where n is the
+  # EnumeratedType.count, which can take seconds when the enunm is loaded,
+  # which is, like, a total bummer.  This class indexes enums by property and
+  # value so lookups are constant time. The backing hash would look like this
+  # for the Shape enum.
+  #
+  # {
+  #   :sides => {
+  #     4 => Shape::Square
+  #   },
+  #   :name => {
+  #     :square => Shape::Square
+  #   }
+  # }
+  #
+  # Note that there is only a single value for each property/value combination.
+  # #set will respect the first instance of a property/value combination (i.e
+  # subsequent duplicate #sets will not override the first value). This matches
+  # the definition of EnumeratedType.by.
+  class PropertyIndex
     def initialize
       self.by_property = { }
     end
@@ -27,7 +49,7 @@ module EnumeratedType
   def self.included(base)
     base.instance_eval do
       @all = []
-      @by_cache = ByCache.new
+      @by_cache = PropertyIndex.new
 
       attr_reader :name, :value
 
@@ -77,12 +99,12 @@ module EnumeratedType
     end
 
     def by(property, value, &miss)
-      miss ||= Proc.new { raise(ArgumentError, "Could not find #{self.name} with ##{property} == #{value.inspect}'") }
+      miss ||= Proc.new { |v| raise(ArgumentError, "Could not find #{self.name} with ##{property} == #{v.inspect}'") }
 
       if @by_cache.has_property?(property)
         @by_cache.get(property, value, miss)
       else
-        find { |e| e.send(property) == value } || miss.call
+        find { |e| e.send(property) == value } || miss.call(value)
       end
     end
 
@@ -121,6 +143,7 @@ module EnumeratedType
         end
 
         attr_accessor(:"#{property}")
+        public(:"#{property}")
         private(:"#{property}=")
       end
 

data/lib/enumerated_type/version.rb

@@ -1,3 +1,3 @@
 module EnumeratedType
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/enumerated_type_spec.rb

@@ -190,7 +190,7 @@ describe EnumeratedType do
       Shapes.by(:sides, 4).must_equal(Shapes::RECTANGLE)
     end
 
-    it "raises an argument if there is no match" do
+    it "raises an argument if there is no match and no block given" do
       lambda { Shapes.by(:sides, 6) }.must_raise(ArgumentError)
     end
 
@@ -198,6 +198,10 @@ describe EnumeratedType do
       (Shapes.by(:sides, 6) { "UnknownShape"}).must_equal("UnknownShape")
     end
 
+    it "passes the value to the block" do
+      (Shapes.by(:sides, 6) { |sides| "No shape with #{sides} sides" }).must_equal("No shape with 6 sides")
+    end
+
     it "returns the first declared value if there is more than one match" do
       Shapes.by(:pretty_hip, "YEAH").must_equal(Shapes::TRIANGLE)
     end
@@ -205,6 +209,12 @@ describe EnumeratedType do
     it "works with arbitrary methods" do
       Shapes.by(:sides_squared, 16).must_equal(Shapes::RECTANGLE)
     end
+
+    it "passes the value to the block for arbitrary methods" do
+      (Shapes.by(:sides_squared, 3) { |sides| "No shape with #{sides} sides squared" }).must_equal("No shape with 3 sides squared")
+    end
+
+
   end
 
   describe "#inspect" do

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: enumerated_type
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
+  prerelease: 
 platform: ruby
 authors:
 - Rafer Hazen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -71,26 +78,33 @@ files:
 homepage: https://github.com/rafer/enumerated_type
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 491884112611942535
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 491884112611942535
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Simple enumerated types
 test_files:
 - test/enumerated_type_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGRiNTE1NTQ1ZjI5N2IwMGM4ZmVlNjEzYjFhYjNjMGFkNDY1MjdiYQ==
-  data.tar.gz: !binary |-
-    NDM3MDI1NjczOTVmY2E2ZmQwOTQyZWYxMzk5NWFkNTZmNjFlNTdhZQ==
-SHA512:
-  metadata.gz: !binary |-
-    NGU1MjA4OGRkYTU4MDU2MjdlMmI0MjM1NzYwMWRiYTk5Mzg4ZjNiYjgxZjll
-    NDQxNWM1NTA2MjZmYTU4ZmQ5NTJiZjA3Mjk2ZGNlMmUyNGRlYTFhNWU2Njk5
-    MWM1MjM2MDBmNTE0MzQ2YmI5OGYyNmVmNGUyNjQzZWM1ZWQ3N2M=
-  data.tar.gz: !binary |-
-    NDA5MzBmYmNjN2UyMGFlZjA2YTIwYmIzYjVlNjRjMGM2N2YwYjA3ZWFlNDAw
-    ZDk0OTNlYjk3YTRkNDY4NmUwODg0NjIwMDdiODU4YmZiMDFhZjJkZmMwZmE1
-    MjFkYmFjYzg3MDA1MmZlYjhkY2JmYzExM2JhMmYyYTNlNGUzNzI=