couchrest_model 2.1.0.rc1 → 2.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9cebaec8e04dcd93d4d5f53740ba5ce5b6af068
-  data.tar.gz: 71c3fb5e884c883124e05b2d69b60be3f474f7a1
+  metadata.gz: dc3de5182b5c551856bd3dbbbdea62fe97feccf8
+  data.tar.gz: 1aac104a38f10500bcfbf6d3812442b7fa6ca677
 SHA512:
-  metadata.gz: 9cfc97e0e45f07cfadfb6d9bdfe89e7a1437e1ffbb935c6584d0f0d83ebb3fce064490330cc84452ff2237548358ca805e7bdf15d3b8d586b7800235297c91d9
-  data.tar.gz: 7e0148b1299d685cb49af8c554ef5855b69e47cb270ed120b8ddebc5d2db2cd791f2a88de2689ca799d1b416b31f0886ba5c992b83056eeb496055c521e2dade
+  metadata.gz: f5c34608cb902751b5671abc660a23203cd7f340fcc05eefc670be5859f7693bb482bf05c400fd5789abfdd09affd9379ecc6589924b5ac70805a05fc0b81421
+  data.tar.gz: 39b5d65f53d8cb283f86fbfa0a3d6c27edea311dede32422cce4a0225cc42f98f2ed672cd65e01f48d176cc18a031f2758bbb12011f5391f7f57800ea88bcd80

data/.gitignore

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

data/.travis.yml

@@ -1,14 +1,25 @@
+language: ruby
+gemfile:
+  - Gemfile.activesupport-4.x
+  - Gemfile.activesupport-5.x
 rvm:
   - 2.3.0
-  - 2.2.2
+  - 2.2.4
   - 2.1.10
   - 2.0.0
   - jruby
+  - rbx
 services: couchdb
-matrix:
-  allow_failures:
-    - rvm: jruby
 before_install:
   - gem install bundler
 env:
   - JRUBY_OPTS=--2.0
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+      gemfile: Gemfile.activesupport-5.x
+    - rvm: 2.1.10
+      gemfile: Gemfile.activesupport-5.x
+    - rvm: jruby
+      gemfile: Gemfile.activesupport-5.x
+    - rvm: rbx # Has problems with Array#insert inheritence

data/Gemfile.activesupport-4.x

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'activesupport', '~> 4.0'

data/Gemfile.activesupport-5.x

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'activesupport', '~> 5.0'

data/README.md

@@ -19,6 +19,8 @@ See the [update history](https://github.com/couchrest/couchrest_model/blob/maste
 
 ### Upgrading from an earlier version?
 
+*Pre 2.2:* As of August 2016, dirty tracking has been radically re-factored away from ActiveModel::Dirty, which only has support for basic attributes, into a solution that uses [Hashdiff](https://github.com/liufengyun/hashdiff), more details available in the [pull request](https://github.com/couchrest/couchrest_model/pull/211). The result is that some of ActiveModel's Dirty methods are no longer available, these are: `changes_applied`, `restore_attributes`, `previous_changes`, and `changed_attributes`.
+
 *Pre 2.0:* As of June 2012, couchrest model no longer supports the `view_by` and `view` calls from the model. Views are no only accessed via a design document. If you have older code and wish to upgrade, please ensure you move to the new syntax for using views.
 
 *Pre 1.1:* As of April 2011 and the release of version 1.1.0, the default model type key is 'type' instead of 'couchrest-type'. Simply updating your project will not work unless you migrate your data or set the configuration option in your initializers:

data/VERSION

@@ -1 +1 @@
-2.1.0.rc1
+2.2.0.beta1

data/couchrest_model.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency("couchrest",   "2.0.0")
-  s.add_dependency("activemodel", "~> 4.0")
+  s.add_dependency("activemodel", ">= 4.0.2")
   s.add_dependency("tzinfo",      ">= 0.3.22")
-  s.add_development_dependency("rspec", "~> 2.14.1")
+  s.add_dependency("hashdiff",    "~> 0.3")
+  s.add_development_dependency("rspec", "~> 3.5.0")
   s.add_development_dependency("rack-test", ">= 0.5.7")
   s.add_development_dependency("rake", ">= 0.8.0")
   s.add_development_dependency("test-unit")

data/history.md

@@ -1,6 +1,19 @@
 # CouchRest Model Change History
 
-## 2.1.0 - 2016-07-06
+## 2.2.0.beta1 - pending
+
+  * Radical re-factor of dirty tracking using Hashdiff gem, providing reliable change detection with nested data. ([PR](https://github.com/couchrest/couchrest_model/pull/211) @samlown)
+  * Implement proxy for factory methods ([PR](https://github.com/couchrest/couchrest_model/pull/210) @ellneal)
+  * Add view option to specify a custom emit value for views ([PR](https://github.com/couchrest/couchrest_model/pull/209) @ellneal)
+  * Support proxying to multiple databases ([PR](https://github.com/couchrest/couchrest_model/pull/206) @ellneal)
+  * Support concurrent auto design doc updates ([PR](https://github.com/couchrest/couchrest_model/pull/201) @ghempton)
+  * Upgrading to rspec 3.5 and adding ActiveSupport 5.X tests (@samlown)
+
+## 2.1.0 - skipped!
+
+  * No release, moved straight to 2.2.0.
+
+## 2.1.0.rc1 - 2016-07-06
 
   * Adding "persistent" connection configuration property (@samlown)
   * Releasing 2.1.0 off of CouchRest 2.0.0.

data/lib/couchrest/model/associations.rb

@@ -1,12 +1,8 @@
 module CouchRest
   module Model
+    # Basic support for relationships between CouchRest::Model::Base
     module Associations
-
-      # Basic support for relationships between CouchRest::Model::Base
-      
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
+      extend ActiveSupport::Concern
 
       module ClassMethods
 
@@ -240,8 +236,7 @@ module CouchRest
 
       # Override CastedArray instantiation_and_cast method for a simpler
       # version that will not try to cast the model.
-      def instantiate_and_cast(obj, change = true)
-        couchrest_parent_will_change! if change && use_dirty?
+      def instantiate_and_cast(obj)
         obj.casted_by = casted_by if obj.respond_to?(:casted_by)
         obj.casted_by_property = casted_by_property if obj.respond_to?(:casted_by_property)
         obj

data/lib/couchrest/model/base.rb

@@ -45,19 +45,22 @@ module CouchRest
       #
       # Options supported:
       #
-      # * :directly_set_attributes, true when data comes directly from database
+      # * :write_all_attributes, true when data comes directly from database so we can set protected and read-only attributes.
       # * :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.
-      def initialize(attributes = {}, options = {})
+      def initialize(attributes = {}, options = {}, &block)
         super()
-        prepare_all_attributes(attributes, options)
-        # set the instance's database, if provided
+        
+        # Always force the type of model
+        self[self.model_type_key] = self.class.model_type_value
+
+        # Some instances may require a different database
         self.database = options[:database] unless options[:database].nil?
-        unless self['_id'] && self['_rev']
-          self[self.model_type_key] = self.class.model_type_value
-        end
+
+        # Deal with the attributes
+        write_attributes_for_initialization(attributes, options)
 
         yield self if block_given?
 
@@ -65,6 +68,11 @@ module CouchRest
         run_callbacks(:initialize) { self }
       end
 
+      def self.build(attrs = {}, options = {}, &block)
+
+
+      end
+
       alias :new_record? :new?
       alias :new_document? :new?
 

data/lib/couchrest/model/casted_array.rb

@@ -5,6 +5,7 @@
 
 module CouchRest::Model
   class CastedArray < Array
+    include CouchRest::Model::Configuration
     include CouchRest::Model::CastedBy
     include CouchRest::Model::Dirty
     attr_accessor :casted_by_property
@@ -29,43 +30,15 @@ module CouchRest::Model
       super(instantiate_and_cast(obj))
     end
 
-    def []= index, obj
-      value = instantiate_and_cast(obj, false)
-      couchrest_parent_will_change! if use_dirty? && value != self[index]
-      super(index, value)
+    def []=(index, obj)
+      super(index, instantiate_and_cast(obj))
     end
 
-    def insert index, *args
-      values = *args.map{|obj| instantiate_and_cast(obj, false)}
-      couchrest_parent_will_change! if use_dirty?
+    def insert(index, *args)
+      values = args.map{|obj| instantiate_and_cast(obj)}
       super(index, *values)
     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 clear
-      couchrest_parent_will_change! if use_dirty? && self.length > 0
-      super
-    end
-
-    def delete(obj)
-      couchrest_parent_will_change! if use_dirty? && self.length > 0
-      super(obj)
-    end
-
-    def delete_at(index)
-      couchrest_parent_will_change! if use_dirty? && self.length > 0
-      super(index)
-    end
-
     def build(*args)
       obj = casted_by_property.build(*args)
       self.push(obj)
@@ -76,11 +49,26 @@ module CouchRest::Model
       map{ |v| (v.respond_to?(:as_couch_json) ? v.as_couch_json : v)}
     end
 
+    # Overwrite the standard dirty tracking clearing.
+    # We don't have any properties, but we do need to check
+    # entries in our array.
+    def clear_changes_information
+      if use_dirty?
+        each do |val|
+          if val.respond_to?(:clear_changes_information)
+            val.clear_changes_information
+          end
+        end
+        @original_change_data = current_change_data
+      else
+        @original_change_data = nil
+      end
+    end
+
     protected
 
-    def instantiate_and_cast(obj, change = true)
+    def instantiate_and_cast(obj)
       property = casted_by_property
-      couchrest_parent_will_change! if change && use_dirty?
       if casted_by && property && obj.class != property.type
         property.cast_value(casted_by, obj)
       else

data/lib/couchrest/model/configuration.rb

@@ -15,12 +15,14 @@ module CouchRest
         add_config :connection
         add_config :connection_config_file
         add_config :time_fraction_digits
+        add_config :disable_dirty_tracking
 
         configure do |config|
           config.model_type_key = 'type' # was 'couchrest-type'
           config.mass_assign_any_attribute = false
           config.auto_update_design_doc = true
           config.time_fraction_digits = 3
+          config.disable_dirty_tracking = false
 
           config.environment = :development
           config.connection_config_file = File.join(Dir.pwd, 'config', 'couchdb.yml')

data/lib/couchrest/model/design.rb

@@ -17,6 +17,7 @@ module CouchRest
       def initialize(model, prefix = nil)
         self.model       = model
         self.method_name = self.class.method_name(prefix)
+        @lock            = Mutex.new
         suffix = prefix ? "_#{prefix}" : ''
         self["_id"] = "_design/#{model.to_s}#{suffix}"
         apply_defaults
@@ -26,7 +27,8 @@ module CouchRest
         if auto_update
           db ||= database
           if cache_checksum(db) != checksum
-            sync!(db)
+            # Only allow one thread to update the design document at a time
+            @lock.synchronize { sync!(db) }
             set_cache_checksum(db, checksum)
           end
         end
@@ -39,6 +41,7 @@ module CouchRest
         # Load up the last copy. We never blindly overwrite the remote copy
         # as it may contain views that are not used or known about by
         # our model.
+
         doc = load_from_database(db)
 
         if !doc || doc['couchrest-hash'] != checksum
@@ -181,5 +184,3 @@ module CouchRest
     end
   end
 end
-
-

data/lib/couchrest/model/designs/view.rb

@@ -5,10 +5,10 @@ module CouchRest
       #
       # A proxy class that allows view queries to be created using
       # chained method calls. After each call a new instance of the method
-      # is created based on the original in a similar fashion to ruby's Sequel 
+      # is created based on the original in a similar fashion to ruby's Sequel
       # library, or Rails 3's Arel.
       #
-      # CouchDB views have inherent limitations, so joins and filters as used in 
+      # CouchDB views have inherent limitations, so joins and filters as used in
       # a normal relational database are not possible.
       #
       class View
@@ -52,7 +52,7 @@ module CouchRest
         # == View Execution Methods
         #
         # Request to the CouchDB database using the current query values.
-       
+
         # Return each row wrapped in a ViewRow object. Unlike the raw
         # CouchDB request, this will provide an empty array if there
         # are no results.
@@ -65,7 +65,7 @@ module CouchRest
           else
             if execute && result['rows']
               @rows ||= result['rows'].map{|v| ViewRow.new(v, model, use_database)}
-            else 
+            else
               [ ]
             end
           end
@@ -81,7 +81,7 @@ module CouchRest
         end
 
         # Provide all the documents from the view. If the view has not been
-        # prepared with the +include_docs+ option, each document will be 
+        # prepared with the +include_docs+ option, each document will be
         # loaded individually.
         def docs
           if block_given?
@@ -93,17 +93,17 @@ module CouchRest
           end
         end
 
-        # If another request has been made on the view, this will return 
+        # If another request has been made on the view, this will return
         # the first document in the set. If not, a new query object will be
-        # generated with a limit of 1 so that only the first document is 
+        # generated with a limit of 1 so that only the first document is
         # loaded.
         def first
           result ? all.first : limit(1).all.first
         end
 
         # Same as first but will order the view in descending order. This
-        # does not however reverse the search keys or the offset, so if you 
-        # are using a +startkey+ and +endkey+ you might end up with 
+        # does not however reverse the search keys or the offset, so if you
+        # are using a +startkey+ and +endkey+ you might end up with
         # unexpected results.
         #
         # If in doubt, don't use this method!
@@ -127,7 +127,7 @@ module CouchRest
         #
         # Trying to use this method with the group option will raise an error.
         #
-        # If no reduce function is defined, a query will be performed 
+        # If no reduce function is defined, a query will be performed
         # to return the total number of rows, this is the equivalant of:
         #
         #    view.limit(0).total_rows
@@ -142,7 +142,7 @@ module CouchRest
           end
         end
 
-        # Check to see if the array of documents is empty. This *will* 
+        # Check to see if the array of documents is empty. This *will*
         # perform the query and return all documents ready to use, if you don't
         # want to load anything, use +#total_rows+ or +#count+ instead.
         def empty?
@@ -181,7 +181,7 @@ module CouchRest
         #
         # In this example, the raw option will be ignored, and the total rows
         # will still be accessible.
-        # 
+        #
         def [](value)
           execute[value]
         end
@@ -194,8 +194,8 @@ module CouchRest
 
 
         # == View Filter Methods
-        # 
-        # View filters return a copy of the view instance with the query 
+        #
+        # View filters return a copy of the view instance with the query
         # modified appropriatly. Errors will be raised if the methods
         # are combined in an incorrect fashion.
         #
@@ -208,10 +208,10 @@ module CouchRest
           update_query(:key => value)
         end
 
-        # Find all index keys that start with the value provided. May or may 
+        # Find all index keys that start with the value provided. May or may
         # not be used in conjunction with the +endkey+ option.
         #
-        # When the +#descending+ option is used (not the default), the start 
+        # When the +#descending+ option is used (not the default), the start
         # and end keys should be reversed, as per the CouchDB API.
         #
         # Cannot be used if the key has been set.
@@ -220,7 +220,7 @@ module CouchRest
           update_query(:startkey => value)
         end
 
-        # The result set should start from the position of the provided document. 
+        # The result set should start from the position of the provided document.
         # The value may be provided as an object that responds to the +#id+ call
         # or a string.
         def startkey_doc(value)
@@ -237,19 +237,19 @@ module CouchRest
           update_query(:endkey => value)
         end
 
-        # The result set should end at the position of the provided document. 
-        # The value may be provided as an object that responds to the +#id+ 
+        # The result set should end at the position of the provided document.
+        # The value may be provided as an object that responds to the +#id+
         # call or a string.
         def endkey_doc(value)
           update_query(:endkey_docid => value.is_a?(String) ? value : value.id)
         end
 
         # Keys is a special CouchDB option that will cause the view request to be POSTed
-        # including an array of keys. Only documents with the matching keys will be 
-        # returned. This is much faster than sending multiple requests for a set 
+        # including an array of keys. Only documents with the matching keys will be
+        # returned. This is much faster than sending multiple requests for a set
         # non-consecutive documents.
         #
-        # If no values are provided, this method will act as a wrapper around 
+        # If no values are provided, this method will act as a wrapper around
         # the rows result set, providing an array of keys.
         def keys(*keys)
           if keys.empty?
@@ -302,16 +302,16 @@ module CouchRest
         # Control whether the reduce function reduces to a set of distinct keys
         # or to a single result row.
         #
-        # By default the value is false, and can only be set when the view's 
+        # By default the value is false, and can only be set when the view's
         # +#reduce+ option has been set.
         def group
           raise "View#reduce must have been set before grouping is permitted" unless query[:reduce]
           update_query(:group => true)
         end
 
-        # Will set the level the grouping should be performed to. As per the 
+        # Will set the level the grouping should be performed to. As per the
         # CouchDB API, it only makes sense when the index key is an array.
-        # 
+        #
         # This will automatically set the group option.
         def group_level(value)
           group.update_query(:group_level => value.to_i)
@@ -325,7 +325,7 @@ module CouchRest
 
         # Allow the results of a query to be provided "stale". Setting to 'ok'
         # will disable all view updates for the query.
-        # When 'update_after' is provided the index will be update after the 
+        # When 'update_after' is provided the index will be update after the
         # result has been returned.
         def stale(value)
           unless (['ok', 'update_after'].include?(value.to_s))
@@ -445,17 +445,17 @@ module CouchRest
             create_model_methods(design_doc, name, opts)
           end
 
-          # Simplified view definition. A new view will be added to the 
+          # Simplified view definition. A new view will be added to the
           # provided design document using the name and options.
           #
-          # If the view name starts with "by_" and +:by+ is not provided in 
+          # If the view name starts with "by_" and +:by+ is not provided in
           # the options, the new view's map method will be interpreted and
           # generated automatically. For example:
           #
           #   View.define(Meeting, design, "by_date_and_name")
           #
-          # Will create a view that searches by the date and name properties. 
-          # Explicity setting the attributes to use is possible using the 
+          # Will create a view that searches by the date and name properties.
+          # Explicity setting the attributes to use is possible using the
           # +:by+ option. For example:
           #
           #   View.define(Meeting, design, "by_date_and_name", :by => [:date, :firstname, :lastname])
@@ -491,18 +491,23 @@ module CouchRest
               end
               raise "View cannot be created without recognised name, :map or :by options" if opts[:by].nil?
 
+              # convert emit symbols to properties
+              opts[:emit] = "doc['#{opts[:emit]}']" if opts[:emit].is_a?(Symbol)
+              opts[:emit] = "[" + opts[:emit].map { |i| i.is_a?(Symbol) ? "doc['#{i}']" : i }.join(', ') + "]" if opts[:emit].is_a?(Array)
+
               opts[:allow_blank] = opts[:allow_blank].nil? ? true : opts[:allow_blank]
               opts[:guards] ||= []
               opts[:guards].push "(doc['#{model.model_type_key}'] == '#{model.model_type_value}')"
 
               keys = opts[:by].map{|o| "doc['#{o}']"}
-              emit = keys.length == 1 ? keys.first : "[#{keys.join(', ')}]"
+              emit_keys = keys.length == 1 ? keys.first : "[#{keys.join(', ')}]"
+              emit_value = opts[:emit] || 1;
               opts[:guards] += keys.map{|k| "(#{k} != null)"} unless opts[:allow_nil]
               opts[:guards] += keys.map{|k| "(#{k} != '')"} unless opts[:allow_blank]
               opts[:map] = <<-EOF
                 function(doc) {
                   if (#{opts[:guards].join(' && ')}) {
-                    emit(#{emit}, 1);
+                    emit(#{emit_keys}, #{emit_value});
                   }
                 }
               EOF