migrant 0.2.4 → 1.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    migrant (0.2.3)
+    migrant (0.2.4)
       migrant
       rails
 
@@ -36,7 +36,7 @@ GEM
       activesupport (= 3.0.4)
     activesupport (3.0.4)
     ansi (1.2.2)
-    arel (2.0.8)
+    arel (2.0.9)
     builder (2.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)

data/README.rdoc

@@ -2,19 +2,28 @@
 
 == Summary
 
-Migrant gives you a clean DSL to describe your database schema (somewhat similar to DataMapper)
-and generates all your migrations for you so you can spend more time coding the tricky stuff!
+Migrant gives you a clean DSL to describe your model schema (somewhat similar to DataMapper)
+that generates your migrations for you and enables you to spend more time on describing your domain
+model cleanly and less time managing your database layer.
 
 You'll also get a handy .mock method to instantiate a filled in model for testing or debugging purposes.
 
 == Getting Started
 
-Only for Rails 3 and Ruby 1.9+ folks. Simply install the gem "migrant", or add it to your bundler Gemfile
+In your Gemfile:
+
+  gem "migrant"
+  
+Rails: 3.0+ (Sorry folks, no plans for Rails 2 support)
+Ruby: Tested with 1.8.7 MRI, 1.9.2 MRI, and Rubinius 1.2.1 
+Adapters: Tested with SQLite3, MySQL, MySQL2, Pg. Should work with any AR adapter in theory.
 
 == Jumping right in
 
 Start by creating some models with the structure you need:
 
+  > rails generate migrant:model business
+
   class Business < ActiveRecord::Base
     belongs_to :user
 
@@ -27,8 +36,9 @@ Start by creating some models with the structure you need:
     end
   end
 
-The best and easiest way is to provide example data and then Migrant will work out the appropriate
-column type for you. Another example covering some more bases:
+Simply specify an example of the type of data you'll be storing, and Migrant will work out the 
+correct database schema for you. Note that you don't need to specify foreign keys in the structure, 
+they are automatically inferred from your relations. Here is a further example:
 
   class User < ActiveRecord::Base
     has_many :businesses
@@ -38,9 +48,12 @@ column type for you. Another example covering some more bases:
       surname     "Smith", :validates => :presence  # You can add your validations in here too to keep DRY
       description :string                           # Passing a symbol works like it does in add_column
       timestamps                                    # Gets you a created_at, and updated_at
+
+      # Use an array to specifiy multiple validations
+      secret_code 5521, :validates => [:uniqueness, :numericality]
     end
   end
-
+  
 Now, to get your database up to date simply run:
 
   > rake db:upgrade
@@ -64,15 +77,26 @@ By default, your database structure will be cloned to your test environment. If
 automatically, simply specify an environment variable directly:
 
   > rake db:upgrade RAILS_ENV=development
