hamsterdam 1.0.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+Hamsterdam v1.0.0
+  * Can define immutable record types via Hamsterdam::Struct.define(*field_names)
+	* Provides getters for all fields, and set_* transformers that return the updated version of the record.
+	* Handy merge function for updating one or more fields by name
+	* Wraps Hamaster's (https://github.com/harukizaemon/hamster) immutable Hamster::Hash class

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Deps are in hamsterdam.gemspec
+gemspec

data/README.md

@@ -0,0 +1,11 @@
+# Hamsterdam #
+
+Immutable Struct-like record structures based on Hamster's (https://github.com/harukizaemon/hamster) immutable Hashes.  Convenient methods for updating record structures and returning new immutable instances.
+
+# Example #
+
+    Person = Hamsterdam::Struct.define(:name, :address, :age)
+    david = Person.new(name: "David", age: true, address: "Coopersville")
+    david1 = david.set_address("East Grand Rapids")
+    david2 = david.merge(name: "Crosby", age: "increased")
+    

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+HERE = File.dirname(__FILE__)
+
+Dir[File.expand_path(HERE) + "/rake_tasks/*.rake"].each do |rake_file|
+  import rake_file
+end
+
+# desc 'Default: run specs and cucumber features'
+# task :default => [ "spec", "cuc:features" ]
+
+task :default => [ "spec" ]

