rufus-doric 0.1.1 → 0.1.2

data/CHANGELOG.txt

@@ -2,7 +2,15 @@
 = rufus-doric CHANGELOG.txt
 
 
-== rufus-doric - 0.1.1    not yet released
+== rufus-doric - 0.1.2    released 2010/03/23
+
+- person.belongings() returns all the object whose person_id is person._id
+- multi-class associations : owner.vehicles.collect &class #=> [ Car, Boat ]
+- introduced the Rufus::Doric.types hash ({ 'car' => MyDomain::Car })
+- added property as an alias to h_accessor
+
+
+== rufus-doric - 0.1.1    released 2010/03/22
 
 - associations are in (_id[s]) for Model
 - equality and hash for Model

data/TODO.txt

@@ -3,7 +3,7 @@
 [o] model : validation
 [o] destroy/delete
 
-[ ] lsof check (jig / patron)
+[x] lsof check (jig / patron)
 
 [ ] all, by : limit and skip (pagination)
 

data/lib/rufus/doric/model.rb

@@ -22,7 +22,7 @@
 # Made in Japan.
 #++
 
-#require 'cgi'
+require 'cgi'
 
 
 module Rufus
@@ -41,6 +41,39 @@ module Doric
     }
   }
 
+  # Returns a hash of all the types (models) seen/registered.
+  #
+  # For example, after this class definition :
+  #
+  #   class Concept < Rufus::Doric::Model
+  #     db :doric
+  #     doric_type :concepts
+  #     _id_field :name
+  #     property :name
+  #   end
+  #
+  # this
+  #
+  #   p Rufus::Doric.types
+  #
+  # will yield
+  #
+  #   {"concepts"=>Concept}
+  #
+  def self.types
+
+    (@types ||= {})
+  end
+
+  # Given a document (a Hash instance), will look at its 'doric_type' and
+  # return an instance of a Rufus::Doric::Model or nil if there is
+  # no model defined for that doric_type
+  #
+  def self.instantiate (doc)
+
+    (types[doc['doric_type']].new(doc) rescue nil)
+  end
+
   #
   # Classes extending that class have 1 Couch document per instance
   #
@@ -54,7 +87,11 @@ module Doric
 
     def self.doric_type (rt=nil)
 
-      @doric_type = rt.to_s if rt
+      if rt
+        @doric_type = rt.to_s
+        Rufus::Doric.types[@doric_type] = self
+      end
+
       @doric_type
     end
 
@@ -179,6 +216,62 @@ module Doric
       delete
     end
 
+    # Returns all the other objects in the same db that have a {something}_id
+    # pointing to this object.
+    #
+    # For example, given
+    #
+    #   Person.new(
+    #     :name => 'friedrisch', :vehicle_id => 'GE1212'
+    #   ).save!
+    #
+    #   Book.new(
+    #     :description => 'romance of the three kingdoms',
+    #     :person_id => 'friedrisch'
+    #   ).save!
+    #   Computer.new(
+    #     :description => 'black macbook',
+    #     :person_id => 'friedrisch'
+    #   ).save!
+    #
+    # then
+    #
+    #   f = Person.find('friedrisch')
+    #   p f.belongings.map { |b| b.class.name }.sort)
+    #
+    # will print
+    #
+    #   ["Book", "Computer"]
+    #
+    def belongings
+
+      dd = db.get('_design/doric') || DORIC_DESIGN_DOC
+
+      s = self.class.doric_type.singularize
+
+      view = "by_#{s}_id"
+
+      unless dd['views'][view]
+
+        dd['views'][view] = {
+          'map' => %{
+            function (doc) {
+              if (doc.doric_type && doc.#{s}_id) emit(doc.#{s}_id, null);
+            }
+          }
+        }
+        db.put(dd)
+      end
+
+      i = CGI.escape(Rufus::Json.encode(_id))
+
+      result = db.get("_design/doric/_view/#{view}?key=#{i}&include_docs=true")
+
+      result['rows'].collect { |r| Rufus::Doric.instantiate(r['doc']) }
+    end
+
+    # All the association magic occur here, except for #belongings
+    #
     def method_missing (m, *args)
 
       mm = m.to_s
@@ -188,10 +281,30 @@ module Doric
       klass = sm.camelize
       klass = (self.class.const_get(klass) rescue nil)
 
-      return super unless klass
+      #return super unless klass
 
       id_method = multiple ? "#{sm}_ids" : "#{mm}_id"
 
+      unless klass
+
+        return super unless self.respond_to?(id_method)
+
+        i = self.send(id_method)
+
+        if multiple
+
+          return [] unless i
+
+          return i.collect { |ii|
+            Rufus::Doric.instantiate(db.get(ii))
+          }.select { |e|
+            e != nil
+          }
+        end
+
+        return Rufus::Doric.instantiate(db.get(i))
+      end
+
       if multiple
 
         if self.respond_to?(id_method)
@@ -210,6 +323,7 @@ module Doric
       else
 
         return super unless self.respond_to?(id_method)
+
         klass.find(self.send(id_method))
       end
     end
@@ -265,19 +379,6 @@ module Doric
 
       # by_{key} views
 
-      x = {
-        '_id' => '_design/doric',
-        'views' => {
-          'by_doric_type' => {
-            'map' => %{
-              function(doc) {
-                if (doc.doric_type) emit(doc.doric_type, null);
-              }
-            }
-          }
-        }
-      }
-
       ddoc = db.get(design_path) || {
         '_id' => design_path,
         'views' => {}

data/lib/rufus/doric/models.rb

@@ -38,6 +38,7 @@ module Doric
 
   #
   # The including classes get two new class methods : h_reader and h_accessor
+  # plus property as an alias to h_accessor
   #
   module WithH
 
@@ -64,6 +65,9 @@ module Doric
           end
         end
       end
+      def target.property (*names)
+        h_accessor(*names)
+      end
     end
   end
 

data/lib/rufus/doric/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Doric
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end
 end
 

data/rufus-doric.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-doric}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-03-22}
+  s.date = %q{2010-03-23}
   s.description = %q{
 something at the intersection of Rails3, CouchDB and rufus-jig
   }
@@ -51,7 +51,9 @@ something at the intersection of Rails3, CouchDB and rufus-jig
      "test/ut_3_model_lint.rb",
      "test/ut_4_one_doc_model.rb",
      "test/ut_5_value.rb",
-     "test/ut_6_model_associations.rb"
+     "test/ut_6_model_associations.rb",
+     "test/ut_7_looser_associations.rb",
+     "test/ut_8_belongings.rb"
   ]
   s.homepage = %q{http://github.com/jmettraux/rufus-doric/}
   s.rdoc_options = ["--charset=UTF-8"]

data/test/ut_1_model.rb

@@ -32,6 +32,14 @@ class Item < Rufus::Doric::Model
   validates :supplier, :presence => true
 end
 
+class Concept < Rufus::Doric::Model
+
+  db :doric
+  doric_type :concepts
+  _id_field :name
+  property :name
+end
+
 
 class UtModelTest < Test::Unit::TestCase
 
@@ -48,6 +56,12 @@ class UtModelTest < Test::Unit::TestCase
   #def teardown
   #end
 
+  def test_types
+
+    assert_equal Hash, Rufus::Doric.types.class
+    assert_equal Concept, Rufus::Doric.types['concepts']
+  end
+
   def test_save
 
     Thing.new(
@@ -151,5 +165,14 @@ class UtModelTest < Test::Unit::TestCase
     assert_not_equal a, c
     assert_not_equal a.hash, c.hash
   end
+
+  def test_property
+
+    Concept.new('name' => 'art').save!
+
+    c = Concept.find('art')
+
+    assert_equal 'art', c.name
+  end
 end
 

data/test/ut_6_model_associations.rb

@@ -56,7 +56,7 @@ class Order < Rufus::Doric::Model
 end
 
 
-class UtModelTest < Test::Unit::TestCase
+class UtModelAssociationsTest < Test::Unit::TestCase
 
   def setup
 
@@ -83,6 +83,9 @@ class UtModelTest < Test::Unit::TestCase
     Interest.new(:name => 'litterature').save!
     Interest.new(:name => 'music').save!
     Interest.new(:name => 'dance').save!
+
+    @fred = Customer.find('fred')
+    @famke = Customer.find('famke')
   end
 
   #def teardown
@@ -91,9 +94,8 @@ class UtModelTest < Test::Unit::TestCase
   def test_customer
 
     o = Order.find('a')
-    c = Customer.find('fred')
 
-    assert_equal c, o.customer
+    assert_equal @fred, o.customer
   end
 
   def test_missing_customer
@@ -105,9 +107,7 @@ class UtModelTest < Test::Unit::TestCase
 
   def test_orders
 
-    c = Customer.find('fred')
-
-    os = c.orders
+    os = @fred.orders
 
     assert_equal 2, os.size
     assert_equal [ Order ], os.collect { |o| o.class }.sort.uniq
@@ -115,11 +115,22 @@ class UtModelTest < Test::Unit::TestCase
 
   def test_interests
 
-    fred = Customer.find('fred')
-    famke = Customer.find('famke')
+    assert_equal [], @fred.interests
+    assert_equal %w[ dance music ], @famke.interests.collect { |i| i.name }.sort
+  end
 
-    assert_equal [], fred.interests
-    assert_equal %w[ dance music ], famke.interests.collect { |i| i.name }.sort
+  def test_no_link
+
+    assert_raise NoMethodError do
+      @fred.car
+    end
+  end
+
+  def test_no_links
+
+    assert_raise NoMethodError do
+      @fred.vehicles
+    end
   end
 end
 

data/test/ut_7_looser_associations.rb

@@ -0,0 +1,104 @@
+
+#
+# testing rufus-doric
+#
+# Tue Mar 23 11:07:23 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'rufus/doric'
+
+
+class Owner < Rufus::Doric::Model
+
+  db :doric
+  doric_type :owners
+
+  _id_field :name
+
+  property :name
+  property :vehicle_id
+end
+
+class Car < Rufus::Doric::Model
+
+  db :doric
+  doric_type :cars
+
+  _id_field :plate
+
+  property :plate
+end
+
+class Boat < Rufus::Doric::Model
+
+  db :doric
+  doric_type :boats
+
+  _id_field :immatriculation
+
+  property :immatriculation
+end
+
+class SuperOwner < Rufus::Doric::Model
+
+  db :doric
+  doric_type :super_owners
+
+  _id_field :name
+
+  property :name
+  property :vehicle_ids
+end
+
+
+class UtLooserAssocationsTest < Test::Unit::TestCase
+
+  def setup
+
+    Rufus::Doric.db('doric').delete('.')
+    Rufus::Doric.db('doric').put('.')
+
+    Rufus::Doric.db('doric').http.cache.clear
+      # CouchDB feeds the same etags for views, even after a db has
+      # been deleted and put back, so have to do that 'forgetting'
+
+    Owner.new(
+      :name => 'fred', :vehicle_id => 'GE1212'
+    ).save!
+    Owner.new(
+      :name => 'famke', :vehicle_id => 'GE1313'
+    ).save!
+    Owner.new(
+      :name => 'fellini', :vehicle_id => 'TO45R4'
+    ).save!
+
+    Car.new(:plate => 'GE1212').save!
+    Boat.new(:immatriculation => 'GE1313').save!
+
+    SuperOwner.new(
+      :name => 'aristotle', :vehicle_ids => %w[ GE1212 GE1313 NADA ]).save!
+
+    @fred = Owner.find('fred')
+    @famke = Owner.find('famke')
+    @fellini = Owner.find('fellini')
+    @aristotle = SuperOwner.find('aristotle')
+  end
+
+  #def teardown
+  #end
+
+  def test_vehicles
+
+    assert_equal Car, @fred.vehicle.class
+    assert_equal Boat, @famke.vehicle.class
+    assert_nil @fellini.vehicle
+  end
+
+  def test_super_owner
+
+    assert_equal [ Car, Boat ], @aristotle.vehicles.collect { |v| v.class }
+  end
+end
+

data/test/ut_8_belongings.rb

@@ -0,0 +1,92 @@
+
+#
+# testing rufus-doric
+#
+# Tue Mar 23 13:23:31 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'rufus/doric'
+
+
+class Person < Rufus::Doric::Model
+
+  db :doric
+  doric_type :persons
+
+  _id_field :name
+
+  property :name
+end
+
+class Book < Rufus::Doric::Model
+
+  db :doric
+  doric_type :books
+
+  _id_field :description
+
+  property :description
+  property :person_id
+end
+
+class Computer < Rufus::Doric::Model
+
+  db :doric
+  doric_type :computers
+
+  _id_field :description
+
+  property :description
+  property :person_id
+end
+
+
+class UtBelongingsTest < Test::Unit::TestCase
+
+  def setup
+
+    Rufus::Doric.db('doric').delete('.')
+    Rufus::Doric.db('doric').put('.')
+
+    Rufus::Doric.db('doric').http.cache.clear
+      # CouchDB feeds the same etags for views, even after a db has
+      # been deleted and put back, so have to do that 'forgetting'
+
+    Person.new(
+      :name => 'friedrisch', :vehicle_id => 'GE1212'
+    ).save!
+
+    Book.new(
+      :description => 'romance of the three kingdoms',
+      :person_id => 'friedrisch'
+    ).save!
+    Computer.new(
+      :description => 'black macbook',
+      :person_id => 'friedrisch'
+    ).save!
+    Computer.new(
+      :description => 'old thinkpad',
+      :person_id => 'vlad'
+    ).save!
+
+    @friedrisch = Person.find('friedrisch')
+  end
+
+  #def teardown
+  #end
+
+  def test_belongings
+
+    assert_equal(
+      %w[ Book Computer ],
+      @friedrisch.belongings.map { |b| b.class.name }.sort)
+
+    assert_equal(
+      %w[ Book Computer ],
+      @friedrisch.belongings.map { |b| b.class.name }.sort)
+        # second run shouldn't insert new design_doc
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-22 00:00:00 +09:00
+date: 2010-03-23 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -139,6 +139,8 @@ files:
 - test/ut_4_one_doc_model.rb
 - test/ut_5_value.rb
 - test/ut_6_model_associations.rb
+- test/ut_7_looser_associations.rb
+- test/ut_8_belongings.rb
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-doric/
 licenses: []