dolly 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0ed634c57601285c5f226c689864684e556edbe
-  data.tar.gz: 343cf2e87366a95ca10a22cd76a7e9b014fe8eeb
+  metadata.gz: 1952fc2428d46ea5090b64c1785e63c2665196e1
+  data.tar.gz: 365cf7c705ebd578fe5116721a94653a28cca9fc
 SHA512:
-  metadata.gz: 46eb110e75de2a3511cd5682bc5f8a4caddf11c4c8b41c2af20dd09b29e5413c9380385981c4b957655ac163f24b7a17beb6b43dac012695eaf6d1b2a2794275
-  data.tar.gz: 4cab1eb32ab93835832897fda1ed3a300063df79e1e6f6895024355939843608ba1c3a3168635d63d4a339cc39f4f06eb05322a673e91f03babee3146f180bbb
+  metadata.gz: c043052831b7bc395ca53d49771026d1450e409a1bd92dcc2efc45377d4ae63d1cf81ec95ebed62717998308cadfa8f4a12085c43f1bd2e77fc66631d500e7da
+  data.tar.gz: 0a90e6732e7125a4f835d320c6f6902bff4327f37afd63794789fc4fb8ec0687e30ef638bc1b98dfac1a9ac38fe3388908c90070158cd918b52d275ab8f07d63

data/lib/dolly/document.rb

@@ -10,6 +10,7 @@ module Dolly
 
     attr_accessor :rows, :doc, :key
     class_attribute :properties
+    cattr_accessor :timestamps
 
     def initialize options = {}
       @doc ||= {}
@@ -50,11 +51,12 @@ module Dolly
       doc['_rev'] = value
     end
 
-    def save
+    def save options = {}
+      return false unless options[:validate] == false || valid?
       self.doc['_id'] = self.id if self.id.present?
       self.doc['_id'] = self.class.next_id if self.doc['_id'].blank?
-      set_created_at if respond_to? :created_at
-      set_updated_at if respond_to? :updated_at
+      set_created_at if timestamps
+      set_updated_at if timestamps
       response = database.put(id_as_resource, self.doc.to_json)
       obj = JSON::parse response.parsed_response
       doc['_rev'] = obj['rev'] if obj['rev']
@@ -62,7 +64,7 @@ module Dolly
     end
 
     def save!
-      #TODO: decide how to handle validations...
+      raise DocumentInvalidError unless valid?
       save
     end
 
@@ -96,6 +98,18 @@ module Dolly
       CGI::escape id
     end
 
+    def attach_file! file_name, mime_type, body, opts={}
+      if opts[:inline]
+        attachment_data = { file_name.to_s => { 'content_type' => mime_type,
+                                                'data'         => Base64.encode64(body)} }
+        doc['_attachments'] ||= {}
+        doc['_attachments'].merge! attachment_data
+        save
+      else
+        database.attach id_as_resource, CGI.escape(file_name), body, { 'Content-Type' => mime_type }
+      end
+    end
+
     def self.create options = {}
       obj = new options
       obj.save
@@ -124,11 +138,15 @@ module Dolly
     end
 
     def write_property name, value
-      @doc[name.to_s] = self.properties[name].value = value
+      instance_variable_set(:"@#{name}", value)
+      @doc[name.to_s] = value
     end
 
     def read_property name
-      doc[name.to_s] || self.properties[name].value
+      if instance_variable_get(:"@#{name}").nil?
+        write_property name, (doc[name.to_s] || self.properties[name].value)
+      end
+      instance_variable_get(:"@#{name}")
     end
 
     def _properties
@@ -146,7 +164,11 @@ module Dolly
     end
 
     def initialize_default_properties options
-      _properties.reject { |property| options.keys.include? property.name }.each { |property| self.doc[property.name] ||= property.default }
+      _properties.reject { |property| options.keys.include? property.name }.each do |property|
+        property_value = property.default.clone unless Dolly::Property::CANT_CLONE.any? { |klass| property.default.is_a? klass }
+        property_value ||= property.default
+        self.doc[property.name] ||= property_value
+      end
     end
 
     def init_doc options
@@ -163,5 +185,7 @@ module Dolly
     def properties_include? property
       _properties.map(&:name).include? property
     end
+
+    def valid?; true; end
   end
 end

data/lib/dolly/property.rb

@@ -4,10 +4,13 @@ module Dolly
     attr_accessor :name
     attr_reader :class_name, :default
 
+    CANT_CLONE = [NilClass, TrueClass, FalseClass, Fixnum].freeze
+
     def initialize opts = {}
       @class_name = opts.delete(:class_name) if opts.present?
       @name = opts.delete(:name).to_s
       @default = opts.delete(:default)
+      @default = @default.clone if @default && CANT_CLONE.none? { |klass| @default.is_a? klass }
       @value = @default if @default
       warn 'There are some unprocessed options!' if opts.present?
     end

data/lib/dolly/request.rb

