values 1.4.0 → 1.5.0

data/README.md

@@ -4,7 +4,7 @@ These mostly look like classes created using Struct, but fix two problems with t
 Struct constructors can take less than the default number of arguments and set other fields as nil:
 
 ```ruby
-Point = Struct.new(:x,:y)
+Point = Struct.new(:x, :y)
 Point.new(1)
 # => #<struct Point x=1, y=nil>
 ```
@@ -12,8 +12,8 @@ Point.new(1)
 Structs are also mutable:
 
 ```ruby
-Point = Struct.new(:x,:y)
-p = Point.new(1,2)
+Point = Struct.new(:x, :y)
+p = Point.new(1, 2)
 p.x = 2
 p.x
 # => 2
@@ -30,11 +30,19 @@ Point.new(1)
 # from (irb):5
 # from /usr/local/bin/irb:12:in `<main>
 
-p = Point.new(1,2)
+p = Point.new(1, 2)
 p.x = 1
 # => NoMethodError: undefined method x= for #<Point:0x00000100943788 @x=0, @y=1>
 # from (irb):6
 # from /usr/local/bin/irb:12:in <main>
 ```
 
-Value does NOT have all the features of Struct (nor is it meant to).
+Values also provides an alternative constructor which takes a hash:
+
+```ruby
+p = Point.with(x: 3, y: 4)
+p.x
+# => 3
+```
+
+Values does NOT have all the features of Struct (nor is it meant to).

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/lib/values.rb

@@ -1,49 +1,43 @@
 class Value
   def self.new(*fields)
-    return Class.new do
+    Class.new do
       attr_reader *fields
 
-      define_method(:initialize) do |*input_fields|
-        raise ArgumentError.new("wrong number of arguments, #{input_fields.size} for #{fields.size}") if fields.size != input_fields.size
+      define_method(:initialize) do |*values|
+        raise ArgumentError.new("wrong number of arguments, #{values.size} for #{fields.size}") if fields.size != values.size
 
-        fields.each_with_index do |field, index|
-          instance_variable_set('@' + field.to_s, input_fields[index])
+        fields.zip(values) do |field, value|
+          instance_variable_set(:"@#{field}", value)
         end
-        self.freeze
+
+        freeze
       end
 
       const_set :VALUE_ATTRS, fields
 
       def self.with(hash)
-        args = []
-        self::VALUE_ATTRS.each do |field|
-          args << hash.fetch(field)
-        end
-
         unexpected_keys = hash.keys - self::VALUE_ATTRS
         if unexpected_keys.any?
           raise ArgumentError.new("Unexpected hash keys: #{unexpected_keys}")
         end
-        self.new(*args)
+
+        new(*hash.values_at(*self::VALUE_ATTRS))
       end
 
       def ==(other)
-        self.eql?(other)
+        eql?(other)
       end
 
       def eql?(other)
-        return false if other.class != self.class
-        self.class::VALUE_ATTRS.all? do |field|
-          self.send(field) == other.send(field)
-        end
+        self.class == other.class && values == other.values
       end
 
       def hash
-        result = 0
-        self.class::VALUE_ATTRS.each do |field|
-          result += self.send(field).hash
-        end
-        return result + self.class.hash
+        values.map(&:hash).inject(0, :+) + self.class.hash
+      end
+
+      def values
+        self.class::VALUE_ATTRS.map { |field| send(field) }
       end
     end
   end

data/spec/values_spec.rb

@@ -1,12 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/../lib/values')
 describe 'values' do
+  Cell = Value.new(:alive)
+
   it 'stores a single field' do
-    Cell = Value.new(:alive)
     c = Cell.new(true)
     c.alive.should == true
   end
 
   Point = Value.new(:x, :y)
+
   it 'stores multiple values' do
     p = Point.new(0,1)
     p.x.should == 0
@@ -14,65 +16,62 @@ describe 'values' do
   end
 
   it 'raises argument errors if not given the right number of arguments' do
-    lambda { Point.new }.should raise_error(ArgumentError, 'wrong number of arguments, 0 for 2')
+    expect { Point.new }.to raise_error(ArgumentError, 'wrong number of arguments, 0 for 2')
   end
 
-  it 'can be inherited from to add methods' do
-    class GraphPoint < Value.new(:x, :y)
-      def inspect
-        "GraphPoint at #{@x},#{@y}"
-      end
+  class GraphPoint < Value.new(:x, :y)
+    def inspect
+      "GraphPoint at #{@x},#{@y}"
     end
+  end
 
+  it 'can be inherited from to add methods' do
     c = GraphPoint.new(0,0)
     c.inspect.should == 'GraphPoint at 0,0'
   end
 
   it 'cannot be mutated' do
     p = Point.new(0,1)
-    lambda { p.x = 1}.should raise_error
+    expect { p.x = 1 }.to raise_error
   end
 
-  it 'cannot even be mutated inside a sublass with methods' do
-    class Cow < Value.new(:color)
-      def change_color(new_color)
-        @color = new_color
-      end
+  class Cow < Value.new(:color)
+    def change_color(new_color)
+      @color = new_color
     end
+  end
 
+  it 'cannot even be mutated inside a sublass with methods' do
     c = Cow.new("red")
-    lambda {c.change_color("blue")}.should raise_error
+    expect { c.change_color("blue") }.to raise_error
   end
 
+  Money = Value.new(:amount, :denomination)
+
   it 'cannot be mutated using #instance_variable_set' do
-    Money = Value.new(:amount, :denomination)
     m = Money.new(1, 'USD')
-    lambda {m.instance_variable_set('@amount',2)}.should raise_error
+    expect { m.instance_variable_set('@amount', 2) }.to raise_error
   end
 
   it 'can be instantiated with a hash' do
-    Money = Value.new(:amount, :denomination)
     one_dollar = Money.with(:amount => 1, :denomination => 'USD')
     one_dollar.amount.should == 1
     one_dollar.denomination.should == 'USD'
   end
 
   it 'errors if you instantiate it from a hash with unrecognised fields' do
-    Money = Value.new(:amount, :denomination)
     expect do
       Money.with(:unrecognized_field => 1, :amount => 2, :denomination => 'USD')
     end.to raise_error
   end
 
   it 'errors if you instantiate it from a hash with missing fields' do
-    Money = Value.new(:amount, :denomination)
     expect do
       Money.with
     end.to raise_error
   end
 
   it 'does not error when fields are explicitly nil' do
-    Money = Value.new(:amount, :denomination)
     expect do
       Money.with(:amount => 1, :denomination => nil)
     end.not_to raise_error
@@ -108,4 +107,10 @@ describe 'values' do
       Point.new(0,0).hash.should_not == Y.new(0,0).hash
     end
   end
+
+  describe '#values' do
+    it 'returns an array of field values' do
+      Point.new(10, 13).values.should == [10, 13]
+    end
+  end
 end

data/values.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "values"
-  s.version = "1.4.0"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Crayford"]
-  s.date = "2013-02-03"
+  s.date = "2013-02-22"
   s.description = "Simple immutable value objects for ruby.\n\n    Make a new value class: Point = Value.new(:x, :y)\n    And use it:\n    p = Point.new(1,0)\n    p.x\n    => 1\n    p.y\n    => 0\n    "
   s.email = "tcrayford@googlemail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: values
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 1
-  - 4
+  - 5
   - 0
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Tom Crayford
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-03 00:00:00 Z
+date: 2013-02-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement