enumerated_type 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/README.md

@@ -36,7 +36,7 @@ if job.status == :failure or job.status == :success
 end
 ```
 
-At this point, it's starting to feel like a little bit too much knowledge about the `Job` has slipped into other classes; any changes to the in the way status is handled in `Job` will require change in other classes because they've been exposed to the details of it's implementation. What, for example, if we want to add another "finished" state that a user should be notified of (say, `:partial_success`)? To deal with this we might create a predicate method that lets you interrogate a `Job` more abstractly about it's status:
+At this point, its starting to feel like a little bit too much knowledge about the `Job` has slipped into other classes; any changes to the in the way status is handled in `Job` will require change in other classes because they've been exposed to the details of its implementation. What, for example, if we want to add another "finished" state that a user should be notified of (say, `:partial_success`)? To deal with this we might create a predicate method that lets you interrogate a `Job` more abstractly about it's status:
 
 ```ruby
 class Job
@@ -47,7 +47,7 @@ class Job
 end
 ```
 
-Now, say we need another kind of job: the `AdminJob`. It needs to have the same set of statuses (with the same behavior as `Job`'s status). We could certainly move the status related code into a `StatusHaving` module and mix it in to both `Job` and `AdminJob`, but there are some drawbacks here, chief among them that we'd have to add a good bit of coupling between the `Job`, `AdminJob` and the `StatusHaving` mix-in module. For example both classes and the mix-in would need to agree on the `@status` instance variable. I would argue at this point the idea of a `JobStatus` should be promoted to it's own class, maybe with a little bit of error checking:
+Now, say we need another kind of job: the `AdminJob`. It needs to have the same set of statuses (with the same behavior as `Job`'s status). We could certainly move the status related code into a `StatusHaving` module and mix it in to both `Job` and `AdminJob`, but there are some drawbacks here, chief among them that we'd have to add a good bit of coupling between the `Job`, `AdminJob` and the `StatusHaving` mix-in module. For example both classes and the mix-in would need to agree on the `@status` instance variable. I would argue at this point the idea of a `JobStatus` should be promoted to its own class, maybe with a little bit of error checking:
 
 ```ruby
 class JobStatus
@@ -182,7 +182,7 @@ JobStatus.by(:code, 2) # => #<JobStatus:success>
 JobStatus.by(:code, 4) # => raises a TypeError
 ```
 
-The first parameter specifies the method that will be called on instances of your `EnumeratedType` during lookup. This works for attributes specified with `declare` (such as `:code` above) but also for .
+The first parameter specifies the method that will be called on instances of your `EnumeratedType` during lookup. This works for attributes specified with `declare` (such as `:code` above) but also for any instance method on your `EnumeratedType`.
 
 ```ruby
 class JobStatus
@@ -193,7 +193,7 @@ end
 
 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 more than one instance of your `EnumeratedType` matches, the first match will be returned, in the order the types were `declared`.
 
 ## Development
 

data/lib/enumerated_type.rb

@@ -1,9 +1,33 @@
 require "enumerated_type/version"
 
 module EnumeratedType
+  class ByCache
+    def initialize
+      self.by_property = { }
+    end
+
+    def set(property, value, enumerated)
+      by_value = (by_property[property.to_sym] ||= { })
+      by_value[value] ||= enumerated
+    end
+
+    def get(property, value, miss)
+      by_property.fetch(property.to_sym).fetch(value, &miss)
+    end
+
+    def has_property?(property)
+      by_property.has_key?(property.to_sym)
+    end
+
+    private
+
+    attr_accessor :by_property
+  end
+
   def self.included(base)
     base.instance_eval do
       @all = []
+      @by_cache = ByCache.new
 
       attr_reader :name, :value
 
@@ -52,9 +76,14 @@ module EnumeratedType
       @all.each(&block)
     end
 
-    def by(name, value)
-      found = find { |e| e.send(name) == value }
-      found || raise(ArgumentError, "Could not find #{self.name} with ##{name} == #{value.inspect}'")
+    def by(property, value, &miss)
+      miss ||= Proc.new { raise(ArgumentError, "Could not find #{self.name} with ##{property} == #{value.inspect}'") }
+
+      if @by_cache.has_property?(property)
+        @by_cache.get(property, value, miss)
+      else
+        find { |e| e.send(property) == value } || miss.call
+      end
     end
 
     def [](name)
@@ -78,7 +107,7 @@ module EnumeratedType
     private
 
     def declare(name, options = {})
-      if map(&:name).include?(name)
+      unless by(:name, name) { :not_found } == :not_found
         raise(ArgumentError, "duplicate name #{name.inspect}")
       end
 
@@ -91,18 +120,16 @@ module EnumeratedType
           raise ArgumentError, "Property name 'name' is not allowed (conflicts with default EnumeratedType#name)"
         end
 
-        unless instance_methods.include?(:"#{property}")
-          attr_reader(:"#{property}")
-        end
-
-        unless instance_methods.include?(:"#{property}=")
-          attr_writer(:"#{property}")
-          private(:"#{property}=")
-        end
+        attr_accessor(:"#{property}")
+        private(:"#{property}=")
       end
 
       enumerated = new(name, options).freeze
 
+      (options.keys + [:name]).each do |property|
+        @by_cache.set(property, enumerated.send(property), enumerated)
+      end
+
       @all << enumerated
       const_set(name.to_s.upcase, enumerated)
     end

data/lib/enumerated_type/version.rb

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

data/test/enumerated_type_spec.rb

@@ -190,10 +190,14 @@ describe EnumeratedType do
       Shapes.by(:sides, 4).must_equal(Shapes::RECTANGLE)
     end
 
-    it "raises an argumetn if there is no match" do
+    it "raises an argument if there is no match" do
       lambda { Shapes.by(:sides, 6) }.must_raise(ArgumentError)
     end
 
+    it "executes (and returns) the block if there is no match" do
+      (Shapes.by(:sides, 6) { "UnknownShape"}).must_equal("UnknownShape")
+    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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: enumerated_type
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Rafer Hazen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,33 +71,26 @@ 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: 2282385263752842432
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2282385263752842432
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.3.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple enumerated types
 test_files:
 - test/enumerated_type_spec.rb