couchpillow 0.3.10 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3185ef13356f6eadae67b5b1e57d3af472a3e545
-  data.tar.gz: 9954f18c4e2469738fabab9ff8e3c9cd0409e681
+  metadata.gz: cb55c110b2b546a414fc253680530a0be2d4525b
+  data.tar.gz: 8aee488a67a464972655088b9976777f4a7649ae
 SHA512:
-  metadata.gz: ffd1543a372cd2fa2431d70b9210532ad04ed94398d8b4a54b1ed233070eaeb6dafcc8437e687790a954d3b9a5636e644e50b045ad4e70ab72c3803a47423013
-  data.tar.gz: cedf8d10d9b414c100797b505667da6010d8e6b0088bc73d2646e33456ea859d29b86a3dac0f4958da4fc656631be1de9fb940ffcb7568c3e09d077b14845611
+  metadata.gz: d30b27dc47e70736de216834c2c93721dc536809f90adb06942daedf5ab6d98da0c04c438153a6defe3ecca3737c7599d96279f88335162d7ac831aab71b5c85
+  data.tar.gz: 1c3e5a11b8098a3038e00026a3fc9c97060aaa4f6e50c189c9d4988f46fe689d9a3d29a37d5bcf320342122300b8278a7dcf3c22278796983a5bd5c1b0073967

data/README.markdown

@@ -30,89 +30,108 @@ long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
 
     require 'couchpillow'
 
+    class MyDocument < CouchPillow::Document
+      type :my_document
+      attribute(:stuff)
+    end
+
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
-    doc = CouchPillow::Document.new( { :stuff => 'hello' }, '123' )
+    doc = CouchPillow::Document.new( { :stuff => 'hello' } )
     doc.save!
     
     # {
-    #   '_type': 'default',
+    #   '_id': 'my_document_fb579b265cc005c47ff420a5c2a15d2b',
+    #   '_type': 'my_document',
     #   'stuff': 'hello',
-    #   'created_at': '2014-07-04 00:00:00 UTC'
-    #   'updated_at': '2014-07-04 00:00:00 UTC'
+    #   '_created_at': '2014-07-04 00:00:00 UTC'
+    #   '_updated_at': '2014-07-04 00:00:00 UTC'
     # }
 
 
 Retrieving Documents:
 
-    doc = CouchPillow::Document.get('123')
+    doc = MyDocument.get('123')
     doc.stuff # 'hello'
-  
 
-Overriding `CouchPillow::Document`:
+Specifying custom id:
 
     class User < CouchPillow::Document
       type :user
+      attribute(:email)
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
-    doc = User.new( { :email => 'john@email.com' } )
+    doc = User.new( { :email => 'john@email.com' }, '123' )
     doc.email # 'john@email.com'
     doc.save!
 
     # {
-    #   '_id': 'fb579b265cc005c47ff420a5c2a15d2b',
+    #   '_id': '123',
     #   '_type': 'user',
     #   'email': 'john@email.com',
     #   'created_at': '2014-07-04 00:00:00 UTC'
     #   'updated_at': '2014-07-04 00:00:00 UTC'
     # }
 
-Using built-in validation methods:
+### Attributes
+
+Using Attribute Directives:
 
     class User < CouchPillow::Document
       type              :user
-      validate_presence :email
-      validate_type     :first_name, String
+      attribute(:email)
+        .required
+
+      attribute(:first_name)
+        .type(String)
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
     doc = User.new( { :first_name => 'John' } )
-    doc.save! # raises ValidationError('email is missing')
+    doc.save! # raises ValidationError "Attribute 'email' is missing"
     doc.email = 'john@email.com'
     doc.save! # Success!
 
-Using custom validation blocks:
+List of Attribute Directives:
 
-    class User < CouchPillow::Document
-      type :user
-      validate :phone, 'is not a number', lambda { |v| v.is_a? Numeric }
-    end
+* `required`
 
-    CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
-    doc = User.new
-    doc.phone = '123'
-    doc.save! # raises ValidationError('phone is not a number')
-    doc.phone = 123
-    doc.save! # Success!
+  Sets this attribute as required. Will raise an error if attribute is missing
+  upon `save!` or `update!`
+
+* `type(T)`
 
-Using `rename` to rename keys. Useful to maintain document integrity.
+   Sets the type of this attribute. Will perform type check if specified.
+
+* `auto_convert`
+
+   Enables auto-conversion to the specified type. This gets ignored if `type`
+   directive is not specified.
+
+* `default(&block)`
+
+   Runs the block to set the default value for this attribute, if it's missing
+   or nil.
+
+* `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)
+
+
+### Migration
+
+Using `rename` to rename keys. Useful to maintain document integrity
+from a migration.
 
     class User < CouchPillow::Document
       rename :username, :nickname
+      attribute(:nickname)
     end
     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
@@ -123,5 +142,5 @@ that returns documents as values, you can easily use it like this:
 
     CouchPillow.db.design_docs['my_design_doc'].
       by_email(:body => { :key => 'john@email.com' }).map do |v|
-        new User(v.value, v.id)
+        new User(v.doc, v.id)
       end

data/lib/couchpillow/attribute.rb

@@ -0,0 +1,153 @@
+module CouchPillow
+
+  class Attribute
+
+    attr_reader :name
+
+    @required = false
+    @type = nil
+    @auto_convert = false
+    @default_block = nil
+    @check_value_message = nil
+    @check_value_block = nil
+
+
+    def initialize name
+      @name = name.to_s.to_sym
+    end
+
+
+    # Directive to mark this Attribute as required.
+    #
+    def required
+      @required = true
+      self
+    end
+
+
+    def required?
+      @required
+    end
+
+
+    # Directive to enforce the data type of this Attribute.
+    #
+    def type t
+      @type = t
+      self
+    end
+
+
+    # Attempts to auto convert values to the type specified by the {type}
+    # directive if the value is not of the same type.
+    # Has no effect if {type} is not specified.
+    #
+    def auto_convert
+      @auto_convert = true
+      self
+    end
+
+
+    # Directive to set the default value of this Attribute. Once specified, if
+    # this Attribute does not exist during the Document initialization, whether
+    # that's from {Document.get} or {Document#initialize}, the value of the
+    # Attribute will be set to the value returned by the block.
+    #
+    # @yield Sets the value of this Attribute to the value returned by the
+    #   block.
+    #
+    def default &block
+      @default_block = block
+      self
+    end
+
+
+    def has_default?
+      @default_block != nil
+    end
+
+
+    # Directive to perform a validation over the value of this Attribute.
+    #
+    # @param message Message when block passed fails. Optional.
+    # @yield [v] Value of the Attribute.
+    #
+    # @example
+    #   content("Name must be John") { |v| v == "John" }
+    #   content { |v| v == "John" }
+    #
+    def content message = nil, &block
+      @check_value_message = message
+      @check_value_block = block
+      self
+    end
+
+
+    # Check the default value.
+    #
+    # @param value The value of this attribute to validate.
+    #
+    def trigger_default_directive
+      @default_block.call if has_default?
+    end
+
+
+    # Check value.
+    #
+    def trigger_content_directive value
+      if @check_value_block
+        raise ValidationError, @check_value_message unless
+          @check_value_block.call(value)
+      end
+      value
+    end
+
+
+    # Check type.
+    #
+    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
+
+        if @type == CouchPillow::Boolean
+          raise ValidationError unless !!value == value
+        else
+          raise ValidationError unless value.is_a?(@type)
+        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.
+    #
+    # @return The final value after the validation.
+    #
+    def validate value
+      value = trigger_default_directive if value.nil?
+      trigger_content_directive(trigger_type_directive(value))
+    end
+
+
+  end
+end
+
+

data/lib/couchpillow/attributive.rb

@@ -0,0 +1,37 @@
+module CouchPillow
+
+  module Attributive
+
+    # Declares a new Attribute
+    #
+    def attribute attr
+      attr = attr.to_s.to_sym
+      new_attr = Attribute.new(attr)
+      attributes[attr] = new_attr
+
+      # Define accessor methods
+      define_method(attr) do
+        @data[attr]
+      end
+      define_method("#{attr}=") do |val|
+        @data[attr] = val
+      end
+
+      new_attr
+    end
+
+
+    def attributes
+      @attributes ||= {}
+    end
+
+
+    def inherited(subclass)
+      # Copy existing attributes to subclasses
+      attributes.each do |k, v|
+        subclass.attributes[k] = v
+      end
+    end
+
+  end
+end

data/lib/couchpillow/boolean.rb

@@ -0,0 +1,8 @@
+module CouchPillow
+
+  # Faux Boolean class used for type checking and conversion.
+  #
+  class Boolean
+  end
+
+end

data/lib/couchpillow/document.rb

@@ -2,45 +2,36 @@ module CouchPillow
   
   class Document
 
-    # Validation Error.
-    #
-    class ValidationError < StandardError; end
-
-
-    # Faux Boolean class used for type checking and conversion.
-    #
-    class Boolean; end
-
+    extend Attributive
 
     attr_reader :id
 
+    RESERVED_KEYS = %i[_id _type _created_at _updated_at]
 
-    @type = "default"
+    DEFAULT_TYPE = "default".freeze
 
 
-    PRESENCE_LAMBDA = lambda do |value| !value.nil? end
+    attribute(:_created_at)
+      .required
+      .type(Time).auto_convert
+      .default { Time.now.utc }
 
-    RESERVED_KEYS = %i[_id _type created_at updated_at]
+    attribute(:_updated_at)
+      .required
+      .type(Time).auto_convert
+      .default { Time.now.utc }
 
 
-    def initialize hash = {}, id = SecureRandom.hex
+    def initialize hash = {}, id = "#{self.class._type}_#{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] and
-        @data[:updated_at].is_a? String and
-        @data[:updated_at] = Time.parse(@data[:updated_at])
+      @id = id
+      time = Time.now.utc
+      @data[:_created_at] ||= time
+      @data[:_updated_at] = time
 
-      raise TypeError if @data[:_type] && @data[:_type] != self.class._type
-      @data[:_type] = self.class._type
       rename!
       whitelist!
-      ensure_types!
     end
 
 
@@ -54,38 +45,10 @@ module CouchPillow
     end
 
 
-    # @private
-    # Map hash keys to methods
-    #
-    def method_missing m, *args, &block
-      ms = m.to_s
-      if ms.end_with?("=")
-        ms.gsub!('=', '')
-        @data[ms.to_sym] = args[0]
-      else
-        if @data.has_key?(m)
-          @data[m]
-        else
-          super
-        end
-      end
-    end
-
-
-    # @private
-    #
-    def respond_to? m
-      ms = m.to_s
-      return true if ms.end_with?("=")
-      @data.has_key?(m) or
-        super
-    end
-
-
     # @private
     #
     def timestamp!
-      @data[:updated_at] = Time.now.utc
+      @data[:_updated_at] = Time.now.utc
     end
 
 
@@ -93,10 +56,13 @@ module CouchPillow
     #
     def save!
       whitelist!
-      validate
+      validate!
       sort!
       timestamp!
-      CouchPillow.db.set @id, @data
+      to_save = @data.merge({
+        :_type => self.class._type
+      })
+      CouchPillow.db.set @id, to_save
     end
 
 
@@ -107,34 +73,32 @@ module CouchPillow
     end
 
 
-    # Sort keys on this document.
-    #
-    def sort!
-      @data = @data.sort.to_h
-    end
-
-
     # Attempt to update this Document. Fails if this Document does not yet
     # exist in the database.
     #
     def update!
       whitelist!
-      validate
+      validate!
       sort!
       timestamp!
-      CouchPillow.db.replace @id, @data
+      to_save = @data.merge({
+        :_type => self.class._type
+      })
+      CouchPillow.db.replace @id, to_save
     end
 
 
     # Updates the attributes in the document.
     # Existing attributes will be overwritten and new ones will be added.
-    # Existing attributes that are not present in the hash will be ignored.
+    # Any other existing attributes that are not present in the hash will be ignored.
     #
     def update hash
       hash.each do |k,v|
         @data[k.to_sym] = v
       end
+      rename!
       whitelist!
+      validate!
     end
 
 
@@ -149,15 +113,7 @@ module CouchPillow
 
 
     def to_hash
-      { :_id => @id }.merge!(@data)
-    end
-
-
-    def validate
-      self.class.validate_keys.each do |k, msg, method|
-        raise ValidationError, "[#{k}, #{@data[k]}] #{msg}" unless
-          @data.has_key?(k) && method.call(@data[k])
-      end
+      { :_id => @id, :_type => self.class._type }.merge!(@data)
     end
 
 
@@ -172,63 +128,61 @@ module CouchPillow
     end
 
 
-    # Ensure types of the values in the Document are converted to the type
-    # specified in the {validate_type} method.
+    # Cleanup the @data hash so it only contains relevant fields.
     #
-    def ensure_types!
-      self.class.type_keys.each do |k, t|
-        if value = @data[k] and !value.is_a?(t)
-          if t == Integer
-            @data[k] = Integer(value)
-          elsif t == Float
-            @data[k] = Float(value)
-          elsif t == String
-            @data[k] = String(value)
-          elsif t == Array
-            @data[k] = Array(value)
-          elsif t == Time
-            @data[k] = Time.parse(value)
-          elsif t == Boolean
-            @data[k] = value == 0 || !value ? false : true
-          end
-        end
+    def whitelist!
+      @data.delete_if do |k, v|
+        !self.class.attributes.has_key?(k)
       end
     end
 
 
-    # Filter this Document through the whitelist as specified by the
-    # {whitelist} directive.
+    # Go through each attribute, and validate the values.
+    # Validation also perform auto-conversion if auto-conversion is enabled
+    # for that attribute.
     #
-    def whitelist!
-      unless self.class.whitelist_keys.empty?
-        @data.select! do |k, v|
-          RESERVED_KEYS.include?(k) ||
-            self.class.whitelist_keys.include?(k)
+    def validate!
+      self.class.attributes.each do |k, attr|
+        if has?(k)
+          @data[k] = attr.validate(@data[k]) if has?(k)
+        else
+          @data[k] = attr.trigger_default_directive if attr.has_default?
+          raise ValidationError, "Attribute '#{k}' is required" if attr.required? && !has?(k)
         end
       end
     end
 
 
+    # Sort keys on this document.
+    #
+    def sort!
+      @data = @data.sort.to_h
+    end
+
+
+    def _type
+      self.class._type
+    end
+
+
+    def _id
+      @id
+    end
+
+
     # Get a Document given an id.
     #
-    # @return nil if Document is of a different type.
+    # @return nil if not found or Document is of a different type.
     #
     def self.get id
       result = CouchPillow.db.get(id) and
-        type = result['_type'] and
-        type == self._type and
+        type = result[:_type] || result["_type"] and
+        type == _type and
         new(result, id) or
         nil
     end
 
 
-    # Sets the type of this Document.
-    #
-    def self.type value
-      @type = value.to_s
-    end
-
-
     # Rename an existing key to a new key. This is invoked right after
     # initialize.
     #
@@ -240,80 +194,18 @@ module CouchPillow
     end
 
 
-    # Validate the presence of a particular key, and the value of that key
-    # cannot be nil.
-    #
-    def self.validate_presence key
-      validate key, "is missing", PRESENCE_LAMBDA
-    end
-
-
-    # Validate the type of a particular key.
-    #
-    # @example
-    #   validate_type :name, String
-    #
-    def self.validate_type key, 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.
-    #
-    # @param key Key to be validated.
-    # @param message Message that will be displayed when validation fails.
-    # @yield [v] Value of the key.
-    #   The block must return truthy for it to pass the validation.
-    #
-    # @example
-    #   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
-      validate_keys << [key, message, block]
-    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.
-    #
-    # @param list Whitelist of keys.
-    #
-    # @example
-    #   whitelist :first_name, :last_name, :address
+    # Sets the type of this Document.
     #
-    def self.whitelist *list
-      list.flatten.each do |k|
-        whitelist_keys << k.to_s.to_sym
-      end
+    def self.type value
+      @type = value.to_s
     end
 
 
     private
 
 
-    # Read the type of this Document. Internal use only.
-    #
     def self._type
-      @type
+      @type ||= DEFAULT_TYPE
     end
 
 
@@ -322,26 +214,12 @@ module CouchPillow
     end
 
 
-    def self.type_keys
-      @type_keys ||= []
-    end
-
-
-    def self.validate_keys
-      @validate_keys ||= []
-    end
-
-
-    def self.whitelist_keys
-      @whitelist_keys ||= []
-    end
-
-
     def self.symbolize hash
       hash.inject({}) do |memo,(k,v)|
         memo[k.to_sym] = v
         memo
       end
     end
+
   end
 end

data/lib/couchpillow/validation_error.rb

@@ -0,0 +1,8 @@
+module CouchPillow
+
+  # Validation Error.
+  #
+  class ValidationError < StandardError
+  end
+
+end

data/lib/couchpillow/version.rb

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

data/lib/couchpillow.rb

@@ -14,5 +14,9 @@ module CouchPillow
 
 end
 
+require 'couchpillow/attribute'
+require 'couchpillow/attributive'
+require 'couchpillow/validation_error'
+require 'couchpillow/boolean'
 require 'couchpillow/document'
 require 'couchpillow/version'

data/test/helper.rb

@@ -1,5 +1,9 @@
 require './lib/couchpillow.rb'
 
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'mocha/mini_test'
+
 
 class FakeCouchbaseServer
 

data/test/test_attribute.rb

@@ -0,0 +1,122 @@
+require './test/helper.rb'
+
+class TestAttribute < Minitest::Test
+
+  Attribute = CouchPillow::Attribute
+
+
+  def test_required
+    attr = Attribute.new(:batman).required
+    assert_equal true, attr.required?
+  end
+
+
+  def test_type
+    attr = Attribute.new(:batman).type(String)
+    assert_equal "hello", attr.validate("hello")
+    assert_raises CouchPillow::ValidationError do
+      attr.validate(1)
+    end
+  end
+
+
+  def test_auto_convert_integer
+    attr = Attribute.new(:batman).type(Integer).auto_convert
+    assert_equal 1000, attr.validate(1000)
+    assert_equal 1000, attr.validate("1000")
+  end
+
+
+  def test_auto_convert_float
+    attr = Attribute.new(:batman).type(Float).auto_convert
+    assert_equal 1000.01, attr.validate(1000.01)
+    assert_equal 1000.01, attr.validate("1000.01")
+  end
+
+
+  def test_auto_convert_string
+    attr = Attribute.new(:batman).type(String).auto_convert
+    assert_equal "hello", attr.validate("hello")
+    assert_equal "1", attr.validate(1)
+  end
+
+
+  def test_auto_convert_array
+    attr = Attribute.new(:batman).type(Array).auto_convert
+    assert_equal ["hello"], attr.validate(["hello"])
+    assert_equal [1], attr.validate(1)
+  end
+
+
+  def test_auto_convert_time
+    attr = Attribute.new(:batman).type(Time).auto_convert
+    time = attr.validate("2014/7/14")
+    assert time.is_a?(Time)
+    assert_equal 2014, time.year
+    assert_equal 7, time.month
+    assert_equal 14, time.day
+
+    time = attr.validate(Time.now.utc)
+    assert time
+  end
+
+
+  def test_auto_convert_boolean
+    attr = Attribute.new(:batman).type(CouchPillow::Boolean).auto_convert
+    assert_equal false, attr.validate("false")
+    assert_equal true, attr.validate("123")
+    assert_equal true, attr.validate(1)
+    assert_equal false, attr.validate(0)
+    assert_equal false, attr.validate(nil)
+  end
+
+
+  def test_default
+    attr = Attribute.new(:batman).default { "John" }
+    assert_equal "John", attr.validate(nil)
+  end
+
+
+  def test_has_default
+    attr = Attribute.new(:batman).default { "John" }
+    assert_equal true, attr.has_default?
+
+    no_default_attr = Attribute.new(:batman)
+    assert_equal false, no_default_attr.has_default?
+  end
+
+
+  def test_content
+    attr = Attribute.new(:batman).content { |v| v == "John" }
+    assert_raises CouchPillow::ValidationError do
+      attr.validate("Jim")
+    end
+    attr.validate("John")
+  end
+
+
+  def test_all
+    attr = Attribute.new(:batman)
+      .required
+      .type(Integer)
+      .default { 0 }
+      .content { |v| v >= 0 }
+
+    assert_equal true, attr.required?
+    assert_equal 0, attr.validate(nil)
+    assert_equal 100, attr.validate(100)
+    assert_raises CouchPillow::ValidationError do
+      attr.validate(-100)
+    end
+  end
+
+
+  def test_validate_maintain_value_if_type_not_specified
+    attr = Attribute.new(:batman)
+    [true, false, :symbol, 1, 0, -1, 10.0, "string", 1293.1, 0x90, Time.now, nil].each do |v|
+      assert_equal v, attr.validate(v)
+    end
+  end
+
+
+end

data/test/test_document.rb

@@ -1,6 +1,3 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'mocha/mini_test'
 require './test/helper.rb'
 
 class TestDocument < Minitest::Test
@@ -29,12 +26,12 @@ class TestDocument < Minitest::Test
   def test_timestamp
     d = Document.new({}, "1")
     d.save!
-    assert d.created_at
-    assert d.updated_at
+    assert d._created_at
+    assert d._updated_at
   end
 
 
-  def test_type
+  def test_default_type
     d = Document.new({}, "1")
     assert_equal "default", d._type
   end
@@ -51,16 +48,24 @@ class TestDocument < Minitest::Test
   def test_update
     d = Class.new(Document) do
       type 'test'
+
+      attribute(:me)
+      attribute(:batman)
+      attribute(:apple)
     end.new
+    refute d.me
+    refute d.batman
+    refute d.apple
+
     hash = {
       'me' => 'too',
       :batman => 'robin',
       'apple' => 123
     }
     d.update(hash)
-    assert_equal 'too', d[:me]
-    assert_equal 'robin', d[:batman]
-    assert_equal 123, d[:apple]
+    assert_equal 'too', d.me
+    assert_equal 'robin', d.batman
+    assert_equal 123, d.apple
     assert d.save!
   end
 
@@ -68,8 +73,11 @@ class TestDocument < Minitest::Test
   def test_update_existing_fields
     d = Class.new(Document) do
       type 'test'
+      attribute(:a)
+      attribute(:b)
     end.new({ a: 1, b: 2})
     assert_equal 1, d[:a]
+    assert_equal 1, d.a
     hash = {
       'a' => 'too',
     }
@@ -80,200 +88,11 @@ class TestDocument < Minitest::Test
   end
 
 
-  def test_validate_presence
-    d = Class.new(Document) do
-      validate_presence :xyz
-    end.new
-    assert_raises Document::ValidationError do
-      d.save!
-    end
-
-    d.xyz = 10
-    d.save!
-  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_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"
-      validate_type :abc, Integer
-    end
-
-    CouchPillow.db.
-      expects(:get).
-      with('123').
-      returns( { '_type' => 'test', 'abc' => '100' } )
-
-    d = klass.get('123')
-    assert d
-    assert_equal 100, d.abc
-  end
-
-
-  def test_validate_type_also_ensures_types_on_create_string
-    klass = Class.new(Document) do
-      type "test"
-      validate_type :abc, String
-    end
-
-    CouchPillow.db.
-      expects(:get).
-      with('123').
-      returns( { '_type' => 'test', 'abc' => 100 } )
-
-    d = klass.get('123')
-    assert d
-    assert_equal '100', d.abc
-  end
-
-
-  def test_validate_type_also_ensures_types_on_create_float
-    klass = Class.new(Document) do
-      type "test"
-      validate_type :abc, Float
-    end
-
-    CouchPillow.db.
-      expects(:get).
-      with('123').
-      returns( { '_type' => 'test', 'abc' => '121.21' } )
-
-    d = klass.get('123')
-    assert d
-    assert_equal 121.21, d.abc
-  end
-
-
-  def test_validate_type_also_ensures_types_on_create_array
-    klass = Class.new(Document) do
-      type "test"
-      validate_type :abc, Array
-    end
-
-    CouchPillow.db.
-      expects(:get).
-      with('123').
-      returns( { '_type' => 'test', 'abc' => 1 } )
-
-    d = klass.get('123')
-    assert d
-    assert_equal [1], d.abc
-  end
-
-
-  def test_validate_type_also_ensures_types_on_create_time
-    klass = Class.new(Document) do
-      type "test"
-      validate_type :abc, Time
-    end
-
-    CouchPillow.db.
-      expects(:get).
-      with('123').
-      returns( { '_type' => 'test', 'abc' => "2014/07/04" } )
-
-    d = klass.get('123')
-    assert d
-    assert d.abc.is_a?(Time)
-    assert_equal 2014, d.abc.year
-    assert_equal 7, d.abc.month
-    assert_equal 4, d.abc.day
-  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 }
-    end.new
-    d.xyz = "string"
-    assert_raises Document::ValidationError do
-      d.save!
-    end
-
-    d.xyz = {}
-    assert_raises Document::ValidationError do
-      d.save!
-    end
-
-    d.xyz = 123
-    d.save!
-  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_whitelist_using_symbol_literal
+  def test_exclusion_other_keys
     d = Class.new(Document) do
-      whitelist %i[a b c]
+      attribute :a
+      attribute :b
+      attribute :c
     end.new
     d.update({a: 1, b: 2, c: 3, d: 4})
     assert d.save!
@@ -287,14 +106,14 @@ class TestDocument < Minitest::Test
   def test_to_json
     mock_time
     d = Document.new({}, "1")
-    assert_equal "{\"_id\":\"1\",\"created_at\":\"#{mock_time.to_s}\",\"_type\":\"default\"}", d.to_json
+    assert_equal "{\"_id\":\"1\",\"_type\":\"default\",\"_created_at\":\"#{mock_time.to_s}\",\"_updated_at\":\"#{mock_time.to_s}\"}", d.to_json
   end
 
 
   def test_to_hash
     mock_time
     d = Document.new({}, "1")
-    assert_equal({ :_id => "1", :created_at => mock_time, :_type => "default" }, d.to_hash)
+    assert_equal({ :_id => "1", :_created_at => mock_time, :_type => "default", :_updated_at => mock_time }, d.to_hash)
   end
   
 
@@ -315,6 +134,9 @@ class TestDocument < Minitest::Test
 
   def test_rename_keys
     d = Class.new(Document) do
+      attribute(:bar)
+      attribute(:other)
+
       rename :foo, :bar
     end.new( { :foo => 123, :other => 'abc' } )
     assert_equal 123, d[:bar]
@@ -340,18 +162,34 @@ class TestDocument < Minitest::Test
 
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :created_at, :err
+        rename :_created_at, :err
       end.new
     end
 
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :bla, :updated_at
+        rename :bla, :_updated_at
       end.new
     end
   end
 
 
+  def test_get
+    klass = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+    end
+
+    k = klass.new
+    k.foo = 100
+    k.save!
+    k_id = k._id
+
+    d = klass.get(k_id)
+    assert_equal 100, d.foo
+  end
+
+
   def test_get_returns_nil
     CouchPillow.db.expects(:get).with('123').returns(nil)
     d = Document.get('123')
@@ -375,14 +213,96 @@ class TestDocument < Minitest::Test
 
 
   def test_key_with_false_values
-    d = Document.new({ :key => false }, "1")
+    klass = Class.new(Document) do
+      attribute(:key)
+    end
+    d = klass.new({ :key => false }, "1")
     assert_equal false, d.key
   end
 
 
   def test_key_with_nil_values
-    d = Document.new({ :key => nil }, "1")
+    klass = Class.new(Document) do
+      attribute(:key)
+    end
+    d = klass.new({ :key => nil }, "1")
     assert_equal nil, d.key
   end
 
+
+  def test_attribute
+    d = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+    end.new
+
+    d.foo = 12345
+    d.save!
+  end
+
+
+  def test_attribute_type
+    d = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .type(String)
+    end.new
+
+    d.foo = "test"
+    d.save!
+  end
+
+
+  def test_attribute_auto_convert
+    d = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .type(String).auto_convert
+    end.new
+
+    d.foo = 1
+    d.save!
+
+    assert_equal "1", d.foo
+  end
+
+
+  def test_attribute_with_directives
+    d = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .default { 100 }
+    end.new
+
+    d.save!
+    assert_equal 100, d.foo
+  end
+
+
+  def test_attribute_no_default_but_required
+    klass = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .required
+    end
+
+    k = klass.new
+    assert_raises CouchPillow::ValidationError do
+      k.save!
+    end
+  end
+
+
+  def test_attribute_with_default_but_also_required
+    klass = Class.new(Document) do
+      type 'test'
+      attribute(:foo)
+        .required
+        .default { "batman" }
+    end
+
+    k = klass.new
+    k.save!
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.0
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -64,9 +64,14 @@ files:
 - Rakefile
 - couchpillow.gemspec
 - lib/couchpillow.rb
+- lib/couchpillow/attribute.rb
+- lib/couchpillow/attributive.rb
+- lib/couchpillow/boolean.rb
 - lib/couchpillow/document.rb
+- lib/couchpillow/validation_error.rb
 - lib/couchpillow/version.rb
 - test/helper.rb
+- test/test_attribute.rb
 - test/test_document.rb
 homepage: https://github.com/atedja/pillow
 licenses:
@@ -88,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Document wrapper for Couchbase
 test_files: []
-has_rdoc: