couchrest_model_thought 1.0.0.beta8

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

@@ -0,0 +1,42 @@
+module CouchRest
+  module Model
+    module Validations
+      
+      # Validates if a field is unique 
+      class UniquenessValidator < ActiveModel::EachValidator
+
+        # Ensure we have a class available so we can check for a usable view
+        # or add one if necessary.
+        def setup(klass)
+          @klass = klass
+        end
+
+
+        def validate_each(document, attribute, value)
+          view_name = options[:view].nil? ? "by_#{attribute}" : options[:view]
+          # Determine the base of the search
+          base = options[:proxy].nil? ? @klass : 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
+          end
+
+          docs = base.view(view_name, :key => value, :limit => 2, :include_docs => false)['rows']
+          return if docs.empty?
+
+          unless document.new?
+            return if docs.find{|doc| doc['id'] == document.id}
+          end
+          
+          if docs.length > 0
+            document.errors.add(attribute, :taken, :default => options[:message], :value => value)
+          end
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/validations.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require "couchrest/model/validations/casted_model"
+require "couchrest/model/validations/uniqueness"
+
+I18n.load_path << File.join(
+  File.dirname(__FILE__), "validations", "locale", "en.yml"
+)
+
+module CouchRest
+  module Model
+
+    # Validations may be applied to both Model::Base and Model::CastedModel
+    module Validations
+      extend ActiveSupport::Concern
+      included do
+        include ActiveModel::Validations
+      end
+      
+
+      module ClassMethods
+        
+        # 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.
+        #
+        # Example:
+        #
+        #   class Person < CouchRest::Model::Base
+        #     property :title, String
+        # 
+        #     validates_uniqueness_of :title
+        #   end
+        #
+        # Asside from the standard options, you can specify the name of the view you'd like
+        # to use for the search inside the +:view+ option. The following example would search
+        # for the code in side the +all+ view, useful for when +unique_id+ is used and you'd
+        # like to check before receiving a RestClient Conflict error:
+        #
+        #   validates_uniqueness_of :code, :view => 'all'
+        #
+        # A +:proxy+ parameter is also accepted if you would 
+        # like to call a method on the document on which the view should be performed.
+        #
+        # For Example:
+        #
+        #   # Same as not including proxy:
+        #   validates_uniqueness_of :title, :proxy => 'class'
+        #
+        #   # Person#company.people provides a proxy object for people
+        #   validates_uniqueness_of :title, :proxy => 'company.people'
+        #
+        def validates_uniqueness_of(*args)
+          validates_with(UniquenessValidator, _merge_attributes(args))
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/version.rb

@@ -0,0 +1,5 @@
+module CouchRest
+  module Model
+    VERSION = "1.0.0.beta8".freeze
+  end
+end

data/lib/couchrest/model/views.rb

@@ -0,0 +1,160 @@
+module CouchRest
+  module Model
+    module Views
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        # Define a CouchDB view. The name of the view will be the concatenation
+        # of <tt>by</tt> and the keys joined by <tt>_and_</tt>
+        #  
+        # ==== Example views:
+        #  
+        #   class Post
+        #     # view with default options
+        #     # query with Post.by_date
+        #     view_by :date, :descending => true
+        #  
+        #     # view with compound sort-keys
+        #     # query with Post.by_user_id_and_date
+        #     view_by :user_id, :date
+        #  
+        #     # view with custom map/reduce functions
+        #     # query with Post.by_tags :reduce => true
+        #     view_by :tags,                                                
+        #       :map =>                                                     
+        #         "function(doc) {                                          
+        #           if (doc['couchrest-type'] == 'Post' && doc.tags) {                   
+        #             doc.tags.forEach(function(tag){                       
+        #               emit(doc.tag, 1);                                   
+        #             });                                                   
+        #           }                                                       
+        #         }",                                                       
+        #       :reduce =>                                                  
+        #         "function(keys, values, rereduce) {                       
+        #           return sum(values);                                     
+        #         }"                                                        
+        #   end
+        #  
+        # <tt>view_by :date</tt> will create a view defined by this Javascript
+        # function:
+        #  
+        #   function(doc) {
+        #     if (doc['couchrest-type'] == 'Post' && doc.date) {
+        #       emit(doc.date, null);
+        #     }
+        #   }
+        #  
+        # It can be queried by calling <tt>Post.by_date</tt> which accepts all
+        # valid options for CouchRest::Database#view. In addition, calling with
+        # the <tt>:raw => true</tt> option will return the view rows
+        # themselves. By default <tt>Post.by_date</tt> will return the
+        # documents included in the generated view.
+        #  
+        # Calling with :database => [instance of CouchRest::Database] will
+        # send the query to a specific database, otherwise it will go to
+        # the model's default database (use_database)
+        #  
+        # CouchRest::Database#view options can be applied at view definition
+        # time as defaults, and they will be curried and used at view query
+        # time. Or they can be overridden at query time.
+        #  
+        # Custom views can be queried with <tt>:reduce => true</tt> to return
+        # reduce results. The default for custom views is to query with
+        # <tt>:reduce => false</tt>.
+        #  
+        # Views are generated (on a per-model basis) lazily on first-access.
+        # This means that if you are deploying changes to a view, the views for
+        # that model won't be available until generation is complete. This can
+        # take some time with large databases. Strategies are in the works.
+        #  
+        # To understand the capabilities of this view system more completely,
+        # it is recommended that you read the RSpec file at
+        # <tt>spec/couchrest/more/extended_doc_spec.rb</tt>.
+
+        def view_by(*keys)
+          opts = keys.pop if keys.last.is_a?(Hash)
+          opts ||= {}
+          ducktype = opts.delete(:ducktype)
+          unless ducktype || opts[:map]
+            opts[:guards] ||= []
+            opts[:guards].push "(doc['couchrest-type'] == '#{self.to_s}')"
+          end
+          keys.push opts
+          design_doc.view_by(*keys)
+          req_design_doc_refresh
+        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]
+        end
+
+        # Dispatches to any named view.
+        def view(name, query={}, &block)
+          query = query.dup # Modifications made on copy!
+          db = query.delete(:database) || database
+          refresh_design_doc(db)
+          query[:raw] = true if query[:reduce]        
+          raw = query.delete(:raw)
+          fetch_view_with_docs(db, name, query, raw, &block)
+        end
+
+        # Find the first entry in the view. If the second parameter is a string
+        # it will be used as the key for the request, for example:
+        #
+        #     Course.first_from_view('by_teacher', 'Fred')
+        #
+        # More advanced requests can be performed by providing a hash:
+        #
+        #     Course.first_from_view('by_teacher', :startkey => 'bbb', :endkey => 'eee')
+        #
+        def first_from_view(name, *args)
+          query = {:limit => 1}
+          case args.first
+          when String, Array
+            query.update(args[1]) unless args[1].nil?
+            query[:key] = args.first
+          when Hash
+            query.update(args.first)
+          end
+          view(name, query).first
+        end
+
+        private
+
+        def fetch_view_with_docs(db, name, opts, raw=false, &block)
+          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
+          end
+        end
+
+        def fetch_view(db, view_name, opts, &block)
+          raise "A view needs a database to operate on (specify :database option, or use_database in the #{self.class} class)" unless db
+          retryable = true
+          begin
+            design_doc.view_on(db, view_name, opts, &block)
+            # the design doc may not have been saved yet on this database
+          rescue RestClient::ResourceNotFound => e
+            if retryable
+              save_design_doc(db)
+              retryable = false
+              retry
+            else
+              raise e
+            end
+          end
+        end
+        
+      end # module ClassMethods
+      
+    end
+  end
+end

data/lib/couchrest/model.rb

@@ -0,0 +1,5 @@
+module CouchRest
+  module Model
+    
+  end
+end

data/lib/couchrest_model.rb

