couchpillow 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c941b4db98918cd72e334fb39d97ce2bb6ea24b
-  data.tar.gz: 28babdcc130a232e33d10f72c8771291729b45ce
+  metadata.gz: c8a125e7eabce1a8d19853040151e38791c57d07
+  data.tar.gz: ec143b133ab55a2ec34ec2fd7b4f3c9b84831fad
 SHA512:
-  metadata.gz: 5350184abf2713d2385ebb6c810047696fe38dc37a9ec2984777d8099ec342afc363ed0257e75933930dc6269b3a2f049a51a5a1420ce7dbaf6ee453758db808
-  data.tar.gz: d0428814d6e6811a16c43db27f096a55472f2c82b7fcb1e957f4f654e477033907af5a35bf9f72a30938183ff1e43999de52b1400c96be1a40c16b1091231f03
+  metadata.gz: 0d3ce4a39378e5fbe15e642bcee30e97a03506316741c6ee5e3a242398a3b249e79f2ee6e88d08279bb57aabd3f07968f3c1430930921cf8b310efc42f8b4d5c
+  data.tar.gz: ddf7c4cc0c9ade106a817bd89d3557248933e167c8faadf3db1fd6855d911accbca5bbea68866c0633c449381099161e7082b79401c1d0485159b8f161632a42

data/README.markdown

@@ -22,7 +22,7 @@ methods.
     gem install couchpillow
 
 
-## How To Use
+## Quick Start
 
     require 'couchpillow'
 
@@ -62,16 +62,47 @@ Specifying custom id:
     doc.save!
 
     # {
-    #   '_id': '123',
+    #   '_id': 'user::123',
     #   '_type': 'user',
     #   '_created_at': '2014-07-04 00:00:00 UTC'
     #   '_updated_at': '2014-07-04 00:00:00 UTC'
     #   'email': 'john@email.com',
     # }
 
+
+### Document-Level Directives
+
+The following are directives that can be used to trigger specific behaviors
+at the Document level.
+
+* `type(T)`
+
+  Set the type of the Document.
+
+* `type_prefix(true|false)`
+
+  Default to `true`. If set to false, it removes prefixing document id with
+  the document type. Leaving this to true is the recommended behavior to avoid
+  id conflicts between different types of documents, especially when custom
+  ids are being used.
+
+* `attribute(name, &block)`
+
+  Declares an attribute for this Document. You can specify additional
+  directives for each attribute. See Attributes section.
+
+* `db(connection)`
+
+  Sets the database connections. If set once, it will set that connection as
+  the primary connection.  Any subsequent calls to this directive will set
+  those connections as secondary connections.  See Multiple DB Connections
+  section.
+
+
+
 ### Attributes
 
-Using Attribute Directives:
+Using Attribute Directive:
 
     class User < CouchPillow::Document
       type :user
@@ -164,8 +195,8 @@ via the `db` directive.  Example:
 
 You can also specify multiple `db` directives. The first time the `db`
 directive is called, it sets that connection as the primary connection, as the
