thingtank 0.3.1 → 0.3.2

data/README.md

@@ -283,6 +283,43 @@ since julius is immortal, no one should be able to destroy him:
 You may subclass ThingTank to do further separation and mix the
 native properties of ThingTanks / its subclasses with the characters properties.
 
+Hints:
+-----------------------------------------------
+
+The main idea is that every couch document could have many characters at the same time.
+The implementation is that the document is an object of ThingTank or a subclass of it. ThingTank is compatible to couchrest_model with some helper methods.
+Most of the time you don't want to define properties for the ThingTank class or a subclass. You may store any key => value freely within the document by
+using the [] and []= methods.
+
+The concept is inspired by the way the go language defines interfaces. With _ThingTank_ you may thing of the  main doc as a _Hash_. Then the characters are 
+"interfaces", that define which properties a doc would need to fullfill the character ("to have the character"). But that alone is not suffient. You also 
+need to tell the doc that it will have the character from now on. This information will be stored in the "characters" property of the doc. You might remove this
+statement with or without affecting the properties the character cares about. But only if the doc should have the character you might interact with the subseet of his
+properties that the character cares about via the character. A doc might combine different characters at the same time. There might be even different characters that
+care about the same properties. If so you should take care that there are no conflicting actions taking place at the same update.
+
+The characters are all subclasses of the ThingTank::Character class and are compatible with couchrest_model as well but they won't interact with the database
+directly but only via their document (instance of ThingTank). The characters is where all validation, callbacks, properties and additional methods should go into.
+They do all the hard work, but they aren't loaded automatically but only if you call them via the _ThingTank#as_ method. Then the properties that they care about
+are copied from the doc to the character instance. When you interact with the character object its properties go out of sync with the original doc so here are some hints
+how to handle this dirty state and how to get them back to the doc.
+
+Characters may also interact via the doc, but care has to be taken in order to save the changes back to doc properly and to inform the affected character about the changes.
+
+* Use _Character#to\_doc_ to return the changed date from the character to the doc without saving the doc.
+* Use _Character#reload_ to load the (possibly changed) data from the doc to the character object.
+* Use _Character#reload!_ to load the (possibly changed) data from the database. The doc with be reloaded from the database and then fill the character object.
+* Use _Character#save_ or _ThingTank#save_ to save the doc with all changes
+* Use _ThingTank#add\_character_ to add a Character and pass it a code block, so that all the changes go back to the doc at the end of the code block
+* Use _ThingTank#as_ to work with a certain character of the doc and pass it a code block, so that all the changes go back to the doc at the end of the code block
+* Use _ThingTank#is_ if the properties for the character are already in the doc and you just want it to let it have the character
+* Use _ThingTank#get_ to get the doc out of the database (and then use _ThingTank#as_ to handle it as a character)
+* Views are stored and called via the _ThingTank_ class
+* Pass _ThingTank#add\_character_ as second parameter the name of the property if you want the doc to have a property that has a certain character
+* Use _ThingTank#with_ to use the character of a certain property
+* Use the _doc method with a character method to access the doc and _doc.id for the id
+* Look at the examples and tests
+
 
 Contributing to thingtank
 --------------------------

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/thingtank/character.rb

@@ -92,23 +92,37 @@ class ThingTank
       end
     end
 
-    def flush_to_doc
+    # use to_doc to put characters changes back to the doc without saving the doc
+    def to_doc
       if changed?
         changed_to_character_hash().each do |k,v|
           _character_doc[k] = v
         end
+        @changed_attributes.clear if @changed_attributes
+      end
+    end
+
+    def flush_to_doc
+      if changed?
+        to_doc
         _character_doc.save
-        @changed_attributes.clear        
       end
     end
 
+    # use reload to get the latest properties from the doc without reloading all from the database
     def reload
       attrs = _character_doc.as(self.class).to_character_hash
       prepare_all_attributes(attrs, :directly_set_attributes => true)
-      @changed_attributes.clear
+      @changed_attributes.clear if @changed_attributes
       self
     end
 
+    # use reload! to get the latest properties from the database, the doc will be reloaded and the character to
+    def reload!
+      _character_doc.reload
+      reload
+    end
+
     def to_character(klass, key, &code)
       _character_doc.to_character(klass, key, &code)
     end

data/lib/thingtank/character_handling.rb

@@ -147,6 +147,10 @@ class ThingTank
           @dependencies.add_character(klass) if add_character && key.nil?
           character = key ? property_to_character(key, klass) : FakeBase.new(self, klass, add_character).get()
           (code.call(character) ; character.flush_to_doc) if code
+          # we don't do this. there is no proper way to update all given characters
+          # one must not rely on a character properties after the doc has been manipulated
+          # use Character#reload to get the latest from the doc object to the character and Character#reload! to reload the doc from the database and reload the character then
+          #@dependencies.add_character_object(character)
           character
         end
 

data/lib/thingtank/dependencies.rb

@@ -7,6 +7,8 @@ class ThingTank
       @registration = []
       @save = []
       @children = {}
+      #@character_objects = []
+      #@just_reloaded = []
     end
 
     attr_reader :parent
@@ -19,6 +21,26 @@ class ThingTank
       @registration.each { |character| @doc.register_character(character) }
     end
 
+    # we don't do this. there is no proper way to update all given characters
+    # one must not rely on a character properties after the doc has been manipulated
+    # use Character#reload to get the latest from the doc object to the character and Character#reload! to reload the doc from the database and reload the character then
+    #def add_character_object(obj)
+    #  @character_objects << obj
+    #end
+
+    # we don't do this. there is no proper way to update all given characters
+    # one must not rely on a character properties after the doc has been manipulated
+    # use Character#reload to get the latest from the doc object to the character and Character#reload! to reload the doc from the database and reload the character then
+    #def reload_character_objects()
+    #  @just_reloaded = []
+    #  @character_objects.each do |character|
+    #    unless @just_reloaded.include?(character)
+    #      @just_reloaded << character
+    #      character.reload
+    #    end
+    #  end
+    #end
+
     def save_all()
       refresh true
       @save.each { |character_instance| character_instance.save }

data/lib/thingtank/instance_methods.rb

@@ -15,6 +15,14 @@ class ThingTank
           @dependencies
         end
 
+        # we don't do this. there is no proper way to update all given characters
+        # one must not rely on a character properties after the doc has been manipulated
+        # use Character#reload to get the latest from the doc object to the character and Character#reload! to reload the doc from the database and reload the character then
+        #def reload
+        #  super
+        #  @dependencies.reload_character_objects()
+        #end
+
         def first(key)
           [self[key.to_s]].flatten.last
         end

data/test/test_fakebase.rb

@@ -384,5 +384,21 @@ describe "should character a CouchRest::Database" do
     assert_equal 'A1sub1', doc["check"]["sub"]["checker1"]
   end
 
-end
+  it "should not save the doc when saving a character, but flush its changes to the doc" do
+    doc = create :test => 'hiho'
+    doc['test'] = 'hoho'
+
+    character = doc.add_character(Check)
+
+    character.a = 'A'
 
+    assert_equal nil, doc['a']
+    assert_equal doc, character._doc
+    character.to_doc
+    assert_equal 'A', doc['a']
+    assert_equal 'hoho', doc['test']
+    assert_equal 'hiho', db_load(doc.id)['test']
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thingtank
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-15 00:00:00.000000000Z
+date: 2012-02-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &25861240 !ruby/object:Gem::Requirement
+  requirement: &18368020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25861240
+  version_requirements: *18368020
 - !ruby/object:Gem::Dependency
   name: couchrest
-  requirement: &25859980 !ruby/object:Gem::Requirement
+  requirement: &18366960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25859980
+  version_requirements: *18366960
 - !ruby/object:Gem::Dependency
   name: couchrest_model
-  requirement: &25858600 !ruby/object:Gem::Requirement
+  requirement: &18364340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25858600
+  version_requirements: *18364340
 - !ruby/object:Gem::Dependency
   name: defined
-  requirement: &25857400 !ruby/object:Gem::Requirement
+  requirement: &18363040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25857400
+  version_requirements: *18363040
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &25731840 !ruby/object:Gem::Requirement
+  requirement: &18362480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25731840
+  version_requirements: *18362480
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &25730200 !ruby/object:Gem::Requirement
+  requirement: &18361800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25730200
+  version_requirements: *18361800
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &25729160 !ruby/object:Gem::Requirement
+  requirement: &18360960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25729160
+  version_requirements: *18360960
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &25728300 !ruby/object:Gem::Requirement
+  requirement: &18360160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25728300
+  version_requirements: *18360160
 - !ruby/object:Gem::Dependency
   name: linecache19
-  requirement: &25727420 !ruby/object:Gem::Requirement
+  requirement: &18359500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25727420
+  version_requirements: *18359500
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &25726740 !ruby/object:Gem::Requirement
+  requirement: &18358760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25726740
+  version_requirements: *18358760
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &25725980 !ruby/object:Gem::Requirement
+  requirement: &18357820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *25725980
+  version_requirements: *18357820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &25725100 !ruby/object:Gem::Requirement
+  requirement: &18357260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,10 +142,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *25725100
+  version_requirements: *18357260
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &25724100 !ruby/object:Gem::Requirement
+  requirement: &18354200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -153,7 +153,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *25724100
+  version_requirements: *18354200
 description: 
 email: ! 'Base64.decode64(bGludXhAbWFyY3JlbmVhcm5zLmRl
 
@@ -215,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 106457048767495474
+      hash: -1916048387609429513
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: