thingtank 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem 'couchrest'
+gem 'couchrest_model'
+
+group :development do
+  #gem "minitest", ">= 0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+
+  gem 'linecache19' 
+  gem 'ruby-debug19'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Marc Rene Arns
+
+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,329 @@
+thingtank: play different roles
+=====================
+
+ThingTank is a library that uses couchrest and couchrest model create arbitrary
+objects that may have different roles. The roles determine the
+properties and they can be mixed and matched at will.
+
+
+Installation
+------------
+_thingtank_ is only tested with ruby 1.9.2 and above.
+
+Install it as a gem:
+
+    sudo gem install thingtank
+
+or in rvm:
+
+    gem install thingtank
+
+
+Examples:
+--------
+
+To simplify the class building we let them all inherit from a role class
+
+    class Born < ThingTank::Role
+      property :birth_date
+      property :birth_place
+
+      validates_presence_of :birth_date # make sure a date is given
+    end
+
+
+Imagine a Caesar is born
+
+    class Born < ThingTank::Role
+      property :birth_date, :alias => :born_at
+      property :birth_place
+
+      validates_presence_of :birth_date # make sure a date is given
+    end
+
+    # just in case he might die....we might want to have a date and maybe even a place
+    class Dead < ThingTank::Role
+      property :date_of_death
+      property :place_of_death
+
+      validates_presence_of :date_of_death
+    end
+
+    class Person < ThingTank::Role
+      property :name
+      property :gender
+
+      validates_presence_of :name
+    end
+
+
+    julius = ThingTank.create { :gender => :m, :name => 'Gaius Iulius Caesar' }
+    julius["birth_date"] = "100 BC"
+    julius["birth_place"] = "Rome"
+    julius.is(Born)
+
+    julius.could_be? Person # => true
+    julius.is? Person # => false
+    julius.is Person
+    julius.is? Person # => true
+
+    julius.is(Born)["gender"] # => nil (gender is not a property of born)
+    julius.is(Born)["birth_date"] # => "100BC"
+
+    id = julius.id
+
+later...
+    julius = ThingTank.get id
+    julius["birth_date"] # => "100BC"
+    julius.is? Person # => true
+
+
+when he is adult, he wants to marry. now things are getting a bit more complicated:
+
+    # he needs a marriage and a women
+    class Married < ThingTank::Role
+      property :date              # the date of the marriage
+      property :end               # when the marriage ended
+      property :spouse            # doc_id of the spouse
+      property :state             # state of the marriage
+
+      validates_presence_of :date
+      validates_presence_of :spouse
+      validate :spouse_should_be_a_person
+
+      # ensure that 'spouse' is a doc_id of a Person
+      def spouse_should_be_a_person
+        Person.get(self["spouse"]).valid? # loads doc as role Person and validates
+      end
+    end
+
+    # we want easy access to the name of the spouse
+    class Spouse < ThingTank::Role
+      property :married    # doc must have "married" property (should be of class married)
+      property :married_state
+
+      validate :spouse_should_be_married
+      
+      def married
+        self["married"] # contains a Married role
+      end
+
+      def spouse_should_be_married
+        married["spouse"] == self["_id"]
+      end
+
+      def name
+        self["married_state"] == "married" ?
+          Person.get(married["spouse"]).name :
+          nil
+      end
+
+      def ex
+        self["married_state"] == "divorced" ?
+          Person.get(married["spouse"]).name :
+          nil
+      end
+    end
+
+now we could easily get julius married
+
+    conny = ThingTank.create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+    julius["married"] = {"date" => "84 BC", "spouse" => conny.id}
+    julius["married_state"] = "married"
+
+    julius.with("married").is(Married).valid? # => true  # "married" is a property that plays the  Married
+
+    julius.has(Spouse).valid? # #has is an alias of #is
+
+    julius.save
+    julius.reload
+  
+    julius.has(Spouse).name # => 'Cornelia'
+    
+while that is nice, let see if we could make it more comfortable:
+
+
+    class Married
+
+      # marry a doc or hash
+      def marry(person)
+        person = ThingTank.new(person) if person.is_a?(Hash)
+        person.save # should have a doc_id
+
+        # assign the doc_id to spouse
+        self["spouse"] = person["_id"]
+        self["state"] = 'married'
+        _doc["married_state"] = 'married'
+        
+        unless person["married"] && person.last_role(Married, "married").spouse == _doc["_id"]
+          person.add_role(Married, "married") do |m|
+            m.date = self["date"]
+            m.marry _doc
+          end
+          person.is(Spouse)
+          person.save
+        end
+      end
+
+      def divorce(date)
+        self["state"] = 'divorced'
+        self['end'] = date
+        _doc.save
+        spouse = Spouse.get(self["spouse"])
+        if spouse.married_state == "married"
+          spouse.divorce(date)
+        end
+      end
+
+    end
+
+    class Spouse
+      def married(&code)
+        _doc.last_role Married, "married", &code
+      end
+
+      def divorce(date)
+        self["married_state"] = 'divorced'
+        married { |m| m.divorce(date) }
+      end
+    end
+
+    class Person
+      def marry(date, person)
+        _doc.add_role Married, "married",  do |m|
+          m.date = "84 BC"
+          m.marry person
+        end
+      end
+    end
+
+it now becomes much less work and Cornelia also knows that she is married to Julius
+
+    julius.as(Person).marry "84 BC", :gender => "f", :name => 'Cornelia'
+    julius.save
+    julius.reload
+  
+    julius.has(Spouse).name # => 'Cornelia'
+    julius.has(Spouse).married_state # => 'married'
+
+    conny_id = julius.last_role(Married,"married").spouse
+    conny = ThingTank.get conny_id
+    conny.has(Spouse).married_state # =>   'married'
+
+
+julius could even marry a second time, i.e. marriage becomes an Array of Marriage objects
+
+    julius.as(Person).marry "68-65 BC", :gender => "f", :name => 'Pompeia'
+
+
+
+    Person.get(julius["married"].first["spouse"]).name # => 'Cornelia'
+    Person.get(julius["married"].last["spouse"]).name #  =>   'Pompeia'
+    julius.has(Spouse).name # =>  'Pompeia'
+    julius["married"].first["state"] # =>  'married'
+    julius["married"].last["state"] # => 'married'
+    julius["married"].size # => 2
+
+    # ouch, two women!
+
+
+we should let Spouse know that Marriage might be an array, so simply overwrite marriage with
+julius is still married with Cornelia but he should not
+
+if Cornelia died before his second marriage, it should'nt be a problem:
+
+  class Dead
+
+    # all callbacks of roles are called and defined like corresponding callbacks of the doc
+    before_save do
+      if _doc.is?(Spouse) && _doc['married_state'] == 'married'
+        Spouse.get(_doc.last_role(Married, 'married').spouse).widowed(self["date_of_death"])
+      end
+      true
+    end
+
+  end
+
+  class Person
+    def dies(date)
+      _doc.is(Dead) do |d|
+        d.date_of_death = date
+      end
+    end
+  end
+
+  class Married
+    def widow(date)
+      self["state"] = 'widowed'
+      self['end'] = date
+      _doc.save
+    end
+  end
+
+  class Spouse
+    def widowed(date)
+      self["married_state"] = 'widowed'
+      married { |m| m.widow(date) }
+    end
+  end
+
+  julius.as(Person).marry "84 BC", :gender => "f", :name => 'Cornelia'
+  julius.save
+  julius.reload
+
+  conny = ThingTank.get julius["married"]["spouse"]
+  conny.save
+  conny.reload
+  conny.as(Person).dies "68-65 BC"
+  conny.save
+
+  julius.reload
+
+  julius.as(Person).marry "68-65 BC", :gender => "f", :name => 'Pompeia'
+
+  julius["married"].size # => 2
+  Person.get(julius["married"].first["spouse"]).name # => 'Cornelia'
+  julius["married"].first["state"]   # => 'widowed'
+
+since julius is immortal, no one should be able to destroy him:
+
+
+  class Undestroyable < ThingTank::Role
+    before_destroy do
+      false # never allow to destroy
+    end
+  end
+
+  julius.is(Undestroyable)
+  julius.save # save the role
+
+  id = julius.id
+  julius = ThingTank.get id
+
+  julius.as(Undestroyable).destroy
+  ThingTank.get(id).nil? # => julius is still there
+
+  julius.destroy
+
+  ThingTank.get(id).nil? # => julius is still there
+
+
+You may subclass Hanswurst to do further separation and mix the
+native properties of Hanswursts / its subclasses with the roles properties.
+
+
+== Contributing to thingtank
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Marc Rene Arns. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# 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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "thingtank"
+  gem.homepage = "http://github.com/metakeule/thingtank"
+  gem.license = "MIT"
+  gem.summary = %Q{thin wrapper around couchrest}
+  gem.email = "Base64.decode64(bGludXhAbWFyY3JlbmVhcm5zLmRl\n)"
+  gem.authors = ["Marc Rene Arns"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/bear_julius.rb

@@ -0,0 +1,50 @@
+class Born < ThingTank::Role
+  property :birth_date, :alias => :born_at
+  property :birth_place
+
+  validates_presence_of :birth_date # make sure a date is given
+end
+
+# just in case he might die....we might want to have a date and maybe even a place
+class Dead < ThingTank::Role
+  property :date_of_death
+  property :place_of_death
+
+  validates_presence_of :date_of_death
+end
+
+class Person < ThingTank::Role
+  property :name
+  property :gender
+
+  validates_presence_of :name
+end
+
+def test_bear_julius
+  julius = create({ :gender => :m, :name => 'Gaius Iulius Caesar' })
+  assert julius.could_be? Person
+
+  julius["birth_date"] = "100 BC"
+  julius["birth_place"] = "Rome"
+
+  assert julius.could_be? Born
+
+  julius.is(Born)
+  julius.is(Person)
+  julius.save
+  julius.reload
+
+  assert julius.is? Person
+  assert julius.is? Born
+
+  assert_equal 'Gaius Iulius Caesar', julius["name"]
+  assert_equal 'Rome', julius["birth_place"]
+
+  assert !julius["roles"].nil?
+  assert_equal 2, julius["roles"].size
+  assert julius["roles"].include? Person.to_s
+  assert julius["roles"].include? Born.to_s
+  assert_equal "100 BC", julius.is(Born).born_at
+
+  return julius
+end

data/examples/first_marriage.rb

@@ -0,0 +1,81 @@
+require_relative 'bear_julius.rb'
+
+# he needs a marriage and a women
+class Married < ThingTank::Role
+  property :date              # the date of the marriage
+  property :end               # when the marriage ended
+  property :spouse            # doc_id of the spouse
+  property :state             # state of the marriage
+
+  validates_presence_of :date
+  validates_presence_of :spouse
+  validate :spouse_should_be_a_person
+
+  # ensure that 'spouse' is a doc_id of a Person
+  def spouse_should_be_a_person
+    Person.get(self["spouse"]).valid?
+  end
+end
+
+# we want easy access to the name of the spouse
+class Spouse < ThingTank::Role
+  property :married
+  property :married_state
+
+  validate :spouse_should_be_married
+  
+  def married
+    self["married"]
+  end
+
+  def spouse_should_be_married
+    married["spouse"] == self["_id"]
+  end
+
+  def name
+    self["married_state"] == "married" ?
+      Person.get(married["spouse"]).name :
+      nil
+  end
+
+  def ex
+    self["married_state"] == "divorced" ?
+      Person.get(married["spouse"]).name :
+      nil
+  end
+end
+
+def test_first_marriage()
+  julius = test_bear_julius
+  conny = create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+
+  julius["married"] = {"date" => "84 BC", "spouse" => conny.id}
+  julius["married_state"] = "married"
+
+  assert julius.is(Married, "married").valid?
+  assert julius.has(Spouse).valid?
+
+  julius.save
+  julius.reload
+  
+  assert_equal 'Cornelia', julius.has(Spouse).name
+
+end
+
+
+def test_first_marriage_shortcuts()
+  julius = test_bear_julius
+  conny = create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+
+  julius["married"] = {"date" => "84 BC", "spouse" => conny.id}
+  julius["married_state"] = "married"
+
+  assert (julius>Married-"married").valid?
+  assert (julius>Spouse).valid?
+
+  julius.save
+  julius.reload
+  
+  assert_equal 'Cornelia', (julius>Spouse).name
+
+end

data/examples/immortal_julius.rb

@@ -0,0 +1,25 @@
+require_relative 'bear_julius.rb'
+
+class Undestroyable < ThingTank::Role
+  before_destroy do
+    false # never allow to destroy
+  end
+end
+
+
+
+def test_julius_immortal
+  julius = test_bear_julius()
+  julius.is(Undestroyable)
+  julius.save # save the role
+
+  id = julius.id
+  julius = load id
+
+  julius.as(Undestroyable).destroy
+  assert !load(id).nil? # => julius is still there
+
+  julius.destroy
+
+  assert !load(id).nil? # => julius is still there
+end

data/examples/marriage_improvement.rb

@@ -0,0 +1,120 @@
+require_relative 'first_marriage.rb'
+
+require 'ruby-debug'
+class Married
+
+  # marry a doc or hash
+  def marry(person)
+    person = ThingTank.new(person) if person.is_a?(Hash)
+    person.save
+
+    # assign the doc_id to spouse
+    self["spouse"] = person["_id"]
+    self["state"] = 'married'
+    _doc["married_state"] = 'married'
+    
+    unless person["married"] && person.last_role(Married, "married").spouse == _doc["_id"]
+      person.add_role(Married, "married") do |m|
+        m.date = self["date"]
+        m.marry _doc
+      end
+      person.is(Spouse)
+      person.save
+    end
+  end
+
+  def divorce(date)
+    self["state"] = 'divorced'
+    self['end'] = date
+    _doc.save
+    spouse = Spouse.get(self["spouse"])
+    if spouse.married_state == "married"
+      spouse.divorce(date)
+    end
+  end
+
+end
+
+class Spouse
+  def married(&code)
+    _doc.last_role Married, "married", &code
+  end
+
+  def divorce(date)
+    self["married_state"] = 'divorced'
+    married { |m| m.divorce(date) }
+  end
+end
+
+class Person
+  def marry(date, person)
+    _doc.add_role Married, "married",  do |m|
+      m.date = "84 BC"
+      m.marry person
+    end
+  end
+end
+
+def test_improved_marriage()
+  julius = test_bear_julius()
+  julius.as(Person).marry "84 BC", :gender => "f", :name => 'Cornelia'
+
+  julius.save
+  julius.reload
+  
+  assert_equal 'Cornelia',            julius.has(Spouse).name
+  assert_equal 'married',             julius.has(Spouse).married_state
+
+  conny = load julius.last_role(Married,"married").spouse
+
+  assert_equal 'Gaius Iulius Caesar', conny.has(Spouse).name
+  assert_equal 'married',             conny.has(Spouse).married_state
+
+  assert_equal julius['_id'],         conny.last_role(Married,"married").spouse
+  assert_equal "84 BC",               conny.last_role(Married,"married").date
+
+  return julius
+end
+
+def test_improved_marriage_divorce()
+  julius = test_bear_julius()
+  julius.as(Person).marry "84 BC", :gender => "f", :name => 'Cornelia'
+  julius.as(Spouse).divorce "85 BC"
+
+  assert_equal nil,                    julius.has(Spouse).name
+  assert_equal 'Cornelia',             julius.has(Spouse).ex
+  assert_equal 'divorced',             julius["married_state"]
+  assert_equal "85 BC",                julius.last_role(Married,"married").end
+
+  conny = load julius.last_role(Married,"married").spouse
+
+  assert_equal nil,                    conny.has(Spouse).name
+  assert_equal 'Gaius Iulius Caesar',  conny.has(Spouse).ex
+  assert_equal 'divorced',             conny["married_state"]
+
+  assert_equal julius['_id'],         conny.last_role(Married,"married").spouse
+  assert_equal "85 BC",               conny.last_role(Married,"married").end
+  return julius
+end
+
+def test_improved_marriage_shortcuts()
+  julius = test_bear_julius()
+  (julius>Person).marry "84 BC", :gender => "f", :name => 'Cornelia'
+
+  julius.save
+  julius.reload
+  
+  assert_equal 'Cornelia',            (julius>Spouse).name
+  assert_equal 'married',             (julius>Spouse).married_state
+
+  conny = load (julius>Married-"married").spouse
+
+  assert_equal 'Gaius Iulius Caesar', (conny>Spouse).name
+  assert_equal 'married',             (conny>Spouse).married_state
+
+  assert_equal julius['_id'],         (conny>Married-"married").spouse
+  assert_equal "84 BC",               (conny>Married-"married").date
+
+  return julius
+end
+