rufus-doric 0.1.15 → 0.1.16

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-doric CHANGELOG.txt
 
 
+== rufus-doric - 0.1.16    released 2010/07/12
+
+- OneDocModel#attach
+- removed duplicates for custom view results. Thanks Claudio.
+- 'open' models
+
+
 == rufus-doric - 0.1.15    released 2010/06/22
 
 - view_by :name, :ignore_case => true

data/Rakefile

@@ -79,7 +79,7 @@ end
 #
 # TO THE WEB
 
-task :upload_website => [ :clean, :rdoc ] do
+task :upload_rdoc => [ :clean, :rdoc ] do
 
   account = 'jmettraux@rubyforge.org'
   webdir = '/var/www/gforge-projects/rufus'

data/TODO.txt

@@ -9,12 +9,21 @@
 [o] view_by 'name', %{ emit(doc.nada) }
 [o] start and end key should be by_x(:start => a, :end => b)
 [o] credit Claudio
+[o] case-insentive index (Claudio)
+[o] open model
+[o] custom views : remove duplicate docs from results (Claudio)
 
 [x] lsof check (jig / patron)
 
 [ ] eventually : cache the text index
 
 [ ] view_by 'x', 'emit' ==> view 'x', 'emit' ==> Model.x(key)...
+[ ] view_by 'x', :condition => '{some javascript}' (a la SimplyStored)
 
-[ ] case-insentive index (Claudio)
+[ ] open models, OK, what about on-the-fly views ?
+    do you really need views for those ?
+
+[ ] internal _sum, _count and _stats
+    http://www.mikealrogers.com/archives/785
+    http://wiki.apache.org/couchdb/Built-In_Reduce_Functions
 

data/lib/rufus/doric/model.rb

@@ -105,6 +105,13 @@ module Doric
       @_id_field
     end
 
