couchpillow 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b500f6013d468a7d8dda1e7eee6298520a76244d
-  data.tar.gz: a5b75ca81bfaaffaa5a8e7264fa2caa2f0f6b64f
+  metadata.gz: 3185ef13356f6eadae67b5b1e57d3af472a3e545
+  data.tar.gz: 9954f18c4e2469738fabab9ff8e3c9cd0409e681
 SHA512:
-  metadata.gz: 36bc6d363f9b5f44ce2105bb9e1178b648fe6932eaa90937c40dbce10f33ddf04d38da4a4ea3ca430e9fe245077dd412e41efd9a360daf57ba7e6550629c9d9f
-  data.tar.gz: 8405f987a7711209aea4c01d8d6911eec27d553c1671e595653b09157d9b6e6ea292176662ee3b51fd5d2c24021c4d2167d0571426fb05db060c727345811d82
+  metadata.gz: ffd1543a372cd2fa2431d70b9210532ad04ed94398d8b4a54b1ed233070eaeb6dafcc8437e687790a954d3b9a5636e644e50b045ad4e70ab72c3803a47423013
+  data.tar.gz: cedf8d10d9b414c100797b505667da6010d8e6b0088bc73d2646e33456ea859d29b86a3dac0f4958da4fc656631be1de9fb940ffcb7568c3e09d077b14845611

data/.gitignore

@@ -1,3 +1,5 @@
 *.gem
 *.swp
 tags
+.yardoc
+doc

data/lib/couchpillow/document.rb

@@ -2,9 +2,16 @@ module CouchPillow
   
   class Document
 
+    # Validation Error.
+    #
     class ValidationError < StandardError; end
 
 
+    # Faux Boolean class used for type checking and conversion.
+    #
+    class Boolean; end
+
+
     attr_reader :id
 
 
@@ -47,6 +54,7 @@ module CouchPillow
     end
 
 
+    # @private
     # Map hash keys to methods
     #
     def method_missing m, *args, &block
@@ -64,6 +72,8 @@ module CouchPillow
     end
 
 
+    # @private
+    #
     def respond_to? m
       ms = m.to_s
       return true if ms.end_with?("=")
@@ -72,6 +82,8 @@ module CouchPillow
     end
 
 
+    # @private
+    #
     def timestamp!
       @data[:updated_at] = Time.now.utc
     end
@@ -143,12 +155,14 @@ module CouchPillow
 
     def validate
       self.class.validate_keys.each do |k, msg, method|
-        raise ValidationError, "#{k} #{msg}" unless
+        raise ValidationError, "[#{k}, #{@data[k]}] #{msg}" unless
           @data.has_key?(k) && method.call(@data[k])
       end
     end
 
 
+    # Rename the keys in this Document as specified by the {rename} directive.
+    #
     def rename!
       self.class.rename_keys.each do |from, to|
         @data.has_key?(from) and
@@ -158,6 +172,9 @@ module CouchPillow
     end
 
 
+    # Ensure types of the values in the Document are converted to the type
+    # specified in the {validate_type} method.
+    #
     def ensure_types!
       self.class.type_keys.each do |k, t|
         if value = @data[k] and !value.is_a?(t)
@@ -171,12 +188,17 @@ module CouchPillow
             @data[k] = Array(value)
           elsif t == Time
             @data[k] = Time.parse(value)
+          elsif t == Boolean
+            @data[k] = value == 0 || !value ? false : true
           end
         end
       end
     end
 
 
+    # Filter this Document through the whitelist as specified by the
+    # {whitelist} directive.
+    #
     def whitelist!
       unless self.class.whitelist_keys.empty?
         @data.select! do |k, v|
@@ -189,7 +211,7 @@ module CouchPillow
 
     # Get a Document given an id.
     #
-    # @returns nil if Document is of a different type.
+    # @return nil if Document is of a different type.
     #
     def self.get id
       result = CouchPillow.db.get(id) and
@@ -200,16 +222,13 @@ module CouchPillow
     end
 
 
+    # Sets the type of this Document.
+    #
     def self.type value
       @type = value.to_s
     end
 
 
-    def self._type
-      @type
-    end
-
-
     # Rename an existing key to a new key. This is invoked right after
     # initialize.
     #
@@ -231,23 +250,35 @@ module CouchPillow
 
     # Validate the type of a particular key.
     #
+    # @example
+    #   validate_type :name, String
+    #
     def self.validate_type key, type
-      validate key, "is not the correct type. Expected a #{type}", lambda { |v| v.is_a? type }
+      validate key, "#{key} is not the correct type. Expected a #{type}", lambda { |v| v.is_a? type }
       type_keys << [key, type]
     end
 
 
+    # Validate the type is a Boolean, since Ruby lacks a Boolean class.
+    #
+    # @example
+    #   validate_type_boolean :available, Boolean
+    #
+    def self.validate_type_boolean key
+      validate key, "#{key} is not the correct type. Expected a Boolean", lambda { |v| !!v == v }
+      type_keys << [key, Boolean]
+    end
+
+
     # Validate the presence of a particular key using a custom validation method.
-    # If block is omitted, it only validates the existence of the key.
     #
     # @param key Key to be validated.
     # @param message Message that will be displayed when validation fails.
-    #   Will be appended after the key.
     # @yield [v] Value of the key.
     #   The block must return truthy for it to pass the validation.
     #
     # @example
-    #   validate :first_name, 'does not exist', lambda { |v| !v.nil? }
+    #   validate :first_name, 'first name is not Joe', lambda { |v| v != "Joe" }
     #
     def self.validate key, message, block
       raise ValidationError, "Provide validation method for key #{key}" unless block
@@ -257,13 +288,15 @@ module CouchPillow
 
     # This Document should only accept keys that are specified here.
     # The existence of these keys are optional, and won't trigger any validation
-    # unless specified by the validate methods. Hashes passed to update and
-    # initialize will be filtered through this list.
+    # unless specified by the validate methods. Hashes passed to {#update} and
+    # {#initialize} will be filtered through this list.
     #
     # If you don't specify a whitelist, Document will accept any keys, but
     # once you specify it, only those keys will be accepted and the rest will
     # be dropped.
     #
+    # @param list Whitelist of keys.
+    #
     # @example
     #   whitelist :first_name, :last_name, :address
     #
@@ -277,6 +310,13 @@ module CouchPillow
     private
 
 
+    # Read the type of this Document. Internal use only.
+    #
+    def self._type
+      @type
+    end
+
+
     def self.rename_keys
       @rename_keys ||= []
     end

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.3.9"
+  VERSION = "0.3.10"
 end

data/test/test_document.rb

@@ -108,6 +108,21 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_validate_type_boolean
+    d = Class.new(Document) do
+      validate_type_boolean :abc
+    end.new
+
+    d.abc = "other type"
+    assert_raises Document::ValidationError do
+      d.save!
+    end
+
+    d.abc = true
+    d.save!
+  end
+
+
   def test_validate_type_also_ensures_types_on_create_integer
     klass = Class.new(Document) do
       type "test"
@@ -196,6 +211,34 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_validate_type_also_ensures_types_on_create_boolean
+    klass = Class.new(Document) do
+      type "test"
+      validate_type_boolean :abc
+    end
+
+    # true
+    CouchPillow.db.
+      expects(:get).
+      with('123').
+      returns( { '_type' => 'test', 'abc' => 1 } )
+
+    d = klass.get('123')
+    assert d
+    assert_equal true, d.abc
+
+    # false
+    CouchPillow.db.
+      expects(:get).
+      with('123').
+      returns( { '_type' => 'test', 'abc' => 0 } )
+
+    d = klass.get('123')
+    assert d
+    assert_equal false, d.abc
+  end
+
+
   def test_validate_custom
     d = Class.new(Document) do
       validate :xyz, "must be Numeric", lambda { |v| v.is_a? Numeric }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest