railroady 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d861e99e4da72666e52557b3dd4aae91be9c3810
-  data.tar.gz: 877a3dfee6e413da3f9a7b93a9e434847675e97c
+  metadata.gz: 04e3747c5c99a23bc76daeb07ba2afee3688a470
+  data.tar.gz: df60108b7a16afdf595baa3ee61464130776f013
 SHA512:
-  metadata.gz: 968bf68e7072cba4ab255c8b2ab1da9f880a077b5269dbc0f65abf8c1a4bf1a224345cfd278f0a51a98061381574038a68d2b1cd8c62437dbffaff8a74642b43
-  data.tar.gz: 78b3e11854e3394ce6db8a9c6554bf807cb356ec68dd6f0075c168b3a4e1682e188f9e25cd1f31a774aba2df1a109881418003c53d6d3ee306febcc6ba406f6d
+  metadata.gz: 4e91ce3076f9d0a7a326d50052d50b761340786f581f02a1516b36ac6139a3f443fe7fd1b1bda72455a717103e8f6b7d820c356c0fc0def5d66ca29c70102d2e
+  data.tar.gz: b4debced96a4b045aaaf19ccbaba2dcb33effe84a5233c502962d3d4c775535c480d17f9ea4e518bbbd849f9c1e5cc2115ab328c96fbbebceab274d8696faede

data/README.rdoc

@@ -1,10 +1,10 @@
 = RailRoady 
 
-RailRoady generates Rails 3/4 model (AcitveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
+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.
 
 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 v3 projects. Rails v2 is not supported.
+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
 
@@ -15,13 +15,19 @@ You MUST have the the following utilities available at the command line.
 
 = Mac users
 
-MacPorts users can install in via `sudo port install graphviz`.
-Brew user 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 can install in via `sudo apt-get install graphviz`.
+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...
@@ -34,7 +40,7 @@ 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 dedicate 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.
 
 = Alternate Usage
 
@@ -57,6 +63,7 @@ Common options:
     -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
@@ -134,7 +141,7 @@ also use Omnigraffle (on Mac OS X).
 
 = Rake Tasks
 
-As of Preston Lee's Rails 3 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.)
+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
@@ -143,9 +150,11 @@ 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+
 
 There are no additional requirements (nevertheless, all your Rails application
 requirements must be installed).

data/bin/railroady

@@ -36,11 +36,12 @@ old_dir = Dir.pwd
 
 Dir.chdir(options.root) if options.root != ''
 
-if options.command == 'models'
+case options.command
+when 'models'
   diagram = ModelsDiagram.new options
-elsif options.command == 'controllers'
+when 'controllers'
   diagram = ControllersDiagram.new options
-elsif options.command == 'aasm'
+when 'aasm'
   diagram = AasmDiagram.new(options)
 else
   STDERR.print "#{APP_HUMAN_NAME} v#{APP_VERSION}\n" +

data/lib/railroady/app_diagram.rb

@@ -13,6 +13,7 @@ class AppDiagram
     @options = options
     @graph = DiagramGraph.new
     @graph.show_label = @options.label
+    @graph.alphabetize = @options.alphabetize
   end
   
 

data/lib/railroady/diagram_graph.rb

@@ -10,7 +10,8 @@ class DiagramGraph
 
   def initialize
     @diagram_type = ''
-    @show_label = false
+    @show_label   = false
+    @alphabetize  = false
     @nodes = []
     @edges = []
   end
@@ -31,6 +32,10 @@ class DiagramGraph
     @show_label = value
   end
 
+  def alphabetize= (flag)
+    @alphabetize = flag
+  end
+
 
   # Generate DOT graph
   def to_dot
@@ -78,7 +83,7 @@ class DiagramGraph
     case type
       when 'model'
            options = 'shape=Mrecord, label="{' + name + '|'
-           options += attributes.join('\l')
+           options += attributes.sort_by { |s| @alphabetize ? s : nil }.join('\l')
            options += '\l}"'
       when 'model-brief'
            options = ''
@@ -88,9 +93,9 @@ class DiagramGraph
            options = 'shape=box'
       when 'controller'
            options = 'shape=Mrecord, label="{' + name + '|'
-           public_methods    = attributes[:public].join('\l')
-           protected_methods = attributes[:protected].join('\l')
-           private_methods   = attributes[:private].join('\l')
+           public_methods    = attributes[:public].sort_by    { |s| @alphabetize ? s : nil }.join('\l')
+           protected_methods = attributes[:protected].sort_by { |s| @alphabetize ? s : nil }.join('\l')
+           private_methods   = attributes[:private].sort_by   { |s| @alphabetize ? s : nil }.join('\l')
            options += public_methods + '\l|' + protected_methods + '\l|' +
                       private_methods + '\l'
            options += '}"'

data/lib/railroady/options_struct.rb

@@ -32,6 +32,7 @@ class OptionsStruct < OpenStruct
                      :hide_through => false,
                      :transitive => false,
                      :verbose => false,
+                     :alphabetize => false,
                      :xmi => false,
                      :command => '',
                      :config_file => 'config/environment',
@@ -75,6 +76,9 @@ class OptionsStruct < OpenStruct
               "  (for UML tools)") do |x|
         self.xmi = x
       end
