couchrest_model 2.0.0.beta2 → 2.0.0

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby
+services: couchdb
+matrix:
+  allow_failures:
+    - rvm: jruby

data/Gemfile

@@ -1,4 +1,4 @@
 
-source :rubygems
+source "https://rubygems.org"
 gemspec
 

data/README.md

@@ -1,4 +1,4 @@
-# CouchRest Model: CouchDB, close to shiny metal with rounded edges
+# CouchRest Model: CouchDB, close to shiny metal with rounded edges [![Build Status](https://travis-ci.org/couchrest/couchrest_model.png)](https://travis-ci.org/couchrest/couchrest_model)
 
 CouchRest Models adds additional functionality to the standard CouchRest Document class such as
 setting properties, callbacks, typecasting, and validations.

data/Rakefile

@@ -1,33 +1,18 @@
-require 'rubygems'
+# encoding: utf-8
 require 'bundler'
-require 'rspec/core/rake_task'
-require "rake/rdoctask"
-
 Bundler::GemHelper.install_tasks
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ["--color"]
-  spec.pattern = 'spec/**/*_spec.rb'
-end
+require 'rspec/core/rake_task'
 
-desc "Print specdocs"
-RSpec::Core::RakeTask.new(:doc) do |spec|
-  spec.rspec_opts = ["--format", "specdoc"]
-  spec.pattern = 'spec/*_spec.rb'
-end
+desc 'Default: run unit tests.'
+task :default => :spec
 
-desc "Generate the rdoc"
-Rake::RDocTask.new do |rdoc|
-  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
-  rdoc.rdoc_files.add(files)
-  rdoc.main = "README.rdoc"
-  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["-c", "-f progress"]
 end
 
-desc "Run the rspec"
-task :default => :spec
-
 module Rake
   def self.remove_task(task_name)
     Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
@@ -35,4 +20,4 @@ module Rake
 end
 
 Rake.remove_task("github:release")
-Rake.remove_task("release")
+Rake.remove_task("release")

data/VERSION

@@ -1 +1 @@
-2.0.0.beta2
+2.0.0

data/couchrest_model.gemspec

