railroady 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd1043d72d2cfebcba08c83d8400a8df9bf3a840
-  data.tar.gz: 124ee06425806898b9c792e694aa040f94bfe3ab
+  metadata.gz: 8f5ab1921e48623ca0993f9c7ca08186802204b3
+  data.tar.gz: eb23360fc687b72eddcba86d3eba896a2b3d791c
 SHA512:
-  metadata.gz: 06f654229b6a5547d15e3af00c4fcbd47cee38b39bbd3cb48d58526110b770e8725308c6c7971037d46d32db3052fa19c9d750c7d5cdce6b06445ef2cec8502f
-  data.tar.gz: 3342a69cba5791335db8a0242c3b2f6c04a8282e0f6ccd8fddf3f7de1682e813d5415f936513c1c550858441d09b4b8ffb9257381e1ed408de522c4447879429
+  metadata.gz: 5956104262321ebcde50f24d5eee2b6a043f9a7972b613a041270d55851b811cc169ee32d8ef5fecbbe67a1e3d5a8abc86ae78efa0e8cd35a456b76289d24841
+  data.tar.gz: c64b8551d6d1824a01193862f1b188166197b3825d12576aa08eba471d7e6ea0df8f1c25747d592a29c32fc6c5d7b0fcb557728f39edfb232d3c6ef70500369d

data/Gemfile

@@ -1,3 +1,2 @@
 source 'https://rubygems.org'
-
 gemspec

data/Gemfile.lock

@@ -1,26 +1,24 @@
 PATH
   remote: .
   specs:
-    railroady (1.1.1)
+    railroady (1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    i18n (0.7.0)
+    json (1.8.1)
+    minitest (5.5.0)
+    rake (10.4.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
       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)
 
 PLATFORMS
   ruby
@@ -29,6 +27,5 @@ DEPENDENCIES
   activesupport
   bundler
   minitest
-  minitest-spec-context
   railroady!
   rake

data/Guardfile

@@ -0,0 +1,50 @@
+# 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.rdoc

@@ -42,6 +42,12 @@ The easiest (and recommend) usage is to include railroady as a development depen
 
 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.
@@ -76,6 +82,7 @@ Models diagram options:
     -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)
 
@@ -83,7 +90,7 @@ 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

data/lib/railroady/aasm_diagram.rb

@@ -28,8 +28,9 @@ class AasmDiagram < AppDiagram
   end
 
   def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/models/**/*.rb")
+    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
     files -= Dir.glob(@options.exclude)
     files
   end
@@ -62,7 +63,7 @@ class AasmDiagram < AppDiagram
   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]
@@ -88,14 +89,14 @@ class AasmDiagram < AppDiagram
     node_type = 'aasm'
 
     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" : ""
+    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}];"
     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_name, event|
+      event.transitions.each do |transition|
         @graph.add_edge [
                          'event',
                          current_class.name.downcase + "_" + transition.from.to_s,

data/lib/railroady/app_diagram.rb

@@ -46,6 +46,22 @@ class AppDiagram
     load_environment
   end
 
+  # get all engines
+  def engines
+    engines = []
+    
+    if defined?(Rails)
+      engines = if Rails::Application::Railties.respond_to?(:engines)
+                  Rails::Application::Railties.engines
+                else
+                  # rails 4 way of getting engines
+                  Rails::Engine.subclasses.map(&:instance)
+                end
+    end
+    engines
+  end
+
+
   private 
   
   # Load Rails application's environment

data/lib/railroady/controllers_diagram.rb

@@ -39,10 +39,22 @@ class ControllersDiagram < AppDiagram
 
   def get_files(prefix ='')
     files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/controllers/**/*_controller.rb")
+    files += get_engine_files if @options.engine_controllers
     files -= Dir.glob(@options.exclude)
     files
   end
+  
+  def get_engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root.to_s}/app/controllers/**/*_controller.rb")}.flatten
+  end
+  
+  def extract_class_name(filename)
+    controller_index = filename.split('/').index("controllers") + 1
+    filename.split('/')[controller_index..-1].collect { |i| i.camelize }.join('::').chomp(".rb")
+  end
+
 
