couchrest_model 1.1.0.rc1 → 1.1.0

data/README.md

@@ -70,6 +70,10 @@ The example config above for example would use a database called "project_test".
 
 ## Generators
 
+### Configuration
+
+    $ rails generate couchrest_model:config
+
 ### Model
 
     $ rails generate model person --orm=couchrest_model

data/VERSION

@@ -1 +1 @@
-1.1.0.rc1
+1.1.0

data/couchrest_model.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency(%q<couchrest>, "1.1.0.pre3")
+  s.add_dependency(%q<couchrest>, "1.1.0")
   s.add_dependency(%q<mime-types>, "~> 1.15")
   s.add_dependency(%q<activemodel>, "~> 3.0")
   s.add_dependency(%q<tzinfo>, "~> 0.3.22")

data/history.md

@@ -1,6 +1,18 @@
 # CouchRest Model Change History
 
-## 1.1.0.rc - 2011-06-08
+## 1.1.0 - 2011-06-25
+
+* Major Alterations
+  * CastedModel no longer requires a Hash. Automatically includes all required methods.
+  * CastedModel module renamed to Embeddable (old still works!)
+
+* Minor Fixes
+  * Validation callbacks now support context (thanks kostia)
+  * Document comparisons now performed using database and document ID (pointer by neocsr)
+  * Automatic config generation now supported (thanks lucasrenan)
+  * Comparing documents resorts to Hash comparison if both IDs are nil. (pointer by kostia)
+
+## 1.1.0.rc1 - 2011-06-08
 
 * New Features
   * Properties with a nil value are now no longer sent to the database.

data/lib/couchrest/model/associations.rb

@@ -183,19 +183,19 @@ module CouchRest
           casted_by[casted_by_property.to_s] << obj.id
         end
       end
-      
+
       def << obj
         check_obj(obj)
         casted_by[casted_by_property.to_s] << obj.id
         super(obj)
       end
-      
+
       def push(obj)
         check_obj(obj)
         casted_by[casted_by_property.to_s].push obj.id
         super(obj)
       end
-      
+
       def unshift(obj)
         check_obj(obj)
         casted_by[casted_by_property.to_s].unshift obj.id
@@ -212,7 +212,7 @@ module CouchRest
         casted_by[casted_by_property.to_s].pop
         super
       end
-      
+
       def shift
         casted_by[casted_by_property.to_s].shift
         super

data/lib/couchrest/model/base.rb

@@ -7,7 +7,6 @@ module CouchRest
       include CouchRest::Model::Configuration
       include CouchRest::Model::Connection
       include CouchRest::Model::Persistence
-      include CouchRest::Model::Callbacks
       include CouchRest::Model::DocumentQueries
       include CouchRest::Model::Views
       include CouchRest::Model::DesignDoc
@@ -18,9 +17,11 @@ module CouchRest
       include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
+      include CouchRest::Model::Callbacks
       include CouchRest::Model::Designs
       include CouchRest::Model::CastedBy
       include CouchRest::Model::Dirty
+      include CouchRest::Model::Callbacks
 
       def self.subclasses
         @subclasses ||= []
@@ -46,8 +47,8 @@ module CouchRest
       #
       # Options supported:
       #
-      # * :directly_set_attributes: true when data comes directly from database
-      # * :database: provide an alternative database
+      # * :directly_set_attributes, true when data comes directly from database
+      # * :database, provide an alternative database
       #
       # If a block is provided the new model will be passed into the
       # block so that it can be populated.
@@ -63,6 +64,7 @@ module CouchRest
         yield self if block_given?
 
         after_initialize if respond_to?(:after_initialize)
+        run_callbacks(:initialize) { self }
       end
 
 
@@ -80,10 +82,6 @@ module CouchRest
         super
       end
 
-      def persisted?
-        !new?
-      end
-
       def to_key
         new? ? nil : [id]
       end
@@ -91,6 +89,26 @@ module CouchRest
       alias :to_param :id
       alias :new_record? :new?
       alias :new_document? :new?
+
+      # Compare this model with another by confirming to see 
+      # if the IDs and their databases match!
+      #
+      # Camparison of the database is required in case the 
+      # model has been proxied or loaded elsewhere.
+      #
+      # A Basic CouchRest document will only ever compare using 
+      # a Hash comparison on the attributes.
+      def == other
+        return false unless other.is_a?(Base)
+        if id.nil? && other.id.nil?
+          # no ids? assume comparing nested and revert to hash comparison
+          to_hash == other.to_hash
+        else
+          database == other.database && id == other.id
+        end
+      end
+      alias :eql? :==
+
     end
   end
 end

data/lib/couchrest/model/callbacks.rb

@@ -5,21 +5,23 @@ module CouchRest #:nodoc:
 
     module Callbacks
       extend ActiveSupport::Concern
-      included do
-        extend ActiveModel::Callbacks
 
-        define_model_callbacks \
-          :create,
-          :destroy,
-          :save,
-          :update
+      CALLBACKS = [
+        :before_validation, :after_validation,
+        :after_initialize,
+        :before_create, :around_create, :after_create,
+        :before_destroy, :around_destroy, :after_destroy,
+        :before_save, :around_save, :after_save,
+        :before_update, :around_update, :after_update,
+      ]
 
-      end
+      included do
+        extend ActiveModel::Callbacks
+        include ActiveModel::Validations::Callbacks
 
-      def valid?(*) #nodoc
-        _run_validation_callbacks { super }
+        define_model_callbacks :initialize, :only => :after
+        define_model_callbacks :create, :destroy, :save, :update
       end
-
     end
 
   end

data/lib/couchrest/model/{casted_model.rb → embeddable.rb}

@@ -1,37 +1,34 @@
 module CouchRest::Model
-  module CastedModel
-
+  module Embeddable
     extend ActiveSupport::Concern
 
     included do
+      include CouchRest::Attributes
       include CouchRest::Model::Configuration
-      include CouchRest::Model::Callbacks
       include CouchRest::Model::Properties
       include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
+      include CouchRest::Model::Callbacks
       include CouchRest::Model::CastedBy
       include CouchRest::Model::Dirty
+      include CouchRest::Model::Callbacks
+
       class_eval do
         # Override CastedBy's base_doc?
         def base_doc?
           false # Can never be base doc!
         end
-      end
-    end
-
-    def initialize(keys = {})
-      raise StandardError unless self.is_a? Hash
-      prepare_all_attributes(keys)
-      super()
-    end
 
-    def []= key, value
-      super(key.to_s, value)
-    end
-
-    def [] key
-      super(key.to_s)
+        # Initialize a new Casted Model. Accepts the same
+        # options as CouchRest::Model::Base for preparing and initializing
+        # attributes.
+        def initialize(keys = {}, options = {})
+          super()
+          prepare_all_attributes(keys, options)
+          run_callbacks(:initialize) { self }
+        end
+      end
     end
 
     # False if the casted model has already
@@ -65,6 +62,14 @@ module CouchRest::Model
     end
     alias :attributes= :update_attributes_without_saving
 
+  end # End Embeddable
+
+  # Provide backwards compatability with previous versions (pre 1.1.0)
+  module CastedModel
+    extend ActiveSupport::Concern
+    included do
+      include CouchRest::Model::Embeddable
+    end
   end
 
 end

data/lib/couchrest/model/persistence.rb

@@ -28,7 +28,8 @@ module CouchRest
       # Trigger the callbacks (before, after, around)
       # only if the document isn't new
       def update(options = {})
-        raise "Calling #{self.class.name}#update on document that has not been created!" if self.new?
+        raise "Cannot save a destroyed document!" if destroyed?
+        raise "Calling #{self.class.name}#update on document that has not been created!" if new?
         return false unless perform_validations(options)
         return true if !self.disable_dirty && !self.changed?
         _run_update_callbacks do
@@ -69,6 +70,10 @@ module CouchRest
         !!@_destroyed
       end
 
+      def persisted?
+        !new? && !destroyed?
+      end
+
       # Update the document's attributes and save. For example:
       #
       #   doc.update_attributes :name => "Fred"

data/lib/couchrest/model/properties.rb

@@ -149,15 +149,13 @@ module CouchRest
         # These properties are casted as Time objects, so they should always
         # be set to UTC.
         def timestamps!
-          class_eval <<-EOS, __FILE__, __LINE__
-            property(:updated_at, Time, :read_only => true, :protected => true, :auto_validation => false)
-            property(:created_at, Time, :read_only => true, :protected => true, :auto_validation => false)
+          property(:updated_at, Time, :read_only => true, :protected => true, :auto_validation => false)
+          property(:created_at, Time, :read_only => true, :protected => true, :auto_validation => false)
 
-            set_callback :save, :before do |object|
-              write_attribute('updated_at', Time.now)
-              write_attribute('created_at', Time.now) if object.new?
-            end
-          EOS
+          set_callback :save, :before do |object|
+            write_attribute('updated_at', Time.now)
+            write_attribute('created_at', Time.now) if object.new?
+          end
         end
 
         protected
@@ -168,8 +166,8 @@ module CouchRest
             # check if this property is going to casted
             type = options.delete(:type) || options.delete(:cast_as)
             if block_given?
-              type = Class.new(Hash) do
-                include CastedModel
+              type = Class.new do
+                include Embeddable
               end
               if block.arity == 1 # Traditional, with options
                 type.class_eval { yield type }
@@ -191,42 +189,32 @@ module CouchRest
 
           # defines the getter for the property (and optional aliases)
           def create_property_getter(property)
-            # meth = property.name
-            class_eval <<-EOS, __FILE__, __LINE__ + 1
-              def #{property.name}
-                read_attribute('#{property.name}')
-              end
-            EOS
+            define_method(property.name) do
+              read_attribute(property.name)
+            end
 
             if ['boolean', TrueClass.to_s.downcase].include?(property.type.to_s.downcase)
-              class_eval <<-EOS, __FILE__, __LINE__
-                def #{property.name}?
-                  value = read_attribute('#{property.name}')
-                  !(value.nil? || value == false)
-                end
-              EOS
+              define_method("#{property.name}?") do
+                value = read_attribute(property.name)
+                !(value.nil? || value == false)
+              end
             end
 
             if property.alias
-              class_eval <<-EOS, __FILE__, __LINE__ + 1
-                alias #{property.alias.to_sym} #{property.name.to_sym}
-              EOS
+              alias_method(property.alias, property.name.to_sym)
             end
           end
 
           # defines the setter for the property (and optional aliases)
           def create_property_setter(property)
-            property_name = property.name
-            class_eval <<-EOS
-              def #{property_name}=(value)
-                write_attribute('#{property_name}', value)
-              end
-            EOS
+            name = property.name
+
+            define_method("#{name}=") do |value|
+              write_attribute(name, value)
+            end
 
             if property.alias
-              class_eval <<-EOS
-                alias #{property.alias.to_sym}= #{property_name.to_sym}=
-              EOS
+              alias_method "#{property.alias}=", "#{name}="
             end
           end
 

data/lib/couchrest/model/property.rb

@@ -45,7 +45,7 @@ module CouchRest::Model
 
     # Cast an individual value, not an array
     def cast_value(parent, value)
-      raise "An array inside an array cannot be casted, use CastedModel" if value.is_a?(Array)
+      raise "An array inside an array cannot be casted, use Embeddable module" if value.is_a?(Array)
       value = typecast_value(value, self)
       associate_casted_value_to_parent(parent, value)
     end

data/lib/couchrest/model/validations.rb

@@ -13,22 +13,33 @@ module CouchRest
     # Validations may be applied to both Model::Base and Model::CastedModel
     module Validations
       extend ActiveSupport::Concern
-      included do
-        include ActiveModel::Validations
-        include ActiveModel::Validations::Callbacks
+      include ActiveModel::Validations
+
+      # Determine if the document is valid.
+      #
+      # @example Is the document valid?
+      #   person.valid?
+      #
+      # @example Is the document valid in a context?
+      #   person.valid?(:create)
+      #
+      # @param [ Symbol ] context The optional validation context.
+      #
+      # @return [ true, false ] True if valid, false if not.
+      #
+      def valid?(context = nil)
+        super context ? context : (new? ? :create : :update)
       end
-      
 
       module ClassMethods
-        
-        # Validates the associated casted model. This method should not be 
+
+        # Validates the associated casted model. This method should not be
         # used within your code as it is automatically included when a CastedModel
         # is used inside the model.
-        #
         def validates_casted_model(*args)
           validates_with(CastedModelValidator, _merge_attributes(args))
         end
-        
+
         # Validates if the field is unique for this type of document. Automatically creates
         # a view if one does not already exist and performs a search for all matching
         # documents.

data/lib/couchrest/railtie.rb

@@ -2,10 +2,13 @@ require "rails"
 require "active_model/railtie"
 
 module CouchRest
-  # = Active Record Railtie
   class ModelRailtie < Rails::Railtie
-    config.generators.orm :couchrest_model
-    config.generators.test_framework  :test_unit, :fixture => false
+    def self.generator
+      config.respond_to?(:app_generators) ? :app_generators : :generators
+    end
+
+    config.send(generator).orm :couchrest_model
+    config.send(generator).test_framework  :test_unit, :fixture => false
 
     initializer "couchrest_model.configure_default_connection" do
       CouchRest::Model::Base.configure do |conf|

data/lib/couchrest_model.rb

@@ -33,7 +33,6 @@ require "couchrest/model/property_protection"
 require "couchrest/model/properties"
 require "couchrest/model/casted_array"
 require "couchrest/model/casted_hash"
-require "couchrest/model/casted_model"
 require "couchrest/model/validations"
 require "couchrest/model/callbacks"
 require "couchrest/model/document_queries"
@@ -58,10 +57,10 @@ require "couchrest/model/core_extensions/hash"
 require "couchrest/model/core_extensions/time_parsing"
 
 # Base libraries
-require "couchrest/model/casted_model"
+require "couchrest/model/embeddable"
 require "couchrest/model/base"
-# Add rails support *after* everything has loaded
 
+# Add rails support *after* everything has loaded
 if defined?(Rails)
   require "couchrest/railtie"
 end

data/lib/rails/generators/couchrest_model/config/config_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/couchrest_model'
+
+module CouchrestModel
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def copy_configuration_file
+        template 'couchdb.yml', File.join('config', "couchdb.yml")
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchrest_model/config/templates/couchdb.yml

@@ -0,0 +1,21 @@
+development: &development
+  protocol: 'http'
+  host: localhost
+  port: 5984
+  prefix: <%= app_name %>
+  suffix: development
+  username:
+  password:
+
+test:
+  <<: *development
+  suffix: test
+
+production:
+  protocol: 'https'
+  host: localhost
+  port: 5984
+  prefix: <%= app_name %>
+  suffix: production
+  username: root
+  password: 123

data/spec/fixtures/{base.rb → models/base.rb}

@@ -83,6 +83,17 @@ class WithCallBacks < CouchRest::Model::Base
   end
 end
 
+# Following two fixture classes have __intentionally__ diffent syntax for setting the validation context
+class WithContextualValidationOnCreate < CouchRest::Model::Base
+  property(:name, String)
+  validates(:name, :presence => {:on => :create})
+end
+
+class WithContextualValidationOnUpdate < CouchRest::Model::Base
+  property(:name, String)
+  validates(:name, :presence => true, :on => :update)
+end
+
 class WithTemplateAndUniqueID < CouchRest::Model::Base
   use_database TEST_SERVER.default_database
   unique_id do |model|

data/spec/fixtures/{more → models}/card.rb

@@ -1,3 +1,5 @@
+require 'person'
+
 class Card < CouchRest::Model::Base 
   # Set the default database to use
   use_database DB

data/spec/fixtures/{more → models}/cat.rb

@@ -1,6 +1,6 @@
 
-class CatToy < Hash
-  include ::CouchRest::Model::CastedModel
+class CatToy
+  include CouchRest::Model::Embeddable
 
   property :name
 

data/spec/fixtures/{more → models}/course.rb

@@ -1,5 +1,5 @@
-require File.join(FIXTURE_PATH, 'more', 'question')
-require File.join(FIXTURE_PATH, 'more', 'person')
+require 'question'
+require 'person'
 
 class Course < CouchRest::Model::Base
   use_database TEST_SERVER.default_database

data/spec/fixtures/{more → models}/invoice.rb

@@ -6,9 +6,9 @@ class Invoice < CouchRest::Model::Base
   property :client_name
   property :employee_name
   property :location
-  
+
   # Validation
   validates_presence_of :client_name, :employee_name
   validates_presence_of :location, :message => "Hey stupid!, you forgot the location"
-  
+
 end

data/spec/fixtures/models/membership.rb

@@ -0,0 +1,4 @@
+class Membership
+  include CouchRest::Model::Embeddable
+
+end

data/spec/fixtures/{more → models}/person.rb

@@ -1,5 +1,7 @@
-class Person < Hash
-  include ::CouchRest::Model::CastedModel
+require 'cat'
+
+class Person
+  include ::CouchRest::Model::Embeddable
   property :pet, Cat
   property :name, [String]
   

data/spec/fixtures/models/project.rb

@@ -0,0 +1,6 @@
+class Project < CouchRest::Model::Base
+  use_database DB
+  property :name,   String
+  timestamps!
+  view_by :name
+end

data/spec/fixtures/models/question.rb

@@ -0,0 +1,7 @@
+class Question
+  include ::CouchRest::Model::Embeddable
+
+  property :q
+  property :a
+
+end

data/spec/fixtures/{more → models}/sale_invoice.rb

@@ -1,6 +1,7 @@
-require File.join(FIXTURE_PATH, 'more', 'client')
-require File.join(FIXTURE_PATH, 'more', 'sale_entry')
-class SaleInvoice < CouchRest::Model::Base  
+require 'client'
+require 'sale_entry'
+
+class SaleInvoice < CouchRest::Model::Base
   use_database DB
 
   belongs_to :client
@@ -10,4 +11,4 @@ class SaleInvoice < CouchRest::Model::Base
 
   property :date, Date
   property :price, Integer 
-end
+end

data/spec/functional/validations_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe CouchRest::Model::Validations do
+
+  let(:invoice) do
+    Invoice.new()
+  end
+end