-
+  
 == Want more examples?
 
 Check out the test models in test/rails_app/app/models/*
 
+== Model Generator
+
+  > rails generate migrant:model business name:string website:text
+  
+The model generator works as per the default ActiveRecord one, i.e. you can specify
+fields to be included in the model. However, a migration is not generated immediately,
+but the structure block in the model is automatically filled out for you.
+
+Simply run rake db:upgrade or rails generate migrations to get the required migrations when you're ready.
+
 == What will happen seamlessly
 
 * Creating tables or adding columns (as appropriate)
 * Adding indexes (happens on foreign keys automatically)
+* Validations (ActiveRecord 3)
 * Changing column types
 * Rollbacks for all the above
 
@@ -101,13 +125,12 @@ These actions won't be performed (because we don't want to hurt your data):
 * It's probably a good idea to review the generated migrations before committing to SCM, just to check there's nothing left out.
 
 == Roadmap / Planned features
-* To be implemented very soon - A :was => [:this,:then,:that] option to rename columns and add an alias method onto models (so as to not break existing code)
 * Rake task to consolidate a given set of migrations (a lot of people like to do this once in a while to keep migration levels sane)
-* Fabricator/Factory integration/seperation
+* Fabricator/Factory integration/seperation - Need to assess how useful this is, then optimize or kill.
 
 == License
 
-Copyright (c) 2010 Pascal Houliston
+Copyright (c) 2011 Pascal Houliston
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -130,7 +153,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 == Development
 
-Please be sure to install all the development dependencies from the gemspec, then to run tests do:
+Please be sure to install all the development dependencies via Bundler, then to run tests do:
 
 > rake test
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+1.0.0

data/lib/generators/model.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/active_record'
+
+module Migrant
+  class Model < ActiveRecord::Generators::Base
+    argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+    desc "The migrant:model generator creates a skeleton ActiveRecord model for use with Migrant."
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def create_model_file
+      template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+    end
+    
+    hook_for :test_framework
+    
+    def protip
+      puts "\nNow, go and edit app/models/#{file_name}.rb and/or generate more models, then run 'rake db:upgrade' to generate your schema."
+    end
+
+    protected
+    def parent_class_name
+      options[:parent] || "ActiveRecord::Base"
+    end
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,14 @@
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+  structure do
+<% unless attributes.blank?
+     max_field_length = attributes.collect { |attribute| attribute.name.to_s}.max { |name| name.length }.length
+     attributes.reject { |attr| attr.reference? }.each do |attribute| -%>
+    <%= attribute.name.to_s.ljust(max_field_length) %> :<%= attribute.type %>
+<%  end
+   end -%>
+  end
+end
+

data/lib/migrant.rb

@@ -1,5 +1,4 @@
 require 'active_support'
-#require 'active_support/core_ext/class/attribute_accessors'
 require 'active_record'
 require 'datatype/base'
 require 'migrant/schema'

data/lib/migrant/schema.rb

@@ -1,3 +1,5 @@
+require 'simple_object'
+
 module Migrant
   # Converts the following DSL:
   #

data/lib/railtie.rb

@@ -10,6 +10,7 @@ module Migrant
     
     generators do
       load "generators/migrations.rb"
+      load "generators/model.rb"
     end
   end
 end

data/lib/simple_object.rb

@@ -0,0 +1,13 @@
+
+# Little patch for Ruby 1.8 to give it BasicObject support
+unless defined?(BasicObject)
+ class BasicObject
+    KEEP_METHODS = %w"__id__ __send__ instance_eval == equal? initialize"
+
+    def self.remove_methods!
+      m = (private_instance_methods + instance_methods) - KEEP_METHODS
+      m.each{|m| undef_method(m)}
+    end
+    remove_methods!
+  end
+end

data/migrant.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{migrant}
-  s.version = "0.2.4"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pascal Houliston"]
-  s.date = %q{2011-02-15}
+  s.date = %q{2011-02-26}
   s.description = %q{Migrant gives you a super-clean DSL to describe your ActiveRecord models (somewhat similar to DataMapper) and generates all your migrations for you so you can spend more time coding the stuff that counts!}
   s.email = %q{101pascal@gmail.com}
   s.extra_rdoc_files = [
@@ -36,11 +36,14 @@ Gem::Specification.new do |s|
     "lib/datatype/symbol.rb",
     "lib/datatype/time.rb",
     "lib/generators/migrations.rb",
+    "lib/generators/model.rb",
+    "lib/generators/templates/model.rb",
     "lib/migrant.rb",
     "lib/migrant/migration_generator.rb",
     "lib/migrant/model_extensions.rb",
     "lib/migrant/schema.rb",
     "lib/railtie.rb",
+    "lib/simple_object.rb",
     "lib/tasks/db.rake",
     "migrant.gemspec",
     "test/additional_models/review.rb",
@@ -176,6 +179,13 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<turn>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<ansi>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<turn>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_runtime_dependency(%q<rails>, [">= 0"])
     else
       s.add_dependency(%q<migrant>, [">= 0"])
@@ -214,6 +224,13 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<turn>, [">= 0"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<ansi>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<turn>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<rails>, [">= 0"])
     end
   else
@@ -253,6 +270,13 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<turn>, [">= 0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<ansi>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<turn>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<rails>, [">= 0"])
   end
 end

data/test/helper.rb

@@ -5,6 +5,7 @@ SimpleCov.adapters.define 'migrant' do
   add_filter '/test'
   add_filter '/lib/tasks'
   add_filter '/lib/railtie' # Not covering lines it's running here .. disabling for now
+  add_filter '/lib/simple_object'
   
   add_group 'Core Extensions', '/lib/migrant'
   add_group 'Schema Data Types', '/lib/datatype'

data/test/test_migration_generator.rb

@@ -13,10 +13,12 @@ class TestMigrationGenerator < Test::Unit::TestCase
     assert_equal true, Migrant::MigrationGenerator.new.run, "Migration Generator reported an error"
     Dir.glob(File.join(File.dirname(__FILE__), 'rails_app', 'db' ,'migrate', '*.rb')).each do |migration_file|
         if migration_file.include?(template)
-          correct = File.join(File.dirname(__FILE__), 'verified_output', 'migrations', template+'.rb')
-          assert_equal(File.open(correct, 'r') { |r| r.read}.strip,
-                       File.open(migration_file, 'r') { |r| r.read}.strip,
-                       "Generated migration #{migration_file} does not match template #{correct}")
+          to_test = File.open(migration_file, 'r') { |r| r.read}.strip
+          File.open(File.join(File.dirname(__FILE__), 'verified_output', 'migrations', template+'.rb'), 'r') do |file|
+            while (line = file.gets)
+              assert_not_nil(to_test.match(line.strip), "Generated migration #{migration_file} missing line: #{line}")
+            end
+          end
           rake_migrate
           return
         end
@@ -28,10 +30,12 @@ class TestMigrationGenerator < Test::Unit::TestCase
     should "create migrations for all new tables" do
       assert_equal true, Migrant::MigrationGenerator.new.run, "Migration Generator reported an error"
       Dir.glob(File.join(File.dirname(__FILE__), 'rails_app', 'db' ,'migrate', '*.rb')).each do |migration_file|
-         correct = File.join(File.dirname(__FILE__), 'verified_output', 'migrations', migration_file.sub(/^.*\d+_/, ''))
-         assert_equal(File.open(correct, 'r') { |r| r.read}.strip,
-                      File.open(migration_file, 'r') { |r| r.read}.strip,
-                      "Generated migration #{migration_file} does not match template #{correct}")
+         to_test = File.open(migration_file, 'r') { |r| r.read}.strip
+         File.open(File.join(File.dirname(__FILE__), 'verified_output', 'migrations', migration_file.sub(/^.*\d+_/, '')), 'r') do |file|
+           while (line = file.gets)
+             assert_not_nil(to_test.match(line.strip), "Generated migration #{migration_file} missing line: #{line}")
+           end
+         end
       end
       rake_migrate
     end

metadata

@@ -2,7 +2,7 @@
 name: migrant
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - Pascal Houliston
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +00:00
+date: 2011-02-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -410,16 +410,93 @@ dependencies:
   prerelease: false
   version_requirements: *id036
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: bundler
   requirement: &id037 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id037
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  requirement: &id038 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id038
+- !ruby/object:Gem::Dependency 
+  name: ansi
+  requirement: &id039 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id039
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id040 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id040
+- !ruby/object:Gem::Dependency 
+  name: turn
+  requirement: &id041 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id041
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  requirement: &id042 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id042
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id043 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id043
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id044 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id044
 description: Migrant gives you a super-clean DSL to describe your ActiveRecord models (somewhat similar to DataMapper) and generates all your migrations for you so you can spend more time coding the stuff that counts!
 email: 101pascal@gmail.com
 executables: []
@@ -449,11 +526,14 @@ files:
 - lib/datatype/symbol.rb
 - lib/datatype/time.rb
 - lib/generators/migrations.rb
+- lib/generators/model.rb
+- lib/generators/templates/model.rb
 - lib/migrant.rb
 - lib/migrant/migration_generator.rb
 - lib/migrant/model_extensions.rb
 - lib/migrant/schema.rb
 - lib/railtie.rb
+- lib/simple_object.rb
 - lib/tasks/db.rake
 - migrant.gemspec
 - test/additional_models/review.rb
@@ -519,7 +599,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 645598675
+      hash: 204450561
       segments: 
       - 0
       version: "0"