+  
   private
   # Load controller classes
   def load_classes

data/lib/railroady/models_diagram.rb

@@ -24,17 +24,29 @@ class ModelsDiagram < AppDiagram
       rescue Exception
         STDERR.puts "Warning: exception #{$!} raised while trying to load model class #{f}"
       end
-
+      
     end
   end
 
   def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/models/**/*.rb")
+    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
+    files += get_engine_files if @options.engine_models
     files -= Dir.glob(@options.exclude)
     files
   end
 
+  def get_engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root.to_s}/app/models/**/*.rb")}.flatten
+  end
+
+
+  def extract_class_name(filename)
+    filename.split('/').last.camelize.chomp(".rb")
+  end
+
+  
   # Process a model class
   def process_class(current_class)
     STDERR.puts "Processing #{current_class}" if @options.verbose

data/lib/railroady/options_struct.rb

@@ -27,6 +27,9 @@ class OptionsStruct < OpenStruct
                      :hide_protected => false,
                      :hide_private => false,
                      :plugins_models => false,
+                     :engine_models => false,
+                     :engine_controllers => false, 
+		     :include_concerns => false,
                      :root => '',
                      :show_belongs_to => false,
                      :hide_through => false,
@@ -109,6 +112,12 @@ class OptionsStruct < OpenStruct
       opts.on("-p", "--plugins-models", "Include plugins models") do |p|
         self.plugins_models = p
       end
+      opts.on("-z", "--engine-models", "Include engine models") do |em|
+        self.engine_models = em
+      end
+      opts.on("--include-concerns", "Include models in concerns subdirectory") do |c|
+        self.include_concerns = c
+      end
       opts.on("-t", "--transitive", "Include transitive associations",
               "(through inheritance)") do |t|
         self.transitive = t
@@ -124,6 +133,9 @@ class OptionsStruct < OpenStruct
       opts.on("--hide-private", "Hide private methods") do |h|
         self.hide_private = h
       end
+      opts.on("--engine-controllers", "Include engine controllers") do |ec|
+        self.engine_controllers = ec
+      end
       opts.separator ""
       opts.separator "Other options:"
       opts.on("-h", "--help", "Show this message") do

data/lib/railroady/version.rb

@@ -1,3 +1,3 @@
 module RailRoady
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/railroady.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-spec-context"
   spec.add_development_dependency "activesupport"
 
 end

data/tasks/railroady.rake

@@ -55,6 +55,9 @@ namespace :diagram do
 
   namespace :models do
 
+    desc 'Generated brief and complete class diagrams for all models.'
+    task :all => ['diagram:models:complete', 'diagram:models:brief']
+
     desc 'Generates an class diagram for all models.'
     task :complete do
       f = @MODELS_ALL
@@ -69,9 +72,27 @@ namespace :diagram do
       sh "railroady -blamM | #{@SED} | dot -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
 
+    desc 'Generates an class diagram for all models including those in engines'
+    task :complete_with_engines do
+      f = @MODELS_ALL
+      puts "Generating #{f}"
+      sh "railroady -ilamzM | #{@SED} | dot -T#{RailRoady::RakeHelpers.format} > #{f}"
+    end
+    
+    desc 'Generates an abbreviated class diagram for all models including those in engines'
+    task :brief_with_engines do
+      f = @MODELS_BRIEF
+      puts "Generating #{f}"
+      sh "railroady -bilamzM | #{@SED} | dot -T#{RailRoady::RakeHelpers.format} > #{f}"
+    end
+
+
   end
 
   namespace :controllers do
+    
+    desc 'Generated brief and complete class diagrams for all controllers.'
+    task :all => ['diagram:controllers:complete', 'diagram:controllers:brief']
 
     desc 'Generates an class diagram for all controllers.'
     task :complete do
@@ -86,13 +107,40 @@ namespace :diagram do
       puts "Generating #{f}"
       sh "railroady -blC | #{@SED} | neato -T#{RailRoady::RakeHelpers.format} > #{f}"
     end
+    
+    desc 'Generates an class diagram for all controllers including those in engines'
+    task :complete_with_engines do 
+      f = @CONTROLLERS_ALL
+      puts "Generating #{f}"
+      sh "railroady -ilC --engine-controllers | #{@SED} | neato -T#{RailRoady::RakeHelpers.format} > #{f}"
+    end
+    
+    desc 'Generates an abbreviated class diagram for all controllers including those in engines.'
+    task :brief_with_engines do
+      f = @CONTROLLERS_BRIEF
+      puts "Generating #{f}"
+      sh "railroady -bilC --engine-controllers | #{@SED} | neato -T#{RailRoady::RakeHelpers.format} > #{f}"
+    end
 
+    
   end
 
   desc 'Generates all class diagrams.'
-  task all: ['diagram:setup:create_new_doc_folder_if_needed',
+  task all: [
+             'diagram:setup:create_new_doc_folder_if_needed',
              'diagram:models:complete',
              'diagram:models:brief',
              'diagram:controllers:complete',
-             'diagram:controllers:brief']
+             'diagram:controllers:brief'
+            ]
+
+  desc 'Generates all class diagrams including those in engines'
+  task all_with_engines: [
+             'diagram:setup:create_new_doc_folder_if_needed',
+             'diagram:models:complete_with_engines',
+             'diagram:models:brief_with_engines',
+             'diagram:controllers:complete_with_engines',
+             'diagram:controllers:brief_with_engines'
+            ]
+
 end

data/test/lib/railroady/aasm_diagram_spec.rb

@@ -9,6 +9,13 @@ describe AasmDiagram do
       files.size.must_equal 3
     end
 
+    it 'should include concerns if specified' do
+      options = OptionsStruct.new(:include_concerns => true)
+      ad = AasmDiagram.new(options)
+      files = ad.get_files("test/file_fixture/")
+      files.size.must_equal 4
+    end
+
     it 'should exclude a specific file' do
       options = OptionsStruct.new(:exclude => ['test/file_fixture/app/models/dummy1.rb'])
       ad = AasmDiagram.new(options)

data/test/lib/railroady/controllers_diagram_spec.rb

@@ -45,5 +45,15 @@ describe ControllersDiagram do
       files.size.must_equal 1
     end
 
+    it "should include engine files" do
+      options = OptionsStruct.new(:engine_controllers => true)
+      md = ControllersDiagram.new(options)
+      engines = [OpenStruct.new(:root => "test/file_fixture/lib")]
+      md.stub(:engines, engines) do
+        md.get_files.must_include("test/file_fixture/lib/app/controllers/dummy/dummy_controller.rb")
+      end
+    end
+    
+
   end
 end

data/test/lib/railroady/diagram_graph_spec.rb

@@ -33,17 +33,17 @@ describe DiagramGraph do
     @diagram_graph = DiagramGraph.new
   end
 
-  describe ".dot_edge" do
-    context "has_a/belongs_to" do
-      it { @diagram_graph.send(:dot_edge, "one-one", "source", "target").must_include "arrowtail=odot, arrowhead=dot, dir=both" }
-    end
+  # describe ".dot_edge" do
+  #   context "has_a/belongs_to" do
+  #     it { @diagram_graph.send(:dot_edge, "one-one", "source", "target").must_include "arrowtail=odot, arrowhead=dot, dir=both" }
+  #   end
 
-    context "has_many/belongs_to" do
-      it { @diagram_graph.send(:dot_edge, "one-many", "source", "target").must_include "arrowtail=odot, arrowhead=crow, dir=both" }
-    end
+  #   context "has_many/belongs_to" do
+  #     it { @diagram_graph.send(:dot_edge, "one-many", "source", "target").must_include "arrowtail=odot, arrowhead=crow, dir=both" }
+  #   end
 
-    context "habtm" do
-      it { @diagram_graph.send(:dot_edge, "many-many", "source", "target").must_include "arrowtail=crow, arrowhead=crow, dir=both" }
-    end
-  end
+  #   context "habtm" do
+  #     it { @diagram_graph.send(:dot_edge, "many-many", "source", "target").must_include "arrowtail=crow, arrowhead=crow, dir=both" }
+  #   end
+  # end
 end

data/test/lib/railroady/models_diagram_spec.rb

@@ -9,6 +9,13 @@ describe ModelsDiagram do
       files.size.must_equal 3
     end
 
+    it 'should include concerns if specified' do
+      options = OptionsStruct.new(:include_concerns => true)
+      ad = ModelsDiagram.new(options)
+      files = ad.get_files("test/file_fixture/")
+      files.size.must_equal 4
+    end
+
     it 'should exclude a specific file' do
       options = OptionsStruct.new(:exclude => ['test/file_fixture/app/models/dummy1.rb'])
       md = ModelsDiagram.new(options)
@@ -45,5 +52,14 @@ describe ModelsDiagram do
       files.size.must_equal 1
     end
 
+    it "should include engine files" do
+      options = OptionsStruct.new(:engine_models => true)
+      md = ModelsDiagram.new(options)
+      engines = [OpenStruct.new(:root => "test/file_fixture/lib")]
+      md.stub(:engines, engines) do
+        md.get_files.must_include("test/file_fixture/lib/app/models/dummy1.rb")
+      end
+    end
+    
   end
 end

data/test/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'minitest-spec-context'
+require 'minitest/spec'
 require 'active_support/core_ext/string'
 require File.expand_path('../../lib/railroady.rb', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railroady
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Preston Lee
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,20 +55,6 @@ dependencies:
     - - ">="
       - !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
@@ -102,6 +88,7 @@ files:
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.rdoc
 - README.rdoc
 - Rakefile
@@ -121,9 +108,12 @@ files:
 - test/file_fixture/app/controllers/dummy1_controller.rb
 - test/file_fixture/app/controllers/dummy2_controller.rb
 - test/file_fixture/app/controllers/sub-dir/sub_dummy_controller.rb
+- test/file_fixture/app/models/concerns/taggable.rb
 - test/file_fixture/app/models/dummy1.rb
 - test/file_fixture/app/models/dummy2.rb
 - test/file_fixture/app/models/sub-dir/sub_dummy.rb
+- test/file_fixture/lib/app/controllers/dummy/dummy_controller.rb
+- test/file_fixture/lib/app/models/dummy1.rb
 - test/lib/railroady/aasm_diagram_spec.rb
 - test/lib/railroady/app_diagram_spec.rb
 - test/lib/railroady/controllers_diagram_spec.rb
@@ -151,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails 3/4 model and controller UML class diagram generator.
@@ -160,9 +150,12 @@ test_files:
 - test/file_fixture/app/controllers/dummy1_controller.rb
 - test/file_fixture/app/controllers/dummy2_controller.rb
 - test/file_fixture/app/controllers/sub-dir/sub_dummy_controller.rb
+- test/file_fixture/app/models/concerns/taggable.rb
 - test/file_fixture/app/models/dummy1.rb
 - test/file_fixture/app/models/dummy2.rb
 - test/file_fixture/app/models/sub-dir/sub_dummy.rb
+- test/file_fixture/lib/app/controllers/dummy/dummy_controller.rb
+- test/file_fixture/lib/app/models/dummy1.rb
 - test/lib/railroady/aasm_diagram_spec.rb
 - test/lib/railroady/app_diagram_spec.rb
 - test/lib/railroady/controllers_diagram_spec.rb