migration_assist 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--format nested --color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,81 @@
+# Migration Assistant
+
+Assists in handling migrations, including generating migration files from a Thor Generator
+The *Migration Assistant* includes specialized functionality for operating with *Active Record* migrations.
+
+## Install
+
+<code>gem install migration_assist</code>
+
+## Usage
+
+First you have to tell the gem where your Rails root directory is located so it can calculate the migrations dir from that for its operation.
+
+Example:
+<pre>
+  Rails::Migration::Assist.rails_root_dir = Rails.root
+</pre>  
+
+A common use case for using this gem, is when you are creating code Generators that create Active Record migrations.
+In this case you would add this Helper to your generator sth. like this
+
+<pre>
+require 'migration_assist'
+require 'rails3_assist'
+
+class MigrationGenerator < Rails::Generators::NamedBase 
+  include Rails::Migration::Assist  
+  include Rails::Assist::Migration # from rails3_assist
+  
+  ...
+end
+<pre>
+
+In the above example we also included the migration helper from the *rails3_assist* gem, which adds some migration CRUD functionality to the mix.
+
+### Class methods:
+
+* migrations_list(dirname=nil)*
+
+list of migrations
+
+*first_migration_file: (name, dir=nil) - alias: *migration_exists?*
+
+Get the first migration file matching a given name
+
+*latest_migration_file: (dirname, file_name)*
+
+Get the latest migration file matching a given name
+
+*current_migration_number(dirname=nil)*
+
+Return the highest migration number of the current migration files
+
+*next_migration_number(dirname=nil)*
+
+Often used to generate the number to prefix a new generated migration file
+
+### Instance methods
+
+*migration (name)*
+
+Generate a new named migration using a template [name].erb to be found in a template source path (thor)
+
+*reverse_migration! (migration_path=nil)*
+
+Reverse a given migration, by switching the up and down methods and 
+changing the migration name, fx from Add to Remove or Create to Drop.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "migration_assist"
+    gem.summary = %Q{Assists in handling migrations}
+    gem.description = %Q{Assists in handling migrations, including generating migration files from a Thor Generator}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/migration_assist"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec",       ">= 2.0.0.beta.19"
+    
+    gem.add_dependency "require_all",   ">= 1.1.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/generators/migration/migration_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails3_assist'
+
+class MigrationGenerator < Rails::Generators::NamedBase 
+  include Rails::Migration::Assist
+
+  desc "Creates a migration"
+
+  def self.source_root
+    @source_root ||= File.expand_path("../templates", __FILE__)
+  end
+    
+  def create_migration     
+    # info "Create migration: #{name} from template: 'create_users'" 
+    migration name, 'create_users'
+  end
+end 

data/lib/generators/migration/templates/create_users.erb

@@ -0,0 +1,14 @@
+class <%= name.camelize %> < ActiveRecord::Migration
+  def self.up  
+    create_table :users do |t|
+      t.string  :name
+      t.integer :age
+      t.boolean :admin
+    end
+  end
+
+  def self.down
+    drop_table :users  
+  end
+
+end

data/lib/migration_assist.rb

@@ -0,0 +1,10 @@
+require 'require_all'
+
+module Rails
+  module Migration
+    module Assist
+    end
+  end
+end
+
+require_all File.dirname(__FILE__) + '/migration_assist'

data/lib/migration_assist/class_methods.rb

@@ -0,0 +1,38 @@
+# NOTE:
+# Alternative to use this helper is to inherit from ActiveRecord::Generators::Base
+# which provides the #next_migration_number class method that lets #migration_template work as expected
+# 
+module Rails::Migration::Assist    
+  def self.included(base) #:nodoc: 
+    base.extend ClassMethods      
+  end
+
+  module ClassMethods    
+    def migration_lookup_at(dirname) #:nodoc:
+      Dir.glob("#{dirname}/[0-9]*_*.rb")
+    end
+
+    def migration_exists?(dirname, file_name) #:nodoc:
+      migration_lookup_at(dirname).grep(/\d+_#{file_name}.rb$/).first
+    end 
+    alias_method :first_migration_file, :migration_exists?              
+
+    def latest_migration_file(dirname, file_name) #:nodoc:
+      migration_lookup_at(dirname).grep(/\d+_#{file_name}.rb$/).sort.last
+    end 
+
+    def current_migration_number(dirname) #:nodoc:
+      migration_lookup_at(dirname).collect do |file|
+        File.basename(file).split("_").first.to_i
+      end.max.to_i
+    end
+
+    def next_migration_number(dirname) #:nodoc:
+      orm = Rails.configuration.generators.options[:rails][:orm]
+      require "rails/generators/#{orm}"
+      "#{orm.to_s.camelize}::Generators::Base".constantize.next_migration_number(dirname)
+    rescue
+      raise NotImplementedError
+    end
+  end
+end

data/lib/migration_assist/helper/file_name.rb

@@ -0,0 +1,56 @@
+module Rails::Migration::Assist 
+  class << self
+    attr_accessor :rails_root_dir
+  end  
+  
+  module FileNameHelper         
+    def artifact_path name, type, dir=nil
+      dir ||= send :"#{type}_dir"
+      File.join(dir, "#{name}#{type_postfix type}.rb")
+    end
+
+    def type_postfix type
+      "_#{type}" if ![:model].include?(type)
+    end
+
+    def make_file_name name, type, options={}      
+      send :"#{type}_file_name", name, options
+    end
+
+    def existing_file_name name, type 
+      # first try finder method
+      finder_method = :"find_#{type}"
+      found = send finder_method, name if respond_to? finder_method      
+      # default
+      make_file_name(name, type) if !found
+    end 
+    
+    def find_migration name, option=nil
+      migrations = Dir.glob("#{migration_dir}/[0-9]*_*.rb")
+      return nil if !migrations.empty?      
+      matching_migrations = migrations.grep(/\d+_#{name}\.rb$/)
+      return nil if matching_migrations.empty?
+      migration_file = (option == :last) ? matching_migrations.last : matching_migrations.first
+    end
+
+    def migration_file_name name, options={}
+      number = options[:number]      
+      number = next_migration_number(migration_dir) if !number      
+      File.join(migration_dir, "#{number}_#{name}.rb")      
+    end
+
+    def root_dir                                                                                    
+      dir = Migration::Assist.rails_root_dir
+      raise "You must set the Rails app root dir: Rails::Migration::Assist.rails_root_dir = '/my/root/dir'" if !dir
+      dir
+    end    
+        
+    def db_dir
+      File.join(root_dir, 'db')
+    end        
+
+    def migration_dir
+      File.join(db_dir, 'migrations')
+    end    
+  end
+end  

data/lib/migration_assist/implementation.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'migration_assist/helper/file_name'
+
+module Rails::Migration::Assist
+  include Rails::Generators::Migration
+  # include Rails::Assist::Migration
+  include FileNameHelper
+    
+  def reverse_migration_name name
+    name.gsub(/^add_/, 'remove_').gsub(/^create_/, 'drop_')
+  end
+
+  def reverse_migration! migration_path
+    reverse_class_names! migration_path        
+    reverse_up_down_methods! migration_path
+  end
+
+  def reverse_class_names! migration_path
+    # Change class name
+    gsub_file migration_path, /class Add/, 'class Remove'
+    gsub_file migration_path, /class Create/, 'class Drop'
+  end
+
+  def reverse_up_down_methods! migration_path
+    # swap up and down methods
+    gsub_file migration_path, /up/, 'dwn'
+    gsub_file migration_path, /down/, 'up'
+    gsub_file migration_path, /dwn/, 'down'        
+  end
+
+  def latest_migration_file dir, name
+    self.class.latest_migration_file dir, name
+  end
+  
+  def migration name, template_name=nil
+    migration_template "#{template_name || name}.erb", migration_file_name(name)
+  end  
+end

data/migration_assist.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{migration_assist}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-08-19}
+  s.description = %q{Assists in handling migrations, including generating migration files from a Thor Generator}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/migration/migration_generator.rb",
+     "lib/generators/migration/templates/create_users.erb",
+     "lib/migration_assist.rb",
+     "lib/migration_assist/class_methods.rb",
+     "lib/migration_assist/helper/file_name.rb",
+     "lib/migration_assist/implementation.rb",
+     "migration_assist.gemspec",
+     "spec/generators/migration_generator_spec.rb",
+     "spec/load_spec.rb",
+     "spec/migration_assist/class_methods_spec.rb",
+     "spec/migration_assist/fixtures/001_migration_a.rb",
+     "spec/migration_assist/fixtures/002_migration_b.rb",
+     "spec/migration_assist/fixtures/003_migration_a.rb",
+     "spec/migration_assist/fixtures/004_migration_c.rb",
+     "spec/migration_assist/implementation_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/migration_assist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Assists in handling migrations}
+  s.test_files = [
+    "spec/generators/migration_generator_spec.rb",
+     "spec/load_spec.rb",
+     "spec/migration_assist/class_methods_spec.rb",
+     "spec/migration_assist/fixtures/001_migration_a.rb",
+     "spec/migration_assist/fixtures/002_migration_b.rb",
+     "spec/migration_assist/fixtures/003_migration_a.rb",
+     "spec/migration_assist/fixtures/004_migration_c.rb",
+     "spec/migration_assist/implementation_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<require_all>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<require_all>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<require_all>, [">= 1.1.0"])
+  end
+end
+

data/spec/generators/migration_generator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+# require 'migration-spec'
+# require 'rails3_assist'
+
+# RSpec::Generator.debug = true
+# 
+# require_generator :migration
+# 
+# describe 'migration_generator' do
+#   use_orm :active_record
+#   use_helpers :migration, :helper
+#   
+#   before :each do              
+#     setup_generator 'migration_generator' do
+#       tests MigrationGenerator
+#     end        
+#     remove_migration :create_users    
+#   end
+# 
+#   after :each do
+#   end
+#     
+#   it "should generate create_user migration" do    
+#     with_generator do |g|
+#       g.run_generator :create_users.args
+#       g.should generate_migration :create_users do |content|
+#         content.should have_migration :create_users do |klass|
+#           klass.should have_up do |up|
+#             up.should have_create_table :users do |user_tbl|
+#               user_tbl.should have_columns :name => :string, :age => :integer, :admin => :boolean
+#               user_tbl.should_not have_timestamps              
+#             end
+#           end
+# 
+#           klass.should have_down do |up|
+#             up.should have_drop_table :users
+#           end
+#         end
+#       end
+#     end
+#   end
+# end
+# 
+# 
+# 

data/spec/load_spec.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'rspec/autorun' 
+require 'migration_assist'

data/spec/migration_assist/class_methods_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'rails'
+
+class TestGenerator
+  include Rails::Migration::Assist
+end
+
+describe 'Migration Assist' do
+  let(:dir) { fixtures_dir }  
+  let(:generator) { TestGenerator.new }  
+
+  before :each do              
+  end
+
+  after :each do
+  end
+
+  describe '#migration_lookup_at' do
+    it "should return 4 migrations" do    
+      generator.class.migration_lookup_at(dir).should have(4).items
+    end
+  end
+
+  describe '#migration_exists?' do
+    it "should verify migration 'a' exists" do    
+      generator.class.migration_exists?(dir, 'migration_a').should include('001_migration_a.rb') 
+    end
+
+    it "should verify migration 'c' exists" do          
+      generator.class.migration_exists?(dir, 'migration_c').should include('004_migration_c.rb') 
+    end
+  end
+
+  describe '#first_migration_file' do
+    it "should find first migration 'a'" do    
+      generator.class.first_migration_file(dir, 'migration_a').should include('001_migration_a.rb')       
+    end
+  end
+
+  describe '#latest_migration_file' do
+    it "should lookup latest migration 'a' " do    
+      generator.class.latest_migration_file(dir, 'migration_a').should include('003_migration_a.rb')             
+    end
+
+    it "should lookup latest migration 'b' " do          
+      generator.class.latest_migration_file(dir, 'migration_b').should include('002_migration_b.rb')       
+    end
+  end
+
+  describe '#current_migration_number' do
+    it "should find current migration number 4" do    
+      generator.class.current_migration_number(dir).should be 4
+    end
+  end
+
+  describe '#next_migration_number' do    
+    it "should find next migration number 5" do               
+    end
+  end
+end

data/spec/migration_assist/implementation_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+# RSpec::Generator.debug = true
+# 
+# require_generator :migration
+# 
+# describe 'migration_generator' do
+#   use_orm :active_record
+#   use_helpers :migration, :helper
+#   
+#   before :each do              
+#     setup_generator 'migration_generator' do
+#       tests MigrationGenerator
+#     end        
+#     remove_migration :create_users    
+#   end
+# 
+#   after :each do
+#   end
+#     
+#   it "should generate create_user migration" do    
+#     with_generator do |g|
+#       g.run_generator :create_users.args
+#       g.should generate_migration :create_users do |content|
+#         content.should have_migration :create_users do |klass|
+#           klass.should have_up do |up|
+#             up.should have_create_table :users do |user_tbl|
+#               user_tbl.should have_columns :name => :string, :age => :integer, :admin => :boolean
+#               user_tbl.should_not have_timestamps              
+#             end
+#           end
+# 
+#           klass.should have_down do |up|
+#             up.should have_drop_table :users
+#           end
+#         end
+#       end
+#     end
+#   end
+# end
+# 
+# 
+# 

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec/autorun' 
+require 'migration_assist'
+
+RSpec.configure do |config|  
+end
+
+def fixtures_dir
+  File.expand_path(File.dirname(__FILE__) + '/migration_assist/fixtures')
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: migration_assist
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-19 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+description: Assists in handling migrations, including generating migration files from a Thor Generator
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/generators/migration/migration_generator.rb
+- lib/generators/migration/templates/create_users.erb
+- lib/migration_assist.rb
+- lib/migration_assist/class_methods.rb
+- lib/migration_assist/helper/file_name.rb
+- lib/migration_assist/implementation.rb
+- migration_assist.gemspec
+- spec/generators/migration_generator_spec.rb
+- spec/load_spec.rb
+- spec/migration_assist/class_methods_spec.rb
+- spec/migration_assist/fixtures/001_migration_a.rb
+- spec/migration_assist/fixtures/002_migration_b.rb
+- spec/migration_assist/fixtures/003_migration_a.rb
+- spec/migration_assist/fixtures/004_migration_c.rb
+- spec/migration_assist/implementation_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/migration_assist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Assists in handling migrations
+test_files: 
+- spec/generators/migration_generator_spec.rb
+- spec/load_spec.rb
+- spec/migration_assist/class_methods_spec.rb
+- spec/migration_assist/fixtures/001_migration_a.rb
+- spec/migration_assist/fixtures/002_migration_b.rb
+- spec/migration_assist/fixtures/003_migration_a.rb
+- spec/migration_assist/fixtures/004_migration_c.rb
+- spec/migration_assist/implementation_spec.rb
+- spec/spec_helper.rb