@@ -24,14 +24,16 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency(%q<couchrest>, "~> 1.1.3")
-  s.add_dependency(%q<mime-types>, "~> 1.15")
-  s.add_dependency(%q<activemodel>, "~> 3.0")
-  s.add_dependency(%q<tzinfo>, "~> 0.3.22")
+  s.add_dependency(%q<mime-types>, ">= 1.15")
+  s.add_dependency(%q<activemodel>, ">= 3.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("debugger", "~> 1.2.0")
+  s.add_development_dependency(%q<activemodel>, ">= 4.0")
+  #s.add_development_dependency("debugger", "~> 1.2.0") # TODO put in Gemfile
+  #s.add_development_dependency(%q<oj>, "~> 1.3.4") # TODO put in Gemfile (fails in JRuby)
+  s.add_development_dependency("kaminari", "~> 0.14.1")
   # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
 end
-

data/history.md

@@ -1,6 +1,6 @@
 # CouchRest Model Change History
 
-## 2.0.0.beta2 - 2012-08-02
+## 2.0.0 - 2013-10-04
 
   * Added design doc migration support, including for proxied models
   * Rake tasks available for migrations
@@ -10,6 +10,22 @@
   * Added :allow_blank option to properties so that empty strings are forced to nil.
   * Modified associations to use allow_blank property
   * Incorported Rails 3.2 support changes (Thanks @jodosha)
+  * Kaminari support upgraded to use 0.14.0 API (Thanks @amatsuda)
+  * JSON Oj support, fixed some Time handling issues
+  * Simplifying number typecasting to always provide a number, or nil.
+  * Reduce option in views now accepts symbols: `:sum` to `'_sum'`
+  * Dirty tracking now supports CastedArray#insert method.
+  * Support for Rails 4.0.
+  * Removing support for <= Ruby 1.9.2.
+  * Fixing model translation support.
+  * Fixing `belongs_to` setting foreign key cache issue.
+  * Support typecasting `Symbol`
+  * Added `:array` option to properties
+  * Typecasting Dates, Times, and Booleans, with invalid values returns nil
+  
+  * API Breaking Changes
+    * Properties with blocks are now singular unless the `array: true` option is passed.
+  
 
 ## 1.2.0.beta - 2012-06-08
 

data/lib/couchrest/model/associations.rb

@@ -40,6 +40,7 @@ module CouchRest
 
           property(opts[:foreign_key], String, opts)
 
+          create_association_property_setter(attrib, opts)
           create_belongs_to_getter(attrib, opts)
           create_belongs_to_setter(attrib, opts)
         end
@@ -90,7 +91,7 @@ module CouchRest
 
           property(opts[:foreign_key], [String], opts)
 
-          create_collection_of_property_setter(attrib, opts)
+          create_association_property_setter(attrib, opts)
           create_collection_of_getter(attrib, opts)
           create_collection_of_setter(attrib, opts)
         end
@@ -120,6 +121,20 @@ module CouchRest
           opts
         end
 
+        ### Generic support methods
+
+        def create_association_property_setter(attrib, options)
+          # ensure CollectionOfProxy is nil, ready to be reloaded on request
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{options[:foreign_key]}=(value)
+              @#{attrib} = nil
+              write_attribute("#{options[:foreign_key]}", value)
+            end
+          EOS
+        end
+
+        ### belongs_to support methods
+
         def create_belongs_to_getter(attrib, options)
           class_eval <<-EOS, __FILE__, __LINE__ + 1
             def #{attrib}
@@ -139,16 +154,6 @@ module CouchRest
 
         ### collection_of support methods
 
-        def create_collection_of_property_setter(attrib, options)
-          # ensure CollectionOfProxy is nil, ready to be reloaded on request
-          class_eval <<-EOS, __FILE__, __LINE__ + 1
-            def #{options[:foreign_key]}=(value)
-              @#{attrib} = nil
-              write_attribute("#{options[:foreign_key]}", value)
-            end
-          EOS
-        end
-
         def create_collection_of_getter(attrib, options)
           class_eval <<-EOS, __FILE__, __LINE__ + 1
             def #{attrib}(reload = false)

data/lib/couchrest/model/base.rb

@@ -2,22 +2,24 @@ module CouchRest
   module Model
     class Base < CouchRest::Document
 
-      extend  ActiveModel::Naming
       include ActiveModel::Conversion
 
-      include CouchRest::Model::Configuration
-      include CouchRest::Model::Connection
-      include CouchRest::Model::Persistence
-      include CouchRest::Model::DocumentQueries
-      include CouchRest::Model::ExtendedAttachments
-      include CouchRest::Model::Proxyable
-      include CouchRest::Model::PropertyProtection
-      include CouchRest::Model::Associations
-      include CouchRest::Model::Validations
-      include CouchRest::Model::Callbacks
-      include CouchRest::Model::Designs
-      include CouchRest::Model::CastedBy
-      include CouchRest::Model::Dirty
+      extend Translation
+
+      include Configuration
+      include Connection
+      include Persistence
+      include DocumentQueries
+      include ExtendedAttachments
+      include Proxyable
+      include PropertyProtection
+      include Associations
+      include Validations
+      include Callbacks
+      include Designs
+      include CastedBy
+      include Dirty
+      
 
       def self.subclasses
         @subclasses ||= []
@@ -25,7 +27,7 @@ module CouchRest
 
       def self.inherited(subklass)
         super
-        subklass.send(:include, CouchRest::Model::Properties)
+        subklass.send(:include, Properties)
 
         subklass.class_eval <<-EOS, __FILE__, __LINE__ + 1
           def self.inherited(subklass)

data/lib/couchrest/model/casted_array.rb

@@ -35,6 +35,12 @@ module CouchRest::Model
       super(index, value)
     end
 
+    def insert index, *args
+      values = *args.map{|obj| instantiate_and_cast(obj, false)}
+      couchrest_parent_will_change! if use_dirty?
+      super(index, *values)
+    end
+
     def pop
       couchrest_parent_will_change! if use_dirty? && self.length > 0
       super
@@ -71,7 +77,7 @@ module CouchRest::Model
     def instantiate_and_cast(obj, change = true)
       property = casted_by_property
       couchrest_parent_will_change! if change && use_dirty?
-      if casted_by && property && obj.class != property.type_class
+      if casted_by && property && obj.class != property.type
         property.cast_value(casted_by, obj)
       else
         obj.casted_by = casted_by if obj.respond_to?(:casted_by)

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

@@ -4,29 +4,6 @@ module CouchRest
 
       module TimeParsing
 
-        if RUBY_VERSION < "1.9.0"
-          # Overrwrite Ruby's standard new method to provide compatible support
-          # of 1.9.2's Time.new method.
-          #
-          # Only supports syntax like:
-          #
-          #   Time.new(2011, 4, 1, 18, 50, 32, "+02:00")
-          #   # or
-          #   Time.new(2011, 4, 1, 18, 50, 32)
-          #
-          def new(*args)
-            return super() if (args.empty?)
-            zone = args.delete_at(6)
-            time = mktime(*args)
-            if zone =~ /([\+|\-]?)(\d{2}):?(\d{2})/
-              tz_difference = ("#{$1 == '-' ? '+' : '-'}#{$2}".to_i * 3600) + ($3.to_i * 60)
-              time + tz_difference + zone_offset(time.zone)
-            else
-              time
-            end
-          end
-        end
-
         # Attemtps to parse a time string in ISO8601 format.
         # If no match is found, the standard time parse will be used.
         #

data/lib/couchrest/model/design.rb

@@ -0,0 +1,282 @@
+
+module CouchRest
+  module Model
+
+    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
+
+      # Migrate the design document preventing downtime on a production
+      # system. Typically this will be used when auto updates are disabled.
+      #
+      # Steps taken are:
+      #
+      #  1. Compare the checksum with the current version
+      #  2. If different, create a new design doc with timestamp
+      #  3. Wait until the view returns a result
+      #  4. Copy over the original design doc
+      #
+      # If a block is provided, it will be called with the result of the migration:
+      #
+      #  * :no_change - Nothing performed as there are no changes.
+      #  * :created   - Add a new design doc as non existed
+      #  * :migrated  - Migrated the existing design doc.
+      #
+      # This can be used for progressivly printing the results of the migration.
+      #
+      # After completion, either a "cleanup" Proc object will be provided to finalize
+      # the process and copy the document into place, or simply nil if no cleanup is
+      # required. For example:
+      #
+      #     print "Synchronising Cat model designs: "
+      #     callback = Cat.design_doc.migrate do |res|
+      #       puts res.to_s
+      #     end
+      #     if callback
+      #       puts "Cleaning up."
+      #       callback.call
+      #     end
+      #
+      def migrate(db = nil, &block)
+        db    ||= database
+        doc     = load_from_database(db)
+        cleanup = nil
+        id      = self['_id']
+
+        if !doc
+          # no need to migrate, just save it
+          new_doc = to_hash.dup
+          db.save_doc(new_doc)
+
+          result = :created
+        elsif doc['couchrest-hash'] != checksum
+          id += "_migration"
+
+          # Delete current migration if there is one
+          old_migration = load_from_database(db, id)
+          db.delete_doc(old_migration) if old_migration
+
+          # Save new design doc
+          new_doc = doc.merge(to_hash)
+          new_doc['_id'] = id
+          new_doc.delete('_rev')
+          db.save_doc(new_doc)
+
+          # Proc definition to copy the migration doc over the original
+          cleanup = Proc.new do
+            db.copy_doc(new_doc, doc)
+            db.delete_doc(new_doc)
+            self
+          end
+
+          result = :migrated
+        else
+          # Already up to date
+          result = :no_change
+        end
+
+        if new_doc && !new_doc['views'].empty?
+          # Create a view query and send
+          name = new_doc['views'].keys.first
+          view = new_doc['views'][name]
+          params = {:limit => 1}
+          params[:reduce] = false if view['reduce']
+          db.view("#{id}/_view/#{name}", params) do |res|
+            # Block to use streamer!
+          end
+        end
+
+        # Provide the result in block
+        yield result if block_given?
+
+        cleanup
+      end
+
+      # Perform a single migration and inmediatly request a cleanup operation:
+      #
+      #     print "Synchronising Cat model designs: "
+      #     Cat.design_doc.migrate! do |res|
+      #       puts res.to_s
+      #     end
+      #
+      def migrate!(db = nil, &block)
+        callback = migrate(db, &block)
+        if callback.is_a?(Proc)
+          callback.call
+        else
+          callback
+        end
+      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 = {})
+        Designs::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, id = nil)
+        id ||= self['_id']
+        db.get(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
+
+

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

@@ -0,0 +1,79 @@
+module CouchRest
+  module Model
+    module Designs
+
+      # Support class that allows for a model's design
+      # definition to be converted into an actual design document.
+      #
+      # The methods called in a DesignMapper instance will relay
+      # the parameters to the appropriate method in the design document.
+      #
+      class DesignMapper
+
+        # Basic mapper attributes
+        attr_accessor :model, :method, :prefix
+
+        # Temporary variable storing the design doc
+        attr_accessor :design_doc
+
+        def initialize(model, prefix = nil)
+          self.model  = model
+          self.prefix = prefix
+          self.method = Design.method_name(prefix)
+
+          create_model_design_doc_reader
+          self.design_doc = model.send(method) || assign_model_design_doc
+        end
+
+        def disable_auto_update
+          design_doc.auto_update = false
+        end
+
+        def enable_auto_update
+          design_doc.auto_update = true
+        end
+
+        # Add the specified view to the design doc the definition was made in
+        # and create quick access methods in the model.
+        def view(name, opts = {})
+          design_doc.create_view(name, opts)
+        end
+
+        # Really simple design function that allows a filter
+        # to be added. Filters are simple functions used when listening
+        # to the _changes feed.
+        #
+        # No methods are created here, the design is simply updated.
+        # See the CouchDB API for more information on how to use this.
+        def filter(name, function)
+          design_doc.create_filter(name, function)
+        end
+
+        # Convenience wrapper to access model's type key option.
+        def model_type_key
+          model.model_type_key
+        end
+
+        protected
+
+        # Create accessor in model and assign a new design doc.
+        # New design doc is returned ready to use.
+        def create_model_design_doc_reader
+          model.instance_eval "def #{method}; @#{method}; end"
+        end
+
+        def assign_model_design_doc
+          doc = Design.new(model, prefix)
+          model.instance_variable_set("@#{method}", doc)
+          model.design_docs << doc
+
+          # Set defaults
+          doc.auto_update = model.auto_update_design_doc
+
+          doc
+        end
+
+      end
+    end
+  end
+end

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

@@ -371,9 +371,10 @@ module CouchRest
           query[:limit]
         end
 
-        def num_pages
+        def total_pages
           (total_count.to_f / limit_value).ceil
         end
+        alias num_pages total_pages
 
         def current_page
           (offset_value / limit_value) + 1
@@ -486,14 +487,16 @@ module CouchRest
                 }
               EOF
               if opts[:reduce].nil?
-                opts[:reduce] = <<-EOF
-                  function(key, values, rereduce) {
-                    return sum(values);
-                  }
-                EOF
+                # Use built-in sum function by default
+                opts[:reduce] = "_sum"
               end
             end
 
+            if opts[:reduce].is_a?(Symbol)
+              # Assume calling a built in method, convert to a string
+              opts[:reduce] = "_#{opts[:reduce]}"
+            end
+
             design_doc['views'] ||= {}
             view = design_doc['views'][name.to_s] = { }
             view['map'] = opts[:map]