geert 0.0.3 → 0.1.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+spec/debug.log

data/README.rdoc

@@ -1,14 +1,22 @@
-= Geert: "Geert's an Enterprise Entity Relation Tracker"
+= Geert: "Geert's an Enterprise Entity Relation Tracker" ;)
 
 Find missing foreign keys in ActiveRecord and create a migration to add them.
 
+If you want to do it to keep your DBA happy, or want to generate a nice
+ERD (see below), or you have a legitimate reason to add foreign keys later,
+this gem might be for you.
+
 == Usage
 
 Go to your Rails application and type the command:
 
   geert
 
-And you'll get all the possible migrations you can have for your application.
+And you'll get the migration you need right in your console. To generate a
+migration, run:
+
+  geert --migration add_foreign_keys
+
 Run "geert -h" for all possible options.
 
 == A note of caution
@@ -19,6 +27,13 @@ It does try to get the proper type of constraint (restrict, nullify or delete),
 but that might not be what you want. A properly tested application will help
 you.
 
+A quick summary of how geert decides which type of foreign key to use:
+
+* Did you specify "has_many :foobars" with ":dependent => :delete_all"
+  or with ":dependent => :nullify", that geert will use that too.
+* Can your foreign key be null in the database, than geert will nullify too.
+* If your foreign key cannot be null, it will constrain usage.
+
 == Generating an ERD
 
 See a sample of the generated ERD here, based on Webistrano:
@@ -58,29 +73,9 @@ To install geert:
   gem install geert --source http://gemcutter.org
 
 It requires the foreigner gem as well, so please install that into your
-project, before running the "geert" command.
-
-In Rails < 3, edit config/environment.rb:
-
-  config.gem "matthuhiggins-foreigner", :lib => "foreigner", :source => "http://gemcutter.org"
-
-In Rails 3, edit your Gemfile:
-
-  gem "matthuhiggins-foreigner", :require_as => "foreigner"
-
-See http://github.com/matthuhiggins/foreigner for more info about foreigner.
-
+project, before running the "geert" command. See
+http://github.com/matthuhiggins/foreigner for more info about foreigner.
 
-== 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
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/bin/geert

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-require File.expand_path(File.dirname(__FILE__) + "/../lib/geert/cli")
+require File.dirname(__FILE__) + "/../lib/geert/cli"
 Geert::CLI.execute(STDOUT, ARGV)

data/geert.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geert}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Iain Hecker"]
-  s.date = %q{2009-11-19}
+  s.date = %q{2009-11-23}
   s.default_executable = %q{geert}
   s.description = %q{Find foreign keys in ActiveRecord and create a migration to add them}
   s.email = %q{iain@iain.nl}
@@ -18,8 +18,7 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".document",
-     ".gitignore",
+    ".gitignore",
      "README.rdoc",
      "Rakefile",
      "VERSION",
@@ -30,7 +29,11 @@ Gem::Specification.new do |s|
      "lib/geert/cli.rb",
      "lib/geert/model.rb",
      "lib/geert/project.rb",
+     "lib/options_parser.rb",
      "sample-erd.png",
+     "spec/db/database.yml",
+     "spec/db/geert.sqlite3",
+     "spec/db/schema.rb",
      "spec/geert_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -41,7 +44,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Geert's a Enterprise Entity Relation Tracker}
   s.test_files = [
-    "spec/geert_spec.rb",
+    "spec/db/schema.rb",
+     "spec/geert_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/geert.rb

@@ -4,8 +4,22 @@ require File.dirname(__FILE__) + '/geert/association'
 
 module Geert
 
-  def self.migration(path)
-    Project.new(path).migration
+  def self.migration(stdout, path, options = {})
+    project = Project.new(path, options)
+    if project.output.blank?
+      stdout.puts "No new foreign keys found to be added. Lucky you!"
+      exit
+    end
+    if options[:migration]
+      File.open(project.filename, 'w') do |f|
+        f.puts project.migration
+      end
+      stdout.puts "Generated migration #{project.filename}"
+    else
+      stdout.puts project.output
+    end
   end
 
+  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').chomp
+
 end

data/lib/geert/association.rb

@@ -7,6 +7,10 @@ module Geert
       ":#{source}, :#{target}#{options_string}" unless exclude?
     end
 
+    def output
+      "  :" + target + options_string unless exclude?
+    end
+
     def polymorphic?
       reflection.options[:polymorphic]
     end
@@ -26,7 +30,6 @@ module Geert
     private
 
     def existing?
-      require "foreigner"
       ActiveRecord::Base.connection.foreign_keys(source).any? do |fk|
         fk.options[:column].to_s == column.to_s
       end
@@ -57,13 +60,17 @@ module Geert
     end
 
     def nullify?
-      dependency_option == :nullify
+      dependency_option == :nullify || nullify_because_nullable?
     end
 
     def delete?
       dependency_option == :delete_all
     end
 
+    def nullify_because_nullable?
+      !delete? && model.columns_hash[column.to_s].null
+    end
+
     def dependency_option
       opposite_relation.options[:dependent] if opposite_relation
     end

data/lib/geert/cli.rb

@@ -1,51 +1,45 @@
-require 'optparse'
-require File.dirname(__FILE__) + '/project'
+require File.dirname(__FILE__) + '/../options_parser'
 
 module Geert
 
-  class CLI
+  class CLI < OptionsParser
 
-    def self.execute(stdout, arguments=[])
+    def banner
+      <<-BANNER.gsub(/^ +/,'')
+      Find foreign keys in ActiveRecord and create a migration to add them.
 
-      parser = OptionParser.new do |opts|
+      Go to your Rails directory, or optionally provide the path to it.
 
-        opts.banner = <<-BANNER.gsub(/^ +/,'')
-        Find foreign keys in ActiveRecord and create a migration to add them.
+      Please remember to read the readme, for further instructions.
 
-        Go to your Rails directory, or optionally provide the path to it.
-
-        Please remember to read the readme, for further instructions.
-
-        Usage: geert [options] [DIRECTORY]
-        e.g. geert ~/projects/myapp
-        BANNER
-
-        opts.separator ""
-
-        opts.on(nil, "--readme", "Show the Readme.") do
-          stdout.puts File.read(File.dirname(__FILE__) + '/../../README.rdoc')
-          exit
-        end
-
-        opts.on("-h", "--help", "Show this help message.") do
-          stdout.puts opts
-          exit
-        end
-
-        opts.parse!(arguments)
+      Usage: geert [options] [DIRECTORY]
+      e.g. geert ~/projects/myapp
+      BANNER
+    end
 
-        directory = arguments[-1] || Dir.pwd
+    parse :on, "-m", "--migration MIGRATION_NAME", "Generate a complete migration" do |name|
+      options[:migration] = name
+    end
 
-        unless File.exist?(File.join(directory, "config", "environment.rb"))
-          stdout.puts "Error: #{directory} is not a valid Rails application.\n\n"
-          stdout.puts opts; exit
-        end
+    after do
+      no_rails! unless File.exist?(environment)
+      require environment
+      require 'foreigner'
+      require gem_path("lib", "geert")
+      Geert.migration(stdout, directory, options)
+    end
 
-        require File.dirname(__FILE__) + '/../geert'
-        puts Geert.migration(directory)
+    def no_rails!
+      stdout.puts "Error: #{directory} is not a valid Rails application"
+      halt!
+    end
 
-      end
+    def environment
+      File.join(directory, "config", "environment.rb")
+    end
 
+    def directory
+      arguments[-1] || Dir.pwd
     end
 
   end

data/lib/geert/model.rb

@@ -12,8 +12,12 @@ module Geert
       activerecord? && reflections.any?
     end
 
+    def output
+      output_string if usable? && association_output.any?
+    end
+
     def migration
-      associations.map(&:migration).compact.sort.join("\n") if usable?
+      associations.map(&:migration).compact.sort if usable?
     end
 
     def associations
@@ -24,8 +28,20 @@ module Geert
       model.table_name
     end
 
+    def columns_hash(*args)
+      model.columns_hash(*args)
+    end
+
     private
 
+    def association_output
+      associations.map(&:output).compact
+    end
+
+    def output_string
+      [ "\n", model.class_name + " " + ("-" * (80 - model.class_name.size)) ] + association_output
+    end
+
     def activerecord?
       model.ancestors.include?(ActiveRecord::Base)
     end

data/lib/geert/project.rb

@@ -2,57 +2,68 @@ module Geert
 
   class Project
 
-    attr_reader :path
+    attr_reader :path, :options
 
-    def initialize(path)
-      @path = path
-      load_rails
+    def initialize(path, options = {})
+      @path, @options = path, options
     end
 
     def migration
-      <<-MIGRATION
-class AddMissingForeignKeys < ActiveRecord::Migration
-  def self.up
-#{migration_up}
-  end
+      <<-MIGRATION.gsub(/^ {6}/,'')
+      class #{migration_name.camelize} < ActiveRecord::Migration
+        def self.up
+      #{cleanup migration_up}
+        end
 
-  def self.down
-#{migration_down}
-  end
-end
+        def self.down
+      #{cleanup migration_down}
+        end
+      end
       MIGRATION
     end
 
-    def migration_up
-      migration_lines.map(&modify_line("add"))
+    def filename
+      @filename ||= File.join(path, "db", "migrate", Time.now.strftime("%Y%m%d%H%M%S") + "_" + migration_name + ".rb")
     end
 
-    def migration_down
-      migration_lines.split("\n").reverse.join("\n").map(&modify_line("remove"))
+    def output
+      models.map(&:output).flatten.compact
     end
 
+    private
+
     def migration_lines
-      @migration_lines ||= models.map(&:migration).select(&:present?).join("\n\n")
+      @migration_lines ||= models.map(&:migration).flatten
+    end
+
+    def migration_name
+      options[:migration].to_s.underscore
+    end
+
+    def migration_up
+      migration_lines.map(&modify_line("add")).join("\n")
+    end
+
+    def migration_down
+      migration_lines.reverse.map(&modify_line("remove")).join("\n")
     end
 
     def modify_line(command)
       lambda { |line| line.present? ? "    #{command}_foreign_key #{line}" : "\n" }
     end
 
-    private
-
     def models
       model_files.map { |file| Model.new(file.camelize.constantize) }
     end
 
-    def load_rails
-      require File.join(path, 'config', 'environment')
-    end
-
     def model_files
       Dir.glob("#{path}/app/models/*.rb").map { |file| File.basename(file, ".rb") }
     end
 
+    def cleanup(line)
+      line.gsub(/(\n\n)+/m, "\n")
+    end
+
   end
 
 end

data/lib/options_parser.rb

@@ -0,0 +1,111 @@
+require 'optparse'
+
+# You can extend this class to use a wrapper around the default
+# Ruby OptionParser. If you see this, feel free to copy it to your own gem.
+# Copyright 2009, Iain Hecker. Released under the MIT License.
+class OptionsParser
+
+  attr_accessor :stdout, :arguments
+
+  # Call the excute method from your bin file:
+  #
+  #   #!/usr/bin/env ruby
+  #   require File.dirname(__FILE__) + "/../lib/your_gem/cli")
+  #   YourGem::CLI.execute(STDOUT, ARGV)
+  def self.execute(stdout, arguments = [])
+    cli = new(stdout, arguments)
+    cli.instance_eval(&@before) if @before
+    cli.parse
+    cli.instance_eval(&@after) if @after
+  end
+
+  def initialize(stdout, arguments)
+    @stdout, @arguments = stdout, arguments
+  end
+
+  def options
+    (@options || {}).merge(self.class.options)
+  end
+
+  # Define your application specific command line options.
+  # This gets passed to OptionParser.
+  # The first argument is the method to call, the rest is you world expect
+  #
+  # Example:
+  #
+  # class CLI < OptionsParser
+  #   parse(:on, "-v", "Show version") { stdout.puts YourGem::Version } 
+  def self.parse(*args, &code)
+    parse_options << [ args, code ] unless args.empty?
+  end
+
+  def self.parse_options
+    @parse_options ||= []
+  end
+
+  # Define what needs to be done after parsing the options.
+  # Similar to RSpec's after.
+  def self.after(&code)
+    @after = code
+  end
+
+  # Define what needs to be done before parsing the options.
+  # Similar to RSpec's before.
+  def self.before(&code)
+    @before = code
+  end
+
+  def self.options
+    @options ||= {}
+  end
+
+  # Override to alter the separator
+  def separator; "" end
+
+  # Override to alter the banner
+  def banner; "" end
+
+  # Does the main work or parsing the options
+  def parse
+    OptionParser.new do |opts|
+      opts.banner = banner
+      opts.separator separator
+      parse_options(opts)
+      opts.separator separator
+      opts.on "--readme", "Show the Readme", &readme
+      opts.on "-v", "--version", "Show version", &version
+      opts.on "-h", "--help", "Show this help message", &help(opts)
+      opts.parse! arguments
+    end
+  end
+
+  private
+
+  # Wrapper around File.join, but relative to the root of your gem.
+  def gem_path(*segments)
+    File.join(File.dirname(__FILE__), "..", *segments)
+  end
+
+  def readme
+    lambda { stdout.puts File.read(gem_path('README.rdoc')); halt! }
+  end
+
+  def help(opts)
+    lambda { stdout.puts opts; halt! }
+  end
+
+  def version
+    lambda { stdout.puts File.read(gem_path('VERSION')); halt! }
+  end
+
+  def parse_options(opts)
+    self.class.parse_options.each { |option| opts.__send__(*option[0], &option[-1]) }
+  end
+
+
+  # Exits the application. For stubbing purposes. Use halt! in your CLI too!
+  def halt!
+    exit
+  end
+
+end

data/spec/db/database.yml

@@ -0,0 +1,10 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: spec/db/geert.sqlite3
+
+mysql:
+  :adapter: mysql
+  :database: geert_test
+  :username: root
+  :password:
+  :socket: /tmp/mysql.sock

data/spec/db/schema.rb

@@ -0,0 +1,34 @@
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define(:version => Geert::VERSION) do
+
+  # The other end of the relation
+  create_table :posts, :force => true do |t|
+    t.string :name
+  end
+
+  # Comments have a foreign key that can be nil
+  create_table :comments, :force => true do |t|
+    t.integer :post_id, :null => true
+  end
+
+  # Topics have a foreign key that cannot be nil
+  create_table :topics, :force => true do |t|
+    t.integer :post_id, :null => false
+  end
+
+  # Tags are for testing polymporphic relations
+  create_table :tags, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :taggings, :force => true do |t|
+    t.integer :tag_id
+    t.integer :tagged_id
+    t.string  :tagged_type
+  end
+
+  # The relation has a different name here
+  create_table :subscriptions, :force => true do |t|
+    t.integer :writing_id
+  end
+end

data/spec/geert_spec.rb

@@ -1,7 +1,101 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Geert" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe Geert do
+
+  describe "making migration lines" do
+
+    subject { Geert::Model }
+
+    it "should make dependent nullify if dependent has been set in active record" do
+      class Post < ActiveRecord::Base
+        has_many :comments, :dependent => :nullify
+      end
+      class Comment < ActiveRecord::Base
+        belongs_to :post
+      end
+      subject.new(Comment).migration.should include(":comments, :posts, :dependent => :nullify")
+    end
+
+    it "should make dependent delete if dependent has been set in active record" do
+      class Post < ActiveRecord::Base
+        has_many :comments, :dependent => :delete_all
+      end
+      class Comment < ActiveRecord::Base
+        belongs_to :post
+      end
+      subject.new(Comment).migration.should include(":comments, :posts, :dependent => :delete")
+    end
+
+    it "should make dependent constraint if foreign key cannot be nil" do
+      class Post < ActiveRecord::Base
+        has_many :topics
+      end
+      class Topic < ActiveRecord::Base
+        belongs_to :post
+      end
+      subject.new(Topic).migration.should include(":topics, :posts")
+    end
+
+    it "should make dependent nullify if foreign key can be nil" do
+      class Post < ActiveRecord::Base
+        has_many :comments
+      end
+      class Comment < ActiveRecord::Base
+        belongs_to :post
+      end
+      subject.new(Comment).migration.should include(":comments, :posts, :dependent => :nullify")
+    end
+
+    it "should not make migration lines for polymorphic relations" do
+      class Tagging < ActiveRecord::Base
+        belongs_to :tagged, :polymorphic => true
+      end
+      class Post < ActiveRecord::Base
+        has_many :taggings, :as => :tagged
+      end
+      subject.new(Tagging).migration.should == []
+    end
+
+    it "should not make migration lines for relations that use a polymorphic relation" do
+      class Tag < ActiveRecord::Base
+        has_many :taggings
+        has_many :tagged_posts, :through => :taggings, :source => :post, :conditions => { :tagged_type => "Post" }
+      end
+      class Tagging < ActiveRecord::Base
+        belongs_to :tagged, :polymorphic => true
+      end
+      class Post < ActiveRecord::Base
+        has_many :taggings, :as => :tagged
+      end
+      subject.new(Tagging).migration.should == []
+    end
+
+    it "should not make migration lines for existing foreign keys" do
+      if ActiveRecord::Base.connection.adapter_name =~ /sqlite/i
+        pending "SQLite doesn't support foreign keys.\nConfigure spec/db/database.yml and run DB=mysql rake spec"
+      end
+      ActiveRecord::Base.connection.add_foreign_key :comments, :posts
+      class Post < ActiveRecord::Base
+        has_many :subscriptions
+      end
+      class Comment < ActiveRecord::Base
+        belongs_to :post
+      end
+      subject.new(Comment).migration.should == []
+      ActiveRecord::Base.connection.remove_foreign_key :comments, :posts
+    end
+
+    it "should specify the column name, when different from Rails conventions" do
+      class Post < ActiveRecord::Base
+        has_many :comments, :dependent => :nullify
+      end
+      class Subscription < ActiveRecord::Base
+        belongs_to :writing, :class_name => "Post"
+      end
+      regex = /:column => "writing_id"/
+      subject.new(Subscription).migration.first.should =~ regex
+    end
+
   end
+
 end

data/spec/spec_helper.rb

@@ -1,9 +1,19 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+spec_dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(spec_dir)
+$LOAD_PATH.unshift(File.join(spec_dir, '..', 'lib'))
 require 'geert'
 require 'spec'
 require 'spec/autorun'
+require 'activerecord'
+
+ActiveRecord::Base.logger = Logger.new(spec_dir + "/debug.log")
+databases = YAML::load(IO.read(spec_dir + "/db/database.yml"))
+ActiveRecord::Base.establish_connection(databases[ENV["DB"] || "sqlite3"])
+
+require 'foreigner'
+load(File.join(spec_dir, "db", "schema.rb"))
+
 
 Spec::Runner.configure do |config|
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: geert
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Iain Hecker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +01:00
+date: 2009-11-23 00:00:00 +01:00
 default_executable: geert
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .document
 - .gitignore
 - README.rdoc
 - Rakefile
@@ -53,7 +52,11 @@ files:
 - lib/geert/cli.rb
 - lib/geert/model.rb
 - lib/geert/project.rb
+- lib/options_parser.rb
 - sample-erd.png
+- spec/db/database.yml
+- spec/db/geert.sqlite3
+- spec/db/schema.rb
 - spec/geert_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -86,5 +89,6 @@ signing_key:
 specification_version: 3
 summary: Geert's a Enterprise Entity Relation Tracker
 test_files: 
+- spec/db/schema.rb
 - spec/geert_spec.rb
 - spec/spec_helper.rb

data/.document

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