allenwei-railroad 0.7.8

data/lib/railroad/options_struct.rb

@@ -0,0 +1,193 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'ostruct'
+
+# RailRoad command line options parser
+class OptionsStruct < OpenStruct
+
+  require 'optparse'
+
+  def initialize
+    init_options = { :all => false,
+                     :brief => false,
+                     :exclude => [],
+                     :classes_by_files => {},
+                     :inheritance => false,
+                     :join => false,
+                     :label => false,
+                     :modules => false,
+                     :hide_magic => false,
+                     :hide_types => false,
+                     :hide_public => false,
+                     :hide_protected => false,
+                     :hide_private => false,
+                     :hide_underscore => false,
+                     :plugins_models => false,
+                     :libraries => false,
+                     :root => '',
+                     :transitive => false,
+                     :verbose => false,
+                     :xmi => false,
+                     :command => '' }
+    super(init_options)
+  end # initialize
+
+  def parse(args)
+    @opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{APP_NAME} [options] command"
+      opts.separator ""
+      opts.separator "Common options:"
+      opts.on("-b", "--brief", "Generate compact diagram",
+              "  (no attributes nor methods)") do |b|
+        self.brief = b
+      end
+      opts.on("-e", "--exclude=file1[,fileN]", Array, "Exclude given files") do |list|
+        self.exclude = list
+      end
+      opts.on("-c", "--class-map=file1,MyClass1[,fileN,MyClassN]", Array, "Map files to classes they contain") do |list|
+        self.classes_by_files = Hash[*list]
+      end
+      opts.on("-i", "--inheritance", "Include inheritance relations") do |i|
+        self.inheritance = i
+      end
+      opts.on("-l", "--label", "Add a label with diagram information",
+              "  (type, date, migration, version)") do |l|
+        self.label = l
+      end
+      opts.on("-o", "--output FILE", "Write diagram to file FILE") do |f|
+        self.output = f
+      end
+      opts.on("-r", "--root PATH", "Set PATH as the application root") do |r|
+        self.root = r
+      end
+      opts.on("-v", "--verbose", "Enable verbose output",
+              "  (produce messages to STDOUT)") do |v|
+        self.verbose = v
+      end
+      opts.on("-x", "--xmi", "Produce XMI instead of DOT",
+              "  (for UML tools)") do |x|
+        self.xmi = x
+      end
+      opts.on("-u", "--yuml", "Produce yuml instead of DOT",
+              "  (for http://yuml.me)") do |x|
+        self.yuml = x
+      end
+      opts.separator ""
+      opts.separator "Models diagram options:"
+      opts.on("-a", "--all", "Include all models",
+              "  (not only ActiveRecord::Base derived)") do |a|
+        self.all = a
+      end
+      opts.on("--hide-magic", "Hide magic field names") do |h|
+        self.hide_magic = h
+      end
+      opts.on("--hide-types", "Hide attributes type") do |h|
+        self.hide_types = h
+      end
+      opts.on("-j", "--join", "Concentrate edges") do |j|
+        self.join = j
+      end
+      opts.on("-m", "--modules", "Include modules") do |m|
+        self.modules = m
+      end
+      opts.on("-p", "--plugins-models", "Include plugins models") do |p|
+        self.plugins_models = p
+      end
+      opts.on("-y", "--libraries", "Include application library") do |y|
+        self.libraries = y
+      end
+      opts.on("-t", "--transitive", "Include transitive associations",
+              "(through inheritance)") do |t|
+        self.transitive = t
+      end
+      opts.separator ""
+      opts.separator "Controllers diagram options:"
+      opts.on("--hide-public", "Hide public methods") do |h|
+        self.hide_public = h
+      end
+      opts.on("--hide-protected", "Hide protected methods") do |h|
+        self.hide_protected = h
+      end
+      opts.on("--hide-private", "Hide private methods") do |h|
+        self.hide_private = h
+      end
+      opts.on("--hide-underscore", "Hide methods that begin with an underscore") do |h|
+        self.hide_underscore = h
+      end
+      opts.separator ""
+      opts.separator "Other options:"
+      opts.on("-h", "--help", "Show this message") do
+        STDOUT.print "#{opts}\n"
+        exit
+      end
+      opts.on("--version", "Show version and copyright") do
+        STDOUT.print "#{APP_HUMAN_NAME} version #{APP_VERSION.join('.')}\n\n" +
+                     "#{COPYRIGHT}\nThis is free software; see the source " +
+                     "for copying conditions.\n\n"
+        exit
+      end
+      opts.separator ""
+      opts.separator "Commands (you must supply one of these):"
+      opts.on("-M", "--models", "Generate models diagram") do |c|
+        if self.command != ''
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else
+          self.command = 'models'
+        end
+      end
+      opts.on("-C", "--controllers", "Generate controllers diagram") do |c|
+        if self.command != ''
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else
+          self.command = 'controllers'
+        end
+      end
+      # From Ana Nelson's patch
+      opts.on("-A", "--aasm", "Generate \"acts as state machine\" diagram") do |c|
+        if self.command == 'controllers'
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else
+          self.command = 'aasm'
+        end
+      end
+      opts.on("-L", "--lifecycle", "Generate \"Hobo::Lifecycle\" diagram") do |c|
+        if self.command == 'controllers'
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else
+          self.command = 'lifecycle'
+        end
+      end      
+      opts.separator ""
+      opts.separator "For bug reporting and additional information, please see:"
+      opts.separator "http://railroad.rubyforge.org/"
+    end # do
+
+    begin
+      @opt_parser.parse!(args)
+    rescue OptionParser::AmbiguousOption
+      option_error "Ambiguous option"
+    rescue OptionParser::InvalidOption
+      option_error "Invalid option"
+    rescue OptionParser::InvalidArgument
+      option_error "Invalid argument"
+    rescue OptionParser::MissingArgument
+      option_error "Missing argument"
+    end
+  end  # parse
+
+  private
+
+  def option_error(msg)
+    STDERR.print "Error: #{msg}\n\n #{@opt_parser}\n"
+    exit 1
+  end
+
+end  # class OptionsStruct

data/lib/railroad/tasks/diagrams.rake

@@ -0,0 +1,48 @@
+$:.unshift File.join(File.dirname(__FILE__), '../..')
+require 'railroad'
+
+namespace :doc do
+  namespace :diagrams do
+    desc "Draw model diagrams"
+    task :models => :environment do
+      doc_diagrams_generate(ModelsDiagram, 'models', '-a -m -t -M', 'neato')
+    end
+
+    desc "Draw controller diagrams"
+    task :controllers do
+      doc_diagrams_generate(ControllersDiagram, 'controllers', '-C', 'neato')
+    end
+
+    desc "Draw states diagrams"
+    task :states do
+      doc_diagrams_generate(AasmDiagram, 'states', '-A', 'dot')
+    end
+
+    desc "Draw Hobo::Lifecycle diagrams"
+    task :lifecycle do
+      doc_diagrams_generate(LifecycleDiagram, 'lifecycle', '-L', 'dot')
+    end
+end
+
+  desc "Draw controllers, models & states diagrams"
+  task :diagrams => %w(diagrams:models diagrams:controllers diagrams:states diagrams:lifecycle)
+end
+
+def doc_diagrams_generate(generator, type, options, dot_cmd)
+  options = OptionsStruct.new
+  options.parse "-v -j -l -i #{options}".split
+  
+  output_dir = "doc/diagrams"
+
+  FileUtils.mkdir(output_dir) unless File.exist?(output_dir)
+
+  diagram = generator.new options
+  diagram.generate
+  f=open("#{output_dir}/#{type}.dot", "w")
+  f.write(diagram.to_s)
+  f.close
+
+  sh "#{dot_cmd} -Tpng #{output_dir}/#{type}.dot -o #{output_dir}/#{type}.png"
+  sh "#{dot_cmd} -Tsvg #{output_dir}/#{type}.dot | sed 's/font-size:14.00/font-size:11px/g' > #{output_dir}/#{type}.svg"
+end
+

data/lib/railroad/tasks/diagrams.rb

@@ -0,0 +1 @@
+load 'railroad/tasks/diagrams.rake'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: allenwei-railroad
+version: !ruby/object:Gem::Version 
+  version: 0.7.8
+platform: ruby
+authors: 
+- Javier Smaldone
+- Thomas Ritz
+- Tien Dung
+- Factory Design Labs
+- Mike Mondragon
+- Tero Tilus
+- David Dollar
+- Bruno Michel
+- Allen Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 +08:00
+default_executable: railroad
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: RailRoad is a class diagrams generator for Ruby on Rails applications.
+email: digruby@gmail.com
+executables: 
+- railroad
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- COPYING
+- ChangeLog
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/railroad
+- init.rb
+- lib/railroad.rb
+- lib/railroad/aasm_diagram.rb
+- lib/railroad/app_diagram.rb
+- lib/railroad/controllers_diagram.rb
+- lib/railroad/diagram_graph.rb
+- lib/railroad/models_diagram.rb
+- lib/railroad/options_struct.rb
+- lib/railroad/tasks/diagrams.rb
+- lib/railroad/tasks/diagrams.rake
+has_rdoc: true
+homepage: http://railroad.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: railroad
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: A DOT diagram generator for Ruby on Rail applications
+test_files: []
+