couchrest_model 1.1.0.beta2 → 1.1.0.beta3

data/.gitignore

@@ -6,4 +6,5 @@ pkg
 .bundle
 couchdb.std*
 *.*~
-
+Gemfile.lock
+spec.out

data/README.md

@@ -11,6 +11,14 @@ it is not possible to load ActiveModel into programs that do not use ActiveSuppo
 
 CouchRest Model is only properly tested on CouchDB version 1.0 or newer.
 
+*WARNING:* As of April 2011 and the release of version 1.1.0, the default model type key is 'model' instead of 'couchrest-type'. Simply updating your project will not work unless you migrate your data or set the configuration option in your initializers:
+
+    CouchRest::Model::Base.configure do |config|
+      config.model_type_key = 'couchrest-type'
+    end
+
+This is because CouchRest Model's are not couchrest specific and may be used in any other system such as a Javascript library, the model type should reflect this.
+
 ## Install
 
 ### Gem
@@ -57,6 +65,7 @@ Try some of these gems that add extra funcionality to couchrest_model:
 * [couch_photo](http://github.com/moonmaster9000/couch_photo) - attach images to documents with variations (Matt Parker)
 * [copycouch](http://github.com/moonmaster9000/copycouch) - single document replication on documents (Matt Parker)
 * [recloner](https://github.com/moonmaster9000/recloner) - clone documents easily (Matt Parker)
+* [couchrest_localised_properties](https://github.com/samlown/couchrest_localised_properties) - Transparent support for localised properties (Sam Lown)
 
 If you have an extension that you'd us to add to this list, please get in touch!
 			   
@@ -148,7 +157,7 @@ Boolean or TrueClass types will create a getter with question mark at the end:
 
     @cat.awake?   # true
 
-Adding the +:default+ option will ensure the attribute always has a value.
+Adding the `:default` option will ensure the attribute always has a value.
 
 A read-only property will only have a getter method, and its value is set when the document
 is read from the database. You can however update a read-only attribute using the `write_attribute` method:
@@ -378,6 +387,43 @@ Use pagination as follows:
     # In your view, with the kaminari gem loaded:
     paginate @posts
 
+### Design Documents and Views
+
+Views must be defined in a Design Document for CouchDB to be able to perform searches. Each model therefore must have its own Design Document. Deciding when to update the model's design doc is a difficult issue, as in production you don't want to be constantly checking for updates and in development maximum flexability is important. CouchRest Model solves this issue by providing the `auto_update_design_doc` configuration option and is true by default.
+
+Each time a view or other design method is requested a quick GET for the design will be sent to ensure it is up to date with the latest changes. Results are cached in the current thread for the complete design document's URL, including the database, to try and limit requests. This should be fine for most projects, but dealing with multiple sub-databases may require a different strategy.
+
+Setting the option to false will require a manual update of each model's design doc whenever you know a change has happened. This will be useful in cases when you do not want CouchRest Model to interfere with the views already store in the CouchRest database, or you'd like to deploy your own update strategy. Here's an example of a module that will update all submodules:
+
+    module CouchRestMigration
+      def self.update_design_docs
+        CouchRest::Model::Base.subclasses.each{|klass| klass.save_design_doc! if klass.respond_to?(:save_design_doc!)}
+      end
+    end
+
+    # Running this from your applications initializers would be a good idea,
+    # for example in Rail's application.rb or environments/production.rb:
+    config.after_initialize do
+      CouchRestMigration.update_design_docs
+    end
+
+If you're dealing with multiple databases, using proxied models, or databases that are created on-the-fly, a more sophisticated approach might be required:
+
+    module CouchRestMigration
+      def self.update_all_design_docs
+        update_design_docs(COUCHREST_DATABASE)
+        Company.all.each do |company|
+          update_design_docs(company.proxy_database)
+        end
+      end
+      def self.update_design_docs(db)
+        CouchRest::Model::Base.subclasses.each{|klass| klass.save_design_doc!(db) if klass.respond_to?(:save_design_doc!}
+      end
+    end
+
+    # Command to run after a capistrano migration:
+    $ rails runner "CouchRestMigratin.update_all_design_docs"
+
 
 ## Assocations
 
@@ -546,7 +592,7 @@ such as validating for uniqueness and associations.
 
 CouchRest Model supports a few configuration options. These can be set either for the whole Model code
 base or for a specific model of your chosing. To configure globally, provide something similar to the 
-following in your projects loading code:
+following in your projects initializers or environments:
 
     CouchRest::Model::Base.configure do |config|
       config.mass_assign_any_attribute = true
@@ -562,7 +608,8 @@ To set for a specific model:
 Options currently avilable are:
 
  * `mass_assign_any_attribute` - false by default, when true any attribute may be updated via the update_attributes or attributes= methods.
- * `model_type_key` - 'couchrest-type' by default, is the name of property that holds the class name of each CouchRest Model.
+ * `model_type_key` - 'model' by default, is the name of property that holds the class name of each CouchRest Model.
+ * `auto_update_design_doc` - true by default, every time a view is requested and this option is true, a quick check will be performed to ensure the model's design document is up to date. When disabled, you're design documents will never be updated automatically and you'll need to perform updates manually. Results are cached on a per-database and per-design basis to help lower the number of requests. See the View section for more details.
 
 
 ## Notable Issues

data/VERSION

@@ -1 +1 @@
-1.1.0.beta2
+1.1.0.beta3

data/benchmarks/dirty.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'benchmark'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'couchrest_model'
+
+class BenchmarkCasted < Hash
+  include CouchRest::Model::CastedModel
+  
+  property :name
+end
+
+class BenchmarkModel < CouchRest::Model::Base
+  use_database CouchRest.database!(ENV['BENCHMARK_DB'] || "http://localhost:5984/test")
+
+  property :string, String
+  property :number, Integer
+  property :casted, BenchmarkCasted
+  property :casted_list, [BenchmarkCasted]
+end
+
+# set dirty configuration, return previous configuration setting
+def set_dirty(value)
+  orig = nil
+  CouchRest::Model::Base.configure do |config|
+    orig = config.use_dirty
+    config.use_dirty = value
+  end
+  BenchmarkModel.instance_eval do
+    self.use_dirty = value
+  end
+  orig
+end
+
+def supports_dirty?
+  CouchRest::Model::Base.respond_to?(:use_dirty)
+end
+
+def run_benchmark
+  n = 50000     # property operation count
+  db_n = 1000   # database operation count
+  b = BenchmarkModel.new
+
+  Benchmark.bm(30) do |x|
+
+    # property assigning
+
+    x.report("assign string:") do
+      n.times { b.string = "test" }
+    end
+
+    next if ENV["BENCHMARK_STRING"]
+
+    x.report("assign integer:") do
+      n.times { b.number = 1 }
+    end
+
+    x.report("assign casted hash:") do
+      n.times { b.casted = { 'name' => 'test' } }
+    end
+
+    x.report("assign casted hash list:") do
+      n.times { b.casted_list = [{ 'name' => 'test' }] }
+    end
+
+    # property reading
+
+    x.report("read string") do
+      n.times { b.string }
+    end
+
+    x.report("read integer") do
+      n.times { b.number }
+    end
+
+    x.report("read casted hash") do
+      n.times { b.casted }
+    end
+
+    x.report("read casted hash list") do
+      n.times { b.casted_list }
+    end
+
+    if ENV['BENCHMARK_DB']
+      # db writing
+      x.report("write changed record to db") do
+        db_n.times { |i| b.string = "test#{i}"; b.save }  
+      end
+
+      x.report("write unchanged record to db") do
+        db_n.times { b.save }  
+      end
+
+      # db reading
+      x.report("read record from db") do
+        db_n.times { BenchmarkModel.find(b.id) }
+      end
+
+    end
+
+  end
+end
+
+begin
+  if supports_dirty?
+    if !ENV['BENCHMARK_DIRTY_OFF']
+      set_dirty(true)
+      puts "with use_dirty true"
+      run_benchmark
+    end
+    set_dirty(false)
+    puts "\nwith use_dirty false"
+  end
+
+  run_benchmark
+end

data/couchrest_model.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<railties>, "~> 3.0.0")
   s.add_development_dependency(%q<rspec>, ">= 2.0.0")
   s.add_development_dependency(%q<rack-test>, ">= 0.5.7")
+  # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
 end
 

data/history.txt

@@ -1,3 +1,15 @@
+== 1.1.0.beta3
+
+* Major changes:
+  * Fast Dirty Tracking! Many thanks to @sobakasu (Andrew Williams)
+  * Default CouchRest Model type field now set to 'model' instead of 'couchrest-type'.
+
+* Minor enhancements:
+  * Adding "couchrest-hash" to Design Docs with aim to improve view update handling.
+  * Major changes to the way design document updates are handled internally.
+  * Added "auto_update_design_doc" configuration option.
+  * Using #descending on View object will automatically swap startkey with endkey.
+
 == 1.1.0.beta2
 
 * Minor enhancements:

data/lib/couchrest/model/base.rb

@@ -18,14 +18,17 @@ module CouchRest
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
       include CouchRest::Model::Designs
+      include CouchRest::Model::Dirty
+      include CouchRest::Model::CastedBy
 
       def self.subclasses
         @subclasses ||= []
       end
-      
+
       def self.inherited(subklass)
         super
         subklass.send(:include, CouchRest::Model::Properties)
+
         subklass.class_eval <<-EOS, __FILE__, __LINE__ + 1
           def self.inherited(subklass)
             super
@@ -36,16 +39,12 @@ module CouchRest
         EOS
         subclasses << subklass
       end
-      
-      # Accessors
-      attr_accessor :casted_by
-
 
       # Instantiate a new CouchRest::Model::Base by preparing all properties
       # using the provided document hash.
       #
       # Options supported:
-      # 
+      #
       # * :directly_set_attributes: true when data comes directly from database
       # * :database: provide an alternative database
       #
@@ -59,8 +58,8 @@ module CouchRest
         end
         after_initialize if respond_to?(:after_initialize)
       end
-     
-      
+
+
       # Temp solution to make the view_by methods available
       def self.method_missing(m, *args, &block)
         if has_view?(m)
@@ -74,24 +73,17 @@ module CouchRest
         end
         super
       end
-      
+
       ### instance methods
-      
-      # Gets a reference to the actual document in the DB
-      # Calls up to the next document if there is one,
-      # Otherwise we're at the top and we return self
-      def base_doc
-        return self if base_doc?
-        @casted_by.base_doc
-      end
-      
+
       # Checks if we're the top document
+      # (overrides base_doc? in casted_by.rb)
       def base_doc?
         !@casted_by
       end
-      
+
       ## Compatibility with ActiveSupport and older frameworks
-  
+
       # Hack so that CouchRest::Document, which descends from Hash,
       # doesn't appear to Rails routing as a Hash of options
       def is_a?(klass)
@@ -103,14 +95,14 @@ module CouchRest
       def persisted?
         !new?
       end
-      
+
       def to_key
-        new? ? nil : [id] 
+        new? ? nil : [id]
       end
 
       alias :to_param :id
       alias :new_record? :new?
       alias :new_document? :new?
-    end    
+    end
   end
 end

data/lib/couchrest/model/casted_array.rb

@@ -5,6 +5,7 @@
 
 module CouchRest::Model
   class CastedArray < Array
+    include CouchRest::Model::Dirty
     attr_accessor :casted_by
     attr_accessor :property
 
@@ -14,15 +15,39 @@ module CouchRest::Model
     end
     
     def << obj
+      couchrest_parent_will_change! if use_dirty?
       super(instantiate_and_cast(obj))
     end
     
     def push(obj)
+      couchrest_parent_will_change! if use_dirty?
+      super(instantiate_and_cast(obj))
+    end
+
+    def pop
+      couchrest_parent_will_change! if use_dirty? && self.length > 0
+      super
+    end
+
+    def shift
+      couchrest_parent_will_change! if use_dirty? && self.length > 0
+      super
+    end
+
+    def unshift(obj)
+      couchrest_parent_will_change! if use_dirty?
       super(instantiate_and_cast(obj))
     end
     
     def []= index, obj
-      super(index, instantiate_and_cast(obj))
+      value = instantiate_and_cast(obj)
+      couchrest_parent_will_change! if use_dirty? && value != self[index]
+      super(index, value)
+    end
+
+    def clear
+      couchrest_parent_will_change! if use_dirty? && self.length > 0
+      super
     end
 
     protected

data/lib/couchrest/model/casted_by.rb

@@ -0,0 +1,23 @@
+
+module CouchRest::Model
+  module CastedBy
+    extend ActiveSupport::Concern
+    included do
+      self.send(:attr_accessor, :casted_by)
+    end
+
+    # Gets a reference to the actual document in the DB
+    # Calls up to the next document if there is one,
+    # Otherwise we're at the top and we return self
+    def base_doc
+      return self if base_doc?
+      @casted_by ? @casted_by.base_doc : nil
+    end
+
+    # Checks if we're the top document
+    def base_doc?
+      false
+    end
+
+  end
+end

data/lib/couchrest/model/casted_hash.rb

@@ -0,0 +1,76 @@
+#
+# Wrapper around Hash so that the casted_by attribute is set.
+
+module CouchRest::Model
+  class CastedHash < Hash
+    include CouchRest::Model::Dirty
+    attr_accessor :casted_by
+
+    # needed for dirty
+    def attributes
+      self
+    end
+
+    def []= key, obj
+      couchrest_attribute_will_change!(key) if use_dirty? && obj != self[key]
+      super(key, obj)
+    end
+
+    def delete(key)
+      couchrest_attribute_will_change!(key) if use_dirty? && include?(key)
+      super(key)
+    end
+
+    def merge!(other_hash)
+      if use_dirty? && other_hash && other_hash.kind_of?(Hash)
+        other_hash.keys.each do |key|
+          if self[key] != other_hash[key] || !include?(key)
+            couchrest_attribute_will_change!(key)
+          end
+        end
+      end
+      super(other_hash)
+    end
+
+    def replace(other_hash)
+      if use_dirty? && other_hash && other_hash.kind_of?(Hash)
+        # new keys and changed keys
+        other_hash.keys.each do |key|
+          if self[key] != other_hash[key] || !include?(key) 
+            couchrest_attribute_will_change!(key) 
+          end
+        end
+        # old keys
+        old_keys = self.keys.reject { |key| other_hash.include?(key) }
+        old_keys.each { |key| couchrest_attribute_will_change!(key) }
+      end
+
+      super(other_hash)
+    end
+
+    def clear
+      self.keys.each { |key| couchrest_attribute_will_change!(key) } if use_dirty?
+      super
+    end
+
+    def delete_if
+      if use_dirty? && block_given?
+        self.keys.each do |key|
+          couchrest_attribute_will_change!(key) if yield key, self[key]
+        end
+      end
+      super
+    end
+
+    # ruby 1.9 
+    def keep_if
+      if use_dirty? && block_given?
+        self.keys.each do |key|
+          couchrest_attribute_will_change!(key) if !yield key, self[key]
+        end
+      end
+      super
+    end
+
+  end
+end

data/lib/couchrest/model/casted_model.rb

@@ -10,30 +10,32 @@ module CouchRest::Model
       include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
-      attr_accessor :casted_by
+      include CouchRest::Model::Dirty
+      # attr_accessor :casted_by
     end
-    
+
     def initialize(keys = {})
       raise StandardError unless self.is_a? Hash
       prepare_all_attributes(keys)
       super()
     end
-    
+
     def []= key, value
+      couchrest_attribute_will_change!(key) if self[key] != value
       super(key.to_s, value)
     end
-    
+
     def [] key
       super(key.to_s)
     end
-    
+
     # Gets a reference to the top level extended
     # document that a model is saved inside of
     def base_doc
       return nil unless @casted_by
       @casted_by.base_doc
     end
-    
+
     # False if the casted model has already
     # been saved in the containing document
     def new?
@@ -64,5 +66,6 @@ module CouchRest::Model
       end
     end
     alias :attributes= :update_attributes_without_saving
+
   end
 end

data/lib/couchrest/model/collection.rb

@@ -1,7 +1,13 @@
 module CouchRest
   module Model
+    # Warning! The Collection module is seriously depricated.
+    # Use the new Design Views instead, as this code copies many other parts
+    # of CouchRest Model.
+    #
+    # Expect this to be removed soon.
+    #
     module Collection
-  
+
       def self.included(base)
         base.extend(ClassMethods)
       end
@@ -131,6 +137,9 @@ module CouchRest
           else
             @view_name = "#{design_doc}/#{view_name}"
           end
+
+          # Save the design doc, ready for use
+          @container_class.save_design_doc(@database)
         end
 
         # See Collection.paginate

data/lib/couchrest/model/configuration.rb

@@ -10,10 +10,12 @@ module CouchRest
       included do
         add_config :model_type_key
         add_config :mass_assign_any_attribute
-        
+        add_config :auto_update_design_doc
+
         configure do |config|
-          config.model_type_key = 'couchrest-type' # 'model'?
+          config.model_type_key = 'model' # was 'couchrest-type'
           config.mass_assign_any_attribute = false
+          config.auto_update_design_doc = true
         end
       end
 
@@ -47,5 +49,3 @@ module CouchRest
     end
   end
 end
-
-