couchrest_model 1.0.0 → 1.1.0.beta

data/lib/couchrest/model/property.rb

@@ -58,8 +58,8 @@ module CouchRest::Model
       if default.class == Proc
         default.call
       else
-        # Marshal.load(Marshal.dump(default)) # Removed as there are no failing tests and caused mutex errors
-        default
+        # TODO identify cause of mutex errors
+        Marshal.load(Marshal.dump(default))
       end
     end
 

data/lib/couchrest/model/proxyable.rb

@@ -0,0 +1,152 @@
+module CouchRest
+  module Model
+    # :nodoc: Because I like inventing words
+    module Proxyable
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :model_proxy
+      end
+
+      module ClassMethods
+
+        # Define a collection that will use the base model for the database connection
+        # details.
+        def proxy_for(model_name, options = {})
+          db_method = options[:database_method] || "proxy_database"
+          options[:class_name] ||= model_name.to_s.singularize.camelize
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{model_name}
+              unless respond_to?('#{db_method}')
+                raise "Missing ##{db_method} method for proxy"
+              end
+              @#{model_name} ||= CouchRest::Model::Proxyable::ModelProxy.new(::#{options[:class_name]}, self, self.class.to_s.underscore, #{db_method})
+            end
+          EOS
+        end
+
+        def proxied_by(model_name, options = {})
+          raise "Model can only be proxied once or ##{model_name} already defined" if method_defined?(model_name)
+          attr_accessor model_name
+        end
+      end
+
+      class ModelProxy
+
+        attr_reader :model, :owner, :owner_name, :database
+
+        def initialize(model, owner, owner_name, database)
+          @model      = model
+          @owner      = owner
+          @owner_name = owner_name
+          @database   = database
+        end
+
+        # Base
+        
+        def new(*args)
+          proxy_update(model.new(*args))
+        end
+
+        def build_from_database(doc = {})
+          proxy_update(model.build_from_database(doc))
+        end
+        
+        def method_missing(m, *args, &block)
+          if has_view?(m)
+            if model.respond_to?(m)
+              return model.send(m, *args).proxy(self)
+            else
+              query = args.shift || {}
+              return view(m, query, *args, &block)
+            end
+          elsif m.to_s =~ /^find_(by_.+)/
+            view_name = $1
+            if has_view?(view_name)
+              return first_from_view(view_name, *args) 
+            end
+          end
+          super
+        end
+        
+        # DocumentQueries
+        
+        def all(opts = {}, &block)
+          proxy_update_all(@model.all({:database => @database}.merge(opts), &block))
+        end
+        
+        def count(opts = {})
+          @model.count({:database => @database}.merge(opts))
+        end
+        
+        def first(opts = {})
+          proxy_update(@model.first({:database => @database}.merge(opts)))
+        end
+        
+        def last(opts = {})
+          proxy_update(@model.last({:database => @database}.merge(opts)))
+        end
+        
+        def get(id)
+          proxy_update(@model.get(id, @database))
+        end
+        alias :find :get
+        
+        # Views
+        
+        def has_view?(view)
+          @model.has_view?(view)
+        end
+
+        def view_by(*args)
+          @model.view_by(*args)
+        end
+       
+        def view(name, query={}, &block)
+          proxy_update_all(@model.view(name, {:database => @database}.merge(query), &block))
+        end
+        
+        def first_from_view(name, *args)
+          # add to first hash available, or add to end
+          (args.last.is_a?(Hash) ? args.last : (args << {}).last)[:database] = @database
+          proxy_update(@model.first_from_view(name, *args))
+        end
+       
+        # DesignDoc
+        
+        def design_doc
+          @model.design_doc
+        end
+        
+        def refresh_design_doc(db = nil)
+          @model.refresh_design_doc(db || @database)
+        end
+        
+        def save_design_doc(db = nil)
+          @model.save_design_doc(db || @database)
+        end
+
+
+        protected
+
+        # Update the document's proxy details, specifically, the fields that
+        # link back to the original document.
+        def proxy_update(doc)
+          if doc
+            doc.database = @database if doc.respond_to?(:database=)
+            doc.model_proxy = self if doc.respond_to?(:model_proxy=) 
+            doc.send("#{owner_name}=", owner) if doc.respond_to?("#{owner_name}=")
+          end
+          doc
+        end
+
+        def proxy_update_all(docs)
+          docs.each do |doc|
+            proxy_update(doc)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/couchrest/model/typecast.rb

@@ -79,7 +79,7 @@ module CouchRest
         # Match numeric string
         def typecast_to_numeric(value, method)
           if value.respond_to?(:to_str)
-            if value.gsub(/,/, '.').gsub(/\.(?!\d*\Z)/, '').to_str =~ /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/
+            if value.strip.gsub(/,/, '.').gsub(/\.(?!\d*\Z)/, '').to_str =~ /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/
               $1.send(method)
             else
               value

data/lib/couchrest/model/validations/casted_model.rb

@@ -6,7 +6,9 @@ module CouchRest
         def validate_each(document, attribute, value)
           values = value.is_a?(Array) ? value : [value]
           return if values.collect {|doc| doc.nil? || doc.valid? }.all?
-          document.errors.add(attribute, :invalid, :default => options[:message], :value => value)
+          error_options = { :value => value }
+          error_options[:message] = options[:message] if options[:message]
+          document.errors.add(attribute, :invalid, error_options)
         end
       end
     end

data/lib/couchrest/model/validations/locale/en.yml

@@ -1,5 +1,5 @@
 en:
   errors:
     messages:
-      taken: "is already taken"
+      taken: "has already been taken"
 

data/lib/couchrest/model/validations/uniqueness.rb

@@ -9,19 +9,19 @@ module CouchRest
 
         # Ensure we have a class available so we can check for a usable view
         # or add one if necessary.
-        def setup(klass)
-          @klass = klass
+        def setup(model)
+          @model = model
         end
 
-
         def validate_each(document, attribute, value)
           view_name = options[:view].nil? ? "by_#{attribute}" : options[:view]
+          model = document.model_proxy || @model
           # Determine the base of the search
-          base = options[:proxy].nil? ? @klass : document.instance_eval(options[:proxy])
+          base = options[:proxy].nil? ? model : document.instance_eval(options[:proxy])
 
           if base.respond_to?(:has_view?) && !base.has_view?(view_name)
             raise "View #{document.class.name}.#{options[:view]} does not exist!" unless options[:view].nil?
-            @klass.view_by attribute
+            model.view_by attribute
           end
 
           docs = base.view(view_name, :key => value, :limit => 2, :include_docs => false)['rows']
@@ -32,11 +32,10 @@ module CouchRest
           end
           
           if docs.length > 0
-            document.errors.add(attribute, :taken, :default => options[:message], :value => value)
+            document.errors.add(attribute, :taken, options.merge(:value => value))
           end
         end
 
-
       end
 
     end

data/lib/couchrest/model/validations.rb

@@ -15,6 +15,7 @@ module CouchRest
       extend ActiveSupport::Concern
       included do
         include ActiveModel::Validations
+        include ActiveModel::Validations::Callbacks
       end
       
 

data/lib/couchrest/model/views.rb

@@ -85,9 +85,14 @@ module CouchRest
         end
 
         # returns stored defaults if there is a view named this in the design doc
-        def has_view?(view)
-          view = view.to_s
-          design_doc && design_doc['views'] && design_doc['views'][view]
+        def has_view?(name)
+          design_doc && design_doc.has_view?(name)
+        end
+
+        # Check if the view can be reduced by checking to see if it has a
+        # reduce function.
+        def can_reduce_view?(name)
+          design_doc && design_doc.can_reduce_view?(name)
         end
 
         # Dispatches to any named view.
@@ -127,12 +132,9 @@ module CouchRest
           if raw || (opts.has_key?(:include_docs) && opts[:include_docs] == false)
             fetch_view(db, name, opts, &block)
           else
-            if block.nil?
-              collection_proxy_for(design_doc, name, opts.merge({:database => db, :include_docs => true}))
-            else
-              view = fetch_view db, name, opts.merge({:include_docs => true}), &block
-              view['rows'].collect{|r|create_from_database(r['doc'])} if view['rows']
-            end
+            opts = opts.merge(:include_docs => true)
+            view = fetch_view db, name, opts, &block
+            view['rows'].collect{|r| build_from_database(r['doc'])} if view['rows']
           end
         end
 

data/lib/couchrest_model.rb

@@ -37,9 +37,12 @@ require "couchrest/model/views"
 require "couchrest/model/design_doc"
 require "couchrest/model/extended_attachments"
 require "couchrest/model/class_proxy"
+require "couchrest/model/proxyable"
 require "couchrest/model/collection"
 require "couchrest/model/associations"
 require "couchrest/model/configuration"
+require "couchrest/model/designs"
+require "couchrest/model/designs/view"
 
 # Monkey patches applied to couchrest
 require "couchrest/model/support/couchrest"

data/spec/couchrest/assocations_spec.rb

@@ -44,11 +44,11 @@ describe "Assocations" do
     end
 
     it "should raise error if class name does not exist" do
-      lambda {
+      lambda do
         class TestBadAssoc < CouchRest::Model::Base
           belongs_to :test_bad_item
         end
-      }.should raise_error
+      end.should raise_error(NameError, /TestBadAssoc#test_bad_item/)
     end
 
     it "should allow override of foreign key" do

data/spec/couchrest/base_spec.rb

@@ -34,10 +34,16 @@ describe "Model Base" do
       @obj.should be_new_record
     end
 
-    it "should not failed on a nil value in argument" do
+    it "should not fail with nil argument" do
       @obj = Basic.new(nil)
       @obj.should_not be_nil
     end
+
+    it "should allow the database to be set" do
+      @obj = Basic.new(nil, :database => 'database')
+      @obj.database.should eql('database')
+    end
+
   end
  
   describe "ActiveModel compatability Basic" do
@@ -184,6 +190,14 @@ describe "Model Base" do
       obj = WithDefaultValues.new(:preset => 'test')
       obj.preset = 'test'
     end
+
+    it "should keep default values for new instances" do
+      obj = WithDefaultValues.new
+      obj.preset[:alpha] = 123
+      obj.preset.should == {:right => 10, :top_align => false, :alpha => 123}
+      another = WithDefaultValues.new
+      another.preset.should == {:right => 10, :top_align => false}
+    end
     
     it "should work with a default empty array" do
       obj = WithDefaultValues.new(:tags => ['spec'])

data/spec/couchrest/casted_model_spec.rb

@@ -24,19 +24,24 @@ class DummyModel < CouchRest::Model::Base
   property :sub_models do |child|
     child.property :title
   end
+  property :param_free_sub_models do
+    property :title
+  end
 end
 
 class WithCastedCallBackModel < Hash
   include CouchRest::Model::CastedModel
   property :name
-  property :run_before_validate
-  property :run_after_validate
+  property :run_before_validation
+  property :run_after_validation
+
+  validates_presence_of :run_before_validation
 
-  before_validate do |object|
-    object.run_before_validate = true
+  before_validation do |object|
+    object.run_before_validation = true
   end
-  after_validate do |object|
-    object.run_after_validate = true
+  after_validation do |object|
+    object.run_after_validation = true
   end
 end
 
@@ -98,6 +103,14 @@ describe CouchRest::Model::CastedModel do
       @obj.sub_models << {:title => 'test'}
       @obj.sub_models.first.title.should eql('test')
     end
+    it "should be empty intitally (without params)" do
+      @obj.param_free_sub_models.should_not be_nil
+      @obj.param_free_sub_models.should be_empty
+    end
+    it "should be updatable using a hash (without params)" do
+      @obj.param_free_sub_models << {:title => 'test'}
+      @obj.param_free_sub_models.first.title.should eql('test')
+    end
   end
 
   describe "casted as attribute" do
@@ -284,6 +297,11 @@ describe CouchRest::Model::CastedModel do
         @toy2.errors.should be_empty
         @toy3.errors.should_not be_empty
       end
+
+      it "should not use dperecated ActiveModel options" do
+        ActiveSupport::Deprecation.should_not_receive(:warn)
+        @cat.should_not be_valid
+      end
     end
 
     describe "on a casted model property" do
@@ -423,15 +441,15 @@ describe CouchRest::Model::CastedModel do
     end
 
     describe "validate" do
-      it "should run before_validate before validating" do
-        @model.run_before_validate.should be_nil
+      it "should run before_validation before validating" do
+        @model.run_before_validation.should be_nil
         @model.should be_valid
-        @model.run_before_validate.should be_true
+        @model.run_before_validation.should be_true
       end
-      it "should run after_validate after validating" do
-        @model.run_after_validate.should be_nil
+      it "should run after_validation after validating" do
+        @model.run_after_validation.should be_nil
         @model.should be_valid
-        @model.run_after_validate.should be_true
+        @model.run_after_validation.should be_true
       end
     end
   end

data/spec/couchrest/class_proxy_spec.rb

@@ -85,12 +85,12 @@ describe "Proxy Class" do
   end
   it "should get first" do
     u = @us.first
-    u.title.should =~ /\A...\z/
+    u.should == @us.all.first
   end
   
   it "should get last" do
     u = @us.last
-    u.title.should == "aaa"
+    u.should == @us.all.last
   end
   
   it "should set database on first retreived document" do

data/spec/couchrest/collection_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path("../../spec_helper", __FILE__)
+require File.join(FIXTURE_PATH, 'more', 'article')
+
+describe "Collections" do
+
+  before(:all) do
+    reset_test_db!
+    Article.refresh_design_doc
+    titles = ["very uniq one", "really interesting", "some fun",
+      "really awesome", "crazy bob", "this rocks", "super rad"]
+    titles.each_with_index do |title,i|
+      a = Article.new(:title => title, :date => Date.today)
+      a.save
+    end
+    
+    titles = ["yesterday very uniq one", "yesterday really interesting", "yesterday some fun",
+      "yesterday really awesome", "yesterday crazy bob", "yesterday this rocks"]
+    titles.each_with_index do |title,i|
+      a = Article.new(:title => title, :date => Date.today - 1)
+      a.save
+    end
+  end 
+  it "should return a proxy that looks like an array of 7 Article objects" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :descending => true,
+      :key => Date.today, :include_docs => true)
+    articles.class.should == Array
+    articles.size.should == 7
+  end
+  it "should provide a class method for paginate" do
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :descending => true, :key => Date.today, :include_docs => true)
+    articles.size.should == 3
+    
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 2, :descending => true, :key => Date.today, :include_docs => true)
+    articles.size.should == 3
+    
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 3, :descending => true, :key => Date.today, :include_docs => true)
+    articles.size.should == 1
+  end
+  it "should provide a class method for paginated_each" do
+    options = { :design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 1, :descending => true, :key => Date.today,
+      :include_docs => true }
+    Article.paginated_each(options) do |a|
+      a.should_not be_nil
+    end
+  end
+  it "should provide a class method to get a collection for a view" do
+    articles = Article.find_all_article_details(:key => Date.today)
+    articles.class.should == Array
+    articles.size.should == 7
+  end
+  it "should get a subset of articles using paginate" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :key => Date.today, :include_docs => true)
+    articles.paginate(:page => 1, :per_page => 3).size.should == 3
+    articles.paginate(:page => 2, :per_page => 3).size.should == 3
+    articles.paginate(:page => 3, :per_page => 3).size.should == 1
+  end
+  it "should get all articles, a few at a time, using paginated each" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :key => Date.today, :include_docs => true)
+    articles.paginated_each(:per_page => 3) do |a|
+      a.should_not be_nil
+    end
+  end 
+
+  it "should raise an exception if design_doc is not provided" do
+    lambda{Article.collection_proxy_for(nil, 'by_date')}.should raise_error
+    lambda{Article.paginate(:view_name => 'by_date')}.should raise_error
+  end
+  it "should raise an exception if view_name is not provided" do
+    lambda{Article.collection_proxy_for('Article', nil)}.should raise_error
+    lambda{Article.paginate(:design_doc => 'Article')}.should raise_error
+  end
+  it "should be able to span multiple keys" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :startkey => Date.today - 1, :endkey => Date.today, :include_docs => true)
+    articles.paginate(:page => 1, :per_page => 3).size.should == 3
+    articles.paginate(:page => 3, :per_page => 3).size.should == 3
+    articles.paginate(:page => 5, :per_page => 3).size.should == 1
+  end
+  it "should pass database parameter to pager" do
+    proxy = mock(:proxy)
+    proxy.stub!(:paginate)
+    ::CouchRest::Model::Collection::CollectionProxy.should_receive(:new).with('database', anything(), anything(), anything(), anything()).and_return(proxy)
+    Article.paginate(:design_doc => 'Article', :view_name => 'by_date', :database => 'database')
+  end
+
+end