@@ -40,6 +40,11 @@ module Dolly
       request :delete, full_path(resource), {}
     end
 
+    def attach resource, attachment_name, data, headers = {}
+      data = StringIO.new(data) if data.is_a?(String)
+      request :put, attachment_path(resource, attachment_name), {body: data, headers: headers}
+    end
+
     def protocol
       @protocol || 'http'
     end
@@ -61,8 +66,8 @@ module Dolly
       response = self.class.send method, resource, data.merge(headers: headers)
       if response.code == 404
         raise Dolly::ResourceNotFound
-      elsif (500..600).include? response.code
-        raise Dolly::ServerError
+      elsif (400..600).include? response.code
+        raise Dolly::ServerError.new( response )
       else
         response
       end
@@ -88,6 +93,10 @@ module Dolly
     def full_path resource
       "/#{database_name}/#{resource}"
     end
+
+    def attachment_path resource, attachment_name
+      "#{full_path(resource)}/#{attachment_name}"
+    end
   end
 
 end

data/lib/dolly/timestamps.rb

@@ -4,13 +4,16 @@ module Dolly
     def timestamps!
       property :created_at, :updated_at, class_name: DateTime
 
+      self.class_variable_set :@@timestamps, true
+
       Dolly::Document.class_eval do
+
         def set_created_at
-          self.created_at ||= DateTime.now
+          doc['created_at'] ||= DateTime.now
         end
 
         def set_updated_at
-          self.updated_at = DateTime.now
+          doc['updated_at'] = DateTime.now
         end
       end
     end

data/lib/dolly/version.rb

@@ -1,3 +1,3 @@
 module Dolly
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/exceptions/dolly.rb

@@ -5,8 +5,12 @@ module Dolly
     end
   end
   class ServerError < RuntimeError
+    def initialize msg
+      @msg = msg
+    end
+
     def to_s
-      'There has been an error on the couchdb server. Please review your couch logs.'
+      "There has been an error on the couchdb server: #{@msg.inspect}"
     end
   end
   class MissingDesignError < RuntimeError
@@ -29,4 +33,5 @@ module Dolly
       "Trying to set an undefined property."
     end
   end
+  class DocumentInvalidError < RuntimeError; end
 end

data/test/collection_test.rb

@@ -1,6 +1,8 @@
 require 'test_helper'
 
-class FooBar < Dolly::Document
+class BaseDolly < Dolly::Document; end
+
+class FooBar < BaseDolly
   property :foo, :bar
 end
 

data/test/document_test.rb

@@ -1,12 +1,19 @@
 require 'test_helper'
 
-class FooBar < Dolly::Document
+class BaseDolly < Dolly::Document; end
+
+class BarFoo < BaseDolly
+  property :a, :b, :c, :d, :e, :f, :g, :h, :i, :j, :k, :l, :m, :n, :persist
+end
+
+class FooBar < BaseDolly
   property :foo, :bar
   property :with_default, default: 1
   property :boolean, class_name: TrueClass, default: true
   property :date, class_name: Date
   property :time, class_name: Time
   property :datetime, class_name: DateTime
+  property :is_nil, class_name: NilClass, default: nil
 
   timestamps!
 end
@@ -22,10 +29,26 @@ class FooBaz < Dolly::Document
   end
 end
 
+class WithTime < Dolly::Document
+  property :created_at
+end
+
 class TestFoo < Dolly::Document
   property :default_test_property, class_name: String, default: 'FOO'
 end
 
+class DocumentWithValidMethod < Dolly::Document
+  property :foo
+
+  def valid?
+    foo.present?
+  end
+end
+
+class DocWithSameDefaults < Dolly::Document
+  property :foo, :bar, class_name: Array, default: []
+end
+
 class DocumentTest < ActiveSupport::TestCase
   DB_BASE_PATH = "http://localhost:5984/test".freeze
 
@@ -55,6 +78,7 @@ class DocumentTest < ActiveSupport::TestCase
     FakeWeb.register_uri :get, "#{query_base_path}?keys=%5B%22foo_bar%2Ferror%22%5D&include_docs=true", body: 'error', status: ["500", "Error"]
     FakeWeb.register_uri :get, "#{query_base_path}?keys=%5B%22foo_bar%2F1%22%2C%22foo_bar%2F2%22%5D&include_docs=true", body: @multi_resp.to_json
     FakeWeb.register_uri :get, "#{query_base_path}?keys=%5B%22foo_bar%2F2%22%5D&include_docs=true", body: not_found_resp.to_json
+    FakeWeb.register_uri :get, "#{query_base_path}?keys=%5B%22foo_bar%2Fbig_doc%22%5D&include_docs=true", body: build_view_response([data.merge(other_property: 'other')]).to_json
   end
 
   test 'new in memory document' do
@@ -284,7 +308,7 @@ class DocumentTest < ActiveSupport::TestCase
   test 'trying to update invalid property' do
     foo = FooBar.new 'id' => 'a', foo: 'ab', bar: 'ba'
     assert_raise Dolly::InvalidProperty do
