rails-erd 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d99cbfb786b715088ed547c22acac6150d65109
+  data.tar.gz: 6b7631aea348df78d4d7a6add5c9b590c5c4f2fb
+SHA512:
+  metadata.gz: 912040089037e2eae86864507ee3efd5d1f51825b256e7464204ebaacb1bf5af0a89785f0f4948de093a2b5797bdd119fa3c4a9fcc1e7ce158713179f12c2140
+  data.tar.gz: adf9512f873f3b19632a0e1cf165e764395cda87b03f6fcb1654a58c1d925bc26dd6eae3050450be4d855a948c438a47d2ee5f1eec0497e4c727dab163cd0534

data/README.md

@@ -1,17 +1,11 @@
 Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
 ========================================================================
 
-[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.
+[Rails ERD](http://voormedia.github.io/rails-erd/) 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.
+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 Active Record's
-built-in reflection capabilities to figure out how your models are associated.
+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.
 
 
 Preview
@@ -19,31 +13,53 @@ Preview
 
 Here's an example entity-relationship diagram that was generated by Rails ERD:
 
-![Entity-Relationship Diagram](http://rails-erd.rubyforge.org/images/entity-relationship-diagram.png)
+![Entity-Relationship Diagram](http://voormedia.github.io/rails-erd/images/entity-relationship-diagram.png)
 
-Browse the [gallery](http://rails-erd.rubyforge.org/gallery.html) for more
-example diagrams.
+Browse the [gallery](http://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.
 
 
 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:
+See the [installation instructions](http://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:
 
-* Install Graphviz 2.22+ ([how?](http://rails-erd.rubyforge.org/install.html))
+* Install Graphviz 2.22+ ([how?](http://voormedia.github.io/rails-erd/install.html))
 
 * Add <tt>gem "rails-erd"</tt> to your application's Gemfile
 
 * Run <tt>bundle exec erd</tt>
 
+### Configuration
+
+Rails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found):
+
+```
+attributes:
+  - content
+  - foreign_key
+  - inheritance
+disconnected: true
+filename: erd
+filetype: pdf
+indirect: true
+inheritance: false
+markup: true
+notation: simple
+orientation: horizontal
+polymorphism: false
+warn: true
+title: sample title
+exclude: null
+only: 
+```
+
 
 Learn more
 ----------
 
-More information can be found on [Rails ERD's project homepage](http://rails-erd.rubyforge.org/).
+More information can be found on [Rails ERD's project homepage](http://voormedia.github.io/rails-erd/).
 
-If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rails-erd.rubyforge.org/doc/).
+If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rubydoc.info/github/voormedia/rails-erd/frames).
 
 
 About Rails ERD
@@ -51,7 +67,7 @@ About Rails ERD
 
 Rails ERD was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
 
-Copyright 2010-2013 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+Copyright 2010-2014 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
 
 
 License

data/lib/rails_erd.rb

@@ -1,5 +1,6 @@
 require "active_support/ordered_options"
 require "rails_erd/railtie" if defined? Rails
+require "rails_erd/config"
 
 # Welcome to the API documentation of Rails ERD. If you wish to extend or
 # customise the output that is generated by Rails ERD, you have come to the
@@ -32,6 +33,25 @@ module RailsERD
     # Access to default options. Any instance of RailsERD::Domain and
     # RailsERD::Diagram will use these options unless overridden.
     attr_accessor :options
+
+    def default_options
+      ActiveSupport::OrderedOptions[
+        :attributes, :content,
+        :disconnected, true,
+        :filename, "erd",
+        :filetype, :pdf,
+        :indirect, true,
+        :inheritance, false,
+        :markup, true,
+        :notation, :simple,
+        :orientation, :horizontal,
+        :polymorphism, false,
+        :warn, true,
+        :title, true,
+        :exclude, nil,
+        :only, nil
+      ]
+    end
   end
 
   module Inspectable # @private :nodoc:
@@ -47,20 +67,5 @@ module RailsERD
     end
   end
 
-  self.options = ActiveSupport::OrderedOptions[
-    :attributes, :content,
-    :disconnected, true,
-    :filename, "erd",
-    :filetype, :pdf,
-    :indirect, true,
-    :inheritance, false,
-    :markup, true,
-    :notation, :simple,
-    :orientation, :horizontal,
-    :polymorphism, false,
-    :warn, true,
-    :title, true,
-    :exclude, nil,
-    :only, nil
-  ]
+  self.options = default_options.merge(Config.load)
 end

data/lib/rails_erd/config.rb

@@ -0,0 +1,92 @@
+module RailsERD
+  class Config
+    USER_WIDE_CONFIG_FILE = File.expand_path(".erdconfig", ENV["HOME"])
+    CURRENT_CONFIG_FILE   = File.expand_path(".erdconfig", Dir.pwd)
+
+    attr_reader :options
+
+    def self.load
+      new.load
+    end
+
+    def initialize
+      @options = {}
+    end
+
+    def load
+      load_file(USER_WIDE_CONFIG_FILE)
+      load_file(CURRENT_CONFIG_FILE)
+
+      @options
+    end
+
+    def self.font_names_based_on_os
+      if use_os_x_fonts?
+        { normal: "ArialMT",
+          bold:   "Arial BoldMT",
+          italic: "Arail ItalicMT" }
+      else
+        { normal: "Arial",
+          bold:   "Arial Bold",
+          italic: "Arail Italic" }
+      end
+    end
+
+    private
+
+    def load_file(path)
+      if File.exists?(path)
+        YAML.load_file(path).each do |key, value|
+          key = key.to_sym
+          @options[key] = normalize_value(key, value)
+        end
+      end
+    end
+
+    def normalize_value(key, value)
+      case key
+      # <symbol>[,<symbol>,...] | false
+      when :attributes
+        if value == false
+          return value
+        else
+          # Comma separated string and strings in array are OK.
+          Array(value).join(",").split(",").map { |v| v.strip.to_sym }
+        end
+
+      # <symbol>
+      when :filetype, :notation, :orientation
+        value.to_sym
+
+      # true | false
+      when :disconnected, :indirect, :inheritance, :markup, :polymorphism, :warn
+        !!value
+
+      # nil | <string>
+      when :filename, :only, :exclude
+        value.nil? ? nil : value.to_s
+
+      # true | false | <string>
+      when :title
+        value.is_a?(String) ? value : !!value
+
+      else
+        value
+      end
+    end
+
+    def self.use_os_x_fonts?
+      host = RbConfig::CONFIG['host_os']
+
+      if host.include? "darwin"
+        darwin_version_array = host.split("darwin").last.split(".").map(&:to_i)
+
+        if darwin_version_array[0] == 12 and darwin_version_array[1] >= 5
+          return true
+        end
+      end
+
+      false
+    end
+  end
+end

data/lib/rails_erd/diagram/graphviz.rb

@@ -47,6 +47,8 @@ module RailsERD
 
       NODE_WIDTH = 130 # @private :nodoc:
 
+      FONTS = Config.font_names_based_on_os
+
       # Default graph attributes.
       GRAPH_ATTRIBUTES = {
         :rankdir => :LR,
@@ -57,21 +59,21 @@ module RailsERD
         :concentrate => true,
         :labelloc => :t,
         :fontsize => 13,
-        :fontname => "Arial Bold"
+        :fontname => FONTS[:bold]
       }
 
       # Default node attributes.
       NODE_ATTRIBUTES = {
         :shape => "Mrecord",
         :fontsize => 10,
-        :fontname => "Arial",
+        :fontname => FONTS[:normal],
         :margin => "0.07,0.05",
         :penwidth => 1.0
       }
 
       # Default edge attributes.
       EDGE_ATTRIBUTES = {
-        :fontname => "Arial",
+        :fontname => FONTS[:normal],
         :fontsize => 8,
         :dir => :both,
         :arrowsize => 0.9,

data/lib/rails_erd/diagram/templates/node.html.erb

@@ -1,14 +1,14 @@
 <% if options.orientation == :vertical %>{<% end %>
 <table border="0" align="center" cellspacing="0.5" cellpadding="0" width="<%= NODE_WIDTH + 4 %>">
-  <tr><td align="center" valign="bottom" width="<%= NODE_WIDTH %>"><font face="Arial Bold" point-size="11"><%= entity.name %></font></td></tr>
+  <tr><td align="center" valign="bottom" width="<%= NODE_WIDTH %>"><font face="<%= FONTS[:bold] %>" point-size="11"><%= entity.name %></font></td></tr>
 </table>
 <% if attributes.any? %>
 |
 <table border="0" align="left" cellspacing="2" cellpadding="0" width="<%= NODE_WIDTH + 4 %>">
 <%   attributes.each do |attribute| %>
-  <tr><td align="left" width="<%= NODE_WIDTH %>" port="<%= attribute %>"><%= attribute %> <font face="Arial Italic" color="grey60"><%= attribute.type_description %></font></td></tr>
+  <tr><td align="left" width="<%= NODE_WIDTH %>" port="<%= attribute %>"><%= attribute %> <font face="<%= FONTS[:italic] %>" color="grey60"><%= attribute.type_description %></font></td></tr>
 <%   end %>
 </table>
 <% else %>
 <% end %>
-<% if options.orientation == :vertical %>}<% end %>
+<% if options.orientation == :vertical %>}<% end %>

data/lib/rails_erd/version.rb

@@ -1,4 +1,4 @@
 module RailsERD
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
   BANNER = "RailsERD #{VERSION}"
 end

data/test/support_files/erdconfig.another_example

@@ -0,0 +1,3 @@
+attributes:
+  - primary_key
+

data/test/support_files/erdconfig.example

@@ -0,0 +1,18 @@
+attributes:
+  - content
+  - foreign_key
+  - inheritance
+disconnected: true
+filename: erd
+filetype: pdf
+indirect: true
+inheritance: false
+markup: true
+notation: simple
+orientation: horizontal
+polymorphism: false
+warn: true
+title: sample title
+exclude: null
+only: 
+

data/test/test_helper.rb

@@ -10,6 +10,7 @@ ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":me
 class ActiveSupport::TestCase
   include RailsERD
 
+  setup    :reset_config_file
   teardown :reset_domain
 
   def create_table(table, columns = {}, pk = nil)
@@ -118,6 +119,16 @@ class ActiveSupport::TestCase
 
   private
 
+  def reset_config_file
+    RailsERD::Config.send :remove_const, :USER_WIDE_CONFIG_FILE
+    RailsERD::Config.send :const_set, :USER_WIDE_CONFIG_FILE,
+      File.expand_path("../../examples/erdconfig.not_exists", __FILE__)
+
+    RailsERD::Config.send :remove_const, :CURRENT_CONFIG_FILE
+    RailsERD::Config.send :const_set, :CURRENT_CONFIG_FILE,
+      File.expand_path("../../examples/erdconfig.not_exists", __FILE__)
+  end
+
   def reset_domain
     if defined? ActiveRecord
       ActiveRecord::Base.descendants.each do |model|

data/test/unit/config_test.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+
+class ConfigTest < ActiveSupport::TestCase
+
+  test "load_config_gile should return blank hash when neither CURRENT_CONFIG_FILE nor USER_WIDE_CONFIG_FILE exist." do
+    expected_hash = {}
+    assert_equal expected_hash, RailsERD::Config.load
+  end
+
+  test "load_config_gile should return a hash from USER_WIDE_CONFIG_FILE when only USER_WIDE_CONFIG_FILE exists." do
+    set_user_config_file_to("erdconfig.example")
+
+    expected_hash = {
+      attributes:   [:content, :foreign_key, :inheritance],
+      disconnected: true,
+      filename:     "erd",
+      filetype:     :pdf,
+      indirect:     true,
+      inheritance:  false,
+      markup:       true,
+      notation:     :simple,
+      orientation:  :horizontal,
+      polymorphism: false,
+      warn:         true,
+      title:        "sample title",
+      exclude:      nil,
+      only:         nil
+    }
+    assert_equal expected_hash, RailsERD::Config.load
+  end
+
+  test "load_config_gile should return a hash from CURRENT_CONFIG_FILE when only CURRENT_CONFIG_FILE exists." do
+    set_local_config_file_to("erdconfig.another_example")
+
+    expected_hash = {
+      :attributes => [:primary_key]
+    }
+    assert_equal expected_hash, RailsERD::Config.load
+  end
+
+  test "load_config_gile should return a hash from CURRENT_CONFIG_FILE overriding USER_WIDE_CONFIG_FILE when both of them exist." do
+    set_user_config_file_to("erdconfig.example")
+    set_local_config_file_to("erdconfig.another_example")
+
+    expected_hash = {
+      attributes:   [:primary_key],
+      disconnected: true,
+      filename:     "erd",
+      filetype:     :pdf,
+      indirect:     true,
+      inheritance:  false,
+      markup:       true,
+      notation:     :simple,
+      orientation:  :horizontal,
+      polymorphism: false,
+      warn:         true,
+      title:        "sample title",
+      exclude:      nil,
+      only:         nil
+    }
+    assert_equal expected_hash, RailsERD::Config.load
+  end
+
+  test "normalize_value should return symbols in an array when key is :attributes and value is a comma-joined string." do
+    assert_equal [:content, :foreign_keys], normalize_value(:attributes, "content,foreign_keys")
+  end
+
+  test "normalize_value should return symbols in an array when key is :attributes and value is strings in an array." do
+    assert_equal [:content, :primary_keys], normalize_value(:attributes, ["content", "primary_keys"])
+  end
+
+  def normalize_value(key, value)
+    RailsERD::Config.new.send(:normalize_value, key, value)
+  end
+
+  def set_user_config_file_to(config_file)
+    RailsERD::Config.send :remove_const, :USER_WIDE_CONFIG_FILE
+    RailsERD::Config.send :const_set, :USER_WIDE_CONFIG_FILE,
+      File.expand_path("test/support_files/#{config_file}")
+  end
+
+  def set_local_config_file_to(config_file)
+    RailsERD::Config.send :remove_const, :CURRENT_CONFIG_FILE
+    RailsERD::Config.send :const_set, :CURRENT_CONFIG_FILE,
+      File.expand_path("test/support_files/#{config_file}")
+  end
+end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Rolf Timmermans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-17 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: choice
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.6
 description: Automatically generate an entity-relationship diagram (ERD) for your
@@ -91,6 +82,7 @@ files:
 - lib/rails-erd.rb
 - lib/rails_erd.rb
 - lib/rails_erd/cli.rb
+- lib/rails_erd/config.rb
 - lib/rails_erd/diagram.rb
 - lib/rails_erd/diagram/graphviz.rb
 - lib/rails_erd/diagram/templates/node.html.erb
@@ -104,9 +96,12 @@ files:
 - lib/rails_erd/railtie.rb
 - lib/rails_erd/tasks.rake
 - lib/rails_erd/version.rb
+- test/support_files/erdconfig.another_example
+- test/support_files/erdconfig.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb
+- test/unit/config_test.rb
 - test/unit/diagram_test.rb
 - test/unit/domain_test.rb
 - test/unit/entity_test.rb
@@ -114,40 +109,36 @@ files:
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
-homepage: http://rails-erd.rubyforge.org/
+homepage: https://github.com/voormedia/rails-erd
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1960804951299581689
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1960804951299581689
 requirements: []
 rubyforge_project: rails-erd
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files:
+- test/support_files/erdconfig.another_example
+- test/support_files/erdconfig.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb
+- test/unit/config_test.rb
 - test/unit/diagram_test.rb
 - test/unit/domain_test.rb
 - test/unit/entity_test.rb