geert 0.0.1

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/README.rdoc

@@ -0,0 +1,87 @@
+= Geert: "Geert's an Enterprise Entity Relation Tracker"
+
+Find missing foreign keys in ActiveRecord and create a migration to add them.
+
+== 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.
+Run "geert -h" for all possible options.
+
+== A note of caution
+
+Foreign key constraints have a real impact on your application. Geert can't
+always see the difference between the desired and unwanted foreign keys.
+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.
+
+== Generating an ERD
+
+See a sample of the generated ERD here, based on Webistrano:
+
+  http://github.com/finalist/geert/blob/master/sample-erd.png
+
+Click on raw for full size. Can't link directly, because github will show
+it directly, which is rather awkward.
+
+If you run on a Mac, this is really easy. You'll might have to sacrifice a
+database for it, and you'll need at least graphviz and Sequel Pro.
+
+* Run geert
+* Migrate your database, apply all foreign keys for the best effect.
+* Open the database in Sequel Pro
+* Select: File -> Export -> Graphviz dotfile
+* Save the dotfile
+* In the console:
+
+    dot -Tsvg your_database.dot > your_database.svg
+
+* If you have librsvg installed, you can also generate a png file:
+
+    dot -Tsvg your_database.dot | rsvg-convert -o your_database.png
+
+You can find these applications here:
+
+* Sequel Pro: http://sequelpro.com
+* Graphviz:   http://graphviz.org
+* librsvg:    sudo port install librsvg (warning, has a lot of X11 dependencies)
+
+
+== Installation
+
+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.
+
+
+== 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) 2009 Iain Hecker. Released under the MIT License.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geert"
+    gem.summary = %Q{Geert's a Enterprise Entity Relation Tracker}
+    gem.description = %Q{Find foreign keys in ActiveRecord and create a migration to add them}
+    gem.email = "iain@iain.nl"
+    gem.homepage = "http://github.com/finalist/geert"
+    gem.authors = ["Iain Hecker"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_runtime_dependency "matthuhiggins-foreigner"
+    # 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: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geert #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/geert

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

data/geert.gemspec

@@ -0,0 +1,64 @@
+# 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{geert}
+  s.version = "0.0.1"
+
+  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.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}
+  s.executables = ["geert"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/geert",
+     "geert.gemspec",
+     "lib/geert.rb",
+     "lib/geert/association.rb",
+     "lib/geert/cli.rb",
+     "lib/geert/model.rb",
+     "lib/geert/project.rb",
+     "sample-erd.png",
+     "spec/geert_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/finalist/geert}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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/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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<matthuhiggins-foreigner>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<matthuhiggins-foreigner>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<matthuhiggins-foreigner>, [">= 0"])
+  end
+end
+

data/lib/geert/association.rb

@@ -0,0 +1,49 @@
+module Geert
+
+  class Association
+
+    attr_reader :reflection, :model
+
+    def exclude?
+      polymorphic? or uses_polymorphic?
+    end
+
+    def migration
+      "add_foreign_key :#{source}, :#{target}, #{options_string}" unless exclude?
+    end
+
+    def polymorphic?
+      reflection.options[:polymorphic]
+    end
+
+    def uses_polymorphic?
+      model.associations.select(&:polymorphic?).map(&:column).include?(column)
+    end
+
+    def column
+      reflection.primary_key_name
+    end
+
+    def source
+      model.table_name
+    end
+
+    def target
+      reflection.table_name
+    end
+
+    def options
+      {:column => column}
+    end
+
+    def options_string
+      options.inspect.gsub(/\A\{(.*)\}\z/, '\\1')
+    end
+
+    def initialize(reflection, model)
+      @reflection, @model = reflection, model
+    end
+
+  end
+
+end

data/lib/geert/cli.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+require File.dirname(__FILE__) + '/project'
+
+module Geert
+
+  class CLI
+
+    def self.execute(stdout, arguments=[])
+
+      parser = OptionParser.new do |opts|
+
+        opts.banner = <<-BANNER.gsub(/^ +/,'')
+        Find foreign keys in ActiveRecord and create a migration to add them.
+
+        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)
+
+        directory = arguments[-1] || Dir.pwd
+
+        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
+
+        require File.dirname(__FILE__) + '/../geert'
+        puts Geert.migration(directory)
+
+      end
+
+    end
+
+  end
+
+end

data/lib/geert/model.rb

@@ -0,0 +1,39 @@
+module Geert
+
+  class Model
+
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    def usable?
+      activerecord? && reflections.any?
+    end
+
+    def migration
+      associations.map(&:migration).compact.join("\n") if usable?
+    end
+
+    def associations
+      @associations ||= reflections.map { |reflection| Association.new(reflection, self) }
+    end
+
+    def table_name
+      model.table_name
+    end
+
+    private
+
+    def activerecord?
+      model.ancestors.include?(ActiveRecord::Base)
+    end
+
+    def reflections
+      @reflection ||= model.reflect_on_all_associations(:belongs_to)
+    end
+
+  end
+
+end

data/lib/geert/project.rb

@@ -0,0 +1,32 @@
+module Geert
+
+  class Project
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+      load_rails
+    end
+
+    def migration
+      models.map(&:migration).select(&:present?).join("\n\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
+
+  end
+
+end

data/lib/geert.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/geert/project'
+require File.dirname(__FILE__) + '/geert/model'
+require File.dirname(__FILE__) + '/geert/association'
+
+module Geert
+
+  def self.migration(path)
+    Project.new(path).migration
+  end
+
+end

data/spec/geert_spec.rb

@@ -0,0 +1,7 @@
+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"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'geert'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: geert
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Iain Hecker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 +01:00
+default_executable: geert
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: matthuhiggins-foreigner
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Find foreign keys in ActiveRecord and create a migration to add them
+email: iain@iain.nl
+executables: 
+- geert
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/geert
+- geert.gemspec
+- lib/geert.rb
+- lib/geert/association.rb
+- lib/geert/cli.rb
+- lib/geert/model.rb
+- lib/geert/project.rb
+- sample-erd.png
+- spec/geert_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/finalist/geert
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Geert's a Enterprise Entity Relation Tracker
+test_files: 
+- spec/geert_spec.rb
+- spec/spec_helper.rb