@@ -0,0 +1,53 @@
+require 'couchrest'
+require 'couchrest_extended_document'
+
+require 'active_support/core_ext'
+require 'active_support/json'
+
+require 'active_model'
+require "active_model/callbacks"
+require "active_model/conversion"
+require "active_model/deprecated_error_methods"
+require "active_model/errors"
+require "active_model/naming"
+require "active_model/serialization"
+require "active_model/translation"
+require "active_model/validator"
+require "active_model/validations"
+
+require 'mime/types'
+require "enumerator"
+require "time"
+require 'digest/md5'
+
+require 'bigdecimal' # used in typecast
+require 'bigdecimal/util' # used in typecast
+
+require 'couchrest/model'
+require 'couchrest/model/errors'
+require "couchrest/model/persistence"
+require "couchrest/model/typecast"
+require "couchrest/model/property"
+require "couchrest/model/casted_array"
+require "couchrest/model/properties"
+require "couchrest/model/validations"
+require "couchrest/model/callbacks"
+require "couchrest/model/document_queries"
+require "couchrest/model/views"
+require "couchrest/model/design_doc"
+require "couchrest/model/extended_attachments"
+require "couchrest/model/class_proxy"
+require "couchrest/model/collection"
+require "couchrest/model/attribute_protection"
+require "couchrest/model/attributes"
+require "couchrest/model/associations"
+
+# Monkey patches applied to couchrest
+require "couchrest/model/support/couchrest"
+require "couchrest/model/support/hash"
+
+# Base libraries
+require "couchrest/model/casted_model"
+require "couchrest/model/base"
+
+# Add rails support *after* everything has loaded

data/spec/couchrest/assocations_spec.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+require File.expand_path('../../spec_helper', __FILE__)
+
+class Client < CouchRest::Model::Base
+  use_database DB
+
+  property :name
+  property :tax_code
+end
+
+class SaleEntry < CouchRest::Model::Base
+  use_database DB
+
+  property :description
+  property :price
+end
+
+class SaleInvoice < CouchRest::Model::Base  
+  use_database DB
+
+  belongs_to :client
+  belongs_to :alternate_client, :class_name => 'Client', :foreign_key => 'alt_client_id'
+
+  collection_of :entries, :class_name => 'SaleEntry'
+
+  property :date, Date
+  property :price, Integer 
+end
+
+
+describe "Assocations" do
+
+  describe "of type belongs to" do
+
+    before :each do
+      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @client = Client.create(:name => "Sam Lown")
+    end
+
+    it "should create a foreign key property with setter and getter" do
+      @invoice.properties.find{|p| p.name == 'client_id'}.should_not be_nil
+      @invoice.respond_to?(:client_id).should be_true
+      @invoice.respond_to?("client_id=").should be_true
+    end
+
+    it "should set the property and provide object when set" do
+      @invoice.client = @client
+      @invoice.client_id.should eql(@client.id)
+      @invoice.client.should eql(@client)
+    end
+
+    it "should set the attribute, save and return" do
+      @invoice.client = @client
+      @invoice.save
+      @invoice = SaleInvoice.get(@invoice.id)
+      @invoice.client.id.should eql(@client.id)
+    end
+
+    it "should remove the association if nil is provided" do
+      @invoice.client = @client
+      @invoice.client = nil
+      @invoice.client_id.should be_nil
+    end
+
+    it "should not try to search for association if foreign_key is nil" do
+      @invoice.client_id = nil
+      Client.should_not_receive(:get)
+      @invoice.client
+    end
+
+    it "should raise error if class name does not exist" do
+      lambda {
+        class TestBadAssoc < CouchRest::Model::Base
+          belongs_to :test_bad_item
+        end
+      }.should raise_error
+    end
+
+    it "should allow override of foreign key" do
+      @invoice.respond_to?(:alternate_client).should be_true
+      @invoice.respond_to?("alternate_client=").should be_true
+      @invoice.properties.find{|p| p.name == 'alt_client_id'}.should_not be_nil
+    end
+
+    it "should allow override of foreign key and save" do
+      @invoice.alternate_client = @client
+      @invoice.save
+      @invoice = SaleInvoice.get(@invoice.id)
+      @invoice.alternate_client.id.should eql(@client.id)
+    end
+
+  end
+
+  describe "of type collection_of" do
+
+    before(:each) do
+      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @entries = [
+        SaleEntry.create(:description => 'test line 1', :price => 500),
+        SaleEntry.create(:description => 'test line 2', :price => 500),
+        SaleEntry.create(:description => 'test line 3', :price => 1000)
+      ]
+    end
+
+    it "should create an associated property and collection proxy" do
+      @invoice.respond_to?('entry_ids')
+      @invoice.respond_to?('entry_ids=')
+      @invoice.entries.class.should eql(::CouchRest::CollectionOfProxy)
+    end
+
+    it "should allow replacement of objects" do
+      @invoice.entries = @entries
+      @invoice.entries.length.should eql(3)
+      @invoice.entry_ids.length.should eql(3)
+      @invoice.entries.first.should eql(@entries.first)
+      @invoice.entry_ids.first.should eql(@entries.first.id)
+    end
+
+    it "should allow ids to be set directly and load entries" do
+      @invoice.entry_ids = @entries.collect{|i| i.id}
+      @invoice.entries.length.should eql(3)
+      @invoice.entries.first.should eql(@entries.first)
+    end
+    
+    it "should replace collection if ids replaced" do
+      @invoice.entry_ids = @entries.collect{|i| i.id}
+      @invoice.entries.length.should eql(3) # load once
+      @invoice.entry_ids = @entries[0..1].collect{|i| i.id}
+      @invoice.entries.length.should eql(2)
+    end
+
+    it "should allow forced collection update if ids changed" do
+      @invoice.entry_ids = @entries[0..1].collect{|i| i.id}
+      @invoice.entries.length.should eql(2) # load once
+      @invoice.entry_ids << @entries[2].id
+      @invoice.entry_ids.length.should eql(3)
+      @invoice.entries.length.should eql(2) # cached!
+      @invoice.entries(true).length.should eql(3) 
+    end
+
+    it "should empty arrays when nil collection provided" do
+      @invoice.entries = @entries
+      @invoice.entries = nil
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    it "should empty arrays when nil ids array provided" do
+      @invoice.entries = @entries
+      @invoice.entry_ids = nil
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    it "should ignore nil entries" do
+      @invoice.entries = [ nil ]
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    describe "proxy" do
+
+      it "should ensure new entries to proxy are matched" do
+        @invoice.entries << @entries.first
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+        @invoice.entries.first.should eql(@entries.first)
+        @invoice.entries << @entries[1]
+        @invoice.entries.count.should eql(2)
+        @invoice.entry_ids.count.should eql(2)
+        @invoice.entry_ids.last.should eql(@entries[1].id)
+        @invoice.entries.last.should eql(@entries[1])
+      end
+
+      it "should support push method" do
+        @invoice.entries.push(@entries.first)
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+      end
+
+      it "should support []= method" do
+        @invoice.entries[0] = @entries.first
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+      end
+
+      it "should support unshift method" do
+        @invoice.entries.unshift(@entries.first)
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+        @invoice.entries.unshift(@entries[1])
+        @invoice.entry_ids.first.should eql(@entries[1].id)
+      end
+
+      it "should support pop method" do
+        @invoice.entries.push(@entries.first)
+        @invoice.entries.pop.should eql(@entries.first)
+        @invoice.entries.empty?.should be_true
+        @invoice.entry_ids.empty?.should be_true
+      end
+
+      it "should support shift method" do
+        @invoice.entries.push(@entries[0])
+        @invoice.entries.push(@entries[1])
+        @invoice.entries.shift.should eql(@entries[0])
+        @invoice.entries.first.should eql(@entries[1])
+        @invoice.entry_ids.first.should eql(@entries[1].id)
+      end
+
+
+    end
+  
+
+  end
+
+end
+