-above example shows. Any subsequent calls will insert that DB connection as
-secondary connections, which will only be trigger on write (`save!`, `update!`,
+above example shows. Any subsequent calls will insert those DB connection as
+secondary connections, which will only trigger on write (`save!`, `update!`,
 and `delete!`).
 
 

data/lib/couchpillow.rb

@@ -1,13 +1,10 @@
 require 'securerandom'
 require 'json'
 require 'time'
-require 'celluloid/autostart'
 require 'couchbase'
 
 module CouchPillow
 
-  Celluloid.logger = nil
-
   def self.db= driver
     @db = driver
   end
@@ -18,8 +15,11 @@ module CouchPillow
 
 end
 
-require 'couchpillow/attribute'
-require 'couchpillow/attributive'
+require 'couchpillow/directives/type'
+require 'couchpillow/directives/type_prefix'
+require 'couchpillow/directives/attribute'
+require 'couchpillow/directives/multi_db'
+
 require 'couchpillow/errors'
 require 'couchpillow/boolean'
 require 'couchpillow/document'

data/lib/couchpillow/{attribute.rb → directives/attribute.rb}

@@ -1,5 +1,36 @@
 module CouchPillow
 
+  module AttributeDirective
+
+    # Declares a new Attribute
+    #
+    def attribute attr, &block
+      attr = attr.to_s.to_sym
+      new_attr = Attribute.new(attr)
+      attributes[attr] = new_attr
+
+      # Define accessor methods
+      define_method(attr) do
+        @data[attr]
+      end
+      define_method("#{attr}=") do |val|
+        @data[attr] = val
+      end
+
+      new_attr.instance_eval &block if block
+
+      new_attr
+    end
+
+
+    def attributes
+      @attributes ||= {}
+    end
+
+
+  end
+
+
   class Attribute
 
     attr_reader :name
@@ -8,7 +39,6 @@ module CouchPillow
     @type = nil
     @auto_convert = false
     @default_block = nil
-    @check_value_message = nil
     @check_value_block = nil
 
 
@@ -69,18 +99,16 @@ module CouchPillow
 
     # Directive to perform a validation over the value of this Attribute.
     #
-    # @param message Message when block passed fails. Optional.
     # @yield [v] Value of the Attribute.
     #
     # @example
-    #   content("Name must be John") { |v| v == "John" }
     #   content { |v| v == "John" }
     #
-    def content message = nil, &block
-      @check_value_message = message
+    def content &block
       @check_value_block = block
       self
     end
+    alias_method :validate_content, :content
 
 
     # Check the default value.
@@ -96,7 +124,7 @@ module CouchPillow
     #
     def trigger_content_directive value
       if @check_value_block
-        raise ValidationError, @check_value_message unless
+        raise ValidationError, "Content validation error: #{value}" unless
           @check_value_block.call(value)
       end
       value
@@ -110,10 +138,11 @@ module CouchPillow
         # Run auto-conversion first.
         value = trigger_auto_convert_directive(value)
 
+        msg = "Type mismatch for attribute #{@name}"
         if @type == CouchPillow::Boolean
-          raise ValidationError unless !!value == value
+          raise ValidationError, msg unless !!value == value
         else
-          raise ValidationError unless value.is_a?(@type)
+          raise ValidationError, msg unless value.is_a?(@type)
         end
       end
 
@@ -157,5 +186,3 @@ module CouchPillow
 
   end
 end
-
-

data/lib/couchpillow/directives/multi_db.rb

@@ -0,0 +1,70 @@
+require 'celluloid/autostart'
+
+Celluloid.logger = nil
+
+module CouchPillow
+
+  module MultiDBDirective
+
+    # Set a DB connection. Overrides the default CouchPillow.db connection
+    # for the first time this method gets called. Subsequent calls will set
+    # secondary connections, which will only be used for write only.
+    #
+    # Example:
+    #    db primary_db # use for both read and write
+    #    db backup_db1 # write only
+    #    db backup_db2 # write only
+    #
+    def db conn
+      # set the primary db connection
+      @primary_db ||= conn
+
+      # insert as backup db connections
+      if conn && @primary_db && conn != @primary_db
+        _secondary_dbs << conn
+      end
+    end
+
+
+    def _default_db
+      @default_db ||= (@primary_db || CouchPillow.db)
+    end
+
+
+    def _secondary_dbs
+      @secondary_dbs ||= []
+    end
+
+
+    def _write_to_secondary_dbs &block
+      unless _secondary_dbs.empty?
+        _futures << Celluloid::Future.new do
+          _secondary_dbs.each do |db|
+            block.call(db)
+          end
+        end
+      end
+    end
+
+
+    def _futures
+      @futures ||= []
+    end
+
+
+    # Blocks until all pending tasks has completed.
+    # Returns the result of those tasks in an array.
+    #
+    def wait
+      result = []
+      until _futures.empty?
+        f = _futures.shift
+        result << f.value
+      end
+
+      result
+    end
+
+  end
+
+end

data/lib/couchpillow/directives/type.rb

@@ -0,0 +1,28 @@
+module CouchPillow
+
+  module TypeDirective
+
+    # Sets the type of this Document.
+    #
+    def type value
+      @type = value.to_s
+    end
+
+
+    def _doc_type
+      @type ||= "couchpillow"
+    end
+
+
+    # Helper method to sanitize an id string
+    #
+    def _sanitize_id id
+      key = "#{_doc_type}::"
+      id = id.to_s
+      id.start_with?(key) and
+        id = id[key.length..-1] or
+        id
+    end
+
+  end
+end

data/lib/couchpillow/directives/type_prefix.rb

@@ -0,0 +1,16 @@
+module CouchPillow
+
+  module TypePrefixDirective
+
+
+    def type_prefix v
+      @type_prefix = v == true
+    end
+
+
+    def _is_type_prefixed?
+      @type_prefix == true
+    end
+
+  end
+end

data/lib/couchpillow/document.rb

@@ -2,19 +2,23 @@ module CouchPillow
   
   class Document
 
-    extend Attributive
+    extend TypeDirective
+    extend TypePrefixDirective
+    extend AttributeDirective
+    extend MultiDBDirective
 
-    attr_reader :id
+    attr_accessor :id
 
     RESERVED_KEYS = %i[_id _type _created_at _updated_at]
 
-    DEFAULT_TYPE = "couchpillow".freeze
-
     EVENTS = [ :cas_conflict ].freeze
 
     CAS_CONFLICT_RETRY_COUNT = 5
 
 
+    type_prefix true
+
+
     attribute :_created_at do
       required
       type Time
@@ -37,19 +41,18 @@ module CouchPillow
     # @param flags Flags of the document, from the CB client. Optional.
     #
     def initialize hash = {},
-                   id = "#{self.class.doc_type}::#{SecureRandom.hex}",
+                   id = SecureRandom.hex,
                    cas = nil
 
       @data = self.class.symbolize(hash)
       @original = Marshal.load(Marshal.dump(@data))
 
-      @id = id
+      @id = self.class._is_type_prefixed? ? self.class._sanitize_id(id) : id
+
       time = Time.now.utc
       @data[:_created_at] ||= time
       @data[:_updated_at] = time
 
-      @futures = []
-
       @cas = cas
 
       rename!
@@ -75,19 +78,19 @@ module CouchPillow
       result = nil
 
       # write to the primary db first
-      result = cas_handler do
+      result = _cas_handler do
         whitelist!
         sort!
-        timestamp!
+        _timestamp!
         validate!
         opts[:cas] = @cas
-        self.class.default_db.set(@id, to_save, opts)
+        self.class._default_db.set(db_id, _to_save, opts)
       end
 
       # write to the secondary only if the primary succeeds
       # and ignore CAS for secondary DBs.
-      write_to_secondary_dbs do |db|
-        db.set @id, to_save
+      self.class._write_to_secondary_dbs do |db|
+        db.set(db_id, _to_save)
       end if result
 
       result
@@ -97,11 +100,11 @@ module CouchPillow
     # Delete this document from the server.
     #
     def delete!
-      result = self.class.default_db.delete @id
+      result = self.class._default_db.delete(db_id)
 
       # write to the secondary only if the primary succeeds
-      write_to_secondary_dbs do |db|
-        db.delete @id
+      self.class._write_to_secondary_dbs do |db|
+        db.delete(db_id)
       end if result
 
       result
@@ -114,20 +117,20 @@ module CouchPillow
     def update! opts = {}
 
       # write to the primary db first
-      result = cas_handler do
+      result = _cas_handler do
         whitelist!
         sort!
-        timestamp!
+        _timestamp!
         validate!
         opts[:cas] = @cas
-        result = self.class.default_db.replace(@id, to_save, opts)
+        result = self.class._default_db.replace(db_id, _to_save, opts)
       end
 
       # write to the secondary only if the primary succeeds
       # and ignore CAS for secondary DBs.
       opts.delete :cas
-      write_to_secondary_dbs do |db|
-        db.replace @id, to_save
+      self.class._write_to_secondary_dbs do |db|
+        db.replace(db_id, _to_save)
       end if result
 
       result
@@ -165,7 +168,7 @@ module CouchPillow
     # Convert this Document to a Hash
     #
     def to_hash
-      { :_id => @id, :_type => self.class.doc_type }.merge!(@data)
+      { :_id => @id, :_type => doc_type }.merge!(@data)
     end
 
 
@@ -173,21 +176,7 @@ module CouchPillow
     # Can't really name this `type`. Need to avoid name conflict with Ruby's own `type` method.
     #
     def doc_type
-      self.class.doc_type
-    end
-
-
-    # Blocks until all pending tasks has completed. 
-    # Returns the result of those tasks in an array.
-    #
-    def wait
-      result = []
-      until @futures.empty?
-        f = @futures.shift
-        result << f.value
-      end
-
-      result
+      self.class._doc_type
     end
 
 
@@ -256,11 +245,13 @@ module CouchPillow
     # @return nil if not found or Document is of a different type.
     #
     def self.get id
-      result, _, cas = default_db.get(id, extended: true)
+      id = _sanitize_id(id)
+      tid = _is_type_prefixed? ? "#{_doc_type}::#{id}" : id
+      result, _, cas = _default_db.get(tid, extended: true)
 
       result and
         type = result[:_type] || result["_type"] and
-        type == doc_type and
+        type == _doc_type and
         new(result, id, cas) or
         nil
     end
@@ -277,33 +268,6 @@ module CouchPillow
     end
 
 
-    # Sets the type of this Document.
-    #
-    def self.type value
-      @type = value.to_s
-    end
-
-
-    # Set a DB connection. Overrides the default CouchPillow.db connection
-    # for the first time this method gets called. Subsequent calls will set
-    # secondary connections, which will only be used for write only.
-    #
-    # Example:
-    #    db primary_db # use for both read and write
-    #    db backup_db1 # write only
-    #    db backup_db2 # write only
-    #
-    def self.db conn
-      # set the primary db connection
-      @primary_db ||= conn
-
-      # insert as backup db connections
-      if conn && @primary_db && conn != @primary_db
-        secondary_dbs << conn
-      end
-    end
-
-
     # Registers a listener on a specific event.
     # See {EVENTS} constant for a list of accepted events.
     #
@@ -312,28 +276,27 @@ module CouchPillow
     end
 
 
+    # Inherit directives
+    def self.inherited subclass
+      attributes.each do |k, v|
+        subclass.attributes[k] = v
+      end
+      subclass.type_prefix(_is_type_prefixed?)
+      subclass.type(_doc_type)
+    end
+
+
     private
 
 
     # Timestamp this document
     #
-    def timestamp!
+    def _timestamp!
       @data[:_updated_at] = Time.now.utc
     end
 
 
-    def write_to_secondary_dbs &block
-      unless self.class.secondary_dbs.empty?
-        @futures << Celluloid::Future.new do
-          self.class.secondary_dbs.each do |db|
-            block.call(db)
-          end
-        end
-      end
-    end
-
-
-    def cas_handler &block
+    def _cas_handler &block
       # write to the primary db first
       rtcount = CAS_CONFLICT_RETRY_COUNT
       begin
@@ -343,13 +306,13 @@ module CouchPillow
         raise
 
       rescue Couchbase::Error::KeyExists
-        other_doc, _, newcas = self.class.default_db.get(@id, extended: true)
+        other_doc, _, newcas = self.class._default_db.get(db_id, extended: true)
         raise CASError, "There is a CAS conflict, but DB does not yield a document" unless other_doc
         raise CASError, "There is a CAS conflict, but no :cas_conflict handler has been defined. See 'on' directive." unless self.class.event_listeners[:cas_conflict]
 
         # resolve conflict
         other_doc = self.class.symbolize(other_doc)
-        @data = self.class.event_listeners[:cas_conflict].call(@original, other_doc, to_save)
+        @data = self.class.event_listeners[:cas_conflict].call(@original, other_doc, _to_save)
         @cas = newcas
 
         rtcount -= 1
@@ -363,20 +326,23 @@ module CouchPillow
     # Get the final hash that will be saved to the database.
     # Check if data has been modified.
     #
-    def to_save
+    def _to_save
       hash = @data.hash
       return @tos if @tos && @toshash && @toshash == hash
 
       @tos = @data.merge({
-        :_type => self.class.doc_type
+        :_type => doc_type
       })
       @toshash = @data.hash
       @tos
     end
 
 
-    def self.doc_type
-      @type ||= DEFAULT_TYPE
+    # Get the final id value that will be saved to the database.
+    #
+    def db_id
+      @id = self.class._sanitize_id(@id)
+      self.class._is_type_prefixed? ? "#{doc_type}::#{@id}" : @id
     end
 
 
@@ -385,16 +351,6 @@ module CouchPillow
     end
 
 
-    def self.default_db
-      @default_db ||= (@primary_db || CouchPillow.db)
-    end
-
-
-    def self.secondary_dbs
-      @secondary_dbs ||= []
-    end
-
-
     def self.event_listeners
       @event_listeners ||= {}
     end

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/test/test_document.rb

@@ -209,8 +209,8 @@ class TestDocument < Minitest::Test
 
 
   def test_get_returns_nil
-    CouchPillow.db.expects(:get).with('123', { extended: true }).returns(nil)
-    Document.expects(:default_db).returns(CouchPillow.db)
+    CouchPillow.db.expects(:get).with('couchpillow::123', { extended: true }).returns(nil)
+    Document.expects(:_default_db).returns(CouchPillow.db)
     d = Document.get('123')
     assert_equal nil, d
   end
@@ -221,11 +221,6 @@ class TestDocument < Minitest::Test
       type 'test'
     end
 
-    CouchPillow.db
-      .expects(:get)
-      .with('123', { extended: true })
-      .returns( { '_type' => 'something else', 'stuff' => 'data' } )
-
     d = klass.get('123')
     assert_equal nil, d
   end
@@ -417,7 +412,7 @@ class TestDocument < Minitest::Test
   def test_custom_db_connection
     conn1 = FakeCouchbaseServer.new
 
-    d = Class.new(Document) do
+    klass = Class.new(Document) do
       type 'test'
 
       db conn1
@@ -428,20 +423,16 @@ class TestDocument < Minitest::Test
         required
         default { "tester" }
       end
+    end
 
-
-      def initialize doc = {}
-        super(doc, "1")
-      end
-
-    end.new
+    d = klass.new({}, "1")
     d.foo = "hello"
     d.save!
 
-    fromdefdb = CouchPillow.db.get("1")
+    fromdefdb = CouchPillow.db.get("test::1")
     assert_nil fromdefdb
 
-    fromprimdb = conn1.get("1")
+    fromprimdb = conn1.get("test::1")
     assert_equal "hello", fromprimdb[:foo]
   end
 
@@ -451,8 +442,9 @@ class TestDocument < Minitest::Test
     db2 = FakeCouchbaseServer.new
     db3 = FakeCouchbaseServer.new
 
-    d = Class.new(Document) do
+    klass = Class.new(Document) do
       type 'test'
+      type_prefix false
 
       db db1
       db db2
@@ -465,16 +457,13 @@ class TestDocument < Minitest::Test
         default { "tester" }
       end
 
+    end
 
-      def initialize doc = {}
-        super(doc, "1")
-      end
-
-    end.new
+    d = klass.new( {}, "1" )
     d.foo = "hello"
     d.save!
 
-    res = d.wait
+    res = klass.wait
 
     data = db1.get("1")
     assert_equal "hello", data[:foo]
@@ -551,4 +540,124 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_type_prefix_directive_default
+    assert Document._is_type_prefixed?, "type_prefix default is not true"
+  end
+
+
+  def test_type_prefix_directive_false
+    klass = Class.new(Document) do
+      type 'test'
+      type_prefix false
+
+      attribute :foo do
+        type String
+      end
+    end
+
+    d = klass.new( { foo: "Hello" } , "10" )
+    d.save!
+
+    dataindb = CouchPillow.db.get("10")
+    assert dataindb
+    assert_equal "Hello", dataindb[:foo]
+  end
+
+
+  def test_type_prefix_directive_true
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+      end
+    end
+
+    d = klass.new( { foo: "Hello" } , "10" )
+    assert_equal "10", d.id
+    d.save!
+
+    d1 = klass.get("10")
+    assert_equal "Hello", d1.foo
+
+    dataindb = CouchPillow.db.get("test::10")
+    assert dataindb
+    assert_equal "Hello", dataindb[:foo]
+  end
+
+
+  def test_new_with_type_prefix
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+      end
+    end
+
+    d = klass.new( { foo: "Hello" } , "test::10" )
+    assert_equal "10", d.id
+
+    d = klass.new( { foo: "Hello" } , "wrong::10" )
+    assert_equal "wrong::10", d.id
+
+    klass = Class.new(Document) do
+      type 'test'
+      type_prefix false
+
+      attribute :foo do
+        type String
+      end
+    end
+
+    d = klass.new( { foo: "Hello" } , "test::10" )
+    assert_equal "test::10", d.id
+
+    d = klass.new( { foo: "Hello" } , "wrong::10" )
+    assert_equal "wrong::10", d.id
+  end
+
+
+  def test_content_directive
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        content { |v| v == "must" }
+      end
+    end
+
+    d = klass.new( foo: "Hello" )
+
+    assert_raises CouchPillow::ValidationError do
+      d.save!
+    end
+
+    d.foo = "must"
+    d.save!
+  end
+
+
+  def test_validate_content_alias
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        validate_content { |v| v == "must" }
+      end
+    end
+
+    d = klass.new( foo: "Hello" )
+
+    assert_raises CouchPillow::ValidationError do
+      d.save!
+    end
+
+    d.foo = "must"
+    d.save!
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -92,9 +92,11 @@ files:
 - Rakefile
 - couchpillow.gemspec
 - lib/couchpillow.rb
-- lib/couchpillow/attribute.rb
-- lib/couchpillow/attributive.rb
 - lib/couchpillow/boolean.rb
+- lib/couchpillow/directives/attribute.rb
+- lib/couchpillow/directives/multi_db.rb
+- lib/couchpillow/directives/type.rb
+- lib/couchpillow/directives/type_prefix.rb
 - lib/couchpillow/document.rb
 - lib/couchpillow/errors.rb
 - lib/couchpillow/version.rb

data/lib/couchpillow/attributive.rb

@@ -1,39 +0,0 @@
-module CouchPillow
-
-  module Attributive
-
-    # Declares a new Attribute
-    #
-    def attribute attr, &block
-      attr = attr.to_s.to_sym
-      new_attr = Attribute.new(attr)
-      attributes[attr] = new_attr
-
-      # Define accessor methods
-      define_method(attr) do
-        @data[attr]
-      end
-      define_method("#{attr}=") do |val|
-        @data[attr] = val
-      end
-
-      new_attr.instance_eval &block if block
-
-      new_attr
-    end
-
-
-    def attributes
-      @attributes ||= {}
-    end
-
-
-    def inherited(subclass)
-      # Copy existing attributes to subclasses
-      attributes.each do |k, v|
-        subclass.attributes[k] = v
-      end
-    end
-
-  end
-end