couchpillow 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d84be9337a6dfe5e7c16a73c9b4a7158121270b
-  data.tar.gz: bb05ae6199ee43110587cef9d50ebf1ddb68eeb2
+  metadata.gz: 8766ff55f2a06b3e6a73581eb02a5add86407868
+  data.tar.gz: e4b22c670eefa9f68deb5f4bf5de5db8dfa03613
 SHA512:
-  metadata.gz: 4beacbd56fbcd07aff7c44bf25edaf557857c85d8ff253194286fd42b2f1b39a1388d0aad69f834b4ff2d45d780fb245ad69787d189fa75bd6619678f3c26a55
-  data.tar.gz: 329f5fe5aecfb16772275b08533ec80b691868183d65e69df4fa51e228bc0f0dd50213270fbab93363d0442c7a415e2194adb06b205563a156e7c697a195f862
+  metadata.gz: d8fd8cec7c43b888807d46a1faac51ed83087b1d7a2af8a85ebff8ec517b8937a8b26bf8cb76bc06213eec4c711d4f51de41190b7c4abde78c7c21acce6cd166
+  data.tar.gz: c793792ad45b53674963350e3b740d0b3310e1a10a5b8379a387cee46692c9d1e21d79625e1c44ef13054c9071c9bf485fb218d050a641bc46928d4393bd344d

data/README.markdown

@@ -2,11 +2,8 @@
 
 Light and comfortable Document integrity tool for Couchbase Server.
 
-
-## Why CouchPillow?
-
-CouchPillow is an integrity tool for Couchbase Documents to make sure that all
-current and existing documents can work nicely with the current code.
+CouchPillow is a document integrity tool for Couchbase Documents to make sure
+that all current and existing documents can work nicely with the current code.
 
 CouchPillow separates itself from the database drivers, making it light and
 independent from the implementation.  Although it is initially designed to work
@@ -40,7 +37,7 @@ long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
     doc.save!
     
     # {
-    #   '_id': 'my_document_fb579b265cc005c47ff420a5c2a15d2b',
+    #   '_id': 'my_document::fb579b265cc005c47ff420a5c2a15d2b',
     #   '_type': 'my_document',
     #   'stuff': 'hello',
     #   '_created_at': '2014-07-04 00:00:00 UTC'
@@ -50,10 +47,10 @@ long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
 
 Retrieving Documents:
 
-    doc = MyDocument.get('123')
+    doc = MyDocument.get('my_document::fb579b265cc005c47ff420a5c2a15d2b')
     doc.stuff # 'hello'
 
-Specifying custom id:
+Specifying custom id if the auto-generated id is too confusing:
 
     class User < CouchPillow::Document
       type :user
@@ -116,14 +113,14 @@ List of Attribute Directives:
 * `content(&block)`
 
    Custom validation method to check the value of the attribute. This is useful
-   in cases where you only want certain values to be stored (e.g a number between
-   1-10 only)
+   in cases where you only want certain values to be stored (e.g a number
+   between 1-10 only)
 
 
 ### Migration
 
 Using `rename` to rename keys. Useful to maintain document integrity
-from a migration.
+after a migration.
 
     class User < CouchPillow::Document
       rename :username, :nickname
@@ -132,6 +129,11 @@ from a migration.
     u = User.new( { :username => 'jdoe' } )
     u.nickname # 'jdoe'
 
+Rename triggers per-document basis. You can use this on a separate script
+that queries each document in the database and updates them, or you can
+simply use this inside your application code, so it only migrates the document
+as it reads them.
+
 
 
 ## Design Docs and Views

data/lib/couchpillow/attribute.rb

@@ -108,21 +108,7 @@ module CouchPillow
     def trigger_type_directive value
       if @type
         # Run auto-conversion first.
-        if @auto_convert
-          if @type == Integer
-            value = Integer(value)
-          elsif @type == Float
-            value = Float(value)
-          elsif @type == String
-            value = String(value)
-          elsif @type == Array
-            value = Array(value)
-          elsif @type == Time && !value.is_a?(Time)
-            value = Time.parse(value)
-          elsif @type == CouchPillow::Boolean
-            value = value == 0 || value.to_s.downcase == "false" || !value ? false : true
-          end
-        end
+        value = trigger_auto_convert_directive(value)
 
         if @type == CouchPillow::Boolean
           raise ValidationError unless !!value == value