+      opts.on("--alphabetize", "Sort methods alphabetically") do |a|
+        self.alphabetize = a
+      end
       opts.separator ""
       opts.separator "Models diagram options:"
       opts.on("-a", "--all", "Include all models", 

data/lib/railroady/version.rb

@@ -1,3 +1,3 @@
 module RailRoady
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/railroady.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.email        = ["conmotto@gmail.com", "tcrawley@gmail.com", "peter@hoeg.com", "p.hoeg@northwind.sg", "javier@smaldone.com.ar"]
+  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"

data/tasks/railroady.rake

@@ -1,11 +1,11 @@
 # This suite of tasks generate graphical diagrams via code analysis.
 # A UNIX-like environment is required as well as:
-# 
+#
 # * The railroady gem. (http://github.com/preston/railroady)
 # * The graphviz package which includes the `dot` and `neato` command-line utilities. MacPorts users can install in via `sudo port install graphviz`.
 # * The `sed` command-line utility, which should already be available on all sane UNIX systems.
 #
-# Author: Preston Lee, http://railroady.prestonlee.com 
+# Author: Preston Lee, http://railroady.prestonlee.com
 
 # wrap helper methods so they don't conflict w/ methods on Object
 
@@ -26,7 +26,7 @@ module RailRoady
     def self.sed
       regex = 's/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g'
       case RbConfig::CONFIG['host_os']
-      when /linux|cygwin/
+      when /linux|cygwin|mingw/
         return "sed -r '#{regex}'"
       when /mac|darwin|bsd/
         return "sed -E '#{regex}'"
@@ -40,11 +40,18 @@ end
 
 namespace :diagram do
 
-  @MODELS_ALL = RailRoady::RakeHelpers.full_path("models_complete.#{RailRoady::RakeHelpers.format}").freeze
-  @MODELS_BRIEF = RailRoady::RakeHelpers.full_path("models_brief.#{RailRoady::RakeHelpers.format}").freeze
-  @CONTROLLERS_ALL = RailRoady::RakeHelpers.full_path("controllers_complete.#{RailRoady::RakeHelpers.format}").freeze
-  @CONTROLLERS_BRIEF = RailRoady::RakeHelpers.full_path("controllers_brief.#{RailRoady::RakeHelpers.format}").freeze
-  @SED = RailRoady::RakeHelpers.sed
+  @MODELS_ALL         = RailRoady::RakeHelpers.full_path("models_complete.#{RailRoady::RakeHelpers.format}").freeze
+  @MODELS_BRIEF       = RailRoady::RakeHelpers.full_path("models_brief.#{RailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_ALL    = RailRoady::RakeHelpers.full_path("controllers_complete.#{RailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_BRIEF  = RailRoady::RakeHelpers.full_path("controllers_brief.#{RailRoady::RakeHelpers.format}").freeze
+  @SED                = RailRoady::RakeHelpers.sed
+
+  namespace :setup do
+    desc 'Perform any setup needed for the gem'
+    task :create_new_doc_folder_if_needed do
+      Dir.mkdir('doc') unless File.exists?('doc')
+    end
+  end
 
   namespace :models do
 
@@ -83,6 +90,9 @@ namespace :diagram do
   end
 
   desc 'Generates all class diagrams.'
-  task :all => ['diagram:models:complete', 'diagram:models:brief', 'diagram:controllers:complete', 'diagram:controllers:brief']
-
+  task all: ['diagram:setup:create_new_doc_folder_if_needed',
+             'diagram:models:complete',
+             'diagram:models:brief',
+             'diagram:controllers:complete',
+             'diagram:controllers:brief']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railroady
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Preston Lee
@@ -11,83 +11,83 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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
   graphviz` before use!)
 email:
-- conmotto@gmail.com
+- preston.lee@prestonlee.com
 - tcrawley@gmail.com
 - peter@hoeg.com
 - p.hoeg@northwind.sg
@@ -97,7 +97,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - AUTHORS.rdoc
 - CHANGELOG.rdoc
 - Gemfile
@@ -141,17 +141,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails 3/4 model and controller UML class diagram generator.