couchrest_model 1.1.2 → 1.2.0.beta

data/README.md

@@ -21,7 +21,11 @@ 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 '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:
+### Upgrading from an earlier version?
+
+*Pre 1.2:* 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:
 
     CouchRest::Model::Base.configure do |config|
       config.model_type_key = 'couchrest-type'
@@ -91,7 +95,9 @@ The example config above for example would use a database called "project_test".
 
       timestamps!
 
-      view_by :name
+      design do
+        view :by_name
+      end
 
     end
 

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0.beta

data/couchrest_model.gemspec

@@ -25,11 +25,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency(%q<couchrest>, "~> 1.1.2")
   s.add_dependency(%q<mime-types>, "~> 1.15")
-  s.add_dependency(%q<activemodel>, "~> 3.0")
+  s.add_dependency(%q<activemodel>, "~> 3.1.0")
   s.add_dependency(%q<tzinfo>, "~> 0.3.22")
   s.add_development_dependency(%q<rspec>, "~> 2.6.0")
   s.add_development_dependency(%q<json>, ["~> 1.5.1"])
   s.add_development_dependency(%q<rack-test>, ">= 0.5.7")
+  s.add_development_dependency("rake", ">= 0.8.0")
   # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
 end
 

data/history.md

@@ -1,5 +1,13 @@
 # CouchRest Model Change History
 
+## 1.2.0.beta - 2012-06-08
+
+  * Completely refactored Design Document handling.
+  * Removed old `view` and `view_by` methods.
+  * CouchRest::Model::Base.respond_to_missing? and respond_to? (Kim Burgestrand)
+  * Time#as_json now insists on using xmlschema with 3 fraction digits by default.
+  * Added time_fraction_digits configuration object
+
 ## 1.1.2 - 2011-07-23
 
 * Minor fixes

data/lib/couchrest/model/base.rb

@@ -8,12 +8,8 @@ module CouchRest
       include CouchRest::Model::Connection
       include CouchRest::Model::Persistence
       include CouchRest::Model::DocumentQueries
-      include CouchRest::Model::Views
-      include CouchRest::Model::DesignDoc
       include CouchRest::Model::ExtendedAttachments
-      include CouchRest::Model::ClassProxy
       include CouchRest::Model::Proxyable
-      include CouchRest::Model::Collection
       include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
@@ -21,7 +17,6 @@ module CouchRest
       include CouchRest::Model::Designs
       include CouchRest::Model::CastedBy
       include CouchRest::Model::Dirty
-      include CouchRest::Model::Callbacks
 
       def self.subclasses
         @subclasses ||= []
@@ -67,21 +62,6 @@ module CouchRest
         run_callbacks(:initialize) { self }
       end
 
-
-      # Temp solution to make the view_by methods available
-      def self.method_missing(m, *args, &block)
-        if has_view?(m)
-          query = args.shift || {}
-          return view(m, query, *args, &block)
-        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
-
       def to_key
         new? ? nil : [id]
       end

data/lib/couchrest/model/configuration.rb

@@ -14,11 +14,13 @@ module CouchRest
         add_config :environment
         add_config :connection
         add_config :connection_config_file
+        add_config :time_fraction_digits
 
         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.environment = :development
           config.connection_config_file = File.join(Dir.pwd, 'config', 'couchdb.yml')

data/lib/couchrest/model/core_extensions/time_parsing.rb

@@ -1,6 +1,7 @@
 module CouchRest
   module Model
     module CoreExtensions
+
       module TimeParsing
 
         if RUBY_VERSION < "1.9.0"
@@ -33,22 +34,22 @@ module CouchRest
         # UTC.
         #
         def parse_iso8601(string)
-          if (string =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})[T|\s](\d{2}):(\d{2}):(\d{2})(Z| ?([\+|\s|\-])?(\d{2}):?(\d{2}))?/)
+          if (string =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})[T|\s](\d{2}):(\d{2}):(\d{2}(\.\d+)?)(Z| ?([\+|\s|\-])?(\d{2}):?(\d{2}))?/)
             # $1 = year
             # $2 = month
             # $3 = day
             # $4 = hours
             # $5 = minutes
-            # $6 = seconds
-            # $7 = UTC or Timezone
-            # $8 = time zone direction
-            # $9 = tz difference hours
-            # $10 = tz difference minutes
+            # $6 = seconds (with $7 for fraction)
+            # $8 = UTC or Timezone
+            # $9 = time zone direction
+            # $10 = tz difference hours
+            # $11 = tz difference minutes
 
-            if (!$7.to_s.empty? && $7 != 'Z')
-              new($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i, "#{$8 == '-' ? '-' : '+'}#{$9}:#{$10}")
+            if $8 == 'Z' || $8.to_s.empty?
+              utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_f)
             else
-              utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i)
+              new($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_f, "#{$9 == '-' ? '-' : '+'}#{$10}:#{$11}")
             end
           else
             parse(string)
@@ -56,11 +57,36 @@ module CouchRest
         end
 
       end
+
     end
   end
 end
 
 Time.class_eval do
   extend CouchRest::Model::CoreExtensions::TimeParsing
+
+  # Override the ActiveSupport's Time#as_json method to ensure that we *always* encode
+  # using the iso8601 format and include fractional digits (3 by default).
+  #
+  # Including miliseconds in Time is very important for CouchDB to ensure that order
+  # is preserved between models created in the same second.
+  #
+  # The number of fraction digits can be set by providing it in the options:
+  #
+  #    time.as_json(:fraction_digits => 6)
+  #
+  # The CouchRest Model +time_fraction_digits+ configuration option is used for the
+  # default fraction. Given the global nature of Time#as_json method, this configuration
+  # option can only be set for the whole project.
+  #
+  #    CouchRest::Model::Base.time_fraction_digits = 6
+  #
+
+  def as_json(options = {})
+    digits = options ? options[:fraction_digits] : nil
+    fraction = digits || CouchRest::Model::Base.time_fraction_digits
+    xmlschema(fraction)
+  end
+
 end
 

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

@@ -0,0 +1,182 @@
+
+module CouchRest
+  module Model
+    module Designs
+
+      class Design < ::CouchRest::Design
+
+        # The model Class that this design belongs to and method name
+        attr_accessor :model, :method_name
+
+        # Can this design save itself to the database?
+        # If false, the design will be loaded automatically before a view is executed.
+        attr_accessor :auto_update
+
+
+        # Instantiate a new design document for this model
+        def initialize(model, prefix = nil)
+          self.model       = model
+          self.method_name = self.class.method_name(prefix)
+          suffix = prefix ? "_#{prefix}" : ''
+          self["_id"] = "_design/#{model.to_s}#{suffix}"
+          apply_defaults
+        end
+
+        def sync(db = nil)
+          if auto_update
+            db ||= database
+            if cache_checksum(db) != checksum
+              sync!(db)
+              set_cache_checksum(db, checksum)
+            end
+          end
+          self
+        end
+
+        def sync!(db = nil)
+          db ||= database
+
+          # 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
+            # We need to save something
+            if doc
+              # Different! Update.
+              doc.merge!(to_hash)
+            else
+              # No previous doc, use a *copy* of our version.
+              # Using a copy prevents reverse updates.
+              doc = to_hash.dup
+            end
+            db.save_doc(doc)
+          end
+
+          self
+        end
+
+
+        def checksum
+          sum = self['couchrest-hash']
+          if sum && (@_original_hash == to_hash)
+            sum
+          else
+            checksum!
+          end
+        end
+
+        def database
+          model.database
+        end
+
+        # Override the default #uri method for one that accepts
+        # the current database.
+        # This is used by the caching code.
+        def uri(db = database)
+          "#{db.root}/#{self['_id']}"
+        end
+
+
+        ######## VIEW HANDLING ########
+
+        # Create a new view object.
+        # This overrides the normal CouchRest Design view method
+        def view(name, opts = {})
+          CouchRest::Model::Designs::View.new(self, model, opts, name)
+        end
+
+        # Helper method to provide a list of all the views
+        def view_names
+          self['views'].keys
+        end
+
+        def has_view?(name)
+          view_names.include?(name.to_s)
+        end
+
+        # Add the specified view to the design doc the definition was made in
+        # and create quick access methods in the model.
+        def create_view(name, opts = {})
+          View.define_and_create(self, name, opts)
+        end
+
+        ######## FILTER HANDLING ########
+
+        def create_filter(name, function)
+          filters = (self['filters'] ||= {})
+          filters[name.to_s] = function
+        end
+
+        protected
+
+        def load_from_database(db = database)
+          db.get(self['_id'])
+        rescue RestClient::ResourceNotFound
+          nil
+        end
+
+        # Calculate and update the checksum of the Design document.
+        # Used for ensuring the latest version has been sent to the database.
+        #
+        # This will generate an flatterned, ordered array of all the elements of the
+        # design document, convert to string then generate an MD5 Hash. This should
+        # result in a consisitent Hash accross all platforms.
+        #
+        def checksum!
+          # Get a deep copy of hash to compare with
+          @_original_hash = Marshal.load(Marshal.dump(to_hash))
+          # create a copy of basic elements
+          base = self.dup
+          base.delete('_id')
+          base.delete('_rev')
+          base.delete('couchrest-hash')
+          result = nil
+          flatten =
+            lambda {|r|
+              (recurse = lambda {|v|
+                if v.is_a?(Hash) || v.is_a?(CouchRest::Document)
+                  v.to_a.map{|v| recurse.call(v)}.flatten
+                elsif v.is_a?(Array)
+                  v.flatten.map{|v| recurse.call(v)}
+                else
+                  v.to_s
+                end
+              }).call(r)
+            }
+          self['couchrest-hash'] = Digest::MD5.hexdigest(flatten.call(base).sort.join(''))
+        end
+
+        def cache
+          Thread.current[:couchrest_design_cache] ||= {}
+        end
+        def cache_checksum(db)
+          cache[uri(db)]
+        end
+        def set_cache_checksum(db, checksum)
+          cache[uri(db)] = checksum
+        end
+
+        def apply_defaults
+          merge!(
+            "language" => "javascript",
+            "views"    => { }
+          )
+        end
+
+
+        class << self
+
+          def method_name(prefix = nil)
+            (prefix ? "#{prefix}_" : '') + 'design_doc'
+          end
+
+        end
+
+      end
+    end
+  end
+end
+
+

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

