value_object_struct 0.6.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec"
+  gem "rdoc"
+  gem "jeweler"
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Riley Lynch, Teleological Software, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,50 @@
+= ValueObjectStruct
+
+The ValueObjectStruct module uses Ruby's native Struct class to facilitate the
+declaration of immutable value object classes.
+
+ValueObjectStruct classes are defined with
+ValueObjectStruct.class_with_attributes and a list of member attributes
+specified by Symbol. Like Struct classes, they may be assigned to a constant
+or variable, or used in a superclass declaration.
+
+ValueObjectStruct instances are Struct instances with private attribute write
+access, including both named attribute writers and Hash or Array style
+bracketed subscript assignment. ValueObjectStruct instances created with
+::value (as opposed to ::new or ::for_values) are frozen, so that
+attribute values may not be reassigned after initialization, even by
+private methods.
+
+ValueObjectStruct instances do not enforce immutability of attribute values
+themselves, so it may be desirable to freeze mutable value types such
+as String, Array and Hash before using them to initialize an instance.
+
+As Struct instances, ValueObjectStruct instances provide equality and hash
+semantics via #== and #hash. #empty? returns true for value object
+instances with no non-nil attribute values.
+
+ValueObjectStruct instances provide an #attributes and #attribute method
+for compatibility with ActiveModel. #attributes returns a hash
+representation of attribute values. #attribute is an alias for #[].
+
+== Example
+
+  class Address < ValueObjectStruct.class_with_attributes(:street,:zip); end
+  address = Address.new(street: "123 Main", zip: 11211)
+  
+  address.street   = "123 Maple" # raises NoMethodError
+  address[:street] = "456 Elm"   # raises NoMethodError
+  address[1]       = "789 Pine"  # raises NoMethodError
+  
+  address == Address.new(street: "123 Main", zip: 11211)  # => true
+  address == Address.new(street: "123 Maple", zip: 11211) # => false
+  
+  set = Set[address]
+  set.include? Address.new(street: "123 Main", zip: 11211) # => true
+  set.include? Address.new(street: "123 Main", zip: 11212) # => false
+
+== Copyright
+
+Copyright (c) 2012 Riley Lynch, Teleological Software, LLC.
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "value_object_struct"
+  gem.homepage = "http://github.com/teleological/value_object_struct"
+  gem.license = "MIT"
+  gem.summary = %Q{Immutable value objects}
+  gem.description = %Q{Immutable value objects using Ruby Structs}
+  gem.authors = ["Riley Lynch"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.title = "value_object_struct #{version}"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/lib/value_object_struct.rb

@@ -0,0 +1,68 @@
+
+# The ValueObjectStruct module provides the
+# ValueObjectStruct.class_with_attributes method for defining immutable
+# value object classes based on ruby's Struct class.
+
+module ValueObjectStruct
+
+  # ValueObjectStruct.class_with_attributes accepts a list of member
+  # attributes specified by Symbol and returns a Class that
+  # inherits from a Struct class defined with those attributes.
+  #
+  # The constructor for the resulting class accepts a Hash of
+  # attribute value assignments. Attributes must be specified by
+  # symbolic key. Undeclared attributes are ignored. Declared
+  # attributes of the value object which are not explicitly
+  # initialized are set to the default value of the initializing
+  # Hash (usually nil).
+  #
+  # The class also provides two factory methods: ::for_values, which
+  # accepts an ordered list of attribute values like the Struct class
+  # constructor, and ::value, which accepts a hash of attribute value
+  # assignments, constructs the value object, and then freezes it
+  # before returning it.
+  #
+  # Value object instances are Struct instances with private attribute
+  # write access, including both named attribute writers and Hash or
+  # Array style bracketed subscript assignment. If all attribute values
+  # are nil, the value object is considered empty.
+
+  def self.class_with_attributes(*attributes)
+    Struct.new(*attributes).tap do |klass|
+      klass.class_eval <<-"RUBY", __FILE__, __LINE__
+
+        def self.value(attributes={})
+          new(attributes).freeze
+        end
+
+        def initialize(attributes={})
+          values = members.map { |m| attributes[m] }
+          super(*values)
+        end
+
+        def self.for_values(*values)
+          attributes = {}
+          members.each_with_index { |m,i| attributes[m] = values[i] }
+          new(attributes)
+        end
+
+        def empty?
+          values.all?(&:nil?)
+        end
+
+        def attributes
+          members.each_with_object({}) { |m,h| h[m.to_s] = self[m] }
+        end
+
+        alias_method :attribute, :[]
+
+        private :[]=
+
+        private #{attributes.map {|attr| ":" + attr.to_s + "=" }.join(", ")}
+
+      RUBY
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'value_object_struct'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/value_object_struct_spec.rb

@@ -0,0 +1,116 @@
+
+require 'spec_helper'
+
+describe ValueObjectStruct do
+
+  let(:struct_class) { ValueObjectStruct.class_with_attributes(:foo,:baz) }
+
+  describe ".class_with_attributes" do
+
+    it "defines a Struct subclass" do
+      struct_class.superclass.should be Struct
+    end
+
+    it "declares the given members" do
+      struct_class.members.should == [:foo,:baz]
+    end
+
+  end
+
+  context "as a Struct subclass" do
+
+    context "initialized with a hash" do
+
+      it "initializes members from named argument" do
+        instance = struct_class.new(foo: "bar", baz: "qux")
+        instance[:foo].should == "bar"
+        instance.baz.should == "qux"
+      end
+
+      it "leaves members omitted from constructor hash nil" do
+        instance = struct_class.new(foo: "bar")
+        instance.baz.should be_nil
+      end
+
+    end
+
+    context "initialized without arguments" do
+
+      it "returns a null object" do
+        instance = struct_class.new()
+        instance.members.each {|m| instance[m].should be_nil}
+      end
+
+    end
+
+    describe ".for_values" do
+
+      it "initializes attributes in members order" do
+        instance = struct_class.for_values("bar","qux")
+        instance[:foo].should == "bar"
+        instance.baz.should == "qux"
+      end
+
+      context "without arguments" do
+
+        it "returns a null object" do
+          instance = struct_class.for_values
+          instance.members.each {|m| instance[m].should be_nil}
+        end
+
+      end
+
+    end
+
+    describe ".value" do
+
+      it "initializes members from named argument" do
+        instance = struct_class.value(foo: "bar", baz: "qux")
+        instance[:foo].should == "bar"
+        instance.baz.should == "qux"
+      end
+
+      it "returns a frozen object" do
+        struct_class.value(foo: "bar", baz: "qux").should be_frozen
+      end
+
+    end
+
+    context "given an instance" do
+
+      let(:instance) { struct_class.new(foo: "bar") }
+
+      it "privatizes member setters" do
+        lambda { instance.bar = "quxx" }.
+          should raise_error(NoMethodError)
+      end
+
+      it "privatizes hash write access" do
+        lambda { instance[:bar] = "quxx" }.
+          should raise_error(NoMethodError)
+      end
+
+      it "provides #attributes hash" do
+        instance.attributes.should == { "foo" => "bar", "baz" => nil }
+      end
+
+      it "provides #attribute alias" do
+        instance.attribute(:foo).should == "bar"
+      end
+
+    end
+
+    context "given an instance without initialized attributes" do
+
+      let(:instance) { struct_class.new() }
+
+      it "is considered empty" do
+        instance.should be_empty
+      end
+
+    end
+
+  end
+
+end
+

data/value_object_struct.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "value_object_struct"
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Riley Lynch"]
+  s.date = "2013-03-13"
+  s.description = "Immutable value objects using Ruby Structs"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/value_object_struct.rb",
+    "spec/spec_helper.rb",
+    "spec/value_object_struct_spec.rb",
+    "value_object_struct.gemspec"
+  ]
+  s.homepage = "http://github.com/teleological/value_object_struct"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Immutable value objects"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: value_object_struct
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Riley Lynch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: Immutable value objects using Ruby Structs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/value_object_struct.rb
+- spec/spec_helper.rb
+- spec/value_object_struct_spec.rb
+- value_object_struct.gemspec
+homepage: http://github.com/teleological/value_object_struct
+licenses:
+- MIT
+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: -311494150749971462
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Immutable value objects
+test_files: []