prailroady 1.5.3

data/lib/prailroady/railtie.rb

@@ -0,0 +1,11 @@
+require 'prailroady'
+require 'rails'
+module PrailRoady
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      f = File.join(File.dirname(__FILE__), '..', '..', 'tasks', 'prailroady.rake')
+      load f
+      # load 'tasks/prailroady.rake'
+    end
+  end
+end

data/lib/prailroady/version.rb

@@ -0,0 +1,3 @@
+module PrailRoady
+  VERSION = '1.5.3'
+end

data/prailroady.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prailroady/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prailroady'
+  spec.version       = PrailRoady::VERSION
+  spec.authors       = ['SaKKo']
+  spec.description  = "Plantuml Ruby on Rails 3/4/5 model class diagram generator. Originally based on the 'preston/railroady' plugin and contributions of many others."
+  spec.email        = ['saklism@gmail.com']
+  spec.summary      = 'Ruby on Rails 3/4/5 model UML class diagram generator.'
+  spec.homepage      = 'http://github.com/sakko/prailroady'
+  spec.license       = 'GPL-2.0'
+
+  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']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'activesupport'
+end

data/tasks/prailroady.rake

@@ -0,0 +1,139 @@
+# 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
+
+# wrap helper methods so they don't conflict w/ methods on Object
+
+require 'rbconfig'
+
+module PrailRoady
+  class RakeHelpers
+    def self.format
+      @@DIAGRAM_FORMAT ||= 'svg'
+    end
+
+    # Returns an absolute path for the following file.
+    def self.full_path(name = 'test.txt')
+      f = File.join(Rails.root.to_s.gsub(' ', '\ '), 'doc', name)
+      f.to_s
+    end
+
+    def self.sed
+      regex = 's/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g'
+      case RbConfig::CONFIG['host_os']
+      when /linux/
+        return "sed -r '#{regex}'"
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        return "sed -r \"#{regex}\""
+      when /mac|darwin|bsd/
+        return "sed -E '#{regex}'"
+      else
+        fail NotImplementedError
+      end
+    end
+  end
+end
+
+namespace :diagram do
+  @MODELS_ALL         = PrailRoady::RakeHelpers.full_path("models_complete.#{PrailRoady::RakeHelpers.format}").freeze
+  @MODELS_BRIEF       = PrailRoady::RakeHelpers.full_path("models_brief.#{PrailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_ALL    = PrailRoady::RakeHelpers.full_path("controllers_complete.#{PrailRoady::RakeHelpers.format}").freeze
+  @CONTROLLERS_BRIEF  = PrailRoady::RakeHelpers.full_path("controllers_brief.#{PrailRoady::RakeHelpers.format}").freeze
+  @SED                = PrailRoady::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.exist?('doc')
+    end
+  end
+
+  namespace :models do
+    desc 'Generates brief and complete class diagrams for all models.'
+    task all: ['diagram:setup:create_new_doc_folder_if_needed', 'diagram:models:complete', 'diagram:models:brief']
+
+    desc 'Generates a class diagram for all models.'
+    task :complete do
+      f = @MODELS_ALL
+      puts "Generating #{f}"
+      sh "prailroady -lamM | #{@SED} | dot -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+
+    desc 'Generates an abbreviated class diagram for all models.'
+    task :brief do
+      f = @MODELS_BRIEF
+      puts "Generating #{f}"
+      sh "prailroady -blamM | #{@SED} | dot -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+
+    desc 'Generates a class diagram for all models including those in engines'
+    task :complete_with_engines do
+      f = @MODELS_ALL
+      puts "Generating #{f}"
+      sh "prailroady -ilamzM | #{@SED} | dot -T#{PrailRoady::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 "prailroady -bilamzM | #{@SED} | dot -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+  end
+
+  namespace :controllers do
+    desc 'Generates brief and complete class diagrams for all controllers.'
+    task all: ['diagram:setup:create_new_doc_folder_if_needed', 'diagram:controllers:complete', 'diagram:controllers:brief']
+
+    desc 'Generates a class diagram for all controllers.'
+    task :complete do
+      f = @CONTROLLERS_ALL
+      puts "Generating #{f}"
+      sh "prailroady -lC | #{@SED} | neato -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+
+    desc 'Generates an abbreviated class diagram for all controllers.'
+    task :brief do
+      f = @CONTROLLERS_BRIEF
+      puts "Generating #{f}"
+      sh "prailroady -blC | #{@SED} | neato -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+
+    desc 'Generates a class diagram for all controllers including those in engines'
+    task :complete_with_engines do
+      f = @CONTROLLERS_ALL
+      puts "Generating #{f}"
+      sh "prailroady -ilC --engine-controllers | #{@SED} | neato -T#{PrailRoady::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 "prailroady -bilC --engine-controllers | #{@SED} | neato -T#{PrailRoady::RakeHelpers.format} > #{f}"
+    end
+  end
+
+  desc 'Generates all class diagrams.'
+  task all: [
+    'diagram:setup:create_new_doc_folder_if_needed',
+    'diagram:models:complete',
+    'diagram:models:brief',
+    'diagram:controllers:complete',
+    '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/file_fixture/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/file_fixture/app/models/concerns/author_settings.rb

@@ -0,0 +1,12 @@
+module AuthorSettings   
+  extend ActiveSupport::Concern
+
+  included do
+    before_validation :set_up_author
+  end
+
+  def set_up_author
+    self.created_by = 'Admin'
+    self.updated_by = 'Admin'
+  end
+end

data/test/lib/railroady/aasm_diagram_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe AasmDiagram do
+  describe 'file processing' do
+    it 'should select all the files under the models dir' do
+      ad = AasmDiagram.new
+      files = ad.get_files('test/file_fixture/')
+      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 5
+    end
+
+    it 'should exclude a specific file' do
+      options = OptionsStruct.new(exclude: ['test/file_fixture/app/models/dummy1.rb'])
+      ad = AasmDiagram.new(options)
+      files = ad.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should exclude a glob pattern of files' do
+      options = OptionsStruct.new(exclude: ['test/file_fixture/app/models/*/*.rb'])
+      ad = AasmDiagram.new(options)
+      files = ad.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should include only specific file' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/sub-dir/sub_dummy.rb'])
+      ad = AasmDiagram.new(options)
+      files = ad.get_files('test/file_fixture/')
+      files.size.must_equal 1
+    end
+
+    it 'should include only specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/{dummy1.rb,sub-dir/sub_dummy.rb}'])
+      ad = AasmDiagram.new(options)
+      files = ad.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should include only specified files and exclude specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/{dummy1.rb,sub-dir/sub_dummy.rb}'],
+                                  exclude: ['test/file_fixture/app/models/sub-dir/sub_dummy.rb'])
+      ad = AasmDiagram.new(options)
+      files = ad.get_files('test/file_fixture/')
+      files.size.must_equal 1
+    end
+  end
+end

data/test/lib/railroady/app_diagram_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe AppDiagram do
+  describe 'file name processing' do
+    it 'should extract a simple name' do
+      ad = AppDiagram.new
+      name = ad.instance_eval { extract_class_name('app/models/test_this.rb') }
+      name.must_equal 'TestThis'
+    end
+    it 'should constantize a name' do
+      'String'.constantize.must_equal String
+    end
+  end
+end

data/test/lib/railroady/controllers_diagram_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe ControllersDiagram do
+  describe 'file processing' do
+    it 'should select all the files under the controllers dir' do
+      cd = ControllersDiagram.new
+      files = cd.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/controllers/dummy1_controller.rb'])
+      cd = ControllersDiagram.new(options)
+      files = cd.get_files('test/file_fixture/')
+      files.size.must_equal 3
+    end
+
+    it 'should exclude a glob pattern of files' do
+      options = OptionsStruct.new(exclude: ['test/file_fixture/app/controllers/sub-dir/*.rb'])
+      cd = ControllersDiagram.new(options)
+      files = cd.get_files('test/file_fixture/')
+      files.size.must_equal 3
+    end
+
+    it 'should include only specific file' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/controllers/sub-dir/sub_dummy_controller.rb'])
+      cd = ControllersDiagram.new(options)
+      files = cd.get_files('test/file_fixture/')
+      files.size.must_equal 1
+    end
+
+    it 'should include only specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/controllers/{dummy1_*.rb,sub-dir/sub_dummy_controller.rb}'])
+      cd = ControllersDiagram.new(options)
+      files = cd.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should include only specified files and exclude specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/controllers/{dummy1_*.rb,sub-dir/sub_dummy_controller.rb}'],
+                                  exclude: ['test/file_fixture/app/controllers/sub-dir/sub_dummy_controller.rb'])
+      cd = ControllersDiagram.new(options)
+      files = cd.get_files('test/file_fixture/')
+      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/core_ext_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe String do
+  describe '#camelize' do
+    it 'should upper-camelcase a lower case and underscored word' do
+      'lower_case_and_underscored_word'.camelize.must_equal 'LowerCaseAndUnderscoredWord'
+    end
+
+    it 'should lower-camelcase a lower case and underscored word when the :lower parameter is passed' do
+      'lower_case_and_underscored_word'.camelize(:lower).must_equal 'lowerCaseAndUnderscoredWord'
+    end
+  end
+end