@@ -14,20 +14,22 @@ module CouchRest
       class View
         include Enumerable
 
-        attr_accessor :owner, :model, :name, :query, :result
+        attr_accessor :owner, :model, :design_doc, :name, :query, :result
 
         # Initialize a new View object. This method should not be called from
         # outside CouchRest Model.
-        def initialize(parent, new_query = {}, name = nil)
+        def initialize(design_doc, parent, new_query = {}, name = nil)
+          self.design_doc = design_doc
+          proxy = new_query.delete(:proxy)
           if parent.is_a?(Class) && parent < CouchRest::Model::Base
             raise "Name must be provided for view to be initialized" if name.nil?
-            self.model    = parent
+            self.model    = (proxy || parent)
             self.owner    = parent
             self.name     = name.to_s
             # Default options:
             self.query    = { }
           elsif parent.is_a?(self.class)
-            self.model    = (new_query.delete(:proxy) || parent.model)
+            self.model    = (proxy || parent.model)
             self.owner    = parent.owner
             self.name     = parent.name
             self.query    = parent.query.dup
@@ -271,7 +273,7 @@ module CouchRest
         end
 
         # Use the reduce function on the view. If none is available this method
-        # will fail. 
+        # will fail.
         def reduce
           raise "Cannot reduce a view without a reduce method" unless can_reduce?
           update_query(:reduce => true, :include_docs => nil)
@@ -301,6 +303,17 @@ module CouchRest
 
         ### Special View Filter Methods
 
+        # 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 
+        # result has been returned.
+        def stale(value)
+          unless (['ok', 'update_after'].include?(value.to_s))
+            raise "View#stale can only be set with 'ok' or 'update_after'."
+          end
+          update_query(:stale => value.to_s)
+        end
+
         # Specify the database the view should use. If not defined,
         # an attempt will be made to load its value from the model.
         def database(value)
@@ -309,8 +322,8 @@ module CouchRest
 
         # Set the view's proxy that will be used instead of the model
         # for any future searches. As soon as this enters the
-        # new object's initializer it will be removed and replace
-        # the model object.
+        # new view's initializer it will be removed and set as the model
+        # object.
         #
         # See the Proxyable mixin for more details.
         #
@@ -380,11 +393,7 @@ module CouchRest
         end
 
         def update_query(new_query = {})
-          self.class.new(self, new_query)
-        end
-
-        def design_doc
-          model.design_doc
+          self.class.new(design_doc, self, new_query)
         end
 
         def can_reduce?
@@ -402,27 +411,33 @@ module CouchRest
           # Remove the reduce value if its not needed to prevent CouchDB errors
           query.delete(:reduce) unless can_reduce?
 
-          model.save_design_doc(use_database)
+          design_doc.sync(use_database)
 
-          self.result = model.design_doc.view_on(use_database, name, query.reject{|k,v| v.nil?})
+          self.result = design_doc.view_on(use_database, name, query.reject{|k,v| v.nil?})
         end
 
         # Class Methods
         class << self
-          # Simplified view creation. A new view will be added to the 
-          # provided model's design document using the name and options.
+
+          def define_and_create(design_doc, name, opts = {})
+            define(design_doc, name, opts)
+            create_model_methods(design_doc, name, opts)
+          end
+
+          # 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 
           # the options, the new view's map method will be interpreted and
           # generated automatically. For example:
           #
-          #   View.create(Meeting, "by_date_and_name")
+          #   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 
           # +:by+ option. For example:
           #
-          #   View.create(Meeting, "by_date_and_name", :by => [:date, :firstname, :lastname])
+          #   View.define(Meeting, design, "by_date_and_name", :by => [:date, :firstname, :lastname])
           #
           # The view name is the same, but three keys would be used in the
           # subsecuent index.
@@ -437,44 +452,72 @@ module CouchRest
           # like to enable this, set the <tt>:allow_blank</tt> option to false. The default
           # is true, empty strings are permited in the indexes.
           #
-          def create(model, name, opts = {})
-
-            unless opts[:map]
-              if opts[:by].nil? && name.to_s =~ /^by_(.+)/
-                opts[:by] = $1.split(/_and_/)
-              end
-
-              raise "View cannot be created without recognised name, :map or :by options" if opts[:by].nil?
-
-              opts[:allow_blank] = opts[:allow_blank].nil? ? true : opts[:allow_blank]
-              opts[:guards] ||= []
-              opts[:guards].push "(doc['#{model.model_type_key}'] == '#{model.to_s}')"
-
-              keys = opts[:by].map{|o| "doc['#{o}']"}
-              emit = keys.length == 1 ? keys.first : "[#{keys.join(', ')}]"
-              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);
+          def define(design_doc, name, opts = {})
+            # Don't create the map or reduce method if auto updates are disabled
+            if design_doc.auto_update
+              model = design_doc.model
+              # Is this an all view?
+              if name.to_s == 'all'
+                opts[:map] = <<-EOF
+                  function(doc) {
+                    if (doc['#{model.model_type_key}'] == '#{model.to_s}') {
+                      emit(doc._id, null);
+                    }
+                  }
+                EOF
+              elsif !opts[:map]
+                if opts[:by].nil? && name.to_s =~ /^by_(.+)/
+                  opts[:by] = $1.split(/_and_/)
+                end
+
+                raise "View cannot be created without recognised name, :map or :by options" if opts[:by].nil?
+
+                opts[:allow_blank] = opts[:allow_blank].nil? ? true : opts[:allow_blank]
+                opts[:guards] ||= []
+                opts[:guards].push "(doc['#{model.model_type_key}'] == '#{model.to_s}')"
+
+                keys = opts[:by].map{|o| "doc['#{o}']"}
+                emit = keys.length == 1 ? keys.first : "[#{keys.join(', ')}]"
+                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);
+                    }
                   }
-                }
-              EOF
-              opts[:reduce] = <<-EOF
-                function(key, values, rereduce) {
-                  return sum(values);
-                }
-              EOF
+                EOF
+                opts[:reduce] = <<-EOF
+                  function(key, values, rereduce) {
+                    return sum(values);
+                  }
+                EOF
+              end
+            else
+              # Assume there is always a map method
+              opts[:map] ||= true
             end
 
-            model.design_doc['views'] ||= {}
-            view = model.design_doc['views'][name.to_s] = { }
+            design_doc['views'] ||= {}
+            view = design_doc['views'][name.to_s] = { }
             view['map'] = opts[:map]
             view['reduce'] = opts[:reduce] if opts[:reduce]
             view
           end
 
+
+          def create_model_methods(design_doc, name, opts = {})
+            method = design_doc.method_name
+            design_doc.model.instance_eval <<-EOS, __FILE__, __LINE__ + 1
+              def #{name}(opts = {})
+                #{method}.view('#{name}', opts)
+              end
+              def find_#{name}(*key)
+                #{name}.key(*key).first()
+              end
+            EOS
+          end
+
         end
 
       end