value_struct 0.5.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "read_only Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2012-11-01
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jan Lelis
+
+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.md

@@ -0,0 +1,68 @@
+# Value Struct
+
+A value struct is a subclass of normal [Ruby struct](http://blog.grayproductions.net/articles/all_about_struct) that behaves almost the same. However, it has a major difference:
+
+__Value structs are immutable, i.e. they don't have setters (although, not recursively*)__
+
+This gem also provides the following (optional) mixins, to make life easier when using immutable structs:
+
+* __DupWithChanges__ #dup takes a optional hash for setting new values
+* __StrictArguments__ Value structs need to be initialized with the exact amount of arguments
+* __Freeze__ Automatically freeze new instances
+* __ToH__ #to_h for converting into a hash (if Ruby version below < 2.0)
+
+By default, only the DupWithChanges and ToH mixins get included.
+
+## Why?
+
+Sometimes you want to eliminate state. See [this blog article] for more information.
+
+## Performance
+
+Without mixins, ValueStructs are as fast as normal structs. Some (optional) mixins add noticable overhead, e.g. StrictArguments
+
+## How to use structs with mixins
+
+    Point = ValueStruct.new_with_mixins :x, :y, [
+      ValueStruct::DupWithChanges,
+      ValueStruct::ToH,
+      ValueStruct::StrictArguments,
+      ValueStruct::Freeze,
+    ]
+
+## Example
+
+    require 'value_struct'
+
+    Point = ValueStruct.new(:x, :y) do # methods defined in the block will be available in your new value struct class
+      # ...
+    end
+
+Please refer to the [documentation of Ruby's struct] for more details on usage.
+
+## *
+
+Because of the nature of Ruby, most things are not really immutable. So if you have an attribute `:by` and initialize it with an array, you cannot change the value struct anymore, but still the array:
+
+    Ru = ValueStruct.new(:by)
+    ruby = Ru.by([1,2,3])
+    ruby.by # => [1,2,3]
+
+    ruby.by = [1,2,3,4] # not possible
+    ruby.by << 4        # possible
+
+## Install
+
+    $ gem install value_struct
+
+## Todo
+
+* Make test suite clean and useful
+
+## Influenced by / Thanks to
+
+* Ruby Rogues #123
+* Tom Crayford: [Values](https://github.com/tcrayford/Values)
+* https://github.com/iconara/immutable_struct
+
+## J-_-L

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,18 @@
+name: value_struct
+summary: "Struct-like value objects"
+license: MIT
+authors: Jan Lelis
+email: mail@janlelis.de
+homepage: https://github.com/janlelis/value_struct
+
+development_dependencies:
+  bundler: ~> 1.0
+  rake: ~> 0.8
+  rspec: ~> 2.4
+  rubygems-tasks: ~> 0.2
+  yard: ~> 0.8
+  kramdown: ~> 0.14 
+  debugger: ~> 1.2.1
+  values: ~> 1.2.1
+  immutable_struct: ~> 1.0.2
+  hamster: ~> 0.4.3

data/lib/value_struct.rb

@@ -0,0 +1,27 @@
+require_relative 'value_struct/version'
+require_relative 'value_struct/core'
+require_relative 'value_struct/to_h'
+require_relative 'value_struct/dup_with_changes'
+require_relative 'value_struct/strict_arguments'
+require_relative 'value_struct/freeze'
+
+class ValueStruct < Struct
+  def self.build(*args, &block)
+    struct_class = Struct.new(*args, &block)
+    struct_class.send(:include, ValueStruct::Core)
+    struct_class
+  end
+
+  def self.new_with_mixins(*args, mixins, &block)
+    raise ArgumentError, 'mixin list (last paramater) must be an array' unless mixins.is_a? Array
+    struct_class = build(*args, &block)
+    mixins.each{ |mixin| struct_class.send(:include, mixin) }
+    struct_class
+  end
+
+  def self.new(*args, &block)
+    mixins = [ValueStruct::DupWithChanges]
+    mixins.unshift(ValueStruct::ToH) if RUBY_VERSION < "2.0"
+    new_with_mixins(*args, mixins, &block)
+  end
+end

data/lib/value_struct/core.rb

@@ -0,0 +1,12 @@
+module ValueStruct::Core
+  def inspect
+    super.to_s.sub('struct', 'ValueStruct')
+  end
+
+  def self.included(struct)
+    struct.send(:undef_method, "[]=".to_sym)
+    struct.members.each do |member|
+      struct.send(:undef_method, "#{member}=".to_sym)
+    end
+  end
+end

data/lib/value_struct/dup_with_changes.rb

@@ -0,0 +1,20 @@
+module ValueStruct::DupWithChanges
+  def dup(changes = {})
+    case changes
+    when {}
+      new(values)
+    when Hash
+      new(
+        members.zip(values).map{ |member, value|
+          if changes.has_key?(m)
+            changes[m]
+          else
+            value
+          end
+        }
+      )
+    else
+      raise ArgumentError, 'dup must be given a Hash or nothing'
+    end
+  end
+end

data/lib/value_struct/freeze.rb

@@ -0,0 +1,6 @@
+module ValueStruct::Freeze
+  def initialize(*args, &block)
+    super *args, &block
+    freeze
+  end
+end

data/lib/value_struct/strict_arguments.rb

@@ -0,0 +1,8 @@
+module ValueStruct::StrictArguments
+  def initialize(*args, &block)
+    super *args, &block
+    unless size == args.size + (args[0].is_a?(String) ? 1 : 0)
+      raise ArgumentError, "wrong number of arguments (#{args.size} for #{members.size})"
+    end
+  end
+end

data/lib/value_struct/to_h.rb

@@ -0,0 +1,5 @@
+module ValueStruct::ToH
+  def to_h
+    Hash[members.zip(values)]
+  end
+end

data/lib/value_struct/version.rb

@@ -0,0 +1,3 @@
+class ValueStruct < Struct
+  VERSION = '0.5.0'
+end

data/spec/benchmark.rb

@@ -0,0 +1,44 @@
+require_relative '../lib/value_struct'
+require 'benchmark'
+require 'immutable_struct'
+require 'values'
+
+COUNT = 200_000
+
+def benchmark_for(struct_class)
+  puts "%20s: %s" % [
+    struct_class,
+    Benchmark.measure do
+      struct = struct_class.new(:a, :b, :c, :d)
+       COUNT.times{
+        n = struct.new(nil, nil, nil, nil)
+        s = struct.new([1,2,3,4], "value", 23432421412, n)
+        s.a == s.b
+        s.c == s.d
+        s == n
+      }
+    end
+  ]
+end
+
+def benchmark_for_hash
+  puts "%20s: %s" % [
+    "[Hash]",
+    Benchmark.measure do
+      COUNT.times{
+        n = { a: nil, b: nil, c: nil, d: nil }
+        s = { a: [1,2,3,4], b: "value", c: 23432421412, d: nil }
+        s[:a] == s[:b]
+        s[:c] == s[:d]
+        s == n
+      }
+    end
+  ]
+end
+
+
+benchmark_for(Struct)
+benchmark_for(Value)
+benchmark_for(ImmutableStruct)
+benchmark_for(ValueStruct)
+benchmark_for_hash

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'value_struct'

data/spec/struct_value_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe ValueStruct do
+  it "should have a VERSION constant" do
+    ValueStruct.const_get('VERSION').should_not be_empty
+  end
+
+  describe 'initialization' do
+    subject do
+      ValueStruct.new(:x, :y)
+    end
+
+    it 'creates Class instances' do
+      should be_instance_of Class
+    end
+  end
+
+  describe 'instance' do
+    subject do
+      Point = ValueStruct.new(:x, :y)
+      Point.new(1,2)
+    end
+
+    it { should be_a Struct }
+    it { should be_a ValueStruct::Core }
+
+    it 'stores values accessible by readers' do
+      subject.x.should == 1
+      subject.y.should == 2
+    end
+
+    it 'does not define setters' do
+      expect{ subject.x = 5 }.to raise_error(NoMethodError)
+    end
+
+    it 'does not allow mutatation using []= syntax' do
+      expect{ subject[:x] = 5 }.to raise_error(NoMethodError)
+    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)')
+    # end
+
+    it 'can be inherited from to add methods' do
+      class GraphPoint < ValueStruct.new(:x, :y)
+        def inspect
+          "GraphPoint at #{x},#{y}"
+        end
+      end
+
+      c = GraphPoint.new(0,0)
+      c.inspect.should == 'GraphPoint at 0,0'
+    end
+  end
+
+  describe '#hash and equality' do
+    Y = ValueStruct.new(:x, :y)
+
+    it 'is equal to another value with the same fields' do
+      Point.new(0,0).should == Point.new(0,0)
+    end
+
+    it 'is not equal to an object with a different class' do
+      Point.new(0,0).should_not == Y.new(0,0)
+    end
+
+    it 'is not equal to another value with different fields' do
+      Point.new(0,0).should_not == Point.new(0,1)
+      Point.new(0,0).should_not == Point.new(1,0)
+    end
+
+    it 'has an equal hash if the fields are equal' do
+      p = Point.new(0,0)
+      p.hash.should == Point.new(0,0).hash
+    end
+
+    it 'has a non-equal hash if the fields are different' do
+      p = Point.new(0,0)
+      p.hash.should_not == Point.new(1,0).hash
+    end
+
+    it 'does not have an equal hash if the class is different' do
+      Point.new(0,0).hash.should_not == Y.new(0,0).hash
+      debugger
+    end
+  end
+
+  # describe '#clone and #dup return the same object' do
+  #   it{ subject.object_id.should == subject.clone.object_id }
+  #   it{ subject.object_id.should == subject.dup.object_id }
+  # end
+end

data/value_struct.gemspec

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'value_struct'
+                  ValueStruct::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: value_struct
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: immutable_struct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+description: ''
+email: mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/value_struct.rb
+- lib/value_struct/core.rb
+- lib/value_struct/dup_with_changes.rb
+- lib/value_struct/freeze.rb
+- lib/value_struct/strict_arguments.rb
+- lib/value_struct/to_h.rb
+- lib/value_struct/version.rb
+- spec/benchmark.rb
+- spec/spec_helper.rb
+- spec/struct_value_spec.rb
+- value_struct.gemspec
+homepage: https://github.com/janlelis/value_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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Struct-like value objects
+test_files: []