railroady 1.0.2 → 1.0.3

data/README.rdoc

@@ -9,10 +9,19 @@ I (Preston Lee) am not trying to hijack Peter Hoeg or Javier's project, but rath
 = System Requirements
 
 You MUST have the the following utilities available at the command line.
-  * `dot` and `neato`. MacPorts users can install in via `sudo port install graphviz`.
+  * `dot` and `neato`.
 
   * `sed`, which should already be available on all sane UNIX systems.
 
+= Mac users
+
+MacPorts users can install in via `sudo port install graphviz`.
+Brew user can install via `brew install graphviz`.
+
+= Ubuntu users
+
+Ubuntu users can install in via `sudo apt-get install graphviz`.
+
 = Usage
 
 The easiest (and recommend) usage is to include railroady as a development dependency with your Rails 3 Gemfile, like so...
@@ -52,6 +61,8 @@ Common options:
 Models diagram options:
     -a, --all                        Include all models
                                        (not only ActiveRecord::Base derived)
+        --all-columns                Show all columns 
+                                       (not just content columns)
         --hide-magic                 Hide magic field names
         --hide-types                 Hide attributes type
     -j, --join                       Concentrate edges

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 1
 :minor: 0
-:patch: 2
+:patch: 3
 :build: 

data/lib/railroady/models_diagram.rb

@@ -54,9 +54,12 @@ class ModelsDiagram < AppDiagram
       else 
         node_type = 'model'
 
-        # Collect model's content columns
-
-        content_columns = current_class.content_columns
+        # Collect model's content columns or all columns if all_columns flag is passed
+        if @options.all_columns
+          columns = current_class.columns
+        else
+          columns = current_class.content_columns
+        end
 	
         if @options.hide_magic 
           # From patch #13351
@@ -67,17 +70,16 @@ class ModelsDiagram < AppDiagram
           "rgt", "quote", "template"
           ]
           magic_fields << current_class.table_name + "_count" if current_class.respond_to? 'table_name' 
-          content_columns = current_class.content_columns.select {|c| ! magic_fields.include? c.name}
-        else
-          content_columns = current_class.content_columns
+          columns = current_class.content_columns.select {|c| ! magic_fields.include? c.name}
         end
-        
-        content_columns.each do |a|
-          content_column = a.name
-          content_column += ' :' + a.type.to_s unless @options.hide_types
-          node_attribs << content_column
+
+        columns.each do |a|
+          column = a.name
+          column += ' :' + a.type.to_s unless @options.hide_types
+          node_attribs << column
         end
       end
+
       @graph.add_node [node_type, current_class.name, node_attribs]
       generated = true
       # Process class associations
@@ -122,7 +124,7 @@ class ModelsDiagram < AppDiagram
     
     # from patch #12384
     # if assoc.class_name == assoc.name.to_s.singularize.camelize
-    assoc_class_name = (assoc.class_name.respond_to? 'underscore') ? assoc.class_name.underscore.singularize.camelize : assoc.class_name 
+    assoc_class_name = (assoc.class_name.respond_to? 'underscore') ? assoc.class_name.underscore.camelize : assoc.class_name
     if assoc_class_name == assoc.name.to_s.singularize.camelize
       assoc_name = ''
     else

data/lib/railroady/options_struct.rb

@@ -20,6 +20,7 @@ class OptionsStruct < OpenStruct
                      :join => false,
                      :label => false,
                      :modules => false,
+                     :all_columns => false,
                      :hide_magic => false,
                      :hide_types => false,
                      :hide_public => false,
@@ -81,6 +82,9 @@ class OptionsStruct < OpenStruct
       opts.on("--show-belongs_to", "Show belongs_to associations") do |s|
         self.show_belongs_to = s
       end
+      opts.on("--all-columns", "Show all columns (not just content columns)") do |h|
+        self.all_columns = h
+      end
       opts.on("--hide-magic", "Hide magic field names") do |h|
         self.hide_magic = h
       end

data/lib/railroady/version.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 module RailRoady
   module VERSION #:nodoc:
-	f = File.join(File.dirname(__FILE__), '..', '..', 'VERSION.yml')
+    f = File.join(File.dirname(__FILE__), '..', '..', 'VERSION.yml')
     if File.exist?(f)
       config = YAML.load(File.read(f))
       MAJOR = config[:major]

data/tasks/railroady.rake

@@ -6,57 +6,61 @@
 # * The `sed` command-line utility, which should already be available on all sane UNIX systems.
 #
 # Author: Preston Lee, http://railroady.prestonlee.com 
- 
+
 # Returns an absolute path for the following file.
+def format
+  @@DIAGRAM_FORMAT ||= 'SVG'
+end
+
 def full_path(name = 'test.txt')
   f = File.join(Rails.root.to_s.gsub(' ', '\ '), 'doc', name)
   f.to_s
 end
-  
+
 namespace :diagram do
- 
-  @MODELS_ALL_SVG = full_path('models_complete.svg').freeze
-  @MODELS_BRIEF_SVG = full_path('models_brief.svg').freeze
-  @CONTROLLERS_ALL_SVG = full_path('controllers_complete.svg').freeze
-  @CONTROLLERS_BRIEF_SVG = full_path('controllers_brief.svg').freeze
- 
+
+  @MODELS_ALL = full_path("models_complete.#{format}").freeze
+  @MODELS_BRIEF = full_path("models_brief.#{format}").freeze
+  @CONTROLLERS_ALL = full_path("controllers_complete.#{format}").freeze
+  @CONTROLLERS_BRIEF = full_path("controllers_brief.#{format}").freeze
+
   namespace :models do
- 
-    desc 'Generates an SVG class diagram for all models.'
+
+    desc 'Generates an class diagram for all models.'
     task :complete do
-      f = @MODELS_ALL_SVG
+      f = @MODELS_ALL
       puts "Generating #{f}"
-      sh "railroady -ilamM | dot -Tsvg > #{f}"
+      sh "railroady -ilamM | dot -T#{format} > #{f}"
     end
- 
-    desc 'Generates an abbreviated SVG class diagram for all models.'
+
+    desc 'Generates an abbreviated class diagram for all models.'
     task :brief do
-      f = @MODELS_BRIEF_SVG
+      f = @MODELS_BRIEF
       puts "Generating #{f}"
-      sh "railroady -bilamM | dot -Tsvg > #{f}"
+      sh "railroady -bilamM | dot -T#{format} > #{f}"
     end
-    
+
   end
-  
+
   namespace :controllers do
- 
-    desc 'Generates an SVG class diagram for all controllers.'
+
+    desc 'Generates an class diagram for all controllers.'
     task :complete do
-      f = @CONTROLLERS_ALL_SVG
+      f = @CONTROLLERS_ALL
       puts "Generating #{f}"
-      sh "railroady -ilC | neato -Tsvg > #{f}"
+      sh "railroady -ilC | neato -T#{format} > #{f}"
     end
- 
-    desc 'Generates an abbreviated SVG class diagram for all controllers.'
+
+    desc 'Generates an abbreviated class diagram for all controllers.'
     task :brief do
-      f = @CONTROLLERS_BRIEF_SVG
+      f = @CONTROLLERS_BRIEF
       puts "Generating #{f}"
-      sh "railroady -bilC | neato -Tsvg > #{f}"
+      sh "railroady -bilC | neato -T#{format} > #{f}"
     end
- 
+
   end
- 
-  desc 'Generates all SVG class diagrams.'
+
+  desc 'Generates all class diagrams.'
   task :all => ['diagram:models:complete', 'diagram:models:brief', 'diagram:controllers:complete', 'diagram:controllers:brief']
- 
-end
+
+end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: railroady
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.2
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Preston Lee
@@ -13,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 -07:00
+date: 2011-12-28 00:00:00 +05:30
 default_executable: railroady
 dependencies: []
 
@@ -66,17 +71,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby on Rails 3 model and controller UML class diagram generator.