value_object 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e81fef4675c5209e747e4b0cabff9b7527247517
+  data.tar.gz: cd5bd4d1af224d1df659e5523791db0fdbd2b95f
+SHA512:
+  metadata.gz: aba48d07c45433e9051bb64fa05103db629f119607277cd35927f5da4a60497e82c428509090200e0f9d1c9a7a0f006ea73923ce0be29c489d2e177821c008e5
+  data.tar.gz: f4511e42bae716e17d0dae8d5107d659ca5e073d87e37b8e49510ddbe4d05b016d13ebd8d17bc1b02512687a35b7aa59025fa631d5222bd322b0ce619796c611

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Harry Garrood
+Copyright (c) 2012-2014 Harry Garrood
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,84 +1,75 @@
 # ValueObject
+A very small library to help you define and create immutable value
+objects.  Mainly to reduce the amount of code I needed for ActiveRecord
+`composed_of` classes.
 
-A very small library to help you define and create immutable value objects.
+## overview
 
-## Why?
+Start off by creating a class which derives from `ValueObject::Base`.
+Call `has_fields` to define a list of fields for the class.
 
-Mainly to reduce the amount of code I needed for ActiveRecord `composed_of` classes.
-ValueObjects are designed with `composed_of` in mind; they will:
-
-* happily accept `nil` for their fields, unlike [Values](https://github.com/tcrayford/Values).
-* allow multiple levels of subclassing -- if you want a value object
-which is like some other class of value object (ie, it has all of the other object's fields
-and methods) but will some additional field or method, you can simply subclass it.
-
-## How to use
-
-Require it
-
-    require 'value_object'
-
-Subclass it
-
-
-    class Person < ValueObject::Base
-      has_fields :height, :weight
+    class Route < ValueObject::Base
+      has_fields :from, :to
     end
 
-Create a value object with positional arguments
+You can now create instances of this class with positional arguments:
+
+    m1_motorway    = Route.new("London", "Leeds")
+    channel_tunnel = Route.new("Calais", "Dover")
 
-    tom = Person.new(176, 75)
-    dick = Person.new(160, 60)
+Or with hashes:
 
-Create a value object with a hash
+    route_66 = Route.new(:from => "Santa Monica", :to => "Chicago")
 
-    harry = Person.new(:height => 176, :weight => 75)
-    
-Read their attributes
+You can read their attributes, but you can't write them.
 
-    tom.height        # => 176
-    dick.weight       # => 60
+    m1_motorway.from     # => "London"
+    channel_tunnel.to    # => "Dover"
+    route_66.from = "IL" # => NoMethodError
 
-Test whether value objects are equal (note: #== and #eql? are aliases)
+You can test whether they are equal with `==` or `eql?`, which are
+aliases.
 
-    tom == dick       # => false
-    tom.eql?(harry)   # => true
+    m1_motorway == channel_tunnel                 # => false
+    m1_motorway.eql?(Route.new("London", "Leeds)) # => true
 
-Test for emptiness
+You can also create instances where all values are nil. Objects like this will
+return `true` when sent the message `empty?` (and will)
 
-    Person.new(nil, nil).empty?    # => true
+    m1_motorway.empty?         # => false
+    Route.new(nil, nil).empty? # => true
 
-You can even subclass them again!
+You can even subclass them again to add more fields!
 
-    class Superhero < Person
-      has_fields :power
+    class Railway < Route
+      has_fields :serviced_by
     end
 
-    superman = Superhero.new('6 foot 3', '235 lbs', 'flies')
+    a_railway = Railway.new("Aberdeen", "Inverness", "ScotRail")
 
-    superman.height     # => '6 foot 3'
-    superman.weight     # => '235 lbs'
-    superman.power      # => 'flies'
+    a_railway.height     # => '6 foot 3'
+    a_railway.weight     # => '235 lbs'
+    a_railway.power      # => 'flies'
 
-Turn them into hashes
+Create a hash from a value object by sending `to_hash`.
 
-    superman.to_hash
-    # => {:height => '6 foot 3',
-          :weight => '325 lbs',
-          :power => 'flies'}
+    a_railway.to_hash
+    # => {
+           :from        => "Aberdeen",
+           :to          => "Inverness",
+           :serviced_by => "ScotRail"
+         }
 
-Make copies with only one changed value
+`copy_with` allows you to make a copy of a value object while updating
+certain attributes.
 
-    superman.copy_with(:power => 'laser eyes')
-    # => #<Superhero:0x3914490
-        @height="6 foot 3",
-        @weight="235 lbs",
-        @power="laser eyes"
-    >
+    a_railway.copy_with(:serviced_by => "Virgin")
+    # => #<Railway:0x3914490
+        @from="Aberdeen",
+        @to="Inverness",
+        @serviced_by="Virgin">
 
-Hash them. A hash depends on the both the object's class and the
-attribute values for that object, so that if o1 and o2 are both value
-objects, and o1.eql?(o2), then o1.hash == o2.hash
+Value objects also define `hash`, which depends on the values of the
+fields as well as the class of which they are an instance.
 
-    superman.hash
-    # => 1160641176
+    a_railway.hash            # => 1160641176

data/Rakefile

@@ -10,6 +10,7 @@ desc "Run tests"
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = test_pattern
+  t.warning = true
 end
 
 desc "Run tests with SimpleCov coverage"

data/lib/value_object.rb

@@ -8,15 +8,11 @@ module ValueObject
 
     class << self
       def has_fields(*args)
-        attr_reader *args
+        attr_reader(*args)
         self.fields += args
       end
     end
 
-    def fields
-      self.class.fields
-    end
-
     def initialize(*args)
       if args.length == 1 && args[0].is_a?(Hash)
         fields.each { |f| instance_variable_set "@#{f}", args[0][f] }
@@ -27,7 +23,7 @@ module ValueObject
 
     def eql?(other)
       return false if self.class != other.class
-      fields.all? { |f| send(f) == other.send(f) }
+      fields.all? { |f| public_send(f) == other.public_send(f) }
     end
 
     def ==(other)
@@ -35,12 +31,12 @@ module ValueObject
     end
 
     def empty?
-      fields.all? { |f| send(f).nil? }
+      fields.all? { |f| public_send(f).nil? }
     end
 
     def to_hash
       hash = {}
-      fields.each { |f| hash[f] = send(f) }
+      fields.each { |f| hash[f] = public_send(f) }
       hash
     end
 

data/lib/value_object/version.rb

@@ -1,3 +1,3 @@
 module ValueObject
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/value_object.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Harry Garrood"]
   gem.email         = ["hdgarrood@gmail.com"]
   gem.description   = %q{A tiny gem for value objects.}
-  gem.summary       = %q{A gem which gives you a class which you can subclass to easily create immutable value objects.}
+  gem.summary       = %q{A tiny gem which makes it dead simple to create immutable value objects.}
   gem.homepage      = "https://github.com/hdgarrood/value_object"
 
   gem.files         = `git ls-files`.split($\)
@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "value_object"
   gem.require_paths = ["lib"]
   gem.version       = ValueObject::VERSION
+  gem.license       = "MIT"
 
   gem.add_dependency 'activesupport'
   gem.add_development_dependency 'simplecov'

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: value_object
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Harry Garrood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A tiny gem for value objects.
@@ -50,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -60,30 +55,28 @@ files:
 - test/tc_value_object.rb
 - value_object.gemspec
 homepage: https://github.com/hdgarrood/value_object
-licenses: []
+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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
-summary: A gem which gives you a class which you can subclass to easily create immutable
-  value objects.
+specification_version: 4
+summary: A tiny gem which makes it dead simple to create immutable value objects.
 test_files:
 - test/tc_value_object.rb
-has_rdoc: