couch-migrate 1.0.0 → 1.1.0

data/README.rdoc

@@ -1,9 +1,128 @@
 = couch-migrate
 
-Description goes here.
+A simple migration system for CouchDB.
+
+This gem was created because we needed something more than what "rake
+db:seed" could provide.
+
+== Example Migration File
+
+    # File: db/migrate/1_name_of_migration.rb
+    up do
+      puts "this will be run when rake executes an 'up'"
+    end
+
+    down do
+      puts "this will be run when rake executes a 'down'"
+    end
+
+== Example Migration File Using CouchRest::Model
+
+    # File: db/migrate/2_another_migration.rb
+
+    # In order to lock model definitions to a point in time (so
+    # migrations will work in the future even after models change),
+    # classes can be defined in a migration, that are namespaced
+    # automatically yet still work with CouchDB's usage of the 'type'
+    # field. In order to use CouchRest::Models, include this line:
+    # use_couchrest_model
+
+    use_couchrest_model # this must appear before any class definitions
+
+    # Defined in app/models/account.rb, but duplicated here without any
+    # validations or domain logic, in order to lock the model definition
+    # to this point in time.
+    class Account < CouchRest::Model::Base
+      property :name, String
+      property :description, String
+      collection_of :things, class_name: Thing
+    end
+
+    class Thing < CouchRest::Model::Base
+      belongs_to :account, class_name: Account
+      property :name, String
+      property :characteristics,     [String]
+      timestamps!
+      design do
+        view :by_name # views work as expected
+      end
+    end
+
+    up do
+      # an example of limiting whether a migration runs or not. In this
+      # case, only run this migration if the CouchDB database is
+      # approximately empty.
+      begin
+        threshold = 5
+        db = Account.database # the db url, obtained however you feel
+        if db.info['doc_count'] > threshold
+          puts "Database (#{db.to_s}) has more than #{threshold} documents. This migration will not run"
+          return
+        end
+      rescue
+      end
+
+      Account.create! do |a|
+        a.name = "A new account"
+
+        a.things << Thing.create! do |t|
+          t.name = "Thing # 1"
+          t.characteristics << "Awesome"
+          t.characteristics << "Joy bringing"
+          t.hidden = false
+        end
+        # example code. not tested
+      end
+
+    end
+
+== Example Rake Task
+
+    def migrater
+      couch_db_url = 'http://127.0.0.1:5984/couch-migrate_test'
+      # or, if you are using CouchRest::Model
+      # require 'your_couchreset_model_class'
+      # couch_db_url = YourCouchRestModelClass.database.to_s
+      CouchMigrate::CouchMigrater.new(couch_db_url)
+    end
+
+    namespace :db do
+      desc 'migrate all pending migrations'
+      task :migrate => ['migrate:up']
+
+      namespace :migrate do
+        desc 'couchdb migration up'
+        task 'up' => [:environment, :url] do
+          migrater.migrate(:up)
+        end
+
+        desc 'couchdb migration down'
+        task 'down' => [:environment, :url] do
+          migrater.migrate(:down)
+        end
+
+        desc 'couchdb migration down, then up'
+        task 'redo' => [:environment, :url] do
+          migrater.migrate(:down)
+          migrater.migrate(:up)
+        end
+
+        desc 'print couchdb URL'
+        task 'url' => :environment do
+          $stderr.puts("CouchDB URL: #{CloudProvider.database.to_s}")
+        end
+
+      end
+    end
+
+== Thanks
+
+Thanks to OpenLogic (http://openlogic.com), a great company that
+focuses on supporting the Open Source market, for allowing this work to
+be open sourced.
 
 == Contributing to couch-migrate
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -14,6 +133,6 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2011 Greg Edwards. See LICENSE.txt for
+Copyright (c) 2011 OpenLogic, Inc. and Greg Edwards. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/couch-migrate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couch-migrate}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Greg Edwards"]
-  s.date = %q{2011-09-20}
+  s.date = %q{2011-09-21}
   s.description = %q{A simple migration system for CouchDB.}
   s.email = %q{greg@greglearns.com}
   s.extra_rdoc_files = [

data/lib/couch-migrate.rb

@@ -1,2 +1,4 @@
 require_relative 'couch_migrate_railtie.rb' if defined?(Rails)
-Dir["#{File.dirname(__FILE__)}/couch_migrate/**/*.rb"].each {|f| require f}
+list = Dir["#{File.dirname(__FILE__)}/couch_migrate/**/*.rb"]
+skip = Dir["#{File.dirname(__FILE__)}/couch_migrate/couchrest_model/**/*.rb"]
+(list - skip).each {|f| require f}

data/lib/couch_migrate/couchrest_model/extend.rb

@@ -1,15 +1,17 @@
 # use "use_couchrest_model" in the DSL or
 # include this module in a migration to use CouchRest::Model
-if defined?(CouchRest::CouchRest::Model)
-  module CouchRest
+if defined?(::CouchRest::Model)
+  module ::CouchRest
     module Model
       class Base
-        before_save :rewrite_type_for_migration_classes
+        class << self
+          alias to_s_original to_s
 
-        def rewrite_type_for_migration_classes
-          class_name = self.class.to_s.sub(/CouchMigrate::BaseExecuter::Namespaced::/, '')
-          self['type'] = class_name
+          def to_s
+            to_s_original.sub(/CouchMigrate::BaseExecuter::Namespaced::/, '')
+          end
         end
+
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couch-migrate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000 -06:00
+date: 2011-09-21 00:00:00.000000000 -06:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couchrest
-  requirement: &2157870300 !ruby/object:Gem::Requirement
+  requirement: &2159120560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157870300
+  version_requirements: *2159120560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157869180 !ruby/object:Gem::Requirement
+  requirement: &2159119800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2157869180
+  version_requirements: *2159119800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157868040 !ruby/object:Gem::Requirement
+  requirement: &2159082100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2157868040
+  version_requirements: *2159082100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157866720 !ruby/object:Gem::Requirement
+  requirement: &2159081060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2157866720
+  version_requirements: *2159081060
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157865660 !ruby/object:Gem::Requirement
+  requirement: &2159079780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2157865660
+  version_requirements: *2159079780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2157864760 !ruby/object:Gem::Requirement
+  requirement: &2159078720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157864760
+  version_requirements: *2159078720
 description: A simple migration system for CouchDB.
 email: greg@greglearns.com
 executables: []
@@ -132,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 952696308215902437
+      hash: 4097235762935568490
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: