rufus-doric 0.1.9 → 0.1.10

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-doric CHANGELOG.txt
 
 
+== rufus-doric - 0.1.10    not yet released
+
+- model attachment :x for properties like attachments (#att and #att=(x))
+- model#read(attachment_name)
+
+
 == rufus-doric - 0.1.9    released 2010/05/13
 
 - model#detach(attachment_name)

data/README.rdoc

@@ -184,6 +184,11 @@ this
 will load the documents (and their attachements) into http://127.0.0.1:5984/doric_test
 
 
+== credits
+
+Claudio Petasecca Donati - for his help about attachments
+
+
 == license
 
 MIT

data/TODO.txt

@@ -15,3 +15,5 @@
 
 [ ] view_by 'x', 'emit' ==> view 'x', 'emit' ==> Model.x(key)...
 
+[ ] credit Claudio !!
+

data/lib/rufus/doric/model.rb

@@ -23,6 +23,7 @@
 #++
 
 require 'cgi'
+require 'base64'
 require 'mime/types'
 
 
@@ -104,6 +105,18 @@ module Doric
       @_id_field
     end
 
+    def self.attachment (attachment_name)
+
+      class_eval %{
+        def #{attachment_name}
+          read('#{attachment_name}')
+        end
+        def #{attachment_name}= (data, opts={})
+          attach('#{attachment_name}', data, opts)
+        end
+      }
+    end
+
     # Creates a by_{key} method.
     #
     # If a func (a String) is passed, a {key} method is created that
@@ -254,13 +267,52 @@ module Doric
       raise(SaveFailed.new(self.class.doric_type, _id)) unless r.nil?
     end
 
-    def attach (attname, data)
+    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
+    end
+
+    # Reads an attachment
+    #
+    #   model.read('icon')
+    #   model.read('user_picture.jpg')
+    #   model.read(:user_picture)
+    #
+    def read (attname)
+
+      attname = attname.to_s
 
-      doc = db.get(@h['_id'])
+      extname = File.extname(attname)
+      attname = attachments.find { |a| a.match(/^#{attname}/) } if extname == ''
 
-      db.attach(
-        doc, attname, data,
-        :content_type => ::MIME::Types.type_for(attname).first.to_s)
+      db.get("#{@h['_id']}/#{attname}")
     end
 
     def detach (attname)

data/lib/rufus/doric/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Doric
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end
 end
 

data/rufus-doric.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-doric}
-  s.version = "0.1.9"
+  s.version = "0.1.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-05-13}
+  s.date = %q{2010-05-14}
   s.description = %q{
 something at the intersection of Rails3, CouchDB and rufus-jig
   }
@@ -34,6 +34,7 @@ something at the intersection of Rails3, CouchDB and rufus-jig
      "lib/rufus/doric/value.rb",
      "lib/rufus/doric/version.rb",
      "rufus-doric.gemspec",
+     "test/al_vetro.png",
      "test/base.rb",
      "test/fixtures/test/doric/69247b__picture.jpg",
      "test/fixtures/test/doric/69249__picture.jpg",
@@ -53,6 +54,7 @@ something at the intersection of Rails3, CouchDB and rufus-jig
      "test/ut_14_model_default_id.rb",
      "test/ut_15_model_view_by_and.rb",
      "test/ut_16_model_custom_view.rb",
+     "test/ut_17_model_and_attachments.rb",
      "test/ut_1_model.rb",
      "test/ut_2_model_view.rb",
      "test/ut_3_model_lint.rb",

data/test/ut_17_model_and_attachments.rb

@@ -0,0 +1,192 @@
+
+#
+# testing rufus-doric
+#
+# Thu May 13 08:53:01 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'rufus/doric'
+
+
+class Thing < Rufus::Doric::Model
+
+  db :doric
+
+  doric_type :things
+  _id_field :name
+  h_accessor :name
+end
+
+class Folder < Rufus::Doric::Model
+
+  db :doric
+
+  doric_type :folders
+  _id_field :name
+  h_accessor :name
+
+  attachment :icon
+end
+
+
+class UtModelAndAttachmentsTest < 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_attach_pre_save
+
+    txt = File.read(__FILE__)
+
+    t = Thing.new('name' => 'that_piece_of_code')
+    t.attach('this_code.txt', txt)
+    t.save!
+
+    t = Thing.find('that_piece_of_code')
+
+    assert_equal [ 'this_code.txt' ], t.attachments
+    assert_equal txt, t.db.get('that_piece_of_code/this_code.txt')
+  end
+
+  def test_attach
+
+    txt = File.read(__FILE__)
+
+    t = Thing.new('name' => 'piece_of_code')
+    t.save!
+
+    t = Thing.find('piece_of_code')
+
+    assert_equal [], t.attachments
+
+    t.attach('code.txt', txt)
+
+    t = Thing.find('piece_of_code')
+
+    assert_equal [ 'code.txt' ], t.attachments
+    assert_equal txt, t.db.get('piece_of_code/code.txt')
+  end
+
+  def test_detect_and_attach_pre_save
+
+    t = Thing.new('name' => 'al_vetro_pre')
+    t.attach('result', File.new(path_to('al_vetro.png')))
+    t.save!
+
+    t = Thing.find('al_vetro_pre')
+
+    assert_equal [ 'result.png' ], t.attachments
+    assert_equal "\x89PNG\r\n\x1A", t.read('result')[0, 7]
+    assert_equal "\x89PNG\r\n\x1A", t.read('result.png')[0, 7]
+  end
+
+  def test_detect_and_attach
+
+    t = Thing.new('name' => 'al_vetro')
+    t.save!
+
+    t = Thing.find('al_vetro')
+    t.attach('result', File.new(path_to('al_vetro.png')))
+
+    t = Thing.find('al_vetro')
+
+    assert_equal [ 'result.png' ], t.attachments
+    assert_equal "\x89PNG\r\n\x1A", t.read('result')[0, 7]
+    assert_equal "\x89PNG\r\n\x1A", t.read('result.png')[0, 7]
+  end
+
+  def test_detach
+
+    t = Thing.new('name' => 'ms_excel')
+    t.save!
+
+    t = Thing.find('ms_excel')
+    t.attach('code.txt', File.read(__FILE__))
+
+    t = Thing.find('ms_excel')
+
+    assert_equal [ 'code.txt' ], t.attachments
+
+    t.detach('code.txt')
+
+    assert_equal [], Thing.find('ms_excel').attachments
+  end
+
+  def test_named_attachment_pre_save
+
+    f = Folder.new('name' => 'summer')
+    f.icon = File.new(File.join(File.dirname(__FILE__), 'al_vetro.png'))
+    f.save!
+
+    f = Folder.find('summer')
+    assert_equal [ 'icon.png' ], f.attachments
+
+    assert_equal "\x89PNG\r\n\x1A", f.icon[0, 7]
+  end
+
+  def test_named_attachment
+
+    f = Folder.new('name' => 'winter')
+    f.save!
+
+    f = Folder.find('winter')
+    f.icon = File.new(path_to('al_vetro.png'))
+
+    f = Folder.find('winter')
+    assert_equal [ 'icon.png' ], f.attachments
+
+    assert_equal "\x89PNG\r\n\x1A", f.icon[0, 7]
+  end
+
+  def test_read
+
+    t = Thing.new('name' => 'some_thing')
+    t.attach('toto.txt', File.read(__FILE__))
+    t.save!
+
+    t = Thing.find('some_thing')
+
+    assert_equal "\n#\n# testing r", t.read('toto.txt')[0, 14]
+    assert_equal "\n#\n# testing r", t.read('toto')[0, 14]
+    assert_equal "\n#\n# testing r", t.read(:toto)[0, 14]
+  end
+
+  def test_string_attachment_missing_content_type
+
+    assert_raise ArgumentError do
+      f = Folder.new('name' => 'spring')
+      f.icon = File.read(path_to('al_vetro.png'))
+    end
+  end
+
+  def test_string_attachment
+
+    f = Folder.new('name' => 'spring')
+    f.icon = [ File.read(path_to('al_vetro.png')), 'text/plain' ]
+    f.save!
+
+    f = Folder.find('spring')
+
+    assert_equal [ 'icon.txt' ], f.attachments
+  end
+
+  protected
+
+  def path_to (local_item)
+
+    File.join(File.dirname(__FILE__), local_item)
+  end
+end
+

data/test/ut_1_model.rb

@@ -187,36 +187,5 @@ class UtModelTest < Test::Unit::TestCase
 
     assert_equal 'art', c.name
   end
-
-  def test_attach
-
-    txt = File.read(__FILE__)
-
-    t = Thing.new('name' => 'piece_of_code')
-    t.save!
-
-    assert_equal [], t.attachments
-
-    t.attach('code.txt', txt)
-
-    t = Thing.find('piece_of_code')
-
-    assert_equal [ 'code.txt' ], t.attachments
-    assert_equal txt, t.db.get('piece_of_code/code.txt')
-  end
-
-  def test_detach
-
-    t = Thing.new('name' => 'ms_excel')
-    t.save!
-    t.attach('code.txt', File.read(__FILE__))
-    t = Thing.find('ms_excel')
-
-    assert_equal [ 'code.txt' ], t.attachments
-
-    t.detach('code.txt')
-
-    assert_equal [], Thing.find('ms_excel').attachments
-  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +09:00
+date: 2010-05-14 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -121,6 +121,7 @@ files:
 - lib/rufus/doric/value.rb
 - lib/rufus/doric/version.rb
 - rufus-doric.gemspec
+- test/al_vetro.png
 - test/base.rb
 - test/fixtures/test/doric/69247b__picture.jpg
 - test/fixtures/test/doric/69249__picture.jpg
@@ -140,6 +141,7 @@ files:
 - test/ut_14_model_default_id.rb
 - test/ut_15_model_view_by_and.rb
 - test/ut_16_model_custom_view.rb
+- test/ut_17_model_and_attachments.rb
 - test/ut_1_model.rb
 - test/ut_2_model_view.rb
 - test/ut_3_model_lint.rb