modalfields 1.1.1

data/lib/modalfields/standardfields.rb

@@ -0,0 +1,13 @@
+# Define built-in column types, with default values for valid attributes
+ModalFields.define do
+  string :limit=>255
+  text :limit=>nil
+  integer :limit=>nil
+  float
+  decimal :scale=>nil, :precision=>nil
+  datetime
+  time
+  date
+  binary :limit=>nil
+  boolean
+end

data/lib/modalfields/tasks.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '**/*.rake')].each { |f| load f }

data/lib/tasks/check.rake

@@ -0,0 +1,6 @@
+namespace :fields do
+  desc "Compare the current schema with existing field declarations"
+  task :check=>:environment do
+    ModalFields.check
+  end  
+end

data/lib/tasks/migrate.rake

@@ -0,0 +1,17 @@
+namespace :db do
+  task :migrate do
+    ModalFields.update
+  end
+
+  task :update => [:migrate] do
+    ModalFields.update
+  end
+
+  namespace :migrate do
+    [:up, :down, :reset, :redo].each do |t|
+      task t do
+        ModalFields.update
+      end
+    end
+  end
+end

data/lib/tasks/update.rake

@@ -0,0 +1,6 @@
+namespace :fields do
+  desc "Update the field declarations from the current schema"
+  task :update=>:environment do
+    ModalFields.update
+  end
+end

data/test/create_database.rb

@@ -0,0 +1,47 @@
+def create_database(config)
+  begin
+    if config['adapter'] =~ /sqlite/
+      if File.exist?(config['database'])
+        $stderr.puts "#{config['database']} already exists"
+      else
+        begin
+          # Create the SQLite database
+          ActiveRecord::Base.establish_connection(config)
+          ActiveRecord::Base.connection
+        rescue
+          $stderr.puts $!, *($!.backtrace)
+          $stderr.puts "Couldn't create database for #{config.inspect}"
+        end
+      end
+      return # Skip the else clause of begin/rescue    
+    else
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    end
+  rescue
+    case config['adapter']
+    when 'mysql'
+      @charset   = ENV['CHARSET']   || 'utf8'
+      @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
+      begin
+        ActiveRecord::Base.establish_connection(config.merge('database' => nil))
+        ActiveRecord::Base.connection.create_database(config['database'], :charset => (config['charset'] || @charset), :collation => (config['collation'] || @collation))
+        ActiveRecord::Base.establish_connection(config)
+      rescue
+        $stderr.puts "Couldn't create database for #{config.inspect}, charset: #{config['charset'] || @charset}, collation: #{config['collation'] || @collation} (if you set the charset manually, make sure you have a matching collation)"
+      end
+    when 'postgresql'
+      @encoding = config[:encoding] || ENV['CHARSET'] || 'utf8'
+      begin
+        ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+        ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => @encoding))
+        ActiveRecord::Base.establish_connection(config)
+      rescue
+        $stderr.puts $!, *($!.backtrace)
+        $stderr.puts "Couldn't create database for #{config.inspect}"
+      end
+    end
+  else
+    $stderr.puts "#{config['database']} already exists"
+  end
+end

data/test/database.yml

@@ -0,0 +1,11 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: modalfields_plugin.sqlite3.db
+ 
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database:  modalfields_plugin_test
+  :min_messages: ERROR
+  

data/test/helper.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'active_support'
+require 'active_record'
+require 'logger'
+
+require 'active_support/core_ext/hash'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'modalfields'
+
+class Test::Unit::TestCase
+end
+
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) # + '/../../../..'
+ 
+# require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+module Rails
+  def self.root
+    ENV['RAILS_ROOT']
+  end
+end
+ 
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml')).with_indifferent_access
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ 
+  db_adapter = ENV['DB']
+ 
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite3'
+      'sqlite3'
+      rescue MissingSourceFile
+    end
+ 
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite3."
+  end
+  
+  require File.dirname(__FILE__) + '/create_database'
+  create_database config[db_adapter]
+  
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init'
+end

data/test/model_cases/bare/after/author.rb

@@ -0,0 +1,12 @@
+class Author < ActiveRecord::Base
+
+  fields do
+    name :string
+    number :integer
+    birthdate :date
+    event :datetime
+    decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+  end
+
+  has_many :books
+end

data/test/model_cases/bare/after/book.rb

@@ -0,0 +1,12 @@
+class Book < ActiveRecord::Base
+
+  fields do
+    title :string
+    price :decimal, :precision=>8, :scale=>2
+    code :string, :limit=>4
+    comments :text
+    timestamps
+  end
+
+  belongs_to :author
+end

data/test/model_cases/bare/before/author.rb

@@ -0,0 +1,3 @@
+class Author < ActiveRecord::Base
+  has_many :books
+end

data/test/model_cases/bare/before/book.rb

@@ -0,0 +1,4 @@
+class Book < ActiveRecord::Base
+
+  belongs_to :author
+end

data/test/model_cases/clean/after/author.rb

@@ -0,0 +1,14 @@
+class Author < ActiveRecord::Base
+
+  fields {
+    # The comments must be prerserved
+    number :integer # as well as the order of field declarations,
+      name :string  # indendationa
+      birthdate :date, :unique # specifications...
+    # etc.
+    decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+    event :datetime
+  }
+
+  has_many :books
+end

data/test/model_cases/clean/after/book.rb

@@ -0,0 +1,14 @@
+class Book < ActiveRecord::Base
+
+  # the position of the fields block must be preserved
+  belongs_to :author
+
+  fields do
+    title :string
+    price :decimal, :precision=>8, :scale=>2
+    code :string, :limit=>4
+    comments :text
+    timestamps
+  end
+
+end

data/test/model_cases/clean/before/author.rb

@@ -0,0 +1,14 @@
+class Author < ActiveRecord::Base
+
+  fields {
+    # The comments must be prerserved
+    number :integer # as well as the order of field declarations,
+      name :string  # indendationa
+      birthdate :date, :unique # specifications...
+    # etc.
+    decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+    event :datetime
+  }
+
+  has_many :books
+end

data/test/model_cases/clean/before/book.rb

@@ -0,0 +1,14 @@
+class Book < ActiveRecord::Base
+
+  # the position of the fields block must be preserved
+  belongs_to :author
+
+  fields do
+    title :string
+    price :decimal, :precision=>8, :scale=>2
+    code :string, :limit=>4
+    comments :text
+    timestamps
+  end
+
+end

data/test/model_cases/dirty/after/author.rb

@@ -0,0 +1,14 @@
+class Author < ActiveRecord::Base
+
+  fields {
+    # The comments must be prerserved
+    number :integer # as well as the order of field declarations,
+      name :string  # indendation
+    birthdate :date, :unique # specifications...
+    # etc.
+    decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+    event :datetime
+  }
+
+  has_many :books
+end

data/test/model_cases/dirty/after/book.rb

@@ -0,0 +1,14 @@
+class Book < ActiveRecord::Base
+
+  # the position of the fields block must be preserved
+  belongs_to :author
+
+  fields do
+    title :string
+    price :decimal, :precision=>8, :scale=>2
+    code :string, :limit=>4
+    comments :text
+    timestamps
+  end
+
+end

data/test/model_cases/dirty/before/author.rb

@@ -0,0 +1,15 @@
+class Author < ActiveRecord::Base
+
+  fields {
+    # The comments must be prerserved
+    number :integer # as well as the order of field declarations,
+      name :string  # indendation
+      xxxx :string
+      birthdate :integer, :unique # specifications...
+    # etc.
+    decnum :decimal, :default=>BigDecimal('1.2'), :precision=>11, :scale=>3
+    eventx :datetime
+  }
+
+  has_many :books
+end

data/test/model_cases/dirty/before/book.rb

@@ -0,0 +1,14 @@
+class Book < ActiveRecord::Base
+
+  # the position of the fields block must be preserved
+  belongs_to :author
+
+  fields do
+    title :string
+    price :decimal, :precision=>8, :scale=>4
+    code :string, :limit=>4
+    comments :text
+    zzzzz :integer
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :authors, :force => true do |t|
+    t.string :name
+    t.integer :number
+    t.date :birthdate
+    t.datetime :event
+    t.decimal :decnum, :precision=>10,  :scale=>3, :default=>BigDecimal('1.2')
+  end
+  create_table :books, :force => true do |t|
+    t.integer :author_id
+    t.string :title
+    t.decimal :price, :precision=>8, :scale=>2
+    t.string :code, :limit=>4
+    t.text :comments
+    t.timestamps
+  end
+end

data/test/test_diff.rb

@@ -0,0 +1,127 @@
+require File.dirname(__FILE__)+'/helper'
+
+class TestDiff< Test::Unit::TestCase
+  
+  context "Given model definitions without field declarations" do
+    
+    setup do
+      load_schema
+      class Author < ActiveRecord::Base
+        has_many :books
+      end
+      class Book < ActiveRecord::Base
+        belongs_to :author
+      end
+    end
+    
+    should "Find all fields that are not primary or foreing keys" do
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Author)
+      assert modified_fields.empty?
+      assert deleted_fields.empty?
+      assert_same_elements ["number", "name", "birthdate", "decnum", "event"], new_fields.map{|f| f.name.to_s}
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Book)
+      assert modified_fields.empty?
+      assert deleted_fields.empty?
+      assert_same_elements ["title", "price", "code", "comments", "created_at", "updated_at"], new_fields.map{|f| f.name.to_s}
+    end
+    
+    teardown do
+      TestDiff.send(:remove_const, :Author) if defined?(Author)
+      TestDiff.send(:remove_const, :Book) if defined?(Book)
+    end
+    
+  end
+
+  context "Given model definitions with up to date field declarations" do
+    
+    setup do
+      load_schema
+      class Author < ActiveRecord::Base
+        fields do
+          name :string
+          number :integer
+          birthdate :date
+          event :datetime
+          decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+        end
+        has_many :books
+      end
+      class Book < ActiveRecord::Base
+        fields do
+          title :string
+          price :decimal, :precision=>8, :scale=>2
+          code :string, :limit=>4
+          comments :text
+          timestamps
+        end
+        belongs_to :author
+      end
+    end
+    
+    should "not find any changes" do
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Author)
+      # assert new_fields.empty?
+      # assert modified_fields.empty?
+      # assert deleted_fields.empty?
+      assert_same_elements [], new_fields.map{|f| f.name.to_s}
+      assert_same_elements [], modified_fields.map{|f| f.name.to_s}
+      assert_same_elements [], deleted_fields.map{|f| f.name.to_s}
+      
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Book)
+      # assert new_fields.empty?
+      # assert modified_fields.empty?
+      # assert deleted_fields.empty?
+      assert_same_elements [], new_fields.map{|f| f.name.to_s}
+      assert_same_elements [], modified_fields.map{|f| f.name.to_s}
+      assert_same_elements [], deleted_fields.map{|f| f.name.to_s}
+    end
+    
+    teardown do
+      TestDiff.send(:remove_const, :Author) if defined?(Author)
+      TestDiff.send(:remove_const, :Book) if defined?(Book)
+    end
+    
+  end  
+
+  context "Given model definitions with unaccurate field declarations" do
+    
+    setup do
+      load_schema
+      class Author < ActiveRecord::Base
+        fields do
+          name :string
+          birthdate :datetime
+          nationality :string
+          event :datetime
+          decnum :decimal, :default=>BigDecimal('1.2'), :precision=>10, :scale=>3
+        end
+        has_many :books
+      end
+      class Book < ActiveRecord::Base
+        fields do
+          title :string
+          price :decimal, :precision=>8, :scale=>2
+          code :string, :limit=>5
+          timestamps
+        end
+      end
+    end
+    
+    should "Find schema modifications" do
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Author)
+      assert_same_elements ['nationality'], deleted_fields.map{|f| f.name.to_s}
+      assert_same_elements ['number'], new_fields.map{|f| f.name.to_s}
+      assert_same_elements ['birthdate'], modified_fields.map{|f| f.name.to_s}
+      new_fields, modified_fields, deleted_fields = ModalFields.send(:diff, Book)
+      assert_same_elements [], deleted_fields.map{|f| f.name.to_s}
+      assert_same_elements ['comments', 'author_id'], new_fields.map{|f| f.name.to_s}
+      assert_same_elements ['code'], modified_fields.map{|f| f.name.to_s}
+    end
+    
+    teardown do
+      TestDiff.send(:remove_const, :Author) if defined?(Author)
+      TestDiff.send(:remove_const, :Book) if defined?(Book)
+    end
+    
+  end  
+end