@@ -135,6 +121,28 @@ module CouchPillow
     end
 
 
+    # Auto convert the value
+    #
+    def trigger_auto_convert_directive value
+      if @auto_convert
+        if @type == Integer
+          value = Integer(value)
+        elsif @type == Float
+          value = Float(value)
+        elsif @type == String
+          value = String(value)
+        elsif @type == Array
+          value = Array(value)
+        elsif @type == Time && !value.is_a?(Time)
+          value = Time.parse(value)
+        elsif @type == CouchPillow::Boolean
+          value = value == 0 || value.to_s.downcase == "false" || !value ? false : true
+        end
+      end
+      value
+    end
+
+
     # Run the validation directives, except required directive.
     # First it executes the {default} directive, then {auto_convert} to type,
     # then {type} validation, then finally the {content} directive.

data/lib/couchpillow/attributive.rb

@@ -4,7 +4,7 @@ module CouchPillow
 
     # Declares a new Attribute
     #
-    def attribute attr
+    def attribute attr, &block
       attr = attr.to_s.to_sym
       new_attr = Attribute.new(attr)
       attributes[attr] = new_attr
@@ -17,6 +17,8 @@ module CouchPillow
         @data[attr] = val
       end
 
+      new_attr.instance_eval &block if block
+
       new_attr
     end
 

data/lib/couchpillow/document.rb

@@ -32,6 +32,8 @@ module CouchPillow
 
       rename!
       whitelist!
+      assign_defaults!
+      auto_convert!
     end
 
 
@@ -54,7 +56,7 @@ module CouchPillow
 
     # Save this document to the server
     #
-    def save!
+    def save! opts = {}
       whitelist!
       sort!
       timestamp!
@@ -62,7 +64,7 @@ module CouchPillow
       to_save = @data.merge({
         :_type => self.class._type
       })
-      CouchPillow.db.set @id, to_save
+      CouchPillow.db.set(@id, to_save, opts)
     end
 
 
@@ -136,6 +138,24 @@ module CouchPillow
     end
 
 
+    # Assign default value
+    #
+    def assign_defaults!
+      self.class.attributes.each do |k, attr|
+        @data[k] = attr.trigger_default_directive if !has?(k) && attr.has_default?
+      end
+    end
+
+
+    # Auto convert.
+    #
+    def auto_convert!
+      self.class.attributes.each do |k, attr|
+        @data[k] = attr.trigger_auto_convert_directive(@data[k]) if has?(k)
+      end
+    end
+
+
     # Go through each attribute, and validate the values.
     # Validation also perform auto-conversion if auto-conversion is enabled
     # for that attribute.

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/test/helper.rb

@@ -12,7 +12,7 @@ class FakeCouchbaseServer
   end
 
 
-  def set id, data
+  def set id, data, opts = {}
     @storage[id] = data
   end
 

data/test/test_document.rb

@@ -323,4 +323,74 @@ class TestDocument < Minitest::Test
     k.save!
   end
 
+
+  def test_auto_convert_triggers_on_initialize
+    d = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .type(String).auto_convert
+      attribute(:not_auto)
+        .type(Integer)
+    end.new( foo: 1, not_auto: "100" )
+
+    assert_equal "1", d.foo
+    assert_equal "100", d.not_auto
+  end
+
+
+  def test_dsl_style
+    d = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+      end
+
+      attribute :bar do
+        type Integer
+        auto_convert
+        required
+      end
+    end.new( foo: 1, bar: "100" )
+
+    assert_equal "1", d.foo
+    assert_equal 100, d.bar
+  end
+
+
+  def test_assign_default_value_at_creation
+    d = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+
+    end.new
+
+    assert_equal "tester", d.foo
+  end
+
+
+  def test_ttl_support
+    d = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+
+    end.new
+
+    d.save! ttl: 100
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Document wrapper for Couchbase