couchrest_model 1.2.0.beta → 2.0.0.beta

data/README.md

@@ -23,7 +23,7 @@ CouchRest Model is only properly tested on CouchDB version 1.0 or newer.
 
 ### 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 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 @@
-1.2.0.beta
+2.0.0.beta

data/history.md

@@ -1,10 +1,17 @@
 # CouchRest Model Change History
 
+## 2.0.0.beta - 2012-06-14
+
+  * Added design doc migration support, including for proxied models
+  * Rake tasks available for migrations
+  * Rails config option now available: `config.couchrest_model.auto_update_design_docs = false`
+  * Skipping 1.2 version due to design doc API changes
+
 ## 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)
+  * CouchRest::Model::Base.respond_to_missing? and respond_to? (Kim Burgestrand) (later removed)
   * Time#as_json now insists on using xmlschema with 3 fraction digits by default.
   * Added time_fraction_digits configuration object
 

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

@@ -57,6 +57,107 @@ module CouchRest
           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']
@@ -111,8 +212,9 @@ module CouchRest
 
         protected
 
-        def load_from_database(db = database)
-          db.get(self['_id'])
+        def load_from_database(db = database, id = nil)
+          id ||= self['_id']
+          db.get(id)
         rescue RestClient::ResourceNotFound
           nil
         end

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

@@ -453,49 +453,45 @@ module CouchRest
           # is true, empty strings are permited in the indexes.
           #
           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);
-                    }
+            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
+            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
+                }
+              EOF
+              if opts[:reduce].nil?
                 opts[:reduce] = <<-EOF
                   function(key, values, rereduce) {
                     return sum(values);
                   }
                 EOF
               end
-            else
-              # Assume there is always a map method
-              opts[:map] ||= true
             end
 
             design_doc['views'] ||= {}

data/lib/couchrest/model/migrate.rb

@@ -0,0 +1,92 @@
+module CouchRest
+  module Model
+
+    # Handle CouchDB migrations.
+    #
+    # Actual migrations are handled by the Design document, this serves as a utility
+    # to find all the CouchRest Model submodels and perform the migration on them.
+    #
+    # Also contains some more advanced support for handling proxied models.
+    #
+    # Examples of usage:
+    #
+    #    # Ensure all models have been loaded (only Rails)
+    #    CouchRest::Model::Migrate.load_all_models
+    #
+    #    # Migrate all regular models (not proxied)
+    #    CouchRest::Model::Migrate.all_models
+    #
+    #    # Migrate all models and submodels of proxies
+    #    CouchRest::Model::Migrate.all_models_and_proxies
+    #
+    class Migrate
+
+      def self.all_models
+        callbacks = migrate_each_model(find_models)
+        cleanup(callbacks)
+      end
+
+      def self.all_models_and_proxies
+        callbacks = migrate_each_model(find_models)
+        callbacks += migrate_each_proxying_model(find_proxying_models)
+        cleanup(callbacks)
+      end
+
+      def self.load_all_models
+        # Make a reasonable effort to load all models
+        return unless defined?(Rails)
+        Dir[Rails.root + 'app/models/**/*.rb'].each do |path|
+          require path
+        end
+      end
+
+      def self.find_models
+        CouchRest::Model::Base.subclasses.reject{|m| m.proxy_owner_method.present?}
+      end
+
+      def self.find_proxying_models
+        CouchRest::Model::Base.subclasses.reject{|m| m.proxy_database_method.blank?}
+      end
+
+      def self.migrate_each_model(models, db = nil)
+        callbacks = [ ]
+        models.each do |model|
+          model.design_docs.each do |design|
+            callbacks << migrate_design(model, design, db)
+          end
+        end
+        callbacks
+      end
+
+      def self.migrate_each_proxying_model(models)
+        callbacks = [ ]
+        models.each do |model|
+          submodels = model.proxied_model_names.map{|n| n.constantize}
+          model.all.each do |base|
+            puts "Finding proxied models for #{model}: \"#{base.send(model.proxy_database_method)}\""
+            callbacks += migrate_each_model(submodels, base.proxy_database)
+          end
+        end
+        callbacks
+      end
+
+      def self.migrate_design(model, design, db = nil)
+        print "Migrating #{model.to_s}##{design.method_name}... "
+        callback = design.migrate(db) do |result|
+          puts "#{result.to_s.gsub(/_/, ' ')}"
+        end
+        # Return the callback hash if there is one
+        callback ? {:design => design, :proc => callback, :db => db || model.database} : nil
+      end
+
+      def self.cleanup(methods)
+        methods.compact.each do |cb|
+          name = "/#{cb[:db].name}/#{cb[:design]['_id']}"
+          puts "Activating new design: #{name}"
+          cb[:proc].call
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/proxyable.rb

