railroady 1.1.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04e3747c5c99a23bc76daeb07ba2afee3688a470
-  data.tar.gz: df60108b7a16afdf595baa3ee61464130776f013
+SHA256:
+  metadata.gz: e60172ea20b64daead4e5a040e50c92e411a0ea0824d4bb6836978d16ce7cf82
+  data.tar.gz: d1fb29719573215458dfb3cacf01d0d96a5b98a479accd0688ddd4cab231f5ca
 SHA512:
-  metadata.gz: 4e91ce3076f9d0a7a326d50052d50b761340786f581f02a1516b36ac6139a3f443fe7fd1b1bda72455a717103e8f6b7d820c356c0fc0def5d66ca29c70102d2e
-  data.tar.gz: b4debced96a4b045aaaf19ccbaba2dcb33effe84a5233c502962d3d4c775535c480d17f9ea4e518bbbd849f9c1e5cc2115ab328c96fbbebceab274d8696faede
+  metadata.gz: 458f52b7f8f07b1abae06ee141a4a098f67e8882b1087383d4cfee6d642d2f766cb2937037ee39e87a1c68aadce9321c9c208470423fa8982d17b8bbd0a15f48
+  data.tar.gz: 9d8e33334f7727d5f7049446416328f91f2221d3d8ee261300e44c7507174b4610bab7c447d3511c773bc962dcc73661711493a069a2132bbbd67e06783417f0

data/.gitignore

@@ -1,3 +1,4 @@
+.idea
 *.sw?
 .DS_Store
 coverage

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 3.0.2

data/AUTHORS.rdoc

@@ -16,6 +16,6 @@ http://railroady.prestonlee.com
 * Tim Harvey
 * Atli Christiansen
 * John Bintz (http://www.coswellproductions.com/)
-
+* Stefan Wrobel
 
 And of course, many thanks to the many patch submitters and testers that make this possible!

data/Gemfile

@@ -1,3 +1,4 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,34 +1,35 @@
 PATH
   remote: .
   specs:
-    railroady (1.1.1)
+    railroady (1.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.10)
-    i18n (0.6.4)
-    minitest (4.7.5)
-    minitest-spec-context (0.0.3)
-    multi_json (1.7.7)
-    rake (10.1.0)
-    thread_safe (0.1.2)
-      atomic
-    tzinfo (0.3.37)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   activesupport
   bundler
   minitest
-  minitest-spec-context
   railroady!
   rake
+
+BUNDLED WITH
+   2.2.22

data/Guardfile

@@ -0,0 +1,49 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  # watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  watch(%r{^test/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "test/#{m[1]}_spec.rb" }
+  watch(%r{^test/spec_helper\.rb$}) { 'test' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+end

data/README.md

@@ -0,0 +1,221 @@
+# RailRoady
+
+[![Build Status](https://travis-ci.org/preston/railroady.svg?branch=master)](https://travis-ci.org/preston/railroady)
+
+RailRoady generates Rails 3/4/5 model (ActiveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
+
+Code is based on the original "railroad" gem, patched and maintained over the years. Lineage can be traced via GitHub.
+
+I (Preston Lee) am not trying to hijack Peter Hoeg or Javier's project, but rather create a dedicated, lean gem that can be used without major issue on Rails projects. Rails v2 is not supported.
+
+# System Requirements
+
+You MUST have the the following utilities available at the command line.
+  * `dot` and `neato`.
+
+  * `sed`, which should already be available on all sane UNIX systems.
+
+## Mac users
+
+Brew users can install via:
+
+    brew install graphviz
+
+MacPorts users can install in via
+
+    sudo port 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...
+
+    group :development, :test do
+        gem 'railroady'
+    end
+
+...and then run the master rake task...
+
+    rake diagram:all
+
+This should generate four doc/\*.svg files that can be opened in (most) web browsers as well as dedicated document viewers supporting the Scalable Vector Graphics format.
+
+## Support for Engines
+
+Generate diagram for models and controllers including those in the engines.
+
+    rake diagram:all_with_engines
+
+## Alternate Usage
+
+Alternatively, you may run the 'railroady' command-line program at the Rails application's root directory. You can redirect its output to a .dot file or pipe it to the dot or neato utilities to produce a graphic. Model diagrams are intended to be processed using dot and controller diagrams are best processed using neato.
+
+    railroady [options] command
+
+## Options
+
+  	Common options:
+      	-b, --brief                      Generate compact diagram
+                                         (no attributes nor methods)
+      	-s, --specify file1[,fileN]      Specify only given files
+      	-e, --exclude file1[,fileN]      Exclude given files
+      	-i, --inheritance                Include inheritance relations
+      	-l, --label                      Add a label with diagram information
+                                         (type, date, migration, version)
+      	-o, --output FILE                Write diagram to file FILE
+      	-r, --root PATH                  Set PATH as the application root
+      	-v, --verbose                    Enable verbose output
+                                         (produce messages to STDOUT)
+      	-x, --xmi                        Produce XMI instead of DOT
+                                         (for UML tools)
+        --alphabetize                Sort methods alphabetically
+
+  	Models diagram options:
+      	-a, --all                        Include all models
+                                         (not only ActiveRecord::Base derived)
+          	--show-belongs_to            Show belongs_to associations
+          	--hide-through               Hide through associations
+          	--all-columns                Show all columns (not just content columns)
+          	--hide-magic                 Hide magic field names
+          	--hide-types                 Hide attributes type
+      	-j, --join                       Concentrate edges
+      	-m, --modules                    Include modules
+      	-p, --plugins-models             Include plugins models
+      	-z, --engine-models              Include engine models
+          	--include-concerns           Include models in concerns subdirectory
+      	-t, --transitive                 Include transitive associations
+                                       	(through inheritance)
+
+  	Controllers diagram options:
+          	--hide-public                Hide public methods
+          	--hide-protected             Hide protected methods
+          	--hide-private               Hide private methods
+          	--engine-controllers         Include engine controllers
+
+  	Other options:
+      	-h, --help                       Show this message
+          	--version                    Show version and copyright
+
+      	-c, --config FILE                File to load environment (defaults to config/environment)
+
+## Commands
+
+You must supply one of these:
+
+    -M, --models                     Generate models diagram
+    -C, --controllers                Generate controllers diagram
+    -A, --aasm                       Generate "acts as state machine" diagram
+
+## Examples
+
+    railroady -o models.dot -M
+      Produces a models diagram to the file 'models.dot'
+    railroady -a -i -o full_models.dot -M
+      Models diagram with all classes showing inheritance relations
+    railroady -M | dot -Tsvg > models.svg
+      Model diagram in SVG format
+    railroady -C | neato -Tpng > controllers.png
+      Controller diagram in PNG format
+    railroady -h
+      Shows usage help
+
+
+# Processing DOT files
+
+To produce a PNG image from model diagram generated by RailRoady you can
+issue the following command:
+
+    dot -Tpng models.dot > models.png
+
+If you want to do the same with a controller diagram, use neato instead of
+dot:
+
+    neato -Tpng controllers.dot > controllers.png
+
+If you want to produce SVG (vectorial, scalable, editable) files, you can do
+the following:
+
+    dot -Tsvg models.dot > models.svg
+    neato -Tsvg controllers.dot > controllers.svg
+
+Important: There is a bug in Graphviz tools when generating SVG files that
+cause a text overflow. You can solve this problem editing (with a text
+editor, not a graphical SVG editor) the file and replacing around line 12
+"font-size:14.00;" by "font-size:11.00;", or by issuing the following command
+(see "man sed"):
+
+    sed -i 's/font-size:14.00/font-size:11.00/g' file.svg
+
+Note: For viewing and editing SVG there is an excellent opensource tool
+called Inkscape (similar to Adobe Illustrator. For DOT processing you can
+also use Omnigraffle (on Mac OS X).
+
+= Rake Tasks
+
+As of Preston Lee's Rails 3/4/5 modifications, including RailRoady as a project development dependency will automatically add a set of rake tasks to your project. Sweet! (Run `rake -T` to check them out.)
+
+
+# Requirements
+
+RailRoady has been tested with the following Ruby and Rails versions
+
+## Ruby
+* 1.9.2+
+* 2.0.0+
+
+## Rails
+* 3.0.3+
+* 4.0.0+
+* 5.0.0+
+
+There are no additional requirements (nevertheless, all your Rails application
+requirements must be installed).
+
+In order to view/export the DOT diagrams, you'll need the processing tools
+from Graphviz.
+
+= Website and Project Home
+
+http://railroady.prestonlee.com
+
+# License
+
+RailRoady is distributed under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2 of the
+License, or (at your option) any later version.
+
+See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2007-2008 Javier Smaldone
+Copyright (c) 2009 Peter Hoeg
+Copyright (c) 2010-2016 Preston Lee
+
+See LICENSE for details.
+
+## Authors
+
+Authors/Contributors (in approximate order of appearance):
+
+* Javier Smaldone (javier |at| smaldone |dot| com |dot| ar)
+* Elliot Smith
+* Juan Ignacio Pumarino
+* Hajime Baba
+* Ana Nelson
+* Peter Hoeg
+* John McCaffrey
+* David Jones
+* Mike Dalessio
+* [Preston Lee](https://www.prestonlee.com) and [Lee Does](https://www.leedoes.com), the vendor providing maintenance.
+* Tim Harvey
+* Atli Christiansen
+* John Bintz (http://www.coswellproductions.com/)
+
+And of course, many thanks to the many patch submitters and testers that make this possible!

data/Rakefile

@@ -1,12 +1,12 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
- 
+require 'bundler/gem_tasks'
+
 require 'rake/testtask'
- 
+
 Rake::TestTask.new do |t|
   t.libs << 'lib/railroady'
   t.test_files = FileList['test/lib/railroady/*_spec.rb']
   t.verbose = true
 end
- 
-task :default => :test
+
+task default: :test

data/bin/railroady

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # RailRoady - RoR diagrams generator
 # http://github.com/preston/railroady
@@ -13,19 +14,20 @@
 # the Free Software Foundation; either version 2 of the License, or
 # (at your option) any later version.
 #
-# Modification 2010 by Preston Lee.
+# Modifications 2010-2015 by Preston Lee.
 #
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'railroady'
 
-APP_NAME       = "railroady"
-APP_HUMAN_NAME = "RailRoady"
+APP_NAME       = 'railroady'
+APP_HUMAN_NAME = 'RailRoady'
 # APP_VERSION    = [RailRoady::VERSION::MAJOR, RailRoady::VERSION::MINOR, RailRoady::VERSION::PATCH]
 APP_VERSION    = RailRoady::VERSION
-COPYRIGHT      = "Copyright (C) 2007-2008 Javier Smaldone, 2009 Peter Hoeg, 2010 Preston Lee"
+COPYRIGHT      = 'Copyright (C) 2007-2008 Javier Smaldone, 2009 Peter Hoeg, 2010-2015 Preston Lee'
 
-options = OptionsStruct.new({:app_name => APP_NAME, :app_human_name => APP_HUMAN_NAME, :app_version =>APP_VERSION, :copyright =>COPYRIGHT})
+options = OptionsStruct.new(app_name: APP_NAME, app_human_name: APP_HUMAN_NAME, app_version: APP_VERSION,
+                            copyright: COPYRIGHT)
 
 options.parse ARGV
 
@@ -44,8 +46,8 @@ when 'controllers'
 when 'aasm'
   diagram = AasmDiagram.new(options)
 else
-  STDERR.print "#{APP_HUMAN_NAME} v#{APP_VERSION}\n" +
-    "Error: You must supply a command\n" +
+  $stderr.print "#{APP_HUMAN_NAME} v#{APP_VERSION}\n" \
+    "Error: You must supply a command\n" \
     "  (try #{APP_NAME} -h)\n\n"
   exit 1
 end
@@ -56,4 +58,3 @@ diagram.generate
 Dir.chdir(old_dir)
 
 diagram.print
-

data/lib/railroady/aasm_diagram.rb

@@ -1,18 +1,11 @@
-# RailRoady - RoR diagrams generator
-# http://railroad.rubyforge.org
-#
-# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
-# See COPYING for more details
-
-# AASM code provided by Ana Nelson (http://ananelson.com/)
+# frozen_string_literal: true
 
 require 'railroady/app_diagram'
 
 # Diagram for Acts As State Machine
 class AasmDiagram < AppDiagram
-
   def initialize(options = OptionsStruct.new)
-    #options.exclude.map! {|e| e = "app/models/" + e}
+    # options.exclude.map! {|e| e = "app/models/" + e}
     super options
     @graph.diagram_type = 'Models'
     # Processed habtm associations
@@ -21,89 +14,61 @@ class AasmDiagram < AppDiagram
 
   # Process model files
   def generate
-    STDERR.print "Generating AASM diagram\n" if @options.verbose
+    $stderr.print "Generating AASM diagram\n" if @options.verbose
     get_files.each do |f|
       process_class extract_class_name(f).constantize
     end
   end
 
-  def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/models/**/*.rb")
-    files += Dir.glob("vendor/plugins/**/app/models/*.rb") if @options.plugins_models
-    files -= Dir.glob(@options.exclude)
-    files
+  def get_files(prefix = '')
+    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob("#{prefix}app/models/**/*.rb")
+    files += Dir.glob('vendor/plugins/**/app/models/*.rb') if @options.plugins_models
+    files - Dir.glob("#{prefix}app/models/concerns/**/*.rb") unless @options.include_concerns
+    Dir.glob(@options.exclude)
   end
 
   private
 
   # Load model classes
   def load_classes
-    begin
-      disable_stdout
-      get_files.each {|m| require m }
-      enable_stdout
-    rescue LoadError
-      enable_stdout
-      print_error "model classes"
-      raise
-    end
-  end  # load_classes
+    disable_stdout
+    get_files.each { |m| require m }
+    enable_stdout
+  rescue LoadError
+    enable_stdout
+    print_error 'model classes'
+    raise
+  end
 
   # Process a model class
   def process_class(current_class)
+    $stderr.print "\tProcessing #{current_class}\n" if @options.verbose
 
-    STDERR.print "\tProcessing #{current_class}\n" if @options.verbose
-
-    # Only interested in acts_as_state_machine models.
-    process_acts_as_state_machine_class(current_class)  if current_class.respond_to?(:states)
-    process_aasm_class(current_class)  if current_class.respond_to?(:aasm_states)
-  end # process_class
-
-  def process_acts_as_state_machine_class(current_class)
-    node_attribs = []
-    node_type = 'aasm'
-    
-    STDERR.print "\t\tprocessing as acts_as_state_machine\n" if @options.verbose
-    current_class.states.each do |state_name|
-      state = current_class.read_inheritable_attribute(:states)[state_name]
-      node_shape = (current_class.initial_state === state_name) ? ", peripheries = 2" : ""
-      node_attribs << "#{current_class.name.downcase}_#{state_name} [label=#{state_name} #{node_shape}];"
-    end
-    @graph.add_node [node_type, current_class.name, node_attribs]
-
-    current_class.read_inheritable_attribute(:transition_table).each do |event_name, event|
-      event.each do |transition|
-        @graph.add_edge [
-                         'event',
-                         current_class.name.downcase + "_" + transition.from.to_s,
-                         current_class.name.downcase + "_" + transition.to.to_s,
-                         event_name.to_s
-                        ]
-      end
-    end
+    # Only interested in aasm models.
+    process_aasm_class(current_class)  if current_class.respond_to?(:aasm_states) || current_class.respond_to?(:aasm)
   end
 
   def process_aasm_class(current_class)
     node_attribs = []
     node_type = 'aasm'
+    diagram_friendly_class_name = current_class.name.downcase.gsub(/[^a-z0-9\-_]+/i, '_')
 
-    STDERR.print "\t\tprocessing as aasm\n" if @options.verbose
-    current_class.aasm_states.each do |state|
-      node_shape = (current_class.aasm_initial_state === state.name) ? ", peripheries = 2" : ""
-      node_attribs << "#{current_class.name.downcase}_#{state.name} [label=#{state.name} #{node_shape}];"
+    $stderr.print "\t\tprocessing as aasm\n" if @options.verbose
+    current_class.aasm.states.each do |state|
+      node_shape = current_class.aasm.initial_state == state.name ? ', peripheries = 2' : ''
+      node_attribs << "#{diagram_friendly_class_name}_#{state.name} [label=#{state.name} #{node_shape}];"
     end
     @graph.add_node [node_type, current_class.name, node_attribs]
 
-    current_class.aasm_events.each do |event_name, event|
-      event.all_transitions.each do |transition|
+    current_class.aasm.events.each do |event|
+      event.transitions.each do |transition|
         @graph.add_edge [
-                         'event',
-                         current_class.name.downcase + "_" + transition.from.to_s,
-                         current_class.name.downcase + "_" + transition.to.to_s,
-                         event_name.to_s
-                        ]
+          'event',
+          "#{diagram_friendly_class_name}_#{transition.from}",
+          "#{diagram_friendly_class_name}_#{transition.to}",
+          event.name.to_s
+        ]
       end
     end
   end
-
-end # class AasmDiagram
+end