enumerated_type 0.2.3 → 0.3.0

data/README.md

@@ -154,9 +154,9 @@ Add arbitrary attributes:
 class JobStatus
   include EnumeratedType
 
-  declare :pending, :message => "Your Job is waiting to be processed"
-  declare :success, :message => "Your Job has completed"
-  declare :failure, :message => "Oops, it looks like there was a problem"
+  declare :pending, :code => 1, :message => "Your Job is waiting to be processed"
+  declare :success, :code => 2, :message => "Your Job has completed"
+  declare :failure, :code => 3, :message => "Oops, it looks like there was a problem"
 end
 
 JobStatus::SUCCESS.message # => "Your job has completed"
@@ -175,6 +175,26 @@ JobStatus.coerce(:wrong)             # => raises an ArgumentError
 
 `.coerce` is particularly useful for scrubbing parameters, allowing you to succinctly assert that arguments are valid for your `EnumeratedType`, while also broadening the range of types that can be used as input. Using `.coerce` at the boundaries of your code allows clients the freedom to pass in full fledged `EnumeratedType` objects, symbols or even strings, and allows you to use the `.coerce`d input with confidence (i.e without any type or validity checking beyond the call to `.coerce`).
 
+Look up an enum by a property:
+
+```ruby
+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 .
+
+```ruby
+class JobStatus
+  def display
+    "#{name}-#{code}"
+  end
+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`.
+
 ## Development
 
 To run the tests (assuming you have already run `gem install bundler`):

data/lib/enumerated_type.rb

@@ -52,9 +52,13 @@ 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}'")
+    end
+
     def [](name)
-      found = find { |e| e.name == name }
-      found || raise(ArgumentError, "Unrecognized #{self.name} name #{name.inspect}'")
+      by(:name, name)
     end
 
     def recognized?(name)

data/lib/enumerated_type/version.rb

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

data/test/enumerated_type_spec.rb

@@ -83,25 +83,25 @@ describe EnumeratedType do
     it "freezes String properties" do
       Gender::MALE.planet.frozen?.must_equal true
     end
-    
+
     it "does not freeze other properties" do
       NonString = Class.new do
         def frozen?
           !!@frozen
         end
-        
+
         def freeze
           @frozen = true
         end
       end
-      
+
       non_string = NonString.new
-      
+
       Class.new do
         include EnumeratedType
         declare :test, :other => non_string
       end
-      
+
       non_string.frozen?.must_equal false
     end
 
@@ -173,6 +173,36 @@ describe EnumeratedType do
     end
   end
 
+  describe ".by" do
+    class Shapes
+      include EnumeratedType
+
+      declare :triangle, :sides => 3, :pretty_hip => "YEAH"
+      declare :rectangle, :sides => 4, :pretty_hip => "NAH"
+      declare :pentagon, :sides => 5, :pretty_hip => "YEAH"
+
+      def sides_squared
+        sides * sides
+      end
+    end
+
+    it "looks the value up by the specified attribute" do
+      Shapes.by(:sides, 4).must_equal(Shapes::RECTANGLE)
+    end
+
+    it "raises an argumetn if there is no match" do
+      lambda { Shapes.by(:sides, 6) }.must_raise(ArgumentError)
+    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
+
+    it "works with arbitrary methods" do
+      Shapes.by(:sides_squared, 16).must_equal(Shapes::RECTANGLE)
+    end
+  end
+
   describe "#inspect" do
     it "looks reasonable" do
       Gender::FEMALE.inspect.must_equal "#<Gender:female>"
@@ -189,17 +219,17 @@ describe EnumeratedType do
     it "is the name (as a string)" do
       Gender::MALE.to_json.must_equal '"male"'
     end
-    
+
     it "doesn't raise an exception when given options" do
       Gender::MALE.to_json(:stuff => "here")
     end
   end
-  
+
   describe "#as_json" do
     it "is the name (as a string)" do
       Gender::MALE.as_json.must_equal "male"
     end
-    
+
     it "doesn't raise an exception when given options" do
       Gender::MALE.as_json(:stuff => "here")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerated_type
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3675634527099412429
+      hash: 2282385263752842432
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3675634527099412429
+      hash: 2282385263752842432
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23