-       foo.update_properties key_to_success: false
+      foo.update_properties key_to_success: false
     end
   end
 
@@ -348,6 +372,101 @@ class DocumentTest < ActiveSupport::TestCase
     assert_equal 'bar', test_foo.doc['default_test_property']
   end
 
+  test 'doc and method and instance var are the same' do
+    test_foo = FooBar.new
+    test_foo.foo = 'test_value'
+    assert_equal 'test_value', test_foo.foo
+    assert_equal 'test_value', test_foo.doc['foo']
+    assert_equal 'test_value', test_foo.instance_variable_get(:@foo)
+  end
+
+  test 'created at is current time' do
+    resp = {ok: true, id: "with_time/timed", rev: "FF0000"}
+    FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/with_time%2F.+/, body: resp.to_json
+    test = WithTime.new id: "timed"
+    assert test.respond_to?(:created_at)
+    assert test.save
+    assert test.created_at
+  end
+
+  test 'nil default' do
+    properties = {foo: nil, is_nil: nil}
+    resp = {ok: true, id: "foo_bar/1", rev: "FF0000"}
+    FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/foo_bar%2F.+/, body: resp.to_json
+    foo = FooBar.new properties
+    foo.save
+    properties.each do |k, v|
+      assert_equal v, foo[k]
+    end
+  end
+
+  test 'setting on instance value does set it for other instances' do
+    foo = FooBar.new
+    foo.bar = 'I belong to the foo, not the bar'
+    bar = FooBar.new
+    assert_not_equal foo.bar, bar.bar
+  end
+
+  test 'subclass raises DocumentInvalidError if valid? fails' do
+    foo = DocumentWithValidMethod.new
+    assert_raise Dolly::DocumentInvalidError do
+      foo.save!
+    end
+  end
+
+  test 'save returns false for invalid document on save' do
+    foo = DocumentWithValidMethod.new
+    assert_not foo.save
+  end
+
+  test 'save succeeds for invalid document if skipping validations' do
+    resp = {ok: true, id: "document_with_valid_method/1", rev: "FF0000"}
+    FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/document_with_valid_method%2F.+/, body: resp.to_json
+    foo = DocumentWithValidMethod.new
+    assert foo.save(validate: false)
+  end
+
+  test 'default objects are not the same in memory' do
+    doc_with_same_default = DocWithSameDefaults.new
+    assert_not doc_with_same_default.foo.equal? doc_with_same_default.bar
+    doc_with_same_default.foo.push 'foo'
+    assert doc_with_same_default.bar == []
+  end
+
+  test 'default properties do not update the class default properties' do
+    doc = DocWithSameDefaults.new
+    assert_equal [], DocWithSameDefaults.properties[:foo].default
+    assert doc.foo.push 'foo'
+    assert_equal ['foo'], doc.foo
+    assert_equal [], DocWithSameDefaults.properties[:foo].default
+    assert second_doc = DocWithSameDefaults.new
+    assert_equal [], second_doc.foo
+  end
+
+  test 'attach_file! will add a standalone attachment to the document' do
+    assert save_response = {ok: true, id: "base_dolly/79178957-96ff-40d9-9ecb-217fa35bdea7", rev: "1"}
+    assert FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/base_dolly%2F.+/, body: save_response.to_json
+    assert doc = BaseDolly.new
+    assert doc.save
+    assert resp = {ok: true, id: '79178957-96ff-40d9-9ecb-217fa35bdea7', rev: '2'}
+    assert FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/base_dolly\/79178957-96ff-40d9-9ecb-217fa35bdea7\/test.txt/, body: resp.to_json
+    assert data = File.open("#{FileUtils.pwd}/test/support/test.txt").read
+    assert doc.attach_file! 'test.txt', 'text/plain', data
+  end
+
+  test 'attach_file! will add an inline attachment if specified' do
+    assert save_response = {ok: true, id: "base_dolly/79178957-96ff-40d9-9ecb-217fa35bdea7", rev: "1"}
+    assert FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/base_dolly%2F.+/, body: save_response.to_json
+    assert doc = BaseDolly.new
+    assert doc.save
+    assert resp = {ok: true, id: '79178957-96ff-40d9-9ecb-217fa35bdea7', rev: '2'}
+    assert FakeWeb.register_uri :put, /http:\/\/localhost:5984\/test\/base_dolly\/79178957-96ff-40d9-9ecb-217fa35bdea7\/test.txt/, body: resp.to_json
+    assert data = File.open("#{FileUtils.pwd}/test/support/test.txt").read
+    assert doc.attach_file! 'test.txt', 'text/plain', data, inline: true
+    assert doc.doc['_attachments']['test.txt'].present?
+    assert_equal Base64.encode64(data), doc.doc['_attachments']['test.txt']['data']
+  end
+
   private
   def generic_response rows, count = 1
     {total_rows: count, offset:0, rows: rows}