@@ -17,6 +17,7 @@ module CouchRest
         def proxy_for(assoc_name, options = {})
           db_method = options[:database_method] || "proxy_database"
           options[:class_name] ||= assoc_name.to_s.singularize.camelize
+          proxied_model_names << options[:class_name] unless proxied_model_names.include?(options[:class_name])
           class_eval <<-EOS, __FILE__, __LINE__ + 1
             def #{assoc_name}
               @#{assoc_name} ||= CouchRest::Model::Proxyable::ModelProxy.new(::#{options[:class_name]}, self, self.class.to_s.underscore, #{db_method})
@@ -24,7 +25,7 @@ module CouchRest
           EOS
         end
 
-        # Tell this model which other model to use a base for the database
+        # Tell this model which other model to use as a base for the database
         # connection to use.
         def proxied_by(model_name, options = {})
           raise "Model can only be proxied once or ##{model_name} already defined" if method_defined?(model_name) || !proxy_owner_method.nil?
@@ -47,6 +48,10 @@ module CouchRest
           @proxy_database_method
         end
 
+        def proxied_model_names
+          @proxied_model_names ||= []
+        end
+
         private
 
         # Ensure that no attempt is made to autoload a database connection

data/lib/couchrest/railtie.rb

@@ -18,6 +18,14 @@ module CouchRest
           Rails.application.class.to_s.underscore.gsub(/\/.*/, '')
       end
     end
+
+    config.before_configuration do
+      config.couchrest_model = CouchRest::Model::Base
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
   end
 
 end

data/lib/couchrest_model.rb

@@ -56,6 +56,9 @@ require "couchrest/model/core_extensions/time_parsing"
 require "couchrest/model/embeddable"
 require "couchrest/model/base"
 
+# Design Migration support
+require "couchrest/model/migrate.rb"
+
 # Add rails support *after* everything has loaded
 if defined?(Rails)
   require "couchrest/railtie"

data/lib/tasks/migrations.rake

@@ -0,0 +1,21 @@
+#
+# CouchRest Migration Rake Tasks
+#
+# Use at own risk! These are not tested yet!
+#
+namespace :couchrest do
+
+  desc "Migrate all the design docs found in each model"
+  task :migrate => :environment do
+    CouchRest::Model::Migrate.load_all_models
+    CouchRest::Model::Migrate.all_models
+  end
+
+  desc "Migrate all the design docs "
+  task :migrate_with_proxies => :environment do
+    CouchRest::Model::Migrate.load_all_models
+    CouchRest::Model::Migrate.all_models_and_proxies
+  end
+
+
+end

data/spec/unit/designs/design_spec.rb

@@ -8,7 +8,7 @@ describe CouchRest::Model::Designs::Design do
     reset_test_db!
   end
 
-  class DesignSampleModel < CouchRest::Model::Base
+  class DesignSampleModelBase < CouchRest::Model::Base
     use_database DB
     property :name
     property :surname
@@ -20,6 +20,9 @@ describe CouchRest::Model::Designs::Design do
     end
   end
 
+  class DesignSampleModel < DesignSampleModelBase
+  end
+
   describe "class methods" do
 
     before :all do
@@ -160,7 +163,86 @@ describe CouchRest::Model::Designs::Design do
     end
 
 
-    describe "checksum" do
+    describe "#migrate" do
+      # WARNING! ORDER IS IMPORTANT!
+
+      describe "with limited changes" do
+
+        class DesignSampleModelMigrate < DesignSampleModelBase
+        end
+
+        before :all do
+          reset_test_db!
+          @mod = DesignSampleModelMigrate
+          @doc = @mod.design_doc
+          @db  = @mod.database
+        end
+
+        it "should create new design if non exists" do
+          @db.should_receive(:view).with("#{@doc['_id']}/_view/#{@doc['views'].keys.first}", {:limit => 1, :reduce => false})
+          callback = @doc.migrate do |res|
+            res.should eql(:created)
+          end
+          doc = @db.get(@doc['_id'])
+          doc['views']['all'].should eql(@doc['views']['all'])
+          callback.should be_nil
+        end
+
+        it "should not change anything if design is up to date" do
+          @doc.sync
+          @db.should_not_receive(:view)
+          callback = @doc.migrate do |res|
+            res.should eql(:no_change)
+          end
+          callback.should be_nil
+        end
+
+      end
+
+      describe "migrating a document if there are changes" do
+
+        class DesignSampleModelMigrate2 < DesignSampleModelBase
+        end
+
+        before :all do
+          reset_test_db!
+          @mod = DesignSampleModelMigrate2
+          @doc = @mod.design_doc
+          @db  = @mod.database
+          @doc.sync!
+          @doc.create_view(:by_name_and_surname)
+          @doc_id = @doc['_id'] + '_migration'
+        end
+
+        it "should save new migration design doc" do
+          @db.should_receive(:view).with("#{@doc_id}/_view/by_name", {:limit => 1, :reduce => false})
+          @callback = @doc.migrate do |res|
+            res.should eql(:migrated)
+          end
+          @callback.should_not be_nil
+
+          # should not have updated original view until cleanup
+          doc = @db.get(@doc['_id'])
+          doc['views'].should_not have_key('by_name_and_surname')
+
+          # Should have created the migration
+          new_doc = @db.get(@doc_id)
+          new_doc.should_not be_nil
+
+          # should be possible to perform cleanup
+          @callback.call
+          lambda { new_doc = @db.get(@doc_id) }.should raise_error RestClient::ResourceNotFound
+
+          doc = @db.get(@doc['_id'])
+          doc['views'].should have_key('by_name_and_surname')
+        end
+
+      end
+
+    end
+
+
+    describe "#checksum" do
 
       before :all do
         @mod = DesignSampleModel
@@ -173,7 +255,7 @@ describe CouchRest::Model::Designs::Design do
 
       it "should provide same checksum without refresh on re-request" do
         chk = @doc.checksum
-        @doc.should_not_receive(:chaecksum!)
+        @doc.should_not_receive(:checksum!)
         @doc.checksum.should eql(chk)
       end
 
@@ -271,12 +353,12 @@ describe CouchRest::Model::Designs::Design do
 
     it "should calculate a consistent checksum for model" do
       #WithTemplateAndUniqueID.design_doc.checksum.should eql('caa2b4c27abb82b4e37421de76d96ffc')
-      WithTemplateAndUniqueID.design_doc.checksum.should eql('f0973aaa72e4db0efeb2a281ea297cec')
+      WithTemplateAndUniqueID.design_doc.checksum.should eql('7f44e88afbce06204010c49b76f31bcf')
     end
 
     it "should calculate checksum for complex model" do
       #Article.design_doc.checksum.should eql('70dff8caea143bf40fad09adf0701104')
-      Article.design_doc.checksum.should eql('7ef39bffdf5837e8b078411ac417d860')
+      Article.design_doc.checksum.should eql('0f25a2d9f86e31ebd61b29863a41d5ed')
     end
 
     it "should cache the generated checksum value" do

data/spec/unit/designs/view_spec.rb

@@ -100,32 +100,11 @@ describe "Design View" do
 
     describe ".define" do
 
