couchpillow 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8d1a9b1e1c0a5043f07017b455ec96f31830800
-  data.tar.gz: 96e4d51f5aaf2e8f38cb0c5e1092514560c51544
+  metadata.gz: 34fd1e52575f6546ba76d939d3a14144fed532d4
+  data.tar.gz: 33b2e8b67740bda40d43d152347466a18aa31ec9
 SHA512:
-  metadata.gz: 4d61133ab2fc75c1233e623f9c650038ada2f9b783625c5e245df56f671aad0eaa3c4ef76bf96ed6beaea22cd1ad86355d40f8713a21a2bef96ac02aae1c33fe
-  data.tar.gz: 152f3eb87627b85497698277b26a46f19a3af229d6c955aef296f83a6c016d264ec850f6a8db0b6b1b3be085c8b341526f2233b8bedbeeb338d1b3ec12034aa5
+  metadata.gz: 7c081d50a39666f337b3a487ed08d892df31724705919ff26fe52ac33ca4a53ea68610b7f3abaf9684e979fb30ba95b890efd264cab04b3301a5e27c71e98fd0
+  data.tar.gz: a634742fd125c01fe9b84e67c1cdfba916667a7a701d4725b0ca1b7b451b0e47db06657db11c8f504fbd1547b5d1bb8e95bc253ac2cb1b91a9ac97b34e39399c

data/README.markdown

@@ -103,6 +103,17 @@ Using `rename` to rename keys. Useful to maintain document integrity.
     u = User.new( { :username => 'jdoe' } )
     u.nickname # 'jdoe'
 
+Using `whitelist` to whitelist keys. Also useful to maintain document integrity
+and keeping other fields from being saved. Keep in mind that when loading
+existing documents and if they have keys that are not listed on the whitelist,
+those keys will be dropped upon `save!`.
+
+    class User < CouchPillow::Document
+      whitelist :name
+    end
+    u = User.new( { :age => 10, :name => 'John' } )
+    u.has?(:age) # false
+
 
 ## Design Docs and Views
 

data/lib/couchpillow/document.rb

@@ -32,6 +32,7 @@ module CouchPillow
       raise TypeError if @data[:_type] && @data[:_type] != self.class._type
       @data[:_type] = self.class._type
       rename!
+      whitelist!
       ensure_types!
     end
 
@@ -54,7 +55,11 @@ module CouchPillow
         ms.gsub!('=', '')
         @data[ms.to_sym] = args[0]
       else
-        @data[m] if @data.has_key?(m) or super
+        if @data.has_key?(m)
+          @data[m]
+        else
+          super
+        end
       end
     end
 
@@ -75,6 +80,7 @@ module CouchPillow
     # Save this document to the server
     #
     def save!
+      whitelist!
       validate
       sort!
       timestamp!
@@ -100,6 +106,7 @@ module CouchPillow
     # exist in the database.
     #
     def update!
+      whitelist!
       validate
       sort!
       timestamp!
@@ -115,6 +122,12 @@ module CouchPillow
       hash.each do |k,v|
         @data[k.to_sym] = v
       end
+      whitelist!
+    end
+
+
+    def has? key
+      @data.has_key?(key)
     end
 
 
@@ -164,6 +177,16 @@ module CouchPillow
     end
 
 
+    def whitelist!
+      unless self.class.whitelist_keys.empty?
+        @data.select! do |k, v|
+          RESERVED_KEYS.include?(k) ||
+            self.class.whitelist_keys.include?(k)
+        end
+      end
+    end
+
+
     # Get a Document given an id.
     #
     # @returns nil if Document is of a different type.
@@ -187,7 +210,8 @@ module CouchPillow
     end
 
 
-    # Rename an existing key to a new key. This is invoked right after initialize.
+    # 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
@@ -214,7 +238,16 @@ module CouchPillow
 
 
     # Validate the presence of a particular key using a custom validation method.
-    # Implies the Document must contain the key.
+    # 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? }
     #
     def self.validate key, message, block
       raise ValidationError, "Provide validation method for key #{key}" unless block
@@ -222,6 +255,25 @@ module CouchPillow
     end
 
 
+    # 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.
+    #
+    # 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.
+    #
+    # @example
+    #   whitelist :first_name, :last_name, :address
+    #
+    def self.whitelist *list
+      list.each do |k|
+        whitelist_keys << k.to_s.to_sym
+      end
+    end
+
+
     private
 
 
@@ -240,6 +292,11 @@ module CouchPillow
     end
 
 
+    def self.whitelist_keys
+      @whitelist_keys ||= []
+    end
+
+
     def self.symbolize hash
       hash.inject({}) do |memo,(k,v)|
         memo[k.to_sym] = v

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/test/test_document.rb

@@ -215,6 +215,19 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_whitelist
+    d = Class.new(Document) do
+      whitelist :a, :b, :c
+    end.new
+    d.update({a: 1, b: 2, c: 3, d: 4})
+    assert d.save!
+    assert_equal 1, d.a
+    assert_equal 2, d.b
+    assert_equal 3, d.c
+    assert_equal false, d.has?(:d)
+  end
+
+
   def test_to_json
     mock_time
     d = Document.new({}, "1")

metadata

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