+    # Flags a model as "open". New properties can be added on the fly.
+    #
+    def self.open
+
+      @open = true
+    end
+
     def self.attachment (attachment_name)
 
       class_eval %{
@@ -294,36 +301,16 @@ module Doric
       end
     end
 
+    # Attaches a document to this model.
+    #
+    #   o.attach('icon.jpg', File.read('path/to/file.jpg'))
+    #
+    # No need to save! after an attachment, but the model/instance has to be
+    # up to date (ie, latest _rev).
+    #
     def attach (attname, data, opts={})
 
-      extname = File.extname(attname)
-      basename = File.basename(attname, extname)
-      mime = ::MIME::Types.type_for(attname).first
-
-      if data.is_a?(File)
-        mime = ::MIME::Types.type_for(data.path).first
-        data = data.read
-      elsif data.is_a?(Array)
-        data, mime = data
-        mime = ::MIME::Types[mime].first
-      end
-
-      raise ArgumentError.new("couldn't determine mime type") unless mime
-
-      attname = "#{attname}.#{mime.extensions.first}" if extname == ''
-
-      if @h['_rev'] # document has already been saved
-
-        db.attach(
-          @h['_id'], @h['_rev'], attname, data, :content_type => mime.to_s)
-
-      else # document hasn't yet been saved, inline attachment...
-
-        (@h['_attachments'] ||= {})[attname] = {
-          'content_type' => mime.to_s,
-          'data' => Base64.encode64(data).gsub(/[\r\n]/, '')
-        }
-      end
+      do_attach(@h, attname, data, opts)
     end
 
     # Reads an attachment
@@ -344,6 +331,8 @@ module Doric
       db.get("#{@h['_id']}/#{attname}")
     end
 
+    # Removes an attachment.
+    #
     def detach (attname)
 
       raise ArgumentError.new("model not yet saved") unless @h['_rev']
@@ -351,6 +340,18 @@ module Doric
       db.delete("#{@h['_id']}/#{attname}?rev=#{@h['_rev']}")
     end
 
+    # If this model is open, will remove a property (key and value).
+    # If the model is not open, will raise an error.
+    #
+    def remove (key)
+
+      raise(
+        "model #{self.class.name} is not open, cannot remove properties"
+      ) unless self.class.instance_variable_get(:@open)
+
+      @h.delete(key.to_s)
+    end
+
     #--
     # methods required by ActiveModel (see test/unit/ut_3_model_lint.rb)
     #++
@@ -454,64 +455,17 @@ module Doric
       result['rows'].collect { |r| Rufus::Doric.instantiate(r['doc']) }
     end
 
-    # All the association magic occur here, except for #belongings
+    # The association and the 'open' magic occurs here, except for #belongings
     #
     def method_missing (m, *args)
 
-      mm = m.to_s
-      sm = mm.singularize
-      multiple = (mm != sm)
-
-      klass = sm.camelize
-      klass = (self.class.const_get(klass) rescue nil)
-
-      #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
+      success, result = open_method_missing(m.to_s, args)
+      return result if success
 
-          return i.collect { |ii|
-            Rufus::Doric.instantiate(db.get(ii))
-          }.select { |e|
-            e != nil
-          }
-        end
-
-        return Rufus::Doric.instantiate(db.get(i))
-      end
+      success, result = association_method_missing(m.to_s, args)
+      return result if success
 
-      if multiple
-
-        if self.respond_to?(id_method)
-
-          ids = self.send(id_method)
-          return [] unless ids
-
-          ids.collect { |i| klass.find(i) }
-
-        else
-
-          by_method = "by_#{self.class.doric_type.singularize}_id"
-          klass.send(by_method, self._id)
-        end
-
-      else
-
-        return super unless self.respond_to?(id_method)
-
-        id = self.send(id_method)
-
-        id ? klass.find(id) : nil
-      end
+      super
     end
 
     def hash
@@ -589,6 +543,81 @@ module Doric
       "#{self.class.doric_type}__#{s}"
     end
 
+    def open_method_missing (m, args)
+
+      return false unless self.class.instance_variable_get(:@open)
+
+      key = m.match(/^(.+)=$/)
+
+      if key && args.length == 1
+        @h[key[1]] = args.first
+        return [ true, args.first ]
+      end
+      if ( ! key) && args.length == 0
+        return [ true, @h[m] ]
+      end
+
+      false
+    end
+
+    def association_method_missing (m, args)
+
+      sm = m.singularize
+      multiple = (m != sm)
+
+      klass = sm.camelize
+      klass = (self.class.const_get(klass) rescue nil)
+
+      id_method = multiple ? "#{sm}_ids" : "#{m}_id"
+
+      unless klass
+
+        return false unless self.respond_to?(id_method)
+
+        i = self.send(id_method)
+
+        if multiple
+
+          return [ true, [] ] unless i
+
+          return [
+            true,
+            i.collect { |ii|
+              Rufus::Doric.instantiate(db.get(ii))
+            }.select { |e|
+              e != nil
+            }
+          ]
+        end
+
+        return [ true, Rufus::Doric.instantiate(db.get(i)) ]
+      end
+
+      if multiple
+
+        if self.respond_to?(id_method)
+
+          ids = self.send(id_method)
+
+          [ true, ids ? ids.collect { |i| klass.find(i) } : [] ]
+
+        else
+
+          by_method = "by_#{self.class.doric_type.singularize}_id"
+
+          [ true, klass.send(by_method, self._id) ]
+        end
+
+      else
+
+        return false unless self.respond_to?(id_method)
+
+        id = self.send(id_method)
+
+        [ true, id ? klass.find(id) : nil ]
+      end
+    end
+
     def self.func (body, type=:map)
 
       if type == :map
@@ -755,7 +784,7 @@ module Doric
         r = result['rows'].first
         r ? r['value'] : nil
       else
-        result['rows'].collect { |r| self.new(r['doc']) }
+        result['rows'].collect { |r| self.new(r['doc']) }.uniq
       end
     end
 

data/lib/rufus/doric/models.rb

@@ -126,6 +126,42 @@ module Doric
 
       self.class.db
     end
+
+    protected
+
+    def do_attach (doc, attname, data, opts={})
+
+      extname = File.extname(attname)
+      basename = File.basename(attname, extname)
+      mime = ::MIME::Types.type_for(attname).first
+
+      if data.is_a?(File)
+        mime = ::MIME::Types.type_for(data.path).first
+        data = data.read
+      elsif data.is_a?(Array)
+        data, mime = data
+        mime = ::MIME::Types[mime].first
+      end
+
+      mime ||= (::MIME::Types[opts[:content_type]] || []).first
+
+      raise ArgumentError.new("couldn't determine mime type") unless mime
+
+      attname = "#{attname}.#{mime.extensions.first}" if extname == ''
+
+      if doc['_rev'] # document has already been saved
+
+        db.attach(
+          doc['_id'], doc['_rev'], attname, data, :content_type => mime.to_s)
+
+      else # document hasn't yet been saved, inline attachment...
+
+        (doc['_attachments'] ||= {})[attname] = {
+          'content_type' => mime.to_s,
+          'data' => Base64.encode64(data).gsub(/[\r\n]/, '')
+        }
+      end
+    end
   end
 
   #--

data/lib/rufus/doric/one_doc_model.rb

@@ -94,6 +94,18 @@ module Doric
       delete
     end
 
+    # Given a model named User, some usage examples :
+    #
+    #   u = User.find('john')
+    #   u.attach(File.read('avatar.png', :content_type => 'image/png'
+    #   u.attach([ File.read('avatar.png', 'image/png' ])
+    #
+    def attach (data, opts={})
+
+      #def do_attach (doc, attname, data, opts={})
+      do_attach(db.get(self.class.doc_id), _id, data, opts)
+    end
+
     #--
     # class methods
     #++

data/lib/rufus/doric/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Doric
-  VERSION = '0.1.15'
+  VERSION = '0.1.16'
 end
 end
 

data/rufus-doric.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-doric}
-  s.version = "0.1.15"
+  s.version = "0.1.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-06-22}
+  s.date = %q{2010-07-12}
   s.description = %q{
 something at the intersection of Rails3, CouchDB and rufus-jig
   }
@@ -59,6 +59,7 @@ something at the intersection of Rails3, CouchDB and rufus-jig
      "test/ut_19_neutralize_id.rb",
      "test/ut_1_model.rb",
      "test/ut_20_model_view_by_ignore_case.rb",
+     "test/ut_21_open_model.rb",
      "test/ut_2_model_view.rb",
      "test/ut_3_model_lint.rb",
      "test/ut_4_one_doc_model.rb",

data/test/ut_16_model_custom_view.rb

@@ -25,6 +25,11 @@ class Team < Rufus::Doric::Model
   view 'tysec2', %{
     emit([ doc.type, doc.security_level ], null);
   }
+
+  view 'duplicates', %{
+    emit(doc.type, null);
+    emit(doc.type, null);
+  }
 end
 
 #class City < Rufus::Doric::Model
@@ -99,5 +104,15 @@ class UtModelCustomViewTest < Test::Unit::TestCase
 
     assert_equal 1, Team.by_tysec('rifle__b').size
   end
+
+  def test_remove_duplicates
+
+    Team.new(
+      'type' => 'cleaning',
+      'security_level' => 'b'
+    ).save!
+
+    assert_equal 1, Team.duplicates('cleaning').size
+  end
 end
 

data/test/ut_20_model_view_by_ignore_case.rb

@@ -20,6 +20,7 @@ class Handkerchief < Rufus::Doric::Model
   h_accessor :colour
   h_accessor :owner
 
+  view_by :colour
   view_by :owner, :ignore_case => true
 end
 
@@ -41,18 +42,37 @@ class UtModelViewTest < Test::Unit::TestCase
 
   def test_view_by_owner
 
+    load_data
+
+    assert_equal 1, Handkerchief.by_owner('pepe').size
+    assert_equal 2, Handkerchief.by_owner('jefe').size
+
+    assert_equal 0, Handkerchief.by_owner('Pepe').size
+    assert_equal 0, Handkerchief.by_owner('Jefe').size
+  end
+
+  def test_view_by_colour
+
+    load_data
+
+    assert_equal 1, Handkerchief.by_colour('brown').size
+    assert_equal 1, Handkerchief.by_colour('Brown').size
+    assert_equal 1, Handkerchief.by_colour('browN').size
+  end
+
+  protected
+
+  def load_data
+
     Handkerchief.new(
-      :brand => 'valentino', :colour => 'blue', :owner => 'Pepe'
+      :brand => 'valentino', :colour => 'browN', :owner => 'Pepe'
     ).save!
     Handkerchief.new(
       :brand => 'lv', :colour => 'brown', :owner => 'Jefe'
     ).save!
     Handkerchief.new(
-      :brand => 'chanel', :colour => 'b&w', :owner => 'jefe'
+      :brand => 'chanel', :colour => 'Brown', :owner => 'jefe'
     ).save!
-
-    assert_equal 1, Handkerchief.by_owner('pepe').size
-    assert_equal 2, Handkerchief.by_owner('jefe').size
   end
 end
 

data/test/ut_21_open_model.rb

@@ -0,0 +1,85 @@
+
+#
+# testing rufus-doric
+#
+# Wed Jun 30 15:05:56 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'rufus/doric'
+
+
+class Audit < Rufus::Doric::Model
+
+  db :doric
+  doric_type :audits
+
+  open
+
+  _id_field { "audit_#{name}" }
+  property :name
+end
+
+class Participant < Rufus::Doric::Model
+
+  db :doric
+  doric_type :audits
+
+  _id_field { "participant_#{name}" }
+  property :name
+end
+
+
+class UtOpenModelTest < 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'
+  end
+
+  #def teardown
+  #end
+
+  def test_openness
+
+    a = Audit.new(:name => 'nada')
+    a.save!
+
+    assert_equal nil, a.clerk
+    assert_equal nil, a.whatever
+
+    a = Audit.all.first
+    a.clerk = 'Wilfried'
+    a.save!
+
+    assert_equal 'Wilfried', a.clerk
+  end
+
+  def test_remove
+
+    a = Audit.new(:name => 'berlusconi')
+    a.h['country'] = 'x'
+
+    a.remove(:country)
+
+    assert_equal %w[ doric_type name ], a.h.keys.sort
+  end
+
+  def test_remove_on_a_closed_model
+
+    Participant.new(:name => 'Joseph').save!
+
+    pa = Participant.all.first
+
+    assert_raise RuntimeError do
+      pa.remove(:nationality)
+    end
+  end
+end
+

data/test/ut_4_one_doc_model.rb

@@ -94,9 +94,15 @@ class UtOneDocModelTest < Test::Unit::TestCase
     assert_equal [], User.all
   end
 
-#  def test_missing_db_declaration
-#
-#    Site.new(:name => 'Eur', :streets => [:one, :two, :three]).save!
-#  end
+  def test_attach
+
+    u = User.find('john')
+    u.attach(File.read(__FILE__), :content_type => 'text/plain')
+
+    assert_match /justin/, u.db.get('users/john.txt')
+
+    u = User.find('john')
+    assert_equal 'john.txt', u.attachment
+  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 15
-  version: 0.1.15
+  - 16
+  version: 0.1.16
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 +09:00
+date: 2010-07-12 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -146,6 +146,7 @@ files:
 - test/ut_19_neutralize_id.rb
 - test/ut_1_model.rb
 - test/ut_20_model_view_by_ignore_case.rb
+- test/ut_21_open_model.rb
 - test/ut_2_model_view.rb
 - test/ut_3_model_lint.rb
 - test/ut_4_one_doc_model.rb