-      describe "with no auto update" do
-        before :each do
-          @design_doc = { }
-          @design_doc.stub!(:model).and_return(DesignViewModel)
-          @design_doc.stub!(:auto_update).and_return(false)
-        end
-
-        it "should set map view to true" do
-          @klass.define(@design_doc, 'test_view')
-          @design_doc['views']['test_view']['map'].should eql(true)
-          @design_doc['views']['test_view']['reduce'].should be_false
-        end
-
-        it "should set reduce to true if set" do
-          @klass.define(@design_doc, 'test_view', :reduce => true)
-          @design_doc['views']['test_view']['map'].should eql(true)
-          @design_doc['views']['test_view']['reduce'].should eql(true)
-        end
-      end
-
-      describe "with auto update" do
+      describe "under normal circumstances" do
 
         before :each do
           @design_doc = { }
           @design_doc.stub!(:model).and_return(DesignViewModel)
-          @design_doc.stub!(:auto_update).and_return(true)
         end
 
         it "should add a basic view" do
@@ -133,6 +112,12 @@ describe "Design View" do
           @design_doc['views']['test_view'].should_not be_nil
         end
 
+        it "should not overwrite reduce if set" do
+          @klass.define(@design_doc, 'by_title', :reduce => true)
+          @design_doc['views']['by_title']['map'].should_not be_blank
+          @design_doc['views']['by_title']['reduce'].should eql(true)
+        end
+
         it "should auto generate mapping from name" do
           lambda { @klass.define(@design_doc, 'by_title') }.should_not raise_error
           str = @design_doc['views']['by_title']['map']

data/spec/unit/proxyable_spec.rb

@@ -35,7 +35,6 @@ describe CouchRest::Model::Proxyable do
     it "should raise an error if called and no proxy_database_method set" do
       lambda { @obj.proxy_database }.should raise_error(StandardError, /Please set/)
     end
-
   end
 
   describe "class methods" do
@@ -74,6 +73,11 @@ describe CouchRest::Model::Proxyable do
         @class.should respond_to(:proxy_for)
       end
 
+      it "should add model name to proxied model name array" do
+        @class.proxy_for(:cats)
+        @class.proxied_model_names.should eql(['Cat'])
+      end
+
       it "should create a new method" do
         DummyProxyable.stub!(:method_defined?).and_return(true)
         DummyProxyable.proxy_for(:cats)
@@ -140,6 +144,26 @@ describe CouchRest::Model::Proxyable do
         lambda { @class.database }.should raise_error(StandardError, /database must be accessed via/)
       end
     end
+
+    describe ".proxied_model_names" do
+      before do
+        @class = Class.new(CouchRest::Model::Base)
+      end
+
+      it "should respond to proxied_model_names" do
+        @class.should respond_to(:proxied_model_names)
+      end
+
+      it "should provide an empty array" do
+        @class.proxied_model_names.should be_empty
+      end
+
+      it "should accept new entries" do
+        @class.proxied_model_names << 'Cat'
+        @class.proxied_model_names.first.should eql('Cat')
+      end
+    end
+
   end
 
   describe "ModelProxy" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchrest_model
 version: !ruby/object:Gem::Version
-  version: 1.2.0.beta
+  version: 2.0.0.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couchrest
@@ -185,6 +185,7 @@ files:
 - lib/couchrest/model/embeddable.rb
 - lib/couchrest/model/errors.rb
 - lib/couchrest/model/extended_attachments.rb
+- lib/couchrest/model/migrate.rb
 - lib/couchrest/model/persistence.rb
 - lib/couchrest/model/properties.rb
 - lib/couchrest/model/property.rb
@@ -203,6 +204,7 @@ files:
 - lib/rails/generators/couchrest_model/config/templates/couchdb.yml
 - lib/rails/generators/couchrest_model/model/model_generator.rb
 - lib/rails/generators/couchrest_model/model/templates/model.rb
+- lib/tasks/migrations.rake
 - spec/.gitignore
 - spec/fixtures/attachments/README
 - spec/fixtures/attachments/couchdb.png
@@ -265,9 +267,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3604299647194247287
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: