railroady 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaa6ca5ddf8518e1f146c35ea2973eb013092d4d
-  data.tar.gz: fc51e067821dff9ecb7dcadf847fe21c67217265
+  metadata.gz: 3f6bf55bece6a6c3b86cb259fa55a90450ad0b13
+  data.tar.gz: fc6eb6ecccc214f6af1efd3086af702c4e4681f4
 SHA512:
-  metadata.gz: 16c28d9206208fd1b5d7e8c7577351096804bf88155c2b2ff285140836a2904d6c70a1f85718490fedfb25f6b80d47c922ac4c68a1bacb10b63fc8d547319f3c
-  data.tar.gz: 3f505a379bc651ede5693fa72f16d72d52d5777a0c8bb401a8ae621022e392bb034382f5e64179b61a37fb077062f821da4567dda26a04475db9ce89b4902c8e
+  metadata.gz: 078660548c41a48bfed350461f7cf211a64c9683e3d2a7cda7ddf3521671ae0dd3b5c613ff237a1c92d9241a0e59fef80b650f0d0eecf97be8ab360ac83257a5
+  data.tar.gz: 198e5625e97bec987081fba7a4840929d259f5163fe73c8d20bba98a6c13afb29cabf0e97bae10f0be2613c1f36295ba59e3ac1fe3147d78e4721b618d1afcc9

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    railroady (1.4.2)
+    railroady (1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (4.2.6)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -14,8 +14,8 @@ GEM
       tzinfo (~> 1.1)
     i18n (0.7.0)
     json (1.8.3)
-    minitest (5.8.3)
-    rake (10.4.2)
+    minitest (5.9.0)
+    rake (11.2.2)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -31,4 +31,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

data/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-= RailRoady 
+# RailRoady
 
 RailRoady generates Rails 3/4 model (ActiveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
 
@@ -6,29 +6,31 @@ Code is based on the original "railroad" gem, patched and maintained over the ye
 
 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 v3 and v4 projects. Rails v2 is not supported.
 
-= System Requirements
+# 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
+## Mac users
 
-MacPorts users can install in via 
+Brew users can install via:
+
+    brew install graphviz
+
+MacPorts users can install in via
 
     sudo port install graphviz
-    
-Brew user can install via
 
-    brew install graphviz
 
-= Ubuntu users
+## Ubuntu users
 
-Ubuntu users can install in via 
+Ubuntu users can install in via
 
     sudo apt-get install graphviz
-= Usage
+
+# Usage
 
 The easiest (and recommend) usage is to include railroady as a development dependency with your Rails 3 Gemfile, like so...
 
@@ -40,73 +42,79 @@ The easiest (and recommend) usage is to include railroady as a development depen
 
     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.
+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
+## Support for Engines
 
 Generate diagram for models and controllers including those in the engines.
 
-    rake diagram:all_with_engines 
+    rake diagram:all_with_engines
 
-= Alternate Usage
+## 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 given files only for the diagram
-                                       (can take a glob pattern)
-    -e, --exclude file1[,fileN]      Exclude given files
-                                       (can take a glob pattern)
-    -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
-    -v, --verbose                    Enable verbose output
-                                       (produce messages to STDOUT)
-        --alphabetize                Sort methods alphabetically
 
-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
-        --hide-through               Hide through associations
-    -j, --join                       Concentrate edges
-    -m, --modules                    Include modules
-    -p, --plugins-models             Include plugins models
-    -z, --engine-models              Include engine models
-    -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         Show engine controllers    
-Other options:
-    -h, --help                       Show this message
-        --version                    Show version and copyright
-
-== Commands
+## 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
 
-== Examples
-
-    railroady -o models.dot -M 
+    railroady -o models.dot -M
       Produces a models diagram to the file 'models.dot'
-    railroady -a -i -o full_models.dot -M 
+    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
@@ -116,7 +124,7 @@ Other options:
       Shows usage help
 
 
-= Processing DOT files
+# Processing DOT files
 
 To produce a PNG image from model diagram generated by RailRoady you can
 issue the following command:
@@ -137,7 +145,7 @@ the following:
 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 
+"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
@@ -151,15 +159,15 @@ also use Omnigraffle (on Mac OS X).
 As of Preston Lee's Rails 3/4 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
+# Requirements
 
 RailRoady has been tested with the following Ruby and Rails versions
 
-== Ruby
+## Ruby
 * 1.9.2+
 * 2.0.0+
 
-== Rails
+## Rails
 * 3.0.3+
 * 4.0.0+
 
@@ -173,15 +181,15 @@ from Graphviz.
 
 http://railroady.prestonlee.com
 
-= License
+# 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 
+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
 
 Copyright (c) 2007-2008 Javier Smaldone
 Copyright (c) 2009 Peter Hoeg
@@ -189,6 +197,6 @@ Copyright (c) 2010 Preston Lee
 
 See LICENSE for details.
 
-== Authors
+## Authors
 
 See AUTHORS for details.

data/lib/railroady/aasm_diagram.rb

@@ -62,7 +62,7 @@ class AasmDiagram < AppDiagram
 
     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]
+    #   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

data/lib/railroady/models_diagram.rb

@@ -39,26 +39,26 @@ class ModelsDiagram < AppDiagram
   def engine_files
     engines.collect { |engine| Dir.glob("#{engine.root}/app/models/**/*.rb") }.flatten
   end
-  
+
   def extract_class_name(filename)
     filename_was, class_name = filename, nil
-      
-    filename = "app/models/#{filename.split('app/models')[1]}"   
-      
+
+    filename = "app/models/#{filename.split('app/models')[1]}"
+
     while filename.split('/').length > 2
       begin
         class_name = filename.match(/.*\/models\/(.*).rb$/)[1].camelize
         class_name.constantize
-        
+
         break
-      rescue Exception => e
+	rescue Exception # => e
         class_name = nil
         filename_end = filename.split('/')[2..-1]
         filename_end.shift
         filename = "#{filename.split('/')[0, 2].join('/')}/#{filename_end.join('/')}"
       end
     end
-    
+
     if class_name.nil?
       filename_was.match(/.*\/models\/(.*).rb$/)[1].camelize
     else
@@ -92,8 +92,8 @@ class ModelsDiagram < AppDiagram
 
   def include_inheritance?(current_class)
     STDERR.puts current_class.superclass if @options.verbose
-    (defined?(ActiveRecord::Base) && current_class.superclass != ActiveRecord::Base) ||
-      (defined?(CouchRest::Model::Base) && current_class.superclass != CouchRest::Model::Base) ||
+    (defined?(ActiveRecord::Base) ? current_class.superclass != ActiveRecord::Base : true) &&
+      (defined?(CouchRest::Model::Base) ? current_class.superclass != CouchRest::Model::Base : true) &&
       (current_class.superclass != Object)
   end
 

data/lib/railroady/version.rb

@@ -1,3 +1,3 @@
 module RailRoady
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

data/railroady.gemspec

@@ -7,13 +7,13 @@ Gem::Specification.new do |spec|
   spec.name          = 'railroady'
   spec.version       = RailRoady::VERSION
   spec.authors       = ['Preston Lee', 'Tobias Crawley', 'Peter Hoeg', 'Javier Smaldone']
-  spec.description  = "Ruby on Rails 3/4 model and controller UML class diagram generator. Originally based on the 'railroad' plugin and contributions of many others. (`sudo port install graphviz` before use!)"
+  spec.description  = "Ruby on Rails 3/4 model and controller UML class diagram generator. Originally based on the 'railroad' plugin and contributions of many others. (`brew install graphviz` before use!)"
   spec.email        = ['preston.lee@prestonlee.com', 'tcrawley@gmail.com', 'peter@hoeg.com', 'p.hoeg@northwind.sg', 'javier@smaldone.com.ar']
   spec.summary      = 'Ruby on Rails 3/4 model and controller UML class diagram generator.'
   spec.homepage      = 'http://github.com/preston/railroady'
   spec.license       = 'GPLv2'
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']

data/test/lib/railroady/models_diagram_spec.rb

@@ -96,4 +96,67 @@ describe ModelsDiagram do
       end
     end
   end
+
+  describe '#include_inheritance?' do
+    after do
+      Object.send(:remove_const, :Child)
+    end
+    describe 'when class inherits from another app class' do
+      before do
+        class Parent; end;
+        class Child < Parent; end;
+      end
+      it 'returns true' do
+        md = ModelsDiagram.new(OptionsStruct.new)
+        md.include_inheritance?(Child).must_equal true
+      end
+      after do
+        Object.send(:remove_const, :Parent)
+      end
+    end
+
+    describe 'when class inherits from Object' do
+      before do
+        class Child < Object; end;
+      end
+      it 'returns false' do
+        md = ModelsDiagram.new(OptionsStruct.new)
+        md.include_inheritance?(Child).must_equal false
+      end
+    end
+
+    describe 'when class inherits from ActiveRecord::Base' do
+      before do
+        module ActiveRecord
+          class Base; end;
+        end
+        class Child < ActiveRecord::Base; end;
+      end
+      it 'returns false' do
+        md = ModelsDiagram.new(OptionsStruct.new)
+        md.include_inheritance?(Child).must_equal false
+      end
+      after do
+        Object.send(:remove_const, :ActiveRecord)
+      end
+    end
+
+    describe 'when class inherits from CouchRest::Model::Base' do
+      before do
+        module CouchRest
+          module Model
+            class Base; end;
+          end
+        end
+        class Child < CouchRest::Model::Base; end;
+      end
+      it 'returns false' do
+        md = ModelsDiagram.new(OptionsStruct.new)
+        md.include_inheritance?(Child).must_equal false
+      end
+      after do
+        Object.send(:remove_const, :CouchRest)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railroady
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Preston Lee
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby on Rails 3/4 model and controller UML class diagram generator. Originally
-  based on the 'railroad' plugin and contributions of many others. (`sudo port install
+  based on the 'railroad' plugin and contributions of many others. (`brew install
   graphviz` before use!)
 email:
 - preston.lee@prestonlee.com
@@ -90,7 +90,7 @@ files:
 - Gemfile.lock
 - Guardfile
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - Rakefile
 - bin/railroady
 - lib/railroady.rb
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails 3/4 model and controller UML class diagram generator.