data/hamsterdam.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/lib")
+require File.expand_path('../lib/hamsterdam', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Crosby"]
+  gem.email         = ["david.crosby@atomicobject.com"]
+  gem.description   = %q{Immutable Struct-like record structures based on Hamster.}
+  gem.summary       = %q{Immutable Struct-like record structures based on Hamster.}
+  gem.homepage      = "https://github.com/atomicobject/hamsterdam"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n") - [".gitignore", ".rspec", ".rvmrc", "NOTES.txt", "TODO"]
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hamsterdam"
+  gem.require_paths = ["lib"]
+  gem.version       = Hamsterdam::VERSION
+
+  gem.add_dependency "hamster"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "pry"
+end

data/lib/hamsterdam.rb

@@ -0,0 +1,86 @@
+require 'hamster'
+
+module Hamsterdam
+  VERSION = "1.0.0"
+
+  class Struct
+    def self.define(*field_names)
+      struct_class = Class.new(Hamsterdam::Struct) do
+        field_names.each do |fname|
+          define_method fname do 
+            return @data[fname]
+          end
+
+          define_method "set_#{fname}" do |value|
+            self.class.new(@data.put(fname, value))
+          end
+        end
+
+      end
+
+      struct_class.instance_variable_set(:@field_names, Hamster.set(*field_names))
+      class << struct_class 
+        def field_names
+          @field_names
+        end
+      end
+      struct_class
+    end
+
+    def initialize(values=Hamster.hash)
+      @data = flesh_out(ensure_hamster_hash(values))
+      validate_keys(@data)
+    end
+
+    def merge(values)
+      self.class.new(@data.merge(ensure_hamster_hash(values)))
+    end
+
+    def ==(other)
+      @data == other.to_hamster_hash
+    end
+
+    def eql?(other)
+      self.class == other.class && self == other
+    end
+
+    def hash
+      @data.hash
+    end
+
+    def to_hamster_hash
+      @data
+    end
+
+    private
+    def validate_keys(data)
+      valid_keys = self.class.field_names
+      bad_keys = data.keys - valid_keys
+      if bad_keys.any?
+        raise "#{self.class.name || "Anonymous Hamsterdam::Struct"} can't be constructed with #{bad_keys.inspect}. Valid keys: #{valid_keys.inspect}"
+      end
+    end
+
+    def ensure_hamster_hash(h)
+      case h
+      when Hash
+        Hamster.hash(h)
+      when Hamster::Hash
+        h
+      else
+        raise "Expected Hash or Hamster::Hash. Do not want: #{h.inspect}"
+      end
+    end
+
+    def flesh_out(data)
+      fnames = self.class.field_names
+      miss = fnames - data.keys
+      if miss.any?
+        return miss.inject(data) { |h,name| h.put(name,nil) }
+      else
+        return data
+      end
+    end
+
+  end
+end

data/rake_tasks/rspec.rake

@@ -0,0 +1,25 @@
+begin
+require 'rspec/core/rake_task'
+rescue Exception => e
+  "RSpec is not available.  'spec' task will not be defined."
+end
+
+begin # protect from missing rspec
+  desc "Run specs"
+  RSpec::Core::RakeTask.new do |t|
+    if ENV["file"]
+      t.pattern = ENV["file"]
+    end
+    t.rspec_opts = "--color --format documentation" # --tty
+  end
+  
+  desc "Run individual spec"
+  task "spec:just" do
+    RSpec::Core::RakeTask.new("_tmp_rspec") do |t|
+      t.pattern = ENV["file"] || raise("Please supply 'file' argument")
+      t.rspec_opts = "--color"
+    end
+    Rake::Task["_tmp_rspec"].invoke
+  end
+rescue Exception => e
+end

data/spec/hamsterdam_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "Hamsterdam structures" do
+  def define_hamsterdam_struct(*field_names)
+    Hamsterdam::Struct.define(*field_names)
+  end
+  describe "Struct.define" do
+    let(:struct_class) { define_hamsterdam_struct(:top, :bottom) }
+
+    it "creates a structure class based on the given fields" do
+      struct = struct_class.new(top: 200, bottom: "all the way down")
+      struct.should be
+      struct.top.should == 200
+      struct.bottom.should == "all the way down"
+    end
+
+    it "can be built with Hamster hashes" do
+      struct = struct_class.new(Hamster.hash(top: 10, bottom: "low"))
+      struct.should be
+      struct.top.should == 10
+      struct.bottom.should == "low"
+    end
+
+    it "does not accept constructor inputs that are not defined" do
+      lambda do struct_class.new(oops: ":)", wups: ":(") end.should raise_error(/oops/)
+    end
+
+    it "allows omission of keys" do
+      struct = struct_class.new(top: 50)
+      struct.top.should == 50
+      struct.bottom.should be_nil
+    end
+
+    it "allows omission of all keys" do
+      struct = struct_class.new
+      struct.top.should be_nil
+      struct.bottom.should be_nil
+    end
+
+    it "provides access to the internal data as a Hamster.hash" do
+      s1 = struct_class.new(top: 50, bottom: 75)
+      s1.to_hamster_hash.should == Hamster.hash(top: 50, bottom: 75)
+    end
+
+    it "raises helpful error when constructed with invalid objects" do
+      lambda do struct_class.new("LAWDY") end.should raise_error /Do not want.*LAWDY/
+    end
+
+    describe "equality" do
+      it "considers two structs equal if they have the same field values" do
+        s1 = struct_class.new(top: 50, bottom: 75)
+        s2 = struct_class.new(top: 50, bottom: 75)
+        s1.eql?(s2).should == true
+        (s1 == s2).should == true
+        s1.should == s2
+      end
+
+      it "considers two structs NOT equal if they have the different field values" do
+        s1 = struct_class.new(top: 50, bottom: 75)
+        s2 = struct_class.new(top: 50, bottom: 74)
+        s3 = struct_class.new(top: 51, bottom: 75)
+
+        s1.eql?(s2).should_not == true
+        (s1 == s2).should_not == true
+        s1.should_not == s2
+
+        s1.eql?(s3).should_not == true
+        (s1 == s3).should_not == true
+        s1.should_not == s3
+      end
+
+      it "doesn't consider to structs eql? unless they are same class" do
+        s1 = struct_class.new(top: 50, bottom: 75)
+        s2 = define_hamsterdam_struct(:top, :bottom).new(top:50, bottom:75)
+        s1.eql?(s2).should == false
+        (s1 == s2).should == true # should still be ==
+      end
+
+      it "considers equal two structs if one has missing keys, and the other has nil values for those keys" do
+        s1 = struct_class.new(top: 50, bottom: nil)
+        s2 = struct_class.new(top: 50)
+        #binding.pry
+        s1.eql?(s2).should == true
+        (s1 == s2).should == true
+        s1.should == s2
+      end
+    end
+
+    it "uses the same #hash as Hamster::Hash" do
+      s1 = struct_class.new(top: 50, bottom: 75)
+      s1.hash.should == Hamster.hash(top:50, bottom:75).hash
+    end
+
+    describe "transformation" do
+      it "provides setters for individual fields that return an updated version of the struct" do
+        struct = struct_class.new(top: 10, bottom: 1)
+        struct2 = struct.set_top("woot")
+        struct2.top.should == "woot"
+        struct2.bottom.should == 1
+
+        struct.top.should == 10
+        struct.bottom.should == 1
+      end
+
+      it "provides a merge function" do
+        struct = struct_class.new(top: 10, bottom: 1)
+
+        struct2 = struct.merge(bottom: "new")
+        struct2.top.should == 10
+        struct2.bottom.should == "new"
+
+        struct.top.should == 10
+        struct.bottom.should == 1
+
+        struct3 = struct2.merge(top: "newer", bottom: "very")
+        struct3.top.should == "newer"
+        struct3.bottom.should == "very"
+      end
+
+      it "can merge-in Hamster::Hash" do
+        struct = struct_class.new(top: 10, bottom: 1)
+
+        struct2 = struct.merge(Hamster.hash(bottom: "newer", top: "newest"))
+        struct2.top.should == "newest"
+        struct2.bottom.should == "newer"
+
+        struct.top.should == 10
+        struct.bottom.should == 1
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+PROJECT_ROOT = File.expand_path(File.dirname(__FILE__) + "/..")
+
+$LOAD_PATH << "#{PROJECT_ROOT}/lib"
+$LOAD_PATH << "#{PROJECT_ROOT}/spec"
+
+require 'simplecov' # SimpleCov must come first!
+# This start/config code could alternatively go in .simplecov in project root:
+SimpleCov.start do 
+  add_filter "/spec/"
+end
+
+#ENV["APP_ENV"] = "rspec"
+
+require 'hamsterdam'
+
+require 'pry'
+
+# Load all support files
+Dir["#{PROJECT_ROOT}/spec/support/*.rb"].each do |support|
+  require support
+end
+
+RSpec.configure do |config|
+  config.include HamsterdamHelpers
+end
+

data/spec/support/hamsterdam_helpers.rb

@@ -0,0 +1,3 @@
+module HamsterdamHelpers
+  # 
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: hamsterdam
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Crosby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hamster
+  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: rake
+  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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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 Struct-like record structures based on Hamster.
+email:
+- david.crosby@atomicobject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
+- hamsterdam.gemspec
+- lib/hamsterdam.rb
+- rake_tasks/rspec.rake
+- spec/hamsterdam_spec.rb
+- spec/spec_helper.rb
+- spec/support/hamsterdam_helpers.rb
+homepage: https://github.com/atomicobject/hamsterdam
+licenses: []
+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: Immutable Struct-like record structures based on Hamster.
+test_files:
+- spec/hamsterdam_spec.rb
+- spec/spec_helper.rb
+- spec/support/hamsterdam_helpers.rb