rails-erd 0.4.5 → 1.0.0

data/CHANGES.rdoc

@@ -1,3 +1,21 @@
+=== 1.0.0:
+
+* The internal API is now stable and will be backwards compatible until
+  the next major version.
+* Added experimental command line interface (erd). The CLI still requires a
+  Rails application to be present, but it may one day support other kinds of
+  applications.
+* Crow's foot notation (also known as the Information Engineering notation)
+  can be used by adding 'notation=crowsfoot' to the 'rake erd' command
+  (contributed by Jeremy Holland).
+* Filter models by using the only or exclude options (only=ModelOne,ModelTwo
+  or exclude=ModelThree,ModelFour) from the command line (contributed by
+  Milovan Zogovic).
+* Process column types that are unsupported by Rails (contributed by Erik
+  Gustavson).
+* Ignore custom limit/scale attributes that cannot be converted to an integer
+  (reported by Adam St. John).
+
 === 0.4.5:
 
 * Display more helpful error message when the application models could not be

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Voormedia B.V.
+Copyright (c) 2010-2012 Voormedia B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -31,11 +31,11 @@ Getting started
 See the [installation instructions](http://rails-erd.rubyforge.org/install.html)
 for a complete description of how to install Rails ERD. Here's a summary:
 
-* Install Graphviz 2.22+ with Pango and Cairo support ([how?](http://rails-erd.rubyforge.org/install.html))
+* Install Graphviz 2.22+ ([how?](http://rails-erd.rubyforge.org/install.html))
 
 * Add <tt>gem "rails-erd"</tt> to your application's Gemfile
 
-* Run <tt>rake erd</tt>
+* Run <tt>bundle exec erd</tt>
 
 
 Learn more
@@ -51,7 +51,7 @@ About Rails ERD
 
 Rails ERD was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
 
-Copyright 2010-2011 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+Copyright 2010-2012 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
 
 
 License

data/Rakefile

@@ -1,54 +1,65 @@
-# encoding: utf-8
-require "jeweler"
+require "bundler"
 require "rake/testtask"
 
-Jeweler::Tasks.new do |spec|
-  spec.name = "rails-erd"
-  spec.rubyforge_project = "rails-erd"
-  spec.summary = "Entity-relationship diagram for your Rails models."
-  spec.description = "Automatically generate an entity-relationship diagram (ERD) for your Rails models."
-
-  spec.authors = ["Rolf Timmermans"]
-  spec.email = "r.timmermans@voormedia.com"
-  spec.homepage = "http://rails-erd.rubyforge.org/"
-
-  # Don't bundle examples or website in gem.
-  excluded = Dir["{examples,site}/**/*"]
-  spec.files -= excluded
-  spec.test_files -= excluded
-end
-
-Jeweler::GemcutterTasks.new
-
-Jeweler::RubyforgeTasks.new do |rubyforge|
-  rubyforge.doc_task = "rdoc"
-  rubyforge.remote_doc_path = "doc"
-end
+Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new do |test|
-  test.pattern = "test/unit/**/*_test.rb"
+  test.test_files = FileList["test/**/*_test.rb"]
 end
 
 task :default => :test
 
-begin
-  require "hanna/rdoctask"
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_files = %w{CHANGES.rdoc LICENSE} + Dir["lib/**/*.rb"]
-    rdoc.title = "Rails ERD – API Documentation"
-    rdoc.rdoc_dir = "rdoc"
-    rdoc.main = "RailsERD"
-  end
-rescue LoadError
-end
-
-desc "Generate diagrams for bundled examples"
-task :examples do
-  require File.expand_path("examples/generate", File.dirname(__FILE__))
-end
-
-namespace :examples do
-  task :sfdp do
-    require File.expand_path("examples/sfdp", File.dirname(__FILE__))
-  end
-end
+# # encoding: utf-8
+# require "jeweler"
+# require "rake/testtask"
+#
+# Jeweler::Tasks.new do |spec|
+#   spec.name = "rails-erd"
+#   spec.rubyforge_project = "rails-erd"
+#   spec.summary = "Entity-relationship diagram for your Rails models."
+#   spec.description = "Automatically generate an entity-relationship diagram (ERD) for your Rails models."
+#
+#   spec.authors = ["Rolf Timmermans"]
+#   spec.email = "r.timmermans@voormedia.com"
+#   spec.homepage = "http://rails-erd.rubyforge.org/"
+#
+#   # Don't bundle examples or website in gem.
+#   excluded = Dir["{examples,site}/**/*"]
+#   spec.files -= excluded
+#   spec.test_files -= excluded
+# end
+#
+# Jeweler::GemcutterTasks.new
+#
+# Jeweler::RubyforgeTasks.new do |rubyforge|
+#   rubyforge.doc_task = "rdoc"
+#   rubyforge.remote_doc_path = "doc"
+# end
+#
+# Rake::TestTask.new do |test|
+#   test.pattern = "test/unit/**/*_test.rb"
+# end
+#
+# task :default => :test
+#
+# begin
+#   require "hanna/rdoctask"
+#   Rake::RDocTask.new do |rdoc|
+#     rdoc.rdoc_files = %w{CHANGES.rdoc LICENSE} + Dir["lib/**/*.rb"]
+#     rdoc.title = "Rails ERD – API Documentation"
+#     rdoc.rdoc_dir = "rdoc"
+#     rdoc.main = "RailsERD"
+#   end
+# rescue LoadError
+# end
+#
+# desc "Generate diagrams for bundled examples"
+# task :examples do
+#   require File.expand_path("examples/generate", File.dirname(__FILE__))
+# end
+#
+# namespace :examples do
+#   task :sfdp do
+#     require File.expand_path("examples/sfdp", File.dirname(__FILE__))
+#   end
+# end

data/bin/erd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "rails_erd/cli"
+
+RailsERD::CLI.start

data/lib/rails_erd.rb

@@ -50,7 +50,7 @@ module RailsERD
   self.options = ActiveSupport::OrderedOptions[
     :attributes, :content,
     :disconnected, true,
-    :filename, "ERD",
+    :filename, "erd",
     :filetype, :pdf,
     :indirect, true,
     :inheritance, false,
@@ -59,6 +59,8 @@ module RailsERD
     :orientation, :horizontal,
     :polymorphism, false,
     :warn, true,
-    :title, true
+    :title, true,
+    :exclude, nil,
+    :only, nil
   ]
 end

data/lib/rails_erd/cli.rb

@@ -0,0 +1,149 @@
+require "choice"
+
+Choice.options do
+  separator ""
+  separator "Diagram options:"
+
+  option :title do
+    long "--title=TITLE"
+    desc "Replace default diagram title with a custom one."
+  end
+
+  option :notation do
+    long "--notation=STYLE"
+    desc "Diagram notation style, one of simple, bachman, uml or crowsfoot."
+    default "simple"
+  end
+
+  option :attributes do
+    long "--attributes=TYPE,..."
+    desc "Attribute groups to display: content, primary_keys, foreign_keys, timestamps and/or inheritance."
+    default "content"
+  end
+
+  option :orientation do
+    long "--orientation=ORIENTATION"
+    desc "Orientation of diagram, either horizontal (default) or vertical."
+    default "orientation"
+  end
+
+  option :inheritance do
+    long "--inheritance"
+    desc "Display (single table) inheritance relationships."
+  end
+
+  option :polymorphism do
+    long "--polymorphism"
+    desc "Display polymorphic relationships."
+  end
+
+  option :no_indirect do
+    long "--direct"
+    desc "Omit indirect relationships (through other entities)."
+  end
+
+  option :no_disconnected do
+    long "--connected"
+    desc "Omit entities without relationships."
+  end
+
+  separator ""
+  separator "Output options:"
+
+  option :filename do
+    long "--filename=FILENAME"
+    desc "Basename of the output diagram."
+    default "erd"
+  end
+
+  option :filetype do
+    long "--filetype=TYPE"
+    desc "Output file type. Available types depend on the diagram renderer."
+    default "pdf"
+  end
+
+  option :no_markup do
+    long "--no-markup"
+    desc "Disable markup for enhanced compatibility of .dot output with other applications."
+  end
+
+  option :open do
+    long "--open"
+    desc "Open the output file after it has been saved."
+  end
+
+  separator ""
+  separator "Common options:"
+
+  option :help do
+    long "--help"
+    desc "Display this help message."
+  end
+
+  option :debug do
+    long "--debug"
+    desc "Show stack traces when an error occurs."
+  end
+
+  option :version do
+    short "-v"
+    long "--version"
+    desc "Show version and quit."
+    action do
+      require "rails_erd/version"
+      $stderr.puts RailsERD::BANNER
+      exit
+    end
+  end
+end
+
+module RailsERD
+  class CLI
+    attr_reader :path, :options
+
+    class << self
+      def start
+        path = Choice.rest.first || Dir.pwd
+        options = Choice.choices.each_with_object({}) do |(key, value), opts|
+          if key.start_with? "no_"
+            opts[key.gsub("no_", "").to_sym] = !value
+          elsif value.to_s.include? ","
+            opts[key.to_sym] = value.split(",").map(&:to_sym)
+          else
+            opts[key.to_sym] = value
+          end
+        end
+        new(path, options).start
+      end
+    end
+
+    def initialize(path, options)
+      @path, @options = path, options
+      require "rails_erd/diagram/graphviz"
+    end
+
+    def start
+      load_application
+      create_diagram
+    rescue Exception => e
+      $stderr.puts "Failed: #{e.class}: #{e.message}"
+      $stderr.puts e.backtrace.map { |t| "    from #{t}" } if options[:debug]
+    end
+
+    private
+
+    def load_application
+      $stderr.puts "Loading application in '#{File.basename(path)}'..."
+      # TODO: Add support for different kinds of environment.
+      require "#{path}/config/environment"
+      Rails.application.eager_load!
+    end
+
+    def create_diagram
+      $stderr.puts "Generating entity-relationship diagram for #{ActiveRecord::Base.descendants.length} models..."
+      file = RailsERD::Diagram::Graphviz.create(options)
+      $stderr.puts "Diagram saved to '#{file}'."
+      `open #{file}` if options[:open]
+    end
+  end
+end

data/lib/rails_erd/diagram.rb

@@ -3,7 +3,7 @@ require "rails_erd/domain"
 module RailsERD
   # This class is an abstract class that will process a domain model and
   # allows easy creation of diagrams. To implement a new diagram type, derive
-  # from this class and override +process_entity+, +process_relationship+, 
+  # from this class and override +process_entity+, +process_relationship+,
   # and (optionally) +save+.
   #
   # As an example, a diagram class that generates code that can be used with
@@ -73,13 +73,13 @@ module RailsERD
       def create(options = {})
         new(Domain.generate(options), options).create
       end
-      
+
       protected
-      
+
       def setup(&block)
         callbacks[:setup] = block
       end
-      
+
       def each_entity(&block)
         callbacks[:each_entity] = block
       end
@@ -91,7 +91,7 @@ module RailsERD
       def each_specialization(&block)
         callbacks[:each_specialization] = block
       end
-      
+
       def save(&block)
         callbacks[:save] = block
       end
@@ -105,7 +105,7 @@ module RailsERD
 
     # The options that are used to create this diagram.
     attr_reader :options
-    
+
     # The domain that this diagram represents.
     attr_reader :domain
 
@@ -113,13 +113,13 @@ module RailsERD
     def initialize(domain, options = {})
       @domain, @options = domain, RailsERD.options.merge(options)
     end
-    
+
     # Generates and saves the diagram, returning the result of +save+.
     def create
       generate
       save
     end
-    
+
     # Generates the diagram, but does not save the output. It is called
     # internally by Diagram#create.
     def generate
@@ -137,19 +137,21 @@ module RailsERD
         instance_exec relationship, &callbacks[:each_relationship]
       end
     end
-    
+
     def save
       instance_eval &callbacks[:save]
     end
-    
+
     private
-    
+
     def callbacks
       @callbacks ||= self.class.send(:callbacks)
     end
-    
+
     def filtered_entities
       @domain.entities.reject { |entity|
+        options.exclude && entity.model && [options.exclude].flatten.include?(entity.name.to_sym) or
+        options.only && entity.model && ![options.only].flatten.include?(entity.name.to_sym) or
         !options.inheritance && entity.specialized? or
         !options.polymorphism && entity.generalized? or
         !options.disconnected && entity.disconnected?
@@ -157,20 +159,20 @@ module RailsERD
         raise "No entities found; create your models first!" if entities.empty?
       end
     end
-    
+
     def filtered_relationships
       @domain.relationships.reject { |relationship|
         !options.indirect && relationship.indirect?
       }
     end
-    
+
     def filtered_specializations
       @domain.specializations.reject { |specialization|
         !options.inheritance && specialization.inheritance? or
         !options.polymorphism && specialization.polymorphic?
       }
     end
-    
+
     def filtered_attributes(entity)
       entity.attributes.reject { |attribute|
         # Select attributes that satisfy the conditions in the :attributes option.
@@ -178,7 +180,7 @@ module RailsERD
         [*options.attributes].none? { |type| attribute.send(:"#{type.to_s.chomp('s')}?") }
       }
     end
-    
+
     def warn(message)
       puts "Warning: #{message}" if options.warn
     end