couchpillow 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ee5cf9a4867bd4fa3ab19cb9ad0e1401fa94dce
-  data.tar.gz: 56f2d1e20e5a33755946c1e3c7d1147663be2cae
+  metadata.gz: dd27aa70e0b7f3922ff6580ead5c85c0ad3cbf48
+  data.tar.gz: 7b15227e763211f3638452b5604949b77c5038aa
 SHA512:
-  metadata.gz: de31833c33e134ee6dd08dd35416b80b76249bf06d69187be8d8f7e74828e8698945adcd060187f9eefa2b89d6ff0836e992151b732e16fbbbc6b4fc877d4972
-  data.tar.gz: 78fb2de9b1356819ce87dbd754be463d79bf056c96175f3f92cc52442fe28d1d26594c51cb71f5f94c99c0269857dd2b457444b35c51b81eb718d0688a6034a4
+  metadata.gz: b21d6f6094133fd122e9f3f473c3affcb0e5e268a393138321d0ca7451c57c5d3268fff7afb3abe848abaa563c1f7901d62e19e6e382c47af1572e429ff02a41
+  data.tar.gz: 018d26070dc1111eae361f086fac5317e86fbb01b439a8b8233c16ef68fd8be80fa12cdf14fe316c15d8f790d5788ca2e7d1656a83bb940c7f49571ed31f3d42

data/README.markdown

@@ -1,22 +1,25 @@
 # CouchPillow
 
-Light and comfortable Document wrapper for Couchbase Server.
+Light and comfortable Document wrapper and integrity tool for Couchbase Server.
 
 
 ## Why CouchPillow?
 
-Yet another ORM? Not quite. CouchPillow separates itself from the database
-drivers, making it light and independent from the implementation.
+Yet another ORM? Not quite. CouchPillow is a wrapper to Couchbase Documents
+and also an integrity tool to make sure that all current and existing documents
+can work nicely with the current code.
 
-Although it is initially designed to work with Couchbase Server, one can
-easily extend this to other NoSQL drivers as long as they `respond_to?`
-the `set`, `delete`, `replace`, and `get` methods.
+CouchPillow separates itself from the database drivers, making it light and
+independent from the implementation.  Although it is initially designed to work
+with Couchbase Server, one can easily extend this to other NoSQL drivers as
+long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
 
 
 ## Features
 
-- Automatic timestamp
-- Validation
+- Automatic id generation.
+- Automatic timestamp.
+- Built-in and custom data validations.
 
 
 ## Installation
@@ -40,13 +43,13 @@ the `set`, `delete`, `replace`, and `get` methods.
     # }
 
 
-Retrieving Documents
+Retrieving Documents:
 
     doc = CouchPillow::Document.get('123')
     doc.stuff # '123'
   
 
-Overriding `CouchPillow::Document`
+Overriding `CouchPillow::Document`:
 
     class User < CouchPillow::Document
       type :user
@@ -65,7 +68,7 @@ Overriding `CouchPillow::Document`
     #   'updated_at': '2014-07-04 00:00:00 UTC'
     # }
 
-Using validation
+Using built-in validation methods:
 
     class User < CouchPillow::Document
       type              :user
@@ -79,18 +82,15 @@ Using validation
     doc.email = 'john@email.com'
     doc.save! # Success!
 
-Using custom validation blocks
+Using custom validation blocks:
 
     class User < CouchPillow::Document
       type :user
-      validate_presence :email
       validate :phone, 'is not a number', lambda { |v| v.is_a? Numeric }
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
     doc = User.new
-    doc.email = 'john@email.com'
-    doc.first_name = 'john'
     doc.phone = '123'
     doc.save! # raises ValidationError('phone is not a number')
     doc.phone = 123

data/lib/couchpillow/document.rb

@@ -13,15 +13,21 @@ module CouchPillow
 
     PRESENCE_LAMBDA = lambda do |value| !value.nil? end
 
+    RESERVED_KEYS = %i[_id _type created_at updated_at]
+
 
     def initialize hash = {}, id = SecureRandom.hex
       @data = self.class.symbolize(hash)
       @id = id
 
       @data[:created_at] and
+        @data[:created_at].is_a? String and
         @data[:created_at] = Time.parse(@data[:created_at]) or
         @data[:created_at] = Time.now.utc
-      @data[:updated_at] = Time.parse(@data[:updated_at]) if @data[:updated_at]
+
+      @data[:updated_at] and
+        @data[:updated_at].is_a? String and
+        @data[:updated_at] = Time.parse(@data[:updated_at])
 
       raise TypeError if @data[:_type] && @data[:_type] != self.class._type
       @data[:_type] = self.class._type
@@ -141,6 +147,9 @@ module CouchPillow
     # Rename an existing key to a new key. This is invoked right after initialize.
     #
     def self.rename from, to
+      raise ArgumentError, "Cannot rename reserved keys" if
+        RESERVED_KEYS.include?(from) || RESERVED_KEYS.include?(to)
+
       rename_keys << [from.to_s.to_sym, to.to_s.to_sym]
     end
 

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/couchpillow.rb

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'json'
+require 'time'
 
 module CouchPillow
 

data/test/helper.rb

@@ -0,0 +1,32 @@
+require './lib/couchpillow.rb'
+
+
+class FakeCouchbaseServer
+
+  def initialize
+    @storage = {}
+  end
+
+
+  def set id, data
+    @storage[id] = data
+  end
+
+
+  def delete id
+    @storage.delete(id)
+  end
+
+
+  def replace id, data
+    @storage.has_key?(id) or raise "Document does not exist"
+    @storage[id] = data
+  end
+
+
+  def get id
+    @storage[id]
+  end
+end
+
+

data/test/test_document.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'mocha/mini_test'
-require './lib/couchpillow.rb'
+require './test/helper.rb'
 
 class TestDocument < Minitest::Test
 
@@ -16,12 +16,7 @@ class TestDocument < Minitest::Test
 
 
   def setup
-    @db = mock('couchbaseserver')
-    @db.stubs(:set)
-    @db.stubs(:delete)
-    @db.stubs(:replace)
-    @db.stubs(:get)
-    CouchPillow.db = @db
+    CouchPillow.db = FakeCouchbaseServer.new
   end
 
 
@@ -83,7 +78,7 @@ class TestDocument < Minitest::Test
 
   def test_validate_custom
     d = Class.new(Document) do
-      validate          :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }
+      validate :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }
     end.new
     d.xyz = "string"
     assert_raises Document::ValidationError do
@@ -133,4 +128,31 @@ class TestDocument < Minitest::Test
     assert_equal 'abc', d.other
   end
 
+
+  def test_rename_keys_reserved_keys
+    assert_raises ArgumentError do
+      d = Class.new(Document) do
+        rename :_id, :bad
+      end.new
+    end
+
+    assert_raises ArgumentError do
+      d = Class.new(Document) do
+        rename :_type, :err
+      end.new
+    end
+
+    assert_raises ArgumentError do
+      d = Class.new(Document) do
+        rename :created_at, :err
+      end.new
+    end
+
+    assert_raises ArgumentError do
+      d = Class.new(Document) do
+        rename :bla, :updated_at
+      end.new
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,6 +66,7 @@ files:
 - lib/couchpillow.rb
 - lib/couchpillow/document.rb
 - lib/couchpillow/version.rb
+- test/helper.rb
 - test/test_document.rb
 homepage: https://github.com/atedja/pillow
 licenses: