value_object 0.0.1 → 0.0.3

data/README.md

@@ -1,29 +1,61 @@
 # ValueObject
 
-TODO: Write a gem description
+A very small library to help you define and create immutable value objects.
 
-## Installation
+## Why?
 
-Add this line to your application's Gemfile:
+Mainly to reduce the amount of code I needed for ActiveRecord `composed_of` classes.
+ValueObjects are designed with `composed_of` in mind; they will:
 
-    gem 'value_object'
+* 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.
 
-And then execute:
+## How to use
 
-    $ bundle
+Require it
 
-Or install it yourself as:
+    require 'value_object'
 
-    $ gem install value_object
+Subclass it
 
-## Usage
 
-TODO: Write usage instructions here
+    class Person < ValueObject::Base
+      has_fields :height, :weight
+    end
 
-## Contributing
+Create a value object with positional arguments
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+    tom = Person.new(176, 75)
+    dick = Person.new(160, 60)
+
+Create a value object with a hash
+
+    harry = Person.new(:height => 176, :weight => 75)
+    
+Read their attributes
+
+    tom.height        # => 176
+    dick.weight       # => 60
+
+Test whether value objects are equal
+
+    tom == dick       # => false
+    tom == harry      # => true
+
+Test for emptiness
+
+    Person.new(nil, nil).empty?    # => true
+
+You can even subclass them again!
+
+    class Superhero < Person
+      has_fields :power
+    end
+
+    superman = Superhero.new('6 foot 3', '235 lbs', 'flies')
+
+    superman.height     # => '6 foot 3'
+    superman.weight     # => '235 lbs'
+    superman.power      # => 'flies'

data/Rakefile

@@ -1,2 +1,27 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+def test_pattern
+  'test/tc_*.rb'
+end
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = test_pattern
+end
+
+desc "Run tests with SimpleCov coverage"
+task :coverage do
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/test/'
+  end
+  require 'test/unit'
+  Dir.glob(test_pattern).each do |file|
+    require_relative file
+  end
+end
+
+task :default => [:test]

data/lib/value_object/version.rb

@@ -1,3 +1,3 @@
 module ValueObject
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/tc_value_object.rb

@@ -0,0 +1,49 @@
+require 'test/unit'
+require 'value_object'
+
+class ValueObjectTest < Test::Unit::TestCase
+  def setup
+    @person_class = Class.new(ValueObject::Base)
+    @person_class.has_fields :height, :weight
+  end
+
+  def test_creates_people_properly_with_positional_arguments
+    p = @person_class.new(176, 75)
+    assert_equal(176, p.height)
+    assert_equal(75, p.weight)
+  end
+
+  def test_creates_people_properly_with_hashes
+    p = @person_class.new(:height => 176, :weight => 75)
+    assert_equal(176, p.height)
+    assert_equal(75, p.weight)
+  end
+
+  def test_equality_of_people
+    p1 = @person_class.new(176, 75)
+    p2 = @person_class.new(176, 75)
+    assert_equal(p1, p2)
+  end
+
+  def test_inequality_of_people
+    p1 = @person_class.new(180, 75)
+    p2 = @person_class.new(176, 89)
+    assert_not_equal(p1, p2)
+  end
+
+  def test_emptiness_of_people
+    assert_equal(true, @person_class.new(nil, nil).empty?)
+  end
+
+  def test_can_subclass_subclasses
+    superhero_class = Class.new(@person_class)
+    superhero_class.has_fields :powers
+
+    superman = superhero_class.new('6 foot 3',
+                                   '235 lbs',
+                                   ['flies', 'laser eyes', 'really strong'])
+    assert_equal('6 foot 3', superman.height)
+    assert_equal('235 lbs', superman.weight)
+    assert_equal('flies', superman.powers[0])
+  end
+end

data/value_object.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = ValueObject::VERSION
 
   gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: value_object
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !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.
 email:
 - hdgarrood@gmail.com
@@ -41,6 +57,7 @@ files:
 - Rakefile
 - lib/value_object.rb
 - lib/value_object/version.rb
+- test/tc_value_object.rb
 - value_object.gemspec
 homepage: https://github.com/hdgarrood/value_object
 licenses: []
@@ -62,10 +79,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem which gives you a class which you can subclass to easily create immutable
   value objects.
-test_files: []
+test_files:
+- test/tc_value_object.rb
 has_rdoc: