rails-erd 0.2.0 → 0.3.0

data/.gitignore

@@ -1,5 +1,9 @@
+.DS_Store
+.bundle
+.yardoc
+*.pdf
+*.rbc
 doc
 pkg
 rdoc
-*.rbc
-.yardoc
+site/_generated

data/CHANGES.rdoc

@@ -1,7 +1,21 @@
+=== 0.3.0:
+
+* Added the ability to support multiple styles of cardinality notations.
+  Currently supported types are 'simple' and 'advanced'.
+* Added option to exclude indirect relationships (indirect=false).
+* Added option to change or disable the diagram title (title='Custom title').
+* Altered the type descriptions of attributes.
+* Renamed options for flexibility and clarity.
+* Improved internal logic to determine the cardinality of relationships.
+* More versatile API that allows you to inspect relationships and their
+  cardinalities.
+* Changed line widths to 1.0 to avoid invisible node boundaries with older
+  versions of Graphviz.
+* Bundled examples based on actual applications.
+
 === 0.2.0
 
-* Added simple way to create your own type of diagrams with a tiny amount of
-  code.
+* Added simple way to create your own type of diagrams with a tiny amount of code.
 * Improved internal API and documentation.
 * Subtle changes in diagram style.
 * Fixed error where non-mutual relationships might be inadvertently classified

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "rails-erd", :path => "."
+gem "activesupport", :require => false
+gem "activerecord", :require => "active_record"
+gem "rake"
+gem "jeweler"
+
+platforms :ruby do
+  gem "sqlite3-ruby"
+end
+
+platforms :jruby do
+  gem "jdbc-sqlite3", :require => "jdbc/sqlite3"
+  gem "activerecord-jdbc-adapter", "1.0.0.beta2"
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rails-erd (0.2.0)
+      activerecord (~> 3.0.0)
+      activesupport (~> 3.0)
+      ruby-graphviz (~> 0.9.17)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activerecord-jdbc-adapter (1.0.0.beta2-java)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jdbc-sqlite3 (3.6.3.054)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    ruby-graphviz (0.9.17)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activerecord-jdbc-adapter (= 1.0.0.beta2)
+  activesupport
+  jdbc-sqlite3
+  jeweler
+  rails-erd!
+  rake
+  sqlite3-ruby

data/README.rdoc

@@ -1,213 +1,39 @@
 = Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
 
-Rails ERD is a Rails plugin that allows you to easily generate a diagram based
-on your ActiveRecord models. The diagram gives an overview of how your
-models are related. Having a diagram that describes your models is perfect
-documentation for your application.
+{Rails ERD}[http://rails-erd.rubyforge.org/] is a Rails plugin that allows
+you to easily generate a diagram based on your Active Record models. The
+diagram gives an overview of how your models are related. Having a diagram
+that describes your models is perfect documentation for your application.
 
 The second goal of Rails ERD is to provide you with a tool to inspect your
 application's domain model. If you don't like the default output, it is very
 easy to use the API to build your own diagrams.
 
-Rails ERD was created specifically for Rails 3. It uses ActiveRecord reflection
-to figure out how your models are associated. For older Rails applications,
-you may want to try Railroad[http://railroad.rubyforge.org/].
+Rails ERD was created specifically for Rails 3. It uses Active Record's
+built-in reflection capabilities to figure out how your models are associated.
 
-== Links
+== Preview
 
-Current documentation:
-http://rails-erd.rubyforge.org/doc/
-
-Source code at Github:
-http://github.com/voormedia/rails-erd
-
-Homepage:
-http://rails-erd.rubyforge.org/
-
-== Example output
-
-This is an example diagram from an actual Rails application.
+Here's an example entity-relationship diagram that was generated by Rails ERD:
 
 http://rails-erd.rubyforge.org/examples/event-forms.png
 
-{Download generated PDF}[http://rails-erd.rubyforge.org/examples/event-forms.pdf]
-
-Typo is a blogging application built in Rails. This is an excerpt from the
-diagram that was generated from the Rails 3 branch (which is currently still
-in development).
-
-http://rails-erd.rubyforge.org/examples/typo-blog.png
-
-{Download complete diagram as PDF}[http://rails-erd.rubyforge.org/examples/typo-blog.pdf]
-
-== Getting started
-
-In its most simple form, Rails ERD is a plugin for Rails 3 that provides you
-with a Rake task to create an Entity-Relationship Diagram. It depends on the
-Graphviz[http://www.graphviz.org/] visualisation library. In order to create
-PDF files (the default), you should install or compile Graphviz with support
-for Pango and Cairo.
-
-For example, to install Graphviz with Homebrew:
+== Learn more
 
-  % brew install cairo pango graphviz
-
-Or with MacPorts:
-
-  % sudo port install graphviz
-
-Next, install Rails ERD. Open your +Gemfile+, and add the following:
-
-  group :development do
-    gem 'rails-erd'
-  end
-
-Tell Bundler to install Rails ERD:
-
-  % bundle install
-
-You now have access to Rails ERD through Rake. Generate a new
-Entity-Relationship Diagram for your Rails application:
-
-  % rake erd
-
-All done! You will now have a file named <tt>ERD.pdf</tt> in your application root.
-
-== Customisation
+Homepage:
+http://rails-erd.rubyforge.org/
 
-Rails ERD has several options that you can use to customise its behaviour.
-All options can be provided on the command line. For example:
+Diagram gallery:
+http://rails-erd.rubyforge.org/gallery.html
 
-  % rake erd orientation=vertical exclude_timestamps=false
+Installation instructions:
+http://rails-erd.rubyforge.org/install.html
 
-exclude_foreign_keys:: Excludes foreign key columns from attribute lists.
-                       Defaults to +true+.
-exclude_primary_keys:: Excludes primary key columns from attribute lists.
-                       Defaults to +true+.
-exclude_timestamps:: Excludes timestamp columns (<tt>created_at/on</tt> and
-                     <tt>updated_at/on</tt>) from attribute lists. Defaults
-                     to +true+.
-exclude_unconnected:: Excludes entities that are not connected to other
-                      entities from the diagram. Defaults to +true+.
-file_type:: The file type of the generated diagram. Defaults to +pdf+, which
-            is the recommended format. Other formats may render significantly
-            worse than a PDF file. The available formats depend on your installation
-            of Graphviz.
-orientation:: The direction of the hierarchy of entities. Either +horizontal+
-              or +vertical+. Defaults to +horizontal+. The orientation of the
-              PDF that is generated depends on the amount of hierarchy
-              in your models.
-suppress_warnings:: When set to +true+, no warnings are printed to the
-                    command line while processing the domain model. Defaults
-                    to +false+.
-
-== Custom diagrams
-
-If you're completely unsatisfied with the diagrams that Rails ERD creates,
-you can still use it to create your own diagrams. It provides you with an easy
-way to create any kind of diagram based on your application's domain model.
-
-As an example, a diagram class that generates code that can be used with
-yUML (http://yuml.me) can be as simple as:
-
-  require "rails_erd/diagram"
-
-  class YumlDiagram < RailsERD::Diagram
-    def process_relationship(rel)
-      return if rel.indirect?
-
-      arrow = case
-      when rel.cardinality.one_to_one?   then "1-1>"
-      when rel.cardinality.one_to_many?  then "1-*>"
-      when rel.cardinality.many_to_many? then "*-*>"
-      end
-
-      instructions << "[#{rel.source}] #{arrow} [#{rel.destination}]"
-    end
-
-    def save
-      instructions * "\n"
-    end
-
-    def instructions
-      @instructions ||= []
-    end
-  end
-
-Only 18 lines of code! Then, to generate the diagram (example based on the
-domain model of Gemcutter):
-
-  YumlDiagram.create
-  #=> "[Rubygem] 1-*> [Ownership]
-  #    [Rubygem] 1-*> [Subscription]
-  #    [Rubygem] 1-*> [Version]
-  #    [Rubygem] 1-1> [Linkset]
-  #    [Rubygem] 1-*> [Dependency]
-  #    [Version] 1-*> [Dependency]
-  #    [User] 1-*> [Ownership]
-  #    [User] 1-*> [Subscription]
-  #    [User] 1-*> [WebHook]"
-
-{See what that would look like}[http://yuml.me/diagram/scruffy/class/%5BRubygem%5D%201-*%3E%20%5BOwnership%5D,%20%5BRubygem%5D%201-*%3E%20%5BSubscription%5D,%20%5BRubygem%5D%201-*%3E%20%5BVersion%5D,%20%5BRubygem%5D%201-1%3E%20%5BLinkset%5D,%20%5BRubygem%5D%201-*%3E%20%5BDependency%5D,%20%5BVersion%5D%201-*%3E%20%5BDependency%5D,%20%5BUser%5D%201-*%3E%20%5BOwnership%5D,%20%5BUser%5D%201-*%3E%20%5BSubscription%5D,%20%5BUser%5D%201-*%3E%20%5BWebHook%5D].
-
-== Internal API
-
-Rails ERD also allows you to use its internal API to inspect your Rails domain
-model. It is easy to generate alternative presentations of your Active Record
-models this way. If used outside of Rails, install Rails ERD as a gem:
-
-  % gem install rails-erd
-
-Suppose we have the following models:
-
-  class User < ActiveRecord::Base
-    has_many :posts
-    has_many :comments
-  end
-  
-  class Post < ActiveRecord::Base
-    belongs_to :user
-    has_many :comments
-  end
-  
-  class Comment < ActiveRecord::Base
-    belongs_to :user
-    belongs_to :post
-  end
-
-Then you can inspect your domain model like this:
-
-  require "rails_erd/domain"
-
-  domain = RailsERD::Domain.generate
-  domain.entities
-  #=> [ #<RailsERD::Entity @model=Comment>,
-  #     #<RailsERD::Entity @model=Post>,
-  #     #<RailsERD::Entity @model=User> ]
-  
-  domain.entities.first.connected?
-  #=> true
-  
-  domain.relationships
-  #=> [ #<RailsERD::Relationship @source=Post @destination=Comment>,
-  #     #<RailsERD::Relationship @source=User @destination=Comment>,
-  #     #<RailsERD::Relationship @source=User @destination=Post> ]
-  
-  domain.relationships.first.destination
-  #=> Comment
-  
-  domain.relationships.first.mutual?
-  #=> true
-  
-  domain.relationships.first.cardinality
-  #=> RailsERD::Relationship::Cardinality::OneToMany
-
-The above is just a sample of what is possible. See the API documentation for
-more details:
+Internal API documentation:
 http://rails-erd.rubyforge.org/doc/
 
-Please note that before the 1.0 release, the API may change subtly between
-minor versions.
+Source code at Github:
+http://github.com/voormedia/rails-erd
 
 == About Rails ERD
 

data/Rakefile

@@ -13,9 +13,14 @@ Jeweler::Tasks.new do |spec|
   spec.homepage = "http://rails-erd.rubyforge.org/"
 
   spec.add_runtime_dependency "activerecord", "~> 3.0.0"
-  spec.add_runtime_dependency "activesupport", "~> 3.0.0"
+  spec.add_runtime_dependency "activesupport", "~> 3.0"
   spec.add_runtime_dependency "ruby-graphviz", "~> 0.9.17"
   spec.add_development_dependency "sqlite3-ruby"
+  
+  # Don't bundle examples or website in gem.
+  excluded = Dir["{examples,site}/**/*"]
+  spec.files -= excluded
+  spec.test_files -= excluded
 end
 
 Jeweler::GemcutterTasks.new
@@ -40,3 +45,55 @@ begin
   end
 rescue LoadError
 end
+
+desc "Generate diagrams for bundled examples"
+task :examples do
+  require "rubygems"
+  require "bundler"
+  Bundler.require
+  require "rails_erd/diagram/graphviz"
+
+  Dir["examples/*/*"].each do |path|
+    name = File.basename(path)
+    print "==> Generating ERD for #{name.capitalize}... "
+    begin
+      # Load database schema.
+      ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+      ActiveRecord::Migration.suppress_messages do
+        begin
+          require File.expand_path("#{path}/schema.rb", File.dirname(__FILE__))
+        rescue LoadError
+        end
+      end
+      
+      # Load domain models for this example.
+      Dir["#{path}/**/*.rb"].each do |model|
+        require File.expand_path(model, File.dirname(__FILE__))
+      end
+      
+      # Skip empty domain models.
+      next if ActiveRecord::Base.descendants.empty?
+
+      puts "#{ActiveRecord::Base.descendants.length} models"
+      [:simple, :advanced].each do |notation|
+        filename = File.expand_path("examples/#{name}#{notation != :simple ? "-#{notation}" : ""}", File.dirname(__FILE__))
+
+        default_options = { :notation => notation, :filename => filename, :attributes => [:regular],
+          :title => name.classify + " domain model" }
+
+        specific_options = eval((File.read("#{path}/options.rb") rescue "")) || {}
+
+        # Generate ERD.
+        RailsERD::Diagram::Graphviz.create(default_options.merge(specific_options))
+      end
+    ensure
+      # Completely remove all loaded Active Record models.
+      ActiveRecord::Base.descendants.each do |model|
+        Object.send :remove_const, model.name.to_sym rescue nil
+      end
+      ActiveRecord::Base.direct_descendants.clear
+      Arel::Relation.send :class_variable_set, :@@connection_tables_primary_keys, {}
+      ActiveSupport::Dependencies::Reference.clear!
+    end
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/rails_erd.rb

@@ -2,39 +2,19 @@ require "active_support/ordered_options"
 require "rails_erd/railtie" if defined? Rails
 
 # Rails ERD provides several options that allow you to customise the
-# generation of the diagram and the domain model itself. Currently, the
-# following options are supported:
-#
-# exclude_foreign_keys:: Excludes foreign key columns from attribute lists.
-#                        Defaults to +true+.
-# exclude_primary_keys:: Excludes primary key columns from attribute lists.
-#                        Defaults to +true+.
-# exclude_timestamps:: Excludes timestamp columns (<tt>created_at/on</tt> and
-#                      <tt>updated_at/on</tt>) from attribute lists. Defaults
-#                      to +true+.
-# exclude_unconnected:: Excludes entities that are not connected to other
-#                       entities from the diagram. Defaults to +true+.
-# file_type:: The file type of the generated diagram. Defaults to +:pdf+, which
-#             is the recommended format. Other formats may render significantly
-#             worse than a PDF file.
-# orientation:: The direction of the hierarchy of entities. Either +:horizontal+
-#               or +:vertical+. Defaults to +:horizontal+. The orientation of the
-#               PDF that is generated depends on the amount of hierarchy
-#               in your models.
-# suppress_warnings:: When set to +true+, no warnings are printed to the
-#                     command line while processing the domain model. Defaults
-#                     to +false+.
+# generation of the diagram and the domain model itself. For an overview of
+# all options available in Rails ERD, see README.rdoc.
 #
 # You can specify the option on the command line if you use Rails ERD with
 # Rake:
 #
-#   % rake erd orientation=vertical exclude_timestamps=false
+#   % rake erd orientation=vertical title='My model diagram'
 #
 # When using Rails ERD from within Ruby, you can set the options on the
 # RailsERD namespace module:
 #
 #   RailsERD.options.orientation = :vertical
-#   RailsERD.options.exclude_timestamps = false
+#   RailsERD.options.title = "My model diagram"
 module RailsERD
   class << self
     # Access to default options. Any instance of RailsERD::Domain and
@@ -43,12 +23,14 @@ module RailsERD
   end
 
   self.options = ActiveSupport::OrderedOptions[
-    :exclude_foreign_keys, true,
-    :exclude_primary_keys, true,
-    :exclude_timestamps, true,
-    :exclude_unconnected, true,
-    :file_type, :pdf,
+    :attributes, :regular,
+    :disconnected, true,
+    :filename, "ERD",
+    :filetype, :pdf,
+    :indirect, true,
+    :notation, :simple,
     :orientation, :horizontal,
-    :suppress_warnings, false
+    :warn, true,
+    :title, true
   ]
 end