couchpillow 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efc31e058fa2047dbc8783576c421912a9d27e2f
-  data.tar.gz: fd0d87f1485ec3b5419cc1063b09e3da2724a31e
+  metadata.gz: 3ee5cf9a4867bd4fa3ab19cb9ad0e1401fa94dce
+  data.tar.gz: 56f2d1e20e5a33755946c1e3c7d1147663be2cae
 SHA512:
-  metadata.gz: 40bc500b602c184c47ebfc60bed01a45ffd3c3167ef8f0b8419d4af97e6a31fe22ef372705d3bc09019cc7d6f64ba226778a7a6075fc553084be18d66542beea
-  data.tar.gz: a1c50b1e702d784e695794a770eeacf7daee7151182bd193f9ac58aef01d82e341096c661691a11ad7c0dd1abb8471d76a1a5ae462a2cfa0baa9f717c3ca41d9
+  metadata.gz: de31833c33e134ee6dd08dd35416b80b76249bf06d69187be8d8f7e74828e8698945adcd060187f9eefa2b89d6ff0836e992151b732e16fbbbc6b4fc877d4972
+  data.tar.gz: 78fb2de9b1356819ce87dbd754be463d79bf056c96175f3f92cc52442fe28d1d26594c51cb71f5f94c99c0269857dd2b457444b35c51b81eb718d0688a6034a4

data/README.markdown

@@ -68,8 +68,9 @@ Overriding `CouchPillow::Document`
 Using validation
 
     class User < CouchPillow::Document
-      type :user
+      type              :user
       validate_presence :email
+      validate_type     :first_name, String
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
@@ -95,6 +96,17 @@ Using custom validation blocks
     doc.phone = 123
     doc.save! # Success!
 
+Using `rename` to rename keys. Useful to maintain document integrity.
+
+    class User < CouchPillow::Document
+      rename :username, :nickname
+    end
+    u = User.new( { :username => 'jdoe' } )
+    u.nickname # 'jdoe'
+
+
+## Design Docs and Views
+
 What about Design Docs and Views? They are outside the scope of CouchPillow.
 However, given a design doc named `my_design_doc` and a View named `by_email`,
 that returns documents as values, you can easily use it like this:

data/lib/couchpillow/document.rb

@@ -25,6 +25,7 @@ module CouchPillow
 
       raise TypeError if @data[:_type] && @data[:_type] != self.class._type
       @data[:_type] = self.class._type
+      rename!
     end
 
 
@@ -113,6 +114,15 @@ module CouchPillow
     end
 
 
+    def rename!
+      self.class.rename_keys.each do |from, to|
+        @data.has_key?(from) and
+          @data[to] = @data[from] and
+          @data.delete(from)
+      end
+    end
+
+
     def self.get id
       new(CouchPillow.db.get(id), id)
     end
@@ -128,8 +138,10 @@ module CouchPillow
     end
 
 
-    def self.design_doc value
-      @ddoc = value
+    # Rename an existing key to a new key. This is invoked right after initialize.
+    #
+    def self.rename from, to
+      rename_keys << [from.to_s.to_sym, to.to_s.to_sym]
     end
 
 
@@ -141,6 +153,13 @@ module CouchPillow
     end
 
 
+    # Validate the type of a particular key.
+    #
+    def self.validate_type key, type
+      validate key, "is not the correct type. Expected a #{type}", lambda { |v| v.is_a? type }
+    end
+
+
     # Validate the presence of a particular key using a custom validation method.
     # Implies the Document must contain the key.
     #
@@ -153,6 +172,11 @@ module CouchPillow
     private
 
 
+    def self.rename_keys
+      @rename_keys ||= []
+    end
+
+
     def self.validate_keys
       @validate_key ||= []
     end

data/lib/couchpillow/version.rb

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

data/test/test_document.rb

@@ -5,12 +5,7 @@ require './lib/couchpillow.rb'
 
 class TestDocument < Minitest::Test
 
-  class TestDoc < CouchPillow::Document
-    type              :test
-    validate_presence :xyz
-    validate          :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }
-  end
-
+  Document = CouchPillow::Document
 
   def mock_time
     return @time if @time
@@ -31,13 +26,13 @@ class TestDocument < Minitest::Test
 
 
   def test_create
-    d = CouchPillow::Document.new
+    d = Document.new
     d.save!
   end
 
 
   def test_timestamp
-    d = CouchPillow::Document.new({}, "1")
+    d = Document.new({}, "1")
     d.save!
     assert d.created_at
     assert d.updated_at
@@ -45,20 +40,24 @@ class TestDocument < Minitest::Test
 
 
   def test_type
-    d = CouchPillow::Document.new({}, "1")
+    d = Document.new({}, "1")
     assert_equal "default", d._type
   end
 
 
   def test_type_subclasses
-    d = TestDoc.new({}, "1")
+    d = Class.new(Document) do
+      type 'test'
+    end.new
     assert_equal "test", d._type
   end
 
 
   def test_validate_presence
-    d = TestDoc.new
-    assert_raises CouchPillow::Document::ValidationError do
+    d = Class.new(Document) do
+      validate_presence :xyz
+    end.new
+    assert_raises Document::ValidationError do
       d.save!
     end
 
@@ -67,15 +66,32 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_validate_type
+    d = Class.new(Document) do
+      validate_type     :abc, Hash
+    end.new
+
+    d.abc = "other type"
+    assert_raises Document::ValidationError do
+      d.save!
+    end
+
+    d.abc = { :hello => "world" }
+    d.save!
+  end
+
+
   def test_validate_custom
-    d = TestDoc.new
+    d = Class.new(Document) do
+      validate          :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }
+    end.new
     d.xyz = "string"
-    assert_raises CouchPillow::Document::ValidationError do
+    assert_raises Document::ValidationError do
       d.save!
     end
 
     d.xyz = {}
-    assert_raises CouchPillow::Document::ValidationError do
+    assert_raises Document::ValidationError do
       d.save!
     end
 
@@ -86,13 +102,13 @@ class TestDocument < Minitest::Test
 
   def test_to_json
     mock_time
-    d = CouchPillow::Document.new({}, "1")
+    d = Document.new({}, "1")
     assert_equal "{\"_id\":\"1\",\"created_at\":\"#{mock_time.to_s}\",\"_type\":\"default\"}", d.to_json
   end
   
 
   def test_brackets
-    d = CouchPillow::Document.new({})
+    d = Document.new({})
     d[123] = 'test'
     assert_equal 'test', d[123]
 
@@ -105,4 +121,16 @@ class TestDocument < Minitest::Test
     assert_equal nil, d[:something_else]
   end
 
+
+  def test_rename_keys
+    d = Class.new(Document) do
+      rename :foo, :bar
+    end.new( { :foo => 123, :other => 'abc' } )
+    assert_equal 123, d[:bar]
+    assert_equal 123, d.bar
+    assert_equal nil, d[:foo]
+    refute d.respond_to?(:foo)
+    assert_equal 'abc', d.other
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Albert Tedja