couchrest_model 1.0.0.beta7 → 1.0.0.beta8

data/README.md

@@ -13,7 +13,24 @@ CouchRest Model only supports CouchDB 0.10.0 or newer.
 
 ## Install
 
-    $ sudo gem install couchrest_model
+### From Gem
+
+CouchRest Model depends on Rails 3's ActiveModel which has not yet been released. You'll need to add
+`--pre` to the end of the gem install until the dependencies are stable:
+
+    $ sudo gem install couchrest_model --pre
+
+### Bundler
+
+If you're using bundler, just define a line similar to the following in your project's Gemfile:
+
+    gem 'couchrest_model'
+
+You might also consider using the latest git repository. All tests should pass in the master code branch
+but no guarantees!
+
+    gem 'couchrest_model', :git => 'git://github.com/couchrest/couchrest_model.git'
+
    
 ## General Usage 
 
@@ -57,7 +74,7 @@ with a property, but a property may not have any attributes associated if none h
 
 In its simplest form, a property
 will only create a getter and setter passing all attribute data directly to the database. Assuming the attribute
-provided responds to +to_json+, there will not be any problems saving it, but when loading the 
+provided responds to `to_json`, there will not be any problems saving it, but when loading the 
 data back it will either be a string, number, array, or hash:
 
     class Cat < CouchRest::Model::Base
@@ -110,7 +127,7 @@ Adding the +:default+ option will ensure the attribute always has a value.
 
 Defining a property as read-only will mean that its value is set only when read from the
 database and that it will not have a setter method. You can however update a read-only
-attribute using the +write_attribute+ method:
+attribute using the `write_attribute` method:
 
     class Cat < CouchRest::Model::Base
       property :name, String
@@ -145,7 +162,7 @@ By default, the array will be ready to use from the moment the object as been in
     @cat.nicknames == ['Buffy']
 
 When anything other than a string is set as the class of a property, the array will be converted
-into special wrapper called a CastedArray. If the child objects respond to the 'casted_by' method
+into special wrapper called a CastedArray. If the child objects respond to the `casted_by` method
 (such as those created with CastedModel, below) it will contain a reference to the parent.
 
 ## Casted Models
@@ -214,7 +231,7 @@ TODO: Document properly!
 CouchRest Model automatically includes the new ActiveModel validations, so they should work just as the traditional Rails
 validations. For more details, please see the ActiveModel::Validations documentation.
 
-CouchRest Model adds the possibility to check the uniqueness of attributes using the @validates_uniqueness_of@ class method, for example:
+CouchRest Model adds the possibility to check the uniqueness of attributes using the `validates_uniqueness_of` class method, for example:
 
     class Person < CouchRest::Model::Base
       property :title, String
@@ -223,7 +240,7 @@ CouchRest Model adds the possibility to check the uniqueness of attributes using
     end
 
 The uniqueness validation creates a new view for the attribute or uses one that already exists. You can
-specify a different view using the +:view+ option, useful for when the @unique_id@ is specified and
+specify a different view using the `:view` option, useful for when the `unique_id` is specified and
 you'd like to avoid the typical RestClient Conflict error:
 
     unique_id :code
@@ -307,12 +324,12 @@ CouchRest install, from the project root directory run `rake`, or `autotest`
 
 API: [http://rdoc.info/projects/couchrest/couchrest_model](http://rdoc.info/projects/couchrest/couchrest_model)
 
-Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest](http://wiki.github.com/couchrest/couchrest)
+Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest_model](http://wiki.github.com/couchrest/couchrest_model)
 
 
 ## Contact
 
-Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest/issues](http://github.com/couchrest/couchrest/issues).
+Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest_model/issues](http://github.com/couchrest/couchrest_model/issues).
 
 Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
 

data/Rakefile

@@ -24,14 +24,15 @@ begin
     gemspec.homepage = "http://github.com/couchrest/couchrest_model"
     gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown"]
     gemspec.extra_rdoc_files = %w( README.md LICENSE THANKS.md )
-    gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt couchrest.gemspec) + Dir["{examples,lib,spec,utils}/**/*"] - Dir["spec/tmp"]
+    gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt couchrest.gemspec) + Dir["{examples,lib,spec}/**/*"] - Dir["spec/tmp"]
     gemspec.has_rdoc = true
-    gemspec.add_dependency("couchrest", ">= 1.0.0.beta")
-    gemspec.add_dependency("mime-types", ">= 1.15")
-    gemspec.add_dependency("activesupport", ">= 2.3.5")
-    gemspec.add_dependency("activemodel", ">= 3.0.0.beta4")
+    gemspec.add_dependency("couchrest", "~> 1.0.0")
+    gemspec.add_dependency("mime-types", "~> 1.15")
+    gemspec.add_dependency("activesupport", "~> 2.3.5")
+    gemspec.add_dependency("activemodel", "~> 3.0.0.beta4")
+    gemspec.add_dependency("tzinfo", "~> 0.3.22")
     gemspec.version = CouchRest::Model::VERSION
-    gemspec.date = "2008-11-22"
+    gemspec.date = Time.now.strftime("%Y-%m-%d")
     gemspec.require_path = "lib"
   end
 rescue LoadError

data/THANKS.md

@@ -13,6 +13,8 @@ changes. A list of these people is included below.
  * [Matt Lyon](http://mattly.tumblr.com/)
  * Simon Rozet (simon /at/ rozet /dot/ name)
  * [Marcos Tapajós](http://tapajos.me)
+ * [Sam Lown](http://github.com/samlown)
+ * [Will Leinweber](http://github.com/will)
  
 Patches are welcome. The primary source for this software project is [on Github](http://github.com/couchrest/couchrest)
 

data/history.txt

@@ -3,12 +3,14 @@
 * Major enhancements
 
 * Minor enhancements
+  * Raise error on adding objects to "collection_of" without an id
+  * Allow mixing of protected and accessible properties. Any unspecified properties are now assumed to be protected by default
 
 == CouchRest Model 1.0.0.beta7
 
 * Major enhancements
   * Renamed ExtendedDocument to CouchRest::Model
-  * Added initial support for simple belongs_to associations 
+  * Added initial support for simple belongs_to associations
   * Added support for basic collection_of association (unique to document databases!)
   * Moved Validation to ActiveModel
   * Moved Callbacks to ActiveModel
@@ -16,6 +18,9 @@
   * Validation always included
   * Uniqueness validation now available
 
+* Minor enhancements
+  * Removed support for auto_validate! and :length on properties
+
 
 == 1.0.0.beta6
 
@@ -70,7 +75,7 @@
   * Adds support for continuous replication (sauy7)
   * Automatic Type Casting (Alexander Uvarov, Sam Lown, Tim Heighes, Will Leinweber)
   * Added a search method to CouchRest:Database to search the documents in a given database. (Dave Farkas, Arnaud Berthomier, John Wood)
-  
+
 * Minor enhancements
   * Provide a description of the timeout error (John Wood)
 
@@ -99,9 +104,9 @@
   * Adds attribute protection to properties. (Will Leinweber)
   * Improved CouchRest::Database#save_doc, added "batch" mode to significantly speed up saves at cost of lower durability gurantees. (Igal Koshevoy)
   * Added CouchRest::Database#bulk_save_doc and #batch_save_doc as human-friendlier wrappers around #save_doc. (Igal Koshevoy)
-  
-* Minor enhancements 
-  
+
+* Minor enhancements
+
   * Fix content_type handling for attachments
   * Fixed a bug in the pagination code that caused it to paginate over records outside of the scope of the view parameters.(John Wood)
   * Removed amount_pages calculation for the pagination collection, since it cannot be reliably calculated without a view.(John Wood)
@@ -120,9 +125,9 @@
 * Major enhancements
 
   * Added a new Rack logger middleware letting you log/save requests/queries (Matt Aimonetti)
-  
-* Minor enhancements 
-  
+
+* Minor enhancements
+
   * Added #amount_pages to a paginated result array (Matt Aimonetti)
   * Ruby 1.9.2 compatible (Matt Aimonetti)
   * Added a property? method for property cast as :boolean (John Wood)
@@ -131,14 +136,14 @@
   * Bug fix: made ExtendedDocument#all compatible with Couch 0.10 (tc)
 
 == 0.32
-  
+
 * Major enhancements
 
   * ExtendedDocument.get doesn't raise an exception anymore. If no documents are found nil is returned.
   * ExtendedDocument.get! works the say #get used to work and will raise an exception if a document isn't found.
-  
-* Minor enhancements  
-   
+
+* Minor enhancements
+
   * Bug fix: Model.all(:keys => [1,2]) was not working (Matt Aimonetti)
   * Added ValidationErrors#count in order to play nicely with Rails (Peter Wagenet)
   * Bug fix: class proxy design doc refresh (Daniel Kirsh)
@@ -151,29 +156,29 @@
 
   * Created an abstraction HTTP layer to support different http adapters (Matt Aimonetti)
   * Added ExtendedDocument.create({}) and #create!({}) so you don't have to do Model.new.create (Matt Aimonetti)
-  
+
 * Minor enhancements
-  
+
   * Added an init.rb file for easy usage as a Rails plugin (Aaron Quint)
   * Bug fix: pagination shouldn't die on empty results (Arnaud Berthomier)
   * Optimized ExtendedDocument.count to run about 3x faster (Matt Aimonetti)
   * Added Float casting (Ryan Felton & Matt Aimonetti)
 
 == 0.30
- 
+
 * Major enhancements
- 
+
   * Added support for pagination (John Wood)
   * Improved performance when initializing documents with timestamps (Matt Aimonetti)
- 
+
 * Minor enhancements
- 
+
   * Extended the API to retrieve an attachment URI (Matt Aimonetti)
   * Bug fix: default value should be able to be set as false (Alexander Uvarov)
   * Bug fix: validates_is_numeric should be able to properly validate a Float instance (Rob Kaufman)
   * Bug fix: fixed the Timeout implementation (Seth Falcon)
-  
-  
+
+
 ---
 
 Unfortunately, before 0.30 we did not keep a track of the modifications made to CouchRest.

data/lib/couchrest/model/base.rb

@@ -39,7 +39,7 @@ module CouchRest
       attr_accessor :casted_by
       
 
-      # Instantiate a new ExtendedDocument by preparing all properties
+      # Instantiate a new CouchRest::Model::Base by preparing all properties
       # using the provided document hash.
       #
       # Options supported:

data/lib/couchrest/model/extended_attachments.rb

@@ -7,11 +7,15 @@ module CouchRest
       def create_attachment(args={})
         raise ArgumentError unless args[:file] && args[:name]
         return if has_attachment?(args[:name])
-        self['_attachments'] ||= {}
         set_attachment_attr(args)
       rescue ArgumentError => e
         raise ArgumentError, 'You must specify :file and :name'
       end
+      
+      # return all attachments
+      def attachments
+        self['_attachments'] ||= {}
+      end
 
       # reads the data from an attachment
       def read_attachment(attachment_name)
@@ -30,13 +34,13 @@ module CouchRest
 
       # deletes a file attachment from the current doc
       def delete_attachment(attachment_name)
-        return unless self['_attachments']
-        self['_attachments'].delete attachment_name
+        return unless attachments
+        attachments.delete attachment_name
       end
 
       # returns true if attachment_name exists
       def has_attachment?(attachment_name)
-        !!(self['_attachments'] && self['_attachments'][attachment_name] && !self['_attachments'][attachment_name].empty?)
+        !!(attachments && attachments[attachment_name] && !attachments[attachment_name].empty?)
       end
 
       # returns URL to fetch the attachment from
@@ -62,7 +66,7 @@ module CouchRest
         def set_attachment_attr(args)
           content_type = args[:content_type] ? args[:content_type] : get_mime_type(args[:file].path)
           content_type ||= (get_mime_type(args[:name]) || 'text/plain')
-          self['_attachments'][args[:name]] = {
+          attachments[args[:name]] = {
             'content_type' => content_type,
             'data'         => args[:file].read
           }

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

@@ -1,4 +1,4 @@
-# encoding: urf-8
+# encoding: utf-8
 
 module CouchRest
   module Model
@@ -16,15 +16,14 @@ module CouchRest
 
         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])
 
-          unless @klass.has_view?(view_name)
+          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
 
-          # Determine the base of the search
-          base = options[:proxy].nil? ? @klass : document.instance_eval(options[:proxy])
-
           docs = base.view(view_name, :key => value, :limit => 2, :include_docs => false)['rows']
           return if docs.empty?
 

data/lib/couchrest/model/views.rb

@@ -127,18 +127,11 @@ module CouchRest
           if raw || (opts.has_key?(:include_docs) && opts[:include_docs] == false)
             fetch_view(db, name, opts, &block)
           else
-            begin
-              if block.nil?
-                collection_proxy_for(design_doc, name, opts.merge({: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
-            rescue
-              # fallback for old versions of couchdb that don't 
-              # have include_docs support
-              view = fetch_view(db, name, opts, &block)
-              view['rows'].collect{|r|create_from_database(db.get(r['id']))} if view['rows']
+            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

data/lib/couchrest/model.rb

@@ -3,7 +3,7 @@ module CouchRest
 
   module Model
 
-    VERSION = "1.0.0.beta7"
+    VERSION = "1.0.0.beta8"
 
   end
 

data/lib/couchrest/railtie.rb

@@ -0,0 +1,11 @@
+require "rails"
+require "active_model/railtie"
+
+module CouchrestModel
+  # = Active Record Railtie
+  class Railtie < Rails::Railtie
+    config.generators.orm :couchrest
+  end
+  
+end
+                                      

data/lib/couchrest_model.rb

@@ -1,12 +1,13 @@
-
-# require File.join(File.dirname(__FILE__), "couchrest", "extended_document")
-
-gem 'couchrest'
-
+gem 'couchrest', ">= 1.0.0.beta"
 require 'couchrest'
 
+gem "tzinfo", ">= 0.3.22"
+
+gem "activesupport", ">= 2.3.5"
 require 'active_support/core_ext'
 require 'active_support/json'
+
+gem "activemodel", ">= 3.0.0.beta4"
 require 'active_model'
 require "active_model/callbacks"
 require "active_model/conversion"
@@ -17,6 +18,8 @@ require "active_model/serialization"
 require "active_model/translation"
 require "active_model/validator"
 require "active_model/validations"
+
+gem "mime-types", ">= 1.15"
 require 'mime/types'
 require "enumerator"
 require "time"
@@ -54,3 +57,5 @@ require "couchrest/model/base"
 
 # Add rails support *after* everything has loaded
 
+require "couchrest/railtie"
+

data/lib/rails/generators/couchrest_model/model/model_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/couchrest_model'
+
+module CouchrestModel
+  module Generators
+    class ModelGenerator < Base
+
+      check_class_collision
+
+      def create_model_file
+        template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+
+      def create_module_file
+        return if class_path.empty?
+        template 'module.rb', File.join('app/models', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      protected
+
+        def parent_class_name
+          "CouchRest::Model::Base"
+        end
+
+    end
+  end
+end

data/lib/rails/generators/couchrest_model/model/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < <%= parent_class_name.classify %>
+end

data/lib/rails/generators/couchrest_model.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/named_base'
+require 'rails/generators/active_model'
+require 'couchrest_model'
+
+module CouchrestModel
+  module Generators
+    class Base < Rails::Generators::NamedBase #:nodoc:
+      
+      # Set the current directory as base for the inherited generators.
+      def self.base_root
+        File.dirname(__FILE__)
+      end
+      
+    end
+  end
+end

data/spec/couchrest/assocations_spec.rb

@@ -1,31 +1,6 @@
 # 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
+require File.join(FIXTURE_PATH, 'more', 'sale_invoice')
 
 
 describe "Assocations" do
@@ -33,7 +8,7 @@ describe "Assocations" do
   describe "of type belongs to" do
 
     before :each do
-      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @invoice = SaleInvoice.create(:price => 2000)
       @client = Client.create(:name => "Sam Lown")
     end
 
@@ -94,7 +69,7 @@ describe "Assocations" do
   describe "of type collection_of" do
 
     before(:each) do
-      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @invoice = SaleInvoice.create(:price => 2000)
       @entries = [
         SaleEntry.create(:description => 'test line 1', :price => 500),
         SaleEntry.create(:description => 'test line 2', :price => 500),
@@ -121,7 +96,7 @@ describe "Assocations" do
       @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
@@ -135,7 +110,7 @@ describe "Assocations" do
       @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) 
+      @invoice.entries(true).length.should eql(3)
     end
 
     it "should empty arrays when nil collection provided" do
@@ -203,11 +178,19 @@ describe "Assocations" do
         @invoice.entry_ids.first.should eql(@entries[1].id)
       end
 
+      it "should raise error when adding un-persisted entries" do
+        SaleEntry.find_by_description('test entry').should be_nil
+        entry = SaleEntry.new(:description => 'test entry', :price => 500)
+        lambda {
+          @invoice.entries << entry
+        }.should raise_error
+        # In the future maybe?
+        # @invoice.save.should be_true
+        # SaleEntry.find_by_description('test entry').should_not be_nil
+      end
 
     end
-  
 
   end
 
 end
-

data/spec/couchrest/attachment_spec.rb

@@ -30,6 +30,13 @@ describe "Model attachments" do
       @obj.delete_attachment(@attachment_name)
       @obj.has_attachment?(@attachment_name).should be_false
     end
+    
+    it 'should return false if an attachment has been removed and reloaded' do
+      @obj.delete_attachment(@attachment_name)
+      reloaded_obj = Basic.get(@obj.id)
+      reloaded_obj.has_attachment?(@attachment_name).should be_false
+    end
+    
   end
 
   describe "creating an attachment" do
@@ -46,14 +53,14 @@ describe "Model attachments" do
       @obj.create_attachment(:file => @file_ext, :name => @attachment_name)
       @obj.save.should be_true
       reloaded_obj = Basic.get(@obj.id)
-      reloaded_obj['_attachments'][@attachment_name].should_not be_nil
+      reloaded_obj.attachments[@attachment_name].should_not be_nil
     end
   
     it "should create an attachment from file without an extension" do
       @obj.create_attachment(:file => @file_no_ext, :name => @attachment_name)
       @obj.save.should be_true
       reloaded_obj = Basic.get(@obj.id)
-      reloaded_obj['_attachments'][@attachment_name].should_not be_nil
+      reloaded_obj.attachments[@attachment_name].should_not be_nil
     end
   
     it 'should raise ArgumentError if :file is missing' do
@@ -66,19 +73,19 @@ describe "Model attachments" do
   
     it 'should set the content-type if passed' do
       @obj.create_attachment(:file => @file_ext, :name => @attachment_name, :content_type => @content_type)
-      @obj['_attachments'][@attachment_name]['content_type'].should == @content_type
+      @obj.attachments[@attachment_name]['content_type'].should == @content_type
     end
 
     it "should detect the content-type automatically" do
       @obj.create_attachment(:file => File.open(FIXTURE_PATH + '/attachments/couchdb.png'), :name => "couchdb.png")
-      @obj['_attachments']['couchdb.png']['content_type'].should == "image/png" 
+      @obj.attachments['couchdb.png']['content_type'].should == "image/png" 
     end
 
     it "should use name to detect the content-type automatically if no file" do
       file = File.open(FIXTURE_PATH + '/attachments/couchdb.png')
       file.stub!(:path).and_return("badfilname")
       @obj.create_attachment(:file => File.open(FIXTURE_PATH + '/attachments/couchdb.png'), :name => "couchdb.png")
-      @obj['_attachments']['couchdb.png']['content_type'].should == "image/png" 
+      @obj.attachments['couchdb.png']['content_type'].should == "image/png" 
     end
 
   end
@@ -113,7 +120,7 @@ describe "Model attachments" do
       file = File.open(FIXTURE_PATH + '/attachments/README')
       @file.should_not == file
       @obj.update_attachment(:file => file, :name => @attachment_name, :content_type => @content_type)
-      @obj['_attachments'][@attachment_name]['content_type'].should == @content_type
+      @obj.attachments[@attachment_name]['content_type'].should == @content_type
     end
   
     it 'should delete an attachment that exists' do
@@ -143,6 +150,27 @@ describe "Model attachments" do
     it 'should return the attachment URI' do
       @obj.attachment_uri(@attachment_name).should == "#{Basic.database.uri}/#{@obj.id}/#{@attachment_name}"
     end
-    
+  end
+
+  describe "#attachments" do
+    before(:each) do
+      @obj = Basic.new
+      @file = File.open(FIXTURE_PATH + '/attachments/test.html')
+      @attachment_name = 'my_attachment'
+      @obj.create_attachment(:file => @file, :name => @attachment_name)
+      @obj.save.should be_true
+    end
+  
+    it 'should return an empty Hash when document does not have any attachment' do
+      new_obj = Basic.new
+      new_obj.save.should be_true
+      new_obj.attachments.should == {}
+    end
+  
+    it 'should return a Hash with all attachments' do
+      @file.rewind
+      @obj.attachments.should == { @attachment_name =>{ "data" => "PCFET0NUWVBFIGh0bWw+CjxodG1sPgogIDxoZWFkPgogICAgPHRpdGxlPlRlc3Q8L3RpdGxlPgogIDwvaGVhZD4KICA8Ym9keT4KICAgIDxwPgogICAgICBUZXN0CiAgICA8L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==", "content_type" => "text/html"}}
+    end
+  
   end
 end