data/test/lib/railroady/diagram_graph_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+module CustomDotMatchers
+  class HaveDotOptions
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(target)
+      @target = target
+      return false unless @target =~ /\[(.*)\]/
+      @options = Regexp.last_match(1)
+      @options == @expected
+    end
+
+    def failure_message
+      "expected '#{@target.strip}' to have options '[#{@expected}]'"
+    end
+
+    def negative_failure_message
+      "expected '#{@target.strip}' to not have options '[#{@expected}]'"
+    end
+
+    def description
+      'have dot options'
+    end
+  end
+  def have_dot_options(expected)
+    HaveDotOptions.new expected
+  end
+end
+
+describe DiagramGraph do
+  include CustomDotMatchers
+
+  before 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
+
+  #   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
+end

data/test/lib/railroady/models_diagram_spec.rb

@@ -0,0 +1,162 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe ModelsDiagram do
+  describe 'file  processing' do
+    it 'should select all the files under the models dir' do
+      md = ModelsDiagram.new
+      files = md.get_files('test/file_fixture/')
+      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 5
+    end
+
+    it 'should exclude a specific file' do
+      options = OptionsStruct.new(exclude: ['test/file_fixture/app/models/dummy1.rb'])
+      md = ModelsDiagram.new(options)
+      files = md.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should exclude a glob pattern of files' do
+      options = OptionsStruct.new(exclude: ['test/file_fixture/app/models/*/*.rb'])
+      md = ModelsDiagram.new(options)
+      files = md.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should include only specific file' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/sub-dir/sub_dummy.rb'])
+      md = ModelsDiagram.new(options)
+      files = md.get_files('test/file_fixture/')
+      files.size.must_equal 1
+    end
+
+    it 'should include only specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/{dummy1.rb,sub-dir/sub_dummy.rb}'])
+      md = ModelsDiagram.new(options)
+      files = md.get_files('test/file_fixture/')
+      files.size.must_equal 2
+    end
+
+    it 'should include only specified files and exclude specified files' do
+      options = OptionsStruct.new(specify: ['test/file_fixture/app/models/{dummy1.rb,sub-dir/sub_dummy.rb}'],
+                                  exclude: ['test/file_fixture/app/models/sub-dir/sub_dummy.rb'])
+      md = ModelsDiagram.new(options)
+      files = md.get_files('test/file_fixture/')
+      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
+  
+  describe '#extract_class_name' do
+    describe 'class can be found' do
+      describe 'module without namespace' do
+        module AuthorSettings
+        end
+        
+        it 'does not take every models subdirectory as a namespace' do
+          md = ModelsDiagram.new(OptionsStruct.new)
+          
+          md.extract_class_name('test/file_fixture/app/models/concerns/author_settings.rb').must_equal 'AuthorSettings'
+        end
+      end
+      
+      describe 'module with parent namespace / class' do
+        class User
+          module Authentication
+          end
+        end
+        
+        it 'does not take every models subdirectory as a namespace' do
+          md = ModelsDiagram.new(OptionsStruct.new)
+          
+          md.extract_class_name('test/file_fixture/app/models/concerns/user/authentication.rb').must_equal 'User::Authentication'
+        end
+      end
+    end
+    
+    describe 'class cannot be found' do
+      it 'returns the full class name' do
+        md = ModelsDiagram.new(OptionsStruct.new)
+        
+        md.extract_class_name('test/file_fixture/app/models/concerns/dummy.rb').must_equal 'Concerns::Dummy'
+      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