thingtank 0.1.0 → 0.2.0

data/README.md

@@ -1,8 +1,10 @@
-thingtank: play different roles [![Build Status](https://secure.travis-ci.org/metakeule/thingtank.png)](https://secure.travis-ci.org/metakeule/thingtank)
-=====================
+thingtank: let couchrest docs have multiple characters at the same time
+=======================================================================
+
+[![Build Status](https://secure.travis-ci.org/metakeule/thingtank.png)](https://secure.travis-ci.org/metakeule/thingtank)
 
 ThingTank is a library that uses couchrest and couchrest model to create arbitrary
-objects that may have different roles. The roles determine the
+objects that may have multiple characters. The characters determine the
 properties and they can be mixed and matched at will.
 
 
@@ -24,7 +26,7 @@ Examples:
 
 Imagine a Caesar is born
 
-    class Born < ThingTank::Role
+    class Born < ThingTank::Character
       property :birth_date, :alias => :born_at
       property :birth_place
       validates_presence_of :birth_date # make sure a date is given
@@ -32,7 +34,7 @@ Imagine a Caesar is born
 
 just in case he might die....we might want to have a date and maybe even a place
 
-    class Dead < ThingTank::Role
+    class Dead < ThingTank::Character
       property :date_of_death
       property :place_of_death
       validates_presence_of :date_of_death
@@ -40,7 +42,7 @@ just in case he might die....we might want to have a date and maybe even a place
 
 and then he needs a name
 
-    class Person < ThingTank::Role
+    class Person < ThingTank::Character
       property :name
       property :gender
       validates_presence_of :name
@@ -73,7 +75,7 @@ later...
 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
+    class Married < ThingTank::Character
       property :date              # the date of the marriage
       property :end               # when the marriage ended
       property :spouse            # doc_id of the spouse
@@ -83,20 +85,20 @@ when he is adult, he wants to marry. now things are getting a bit more complicat
       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, same as ThingTank.get(self["spouse"]).as(Person).valid?
+        Person.get(self["spouse"]).valid? # loads doc as character Person and validates, same as ThingTank.get(self["spouse"]).as(Person).valid?
       end
     end
 
 we want easy access to the name of the spouse
 
-    class Spouse < ThingTank::Role
+    class Spouse < ThingTank::Character
       property :married    # doc must have "married" property (should be of class married, we don't check this at the moment)
       property :married_state
 
       validate :spouse_should_be_married
       
       def married
-        self["married"] # contains a Married role
+        self["married"] # contains a Married character
       end
 
       def spouse_should_be_married
@@ -118,10 +120,10 @@ we want easy access to the name of the spouse
 
 now we could easily get julius married
 
-    conny = ThingTank.create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+    conny = ThingTank.create :gender => "f", :name => 'Cornelia', :characters => ['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 role
+    julius.with("married").is(Married).valid? # => true  # "married" is a property that has the Married character
     julius.has(Spouse).valid? # #has is an alias of #is
     julius.save
     julius.reload
@@ -140,8 +142,8 @@ while that is nice, let see if we could make it more comfortable:
         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|
+        unless person["married"] && person.last_character(Married, "married").spouse == _doc["_id"]
+          person.add_character(Married, "married") do |m|
             m.date = self["date"]
             m.marry _doc
           end
@@ -164,7 +166,7 @@ while that is nice, let see if we could make it more comfortable:
 
     class Spouse
       def married(&code)
-        _doc.last_role Married, "married", &code
+        _doc.last_character Married, "married", &code
       end
 
       def divorce(date)
@@ -175,7 +177,7 @@ while that is nice, let see if we could make it more comfortable:
 
     class Person
       def marry(date, person)
-        _doc.add_role Married, "married",  do |m|
+        _doc.add_character Married, "married",  do |m|
           m.date = "84 BC"
           m.marry person
         end
@@ -189,7 +191,7 @@ it now becomes much less work and Cornelia also knows that she is married to Jul
     julius.reload  
     julius.has(Spouse).name # => 'Cornelia'
     julius.has(Spouse).married_state # => 'married'
-    conny_id = julius.last_role(Married,"married").spouse
+    conny_id = julius.last_character(Married,"married").spouse
     conny = ThingTank.get conny_id
     conny.has(Spouse).married_state # =>   'married'
 
@@ -211,10 +213,10 @@ julius is still married with Cornelia but he should not
 if Cornelia died before his second marriage, it would not be a problem:
 
     class Dead
-      # all callbacks of roles are called and defined like corresponding callbacks of the doc
+      # all callbacks of characters 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"])
+          Spouse.get(_doc.last_character(Married, 'married').spouse).widowed(self["date_of_death"])
         end
         true
       end
@@ -259,14 +261,14 @@ if Cornelia died before his second marriage, it would not be a problem:
     
 since julius is immortal, no one should be able to destroy him:
 
-    class Undestroyable < ThingTank::Role
+    class Undestroyable < ThingTank::Character
       before_destroy do
         false # never allow to destroy
       end
     end
     
     julius.is(Undestroyable)
-    julius.save # save the role
+    julius.save # save the character
     
     id = julius.id
     julius = ThingTank.get id
@@ -279,7 +281,7 @@ since julius is immortal, no one should be able to destroy him:
     ThingTank.get(id).nil? # => julius is still there
 
 You may subclass ThingTank to do further separation and mix the
-native properties of ThingTanks / its subclasses with the roles properties.
+native properties of ThingTanks / its subclasses with the characters properties.
 
 
 Contributing to thingtank

data/Rakefile

@@ -17,7 +17,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "thingtank"
   gem.homepage = "http://github.com/metakeule/thingtank"
   gem.license = "MIT"
-  gem.summary = %Q{thin wrapper around couchrest}
+  gem.summary = %Q{let couchrest docs have multiple characters at the same time}
   gem.email = "Base64.decode64(bGludXhAbWFyY3JlbmVhcm5zLmRl\n)"
   gem.authors = ["Marc Rene Arns"]
   # dependencies defined in Gemfile
@@ -31,11 +31,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "guard"
-task :guard do
-  exec("bundle exec guard")
-end
-
 task :default => :test
 
 require 'yard'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/bear_julius.rb

@@ -1,4 +1,4 @@
-class Born < ThingTank::Role
+class Born < ThingTank::Character
   property :birth_date, :alias => :born_at
   property :birth_place
 
@@ -6,14 +6,14 @@ class Born < ThingTank::Role
 end
 
 # just in case he might die....we might want to have a date and maybe even a place
-class Dead < ThingTank::Role
+class Dead < ThingTank::Character
   property :date_of_death
   property :place_of_death
 
   validates_presence_of :date_of_death
 end
 
-class Person < ThingTank::Role
+class Person < ThingTank::Character
   property :name
   property :gender
 
@@ -40,10 +40,10 @@ def test_bear_julius
   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 !julius["characters"].nil?
+  assert_equal 2, julius["characters"].size
+  assert julius["characters"].include? Person.to_s
+  assert julius["characters"].include? Born.to_s
   assert_equal "100 BC", julius.is(Born).born_at
 
   return julius

data/examples/first_marriage.rb

@@ -1,7 +1,7 @@
 require_relative 'bear_julius.rb'
 
 # he needs a marriage and a women
-class Married < ThingTank::Role
+class Married < ThingTank::Character
   property :date              # the date of the marriage
   property :end               # when the marriage ended
   property :spouse            # doc_id of the spouse
@@ -18,7 +18,7 @@ class Married < ThingTank::Role
 end
 
 # we want easy access to the name of the spouse
-class Spouse < ThingTank::Role
+class Spouse < ThingTank::Character
   property :married
   property :married_state
 
@@ -47,7 +47,7 @@ end
 
 def test_first_marriage()
   julius = test_bear_julius
-  conny = create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+  conny = create :gender => "f", :name => 'Cornelia', :characters => ['Person']
 
   julius["married"] = {"date" => "84 BC", "spouse" => conny.id}
   julius["married_state"] = "married"
@@ -65,7 +65,7 @@ end
 
 def test_first_marriage_shortcuts()
   julius = test_bear_julius
-  conny = create :gender => "f", :name => 'Cornelia', :roles => ['Person']
+  conny = create :gender => "f", :name => 'Cornelia', :characters => ['Person']
 
   julius["married"] = {"date" => "84 BC", "spouse" => conny.id}
   julius["married_state"] = "married"

data/examples/immortal_julius.rb

@@ -1,6 +1,6 @@
 require_relative 'bear_julius.rb'
 
-class Undestroyable < ThingTank::Role
+class Undestroyable < ThingTank::Character
   before_destroy do
     false # never allow to destroy
   end
@@ -9,7 +9,7 @@ end
 def test_julius_immortal
   julius = test_bear_julius()
   julius.is(Undestroyable)
-  julius.save # save the role
+  julius.save # save the character
 
   id = julius.id
   julius = db_load id

data/examples/marriage_improvement.rb

@@ -12,8 +12,8 @@ class Married
     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|
+    unless person["married"] && person.last_character(Married, "married").spouse == _doc["_id"]
+      person.add_character(Married, "married") do |m|
         m.date = self["date"]
         m.marry _doc
       end
@@ -36,7 +36,7 @@ end
 
 class Spouse
   def married(&code)
-    _doc.last_role Married, "married", &code
+    _doc.last_character Married, "married", &code
   end
 
   def divorce(date)
@@ -47,7 +47,7 @@ end
 
 class Person
   def marry(date, person)
-    _doc.add_role Married, "married"  do |m|
+    _doc.add_character Married, "married"  do |m|
       m.date = "84 BC"
       m.marry person
     end
@@ -64,13 +64,13 @@ def test_improved_marriage()
   assert_equal 'Cornelia',            julius.has(Spouse).name
   assert_equal 'married',             julius.has(Spouse).married_state
 
-  conny = db_load julius.last_role(Married,"married").spouse
+  conny = db_load julius.last_character(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
+  assert_equal julius['_id'],         conny.last_character(Married,"married").spouse
+  assert_equal "84 BC",               conny.last_character(Married,"married").date
 
   return julius
 end
@@ -85,16 +85,16 @@ def test_improved_marriage_divorce()
   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
+  assert_equal "85 BC",                julius.last_character(Married,"married").end
 
-  conny = db_load julius.last_role(Married,"married").spouse
+  conny = db_load julius.last_character(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
+  assert_equal julius['_id'],         conny.last_character(Married,"married").spouse
+  assert_equal "85 BC",               conny.last_character(Married,"married").end
   return julius
 end
 

data/examples/second_marriage.rb

@@ -2,10 +2,10 @@ require_relative 'marriage_improvement.rb'
 
 class Dead
 
-  # all callbacks of roles are called and defined like corresponding callbacks of the doc
+  # all callbacks of characters 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"])
+      Spouse.get(_doc.last_character(Married, 'married').spouse).widowed(self["date_of_death"])
     end
     true
   end

data/lib/couchrest/extensions/view.rb

@@ -2,13 +2,13 @@
 
 class CouchRest::Model::Designs::DesignMapper
 
-  # generate a view to show only ThingTanks of a certain role, define them all in a ThingTank subclass (not in a role)
-  def role_view(klass, name, opts={})
+  # generate a view to show only ThingTanks of a certain character, define them all in a ThingTank subclass (not in a character)
+  def character_view(klass, name, opts={})
     name = "#{klass.to_s.downcase}_#{name}"
     opts ||= {}
     opts[:guards] ||= []
     # there is no "inArray" like function in couchdb, see http://stackoverflow.com/questions/3740464/i-have-to-write-every-function-i-need-for-couchdb
-    opts[:guards] << "((doc['roles'] !== undefined) && (function (item,arr) { for(p=0;p<arr.length;p++) if (item == arr[p]) return true; return false;})('#{klass.to_s}',doc['roles']))"
+    opts[:guards] << "((doc['characters'] !== undefined) && (function (item,arr) { for(p=0;p<arr.length;p++) if (item == arr[p]) return true; return false;})('#{klass.to_s}',doc['characters']))"
     view(name, opts)
   end
 

data/lib/thingtank/callbacks.rb

@@ -18,7 +18,7 @@ class ThingTank
         # mimic the destroy_document method from https://github.com/langalex/couch_potato/blob/master/lib/couch_potato/database.rb  
         before_destroy do
           ok = true
-          (self["roles"] || []).each do |klass|
+          (self["characters"] || []).each do |klass|
             document = self.as(klass.constantize)
             (ok = false) if false == document.run_callbacks(:destroy) do
               true

data/lib/thingtank/{role.rb → character.rb}

@@ -1,7 +1,7 @@
 
 class ThingTank
 
-  class Role < CouchRest::Model::Base
+  class Character < CouchRest::Model::Base
 
     include ThingTank::ForceUpdate
     include ThingTank::SharedMethods
@@ -9,13 +9,13 @@ class ThingTank
     class << self
 
       def property(name, *args)
-        @role_properties ||= []
-        @role_properties << name.to_s
+        @character_properties ||= []
+        @character_properties << name.to_s
         super
       end
 
-      def role_properties
-        @role_properties
+      def character_properties
+        @character_properties
       end
 
       def -(key)
@@ -25,12 +25,12 @@ class ThingTank
       def get(id, db = database)
         doc = ThingTank.get(id)
         return nil if doc.nil?
-        return doc.to_role(self)
+        return doc.to_character(self)
       end
 
       def get!(id, db = database)
         doc = ThingTank.get!(id)
-        doc.to_role(self)
+        doc.to_character(self)
       end
 
       def wants(*modules)
@@ -43,11 +43,11 @@ class ThingTank
       end
 
       def design
-        raise "design is not supported in ThingTank::Role, please use the 'role_view' method in a ThingTank subclass design definition"
+        raise "design is not supported in ThingTank::Character, please use the 'character_view' method in a ThingTank subclass design definition"
       end
 
       def view_by(*args)
-        raise "view_by is not supported in ThingTank::Role, please use the 'role_view_by' method in a ThingTank subclass"
+        raise "view_by is not supported in ThingTank::Character, please use the 'character_view_by' method in a ThingTank subclass"
       end
 
     end
@@ -65,9 +65,9 @@ class ThingTank
     end
 
     # the virtual _doc that contains me, you should not need it normally
-    def _role_doc
+    def _character_doc
       if database.is_a?(FakeBase) 
-        database._role_doc
+        database._character_doc
       else
         nil
       end
@@ -75,35 +75,35 @@ class ThingTank
 
     def flush_to_doc
       if changed?
-        changed_to_role_hash().each do |k,v|
-          _role_doc[k] = v
+        changed_to_character_hash().each do |k,v|
+          _character_doc[k] = v
         end
-        _role_doc.save
+        _character_doc.save
         @changed_attributes.clear        
       end
     end
 
     def reload
-      attrs = _role_doc.as(self.class).to_role_hash
+      attrs = _character_doc.as(self.class).to_character_hash
       prepare_all_attributes(attrs, :directly_set_attributes => true)
       @changed_attributes.clear
       self
     end
 
-    def to_role(klass, key, &code)
-      _role_doc.to_role(klass, key, &code)
+    def to_character(klass, key, &code)
+      _character_doc.to_character(klass, key, &code)
     end
 
     def first(key)
-      _role_doc.first(key)
+      _character_doc.first(key)
     end
 
     def last(key)
-      _role_doc.last(key)
+      _character_doc.last(key)
     end
 
-    def add_role(klass, key=nil, &code)
-      _role_doc.add_role(klass, key, &code)
+    def add_character(klass, key=nil, &code)
+      _character_doc.add_character(klass, key, &code)
     end
   end