hanswurst 0.3.0 → 0.4.0

data/README.md

@@ -5,7 +5,19 @@ Hanswurst is a library that uses couch potato to create arbitrary
 objects that may have different roles. The roles determine the
 properties and they can be mixed and matched at will.
 
-Hanswurst is only tested with ruby 1.9.2 and above.
+
+Installation
+------------
+_hanswurst_ is only tested with ruby 1.9.2 and above.
+
+Install it as a gem:
+
+    sudo gem install hanswurst
+
+or in rvm:
+
+    gem install hanswurst
+
 
 Example:
 --------

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/hanswurst.rb

@@ -44,7 +44,7 @@ class Hanswurst
       errors = @value.errors.messages.collect do |field, err|
         "#{field} #{err.join('/')}"
       end.join(" # ")
-      "role not valid #{@role}: #{errors}"
+      "#{@role} not valid: #{errors}"
     end
   end
 
@@ -61,7 +61,7 @@ class Hanswurst
       # I keep this commented out to inform the reader that we don't want this in order to easily reuse general lists
       #options[:list] &&= :"#{role_alias}_#{options[:list]}"
       options[:conditions] &&= " && ( #{options[:conditions]} )"
-      options[:conditions] = "(doc.roles.#{role_alias} !== undefined)#{options[:conditions]}"
+      options[:conditions] = "(doc.hanswurst_roles.#{role_alias} !== undefined)#{options[:conditions]}"
       self.view :"#{role_alias}_#{viewname}", options
     end
 
@@ -106,12 +106,12 @@ class Hanswurst
     end
   end
 
-  property :roles
-  property :data
+  property :hanswurst_roles
+  property :hanswurst_data
 
   # check if every role is valid before saving
   before_save do
-    self.data.each do |role,val|
+    self.hanswurst_data.each do |role,val|
       unless val.valid?
         raise RoleNotValid.new(role, val)
       end
@@ -145,33 +145,33 @@ class Hanswurst
     end
   end
 
-  # add more roles at once
+  # add more hanswurst_roles at once
   def add_roles(hsh)
-    self.data ||= {} 
-    self.roles ||= {}
+    self.hanswurst_data ||= {} 
+    self.hanswurst_roles ||= {}
     hsh.each do |role,klass|
       raise "class expected: #{klass.inspect}" unless klass.is_a? Class
       handle_dependancies(role, klass)
       handle_shared(role, klass)
-      self.roles.update role.to_s => klass.name
+      self.hanswurst_roles.update role.to_s => klass.name
     end
-    self.roles
+    self.hanswurst_roles
   end
 
   # does he have a role
   def role_exists?(role)
-    self.roles and self.roles[role.to_s]
+    self.hanswurst_roles and self.hanswurst_roles[role.to_s]
   end
 
-  # does he have data for the role
-  def data_exists?(role)
-    self.data and self.data[role.to_s]
+  # does he have hanswurst_data for the role
+  def hanswurst_data_exists?(role)
+    self.hanswurst_data and self.hanswurst_data[role.to_s]
   end
 
   # set a property of a role
   def set_property(role, property, value)
     return unless role_exists? role
-    create(role) unless data_exists? role
+    create(role) unless hanswurst_data_exists? role
     update role, property, value
   end
 
@@ -182,46 +182,46 @@ class Hanswurst
 
   # delete a role
   def delete_role(role)
-    delete role # delete the data
-    self.roles.delete role.to_s # and the role itself
+    delete role # delete the hanswurst_data
+    self.hanswurst_roles.delete role.to_s # and the role itself
   end
 
   # set instance for a role
   def set(role, val)
-    self.data ||= {}
-    self.data.update role.to_s => val
+    self.hanswurst_data ||= {}
+    self.hanswurst_data.update role.to_s => val
   end
 
   # create a new instance of a role
   def create(role)
     raise "unknown role #{role.inspect}" unless role_exists? role.to_s
-    self.data ||= {}
-    self.data[role.to_s] = self.class.getClass(self.roles[role.to_s]).new
+    self.hanswurst_data ||= {}
+    self.hanswurst_data[role.to_s] = self.class.getClass(self.hanswurst_roles[role.to_s]).new
   end
 
   # delete a role
   def delete(role)
-    self.data ||= {}
-    hsh = self.data
+    self.hanswurst_data ||= {}
+    hsh = self.hanswurst_data
     hsh.delete(role.to_s)
-    self.data = {} # we have to do this, otherwise it won't save?!
-    self.data = hsh
+    self.hanswurst_data = {} # we have to do this, otherwise it won't save?!
+    self.hanswurst_data = hsh
   end
 
   # read a property of a role
   def read(role, property)
-    return self.data[role.to_s].send(property.to_sym) if data_exists?(role.to_s)
+    return self.hanswurst_data[role.to_s].send(property.to_sym) if hanswurst_data_exists?(role.to_s)
     nil
   end
 
   # update a property of a role
   # we have to use this method in order to make sure that everything is saved
   def update(role, property, value)
-    if data_exists? role
-      self.data[role.to_s].send(:"#{property}=", value)
-      hsh = self.data.merge(role.to_s => self.data[role.to_s])
-      self.data = {} # we have to do this, otherwise it won't save?!
-      self.data = hsh
+    if hanswurst_data_exists? role
+      self.hanswurst_data[role.to_s].send(:"#{property}=", value)
+      hsh = self.hanswurst_data.merge(role.to_s => self.hanswurst_data[role.to_s])
+      self.hanswurst_data = {} # we have to do this, otherwise it won't save?!
+      self.hanswurst_data = hsh
     end
   end
 end

data/test/test_hanswurst.rb

@@ -45,15 +45,24 @@ class E
   property :e
 end
 
+
+class F
+  include CouchPotato::Persistence
+  include Hanswurst::Depends
+
+  depends_on 'd', D
+  property :f
+  
+end
 Hanswurst.list_for :pers, :complete_name, %q|
 function(head, req) {
   var row;
   var rows = [];
   send('{"rows": ');
   while(row = getRow()) {
-    row.doc.data.q = req.query;
-    if(req.query["startkey_docid"] && row.doc.data.pers.firstname == req.query["startkey_docid"]){
-      row.doc.data.pers.complete_name = row.doc.data.pers.firstname + ' ' + row.doc.data.pers.lastname;
+    row.doc.hanswurst_data.q = req.query;
+    if(req.query["startkey_docid"] && row.doc.hanswurst_data.pers.firstname == req.query["startkey_docid"]){
+      row.doc.hanswurst_data.pers.complete_name = row.doc.hanswurst_data.pers.firstname + ' ' + row.doc.hanswurst_data.pers.lastname;
       rows[rows.length] = row;
     }    
   };
@@ -107,14 +116,14 @@ class TestCouch < Test::Unit::TestCase
       o.person = Pers.new( :firstname => 'Donald', :lastname => 'Duck' ) 
       save o
       o = load(o._id)      
-      roles = {'person' => 'Pers', 'product' => 'Prod'}
-      assert_equal roles, o.roles
-      assert_equal 'prod1', o.data["product"].name
-      assert_equal 'Donald', o.data["person"].firstname
+      hanswurst_roles = {'person' => 'Pers', 'product' => 'Prod'}
+      assert_equal hanswurst_roles, o.hanswurst_roles
+      assert_equal 'prod1', o.hanswurst_data["product"].name
+      assert_equal 'Donald', o.hanswurst_data["person"].firstname
       assert_equal 'Donald', o.person___firstname
     end
 
-    should "save roles" do
+    should "save hanswurst_roles" do
       o = Hanswurst.new
       o.add_role 'person', Pers
       o.add_role 'product', Prod
@@ -124,8 +133,8 @@ class TestCouch < Test::Unit::TestCase
       o.person___lastname = "Bunny"
       save o
       o = load(o._id)
-      roles = {'person' => 'Pers', 'product' => 'Prod'}
-      assert_equal roles, o.roles
+      hanswurst_roles = {'person' => 'Pers', 'product' => 'Prod'}
+      assert_equal hanswurst_roles, o.hanswurst_roles
       assert_equal 'Bugs', o.person___firstname
       assert_equal 'Bunny', o.person___lastname
       assert_equal 'abc', o.product___article_number
@@ -141,7 +150,7 @@ class TestCouch < Test::Unit::TestCase
       save o
       o = load(o._id)
       assert_equal nil, o.product___name
-      assert !o.roles.has_key?("product")
+      assert !o.hanswurst_roles.has_key?("product")
       assert_equal 'Bugs', o.person___firstname
       assert_equal nil, o.product___article_number
     end
@@ -152,8 +161,8 @@ class TestCouch < Test::Unit::TestCase
       o.thing___a = "hiho"
       save o
       o = load(o._id)
-      roles = {'thing' => 'Thing::A'}
-      assert_equal roles, o.roles
+      hanswurst_roles = {'thing' => 'Thing::A'}
+      assert_equal hanswurst_roles, o.hanswurst_roles
       assert_equal 'hiho', o.thing___a
     end
 
@@ -176,8 +185,8 @@ class TestCouch < Test::Unit::TestCase
       a.add_role 'pers', Pers
       a.pers = Pers.new :firstname => "Mickey", :lastname => "Mouse"
       save a
-      assert_equal "Donald Duck", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.data["pers"].complete_name
-      assert_equal "Donald", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.data["pers"].firstname
+      assert_equal "Donald Duck", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.hanswurst_data["pers"].complete_name
+      assert_equal "Donald", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.hanswurst_data["pers"].firstname
     end
 
     should "create dependancies based on definitions" do
@@ -213,6 +222,17 @@ class TestCouch < Test::Unit::TestCase
       assert_equal "4AD", o.do___e
       assert_equal "Duck", o.person___lastname
     end
+
+    should "create shared dependancies based on definitions" do
+      o = Hanswurst.new
+      o.add_role 'fff', F
+      o.fff___f = "FFF"
+      o.fff__d__person___lastname = "Duck"
+      save o
+      q = load(o._id)
+      assert_equal "FFF", q.fff___f
+      assert_equal "Duck", q.fff__d__person___lastname
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanswurst
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-07 00:00:00.000000000Z
+date: 2012-01-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couch_potato
-  requirement: &27848040 !ruby/object:Gem::Requirement
+  requirement: &15343840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *27848040
+  version_requirements: *15343840
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &27847420 !ruby/object:Gem::Requirement
+  requirement: &15343060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *27847420
+  version_requirements: *15343060
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &27842680 !ruby/object:Gem::Requirement
+  requirement: &15342300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *27842680
+  version_requirements: *15342300
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &27842200 !ruby/object:Gem::Requirement
+  requirement: &15341560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *27842200
+  version_requirements: *15341560
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &27841700 !ruby/object:Gem::Requirement
+  requirement: &15340960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27841700
+  version_requirements: *15340960
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &27841200 !ruby/object:Gem::Requirement
+  requirement: &15340260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27841200
+  version_requirements: *15340260
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &27840680 !ruby/object:Gem::Requirement
+  requirement: &15339560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27840680
+  version_requirements: *15339560
 - !ruby/object:Gem::Dependency
   name: linecache19
-  requirement: &27840180 !ruby/object:Gem::Requirement
+  requirement: &15322280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27840180
+  version_requirements: *15322280
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &27839620 !ruby/object:Gem::Requirement
+  requirement: &15321680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27839620
+  version_requirements: *15321680
 - !ruby/object:Gem::Dependency
   name: couch_potato
-  requirement: &27839100 !ruby/object:Gem::Requirement
+  requirement: &15321080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *27839100
+  version_requirements: *15321080
 description: flexible enhancement of couch potato
 email: ! 'Base64.decode64(''bGludXhAbWFyY3JlbmVhcm5zLmRl
 
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3450462200731043631
+      hash: -2504078645592477714
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: