peterhoeg-railroad 0.5.4

data/lib/options_struct.rb

@@ -0,0 +1,169 @@
+# 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 => [],
+                     :inheritance => false,
+                     :join => false,
+                     :label => false,
+                     :modules => false,
+                     :hide_magic => false,
+                     :hide_types => false,
+                     :hide_public => false,
+                     :hide_protected => false,
+                     :hide_private => false,
+                     :plugins_models => 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("-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.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("-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.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.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/railroad.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{railroad}
+  s.version = "0.5.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Hoeg", "Javier Smaldone"]
+  s.date = %q{2009-05-15}
+  s.default_executable = %q{railroad}
+  s.email = ["peter@hoeg.com", "p.hoeg@northwind.sg", "javier@smaldone.com.ar"]
+  s.executables = ["railroad"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "AUTHORS.rdoc",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/railroad",
+     "lib/aasm_diagram.rb",
+     "lib/app_diagram.rb",
+     "lib/controllers_diagram.rb",
+     "lib/diagram_graph.rb",
+     "lib/models_diagram.rb",
+     "lib/options_struct.rb",
+     "railroad.gemspec",
+     "spec/app_diagram_spec.rb",
+     "spec/railroad_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/peterhoeg/RailRoad}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A DOT diagram generator for Ruby on Rail applications}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/app_diagram_spec.rb",
+     "spec/railroad_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/app_diagram_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AppDiagram do
+  describe 'extracting filenames' do
+    describe 'without namespaces' do
+      it 'should work with a simple name' do
+        ad = AppDiagram.new
+        ad.extract_class_name('app/models/test_this.rb').should == 'TestThis'
+      end
+    end
+  end
+end

data/spec/railroad_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Railroad" do
+#  it "fails" do
+#    fail "hey buddy, you should probably rename this file and start specing for real"
+#  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'railroad'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: peterhoeg-railroad
+version: !ruby/object:Gem::Version 
+  version: 0.5.4
+platform: ruby
+authors: 
+- Peter Hoeg
+- Javier Smaldone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-15 00:00:00 -07:00
+default_executable: railroad
+dependencies: []
+
+description: 
+email: 
+- peter@hoeg.com
+- p.hoeg@northwind.sg
+- javier@smaldone.com.ar
+executables: 
+- railroad
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- AUTHORS.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- bin/railroad
+- lib/aasm_diagram.rb
+- lib/app_diagram.rb
+- lib/controllers_diagram.rb
+- lib/diagram_graph.rb
+- lib/models_diagram.rb
+- lib/options_struct.rb
+- railroad.gemspec
+- spec/app_diagram_spec.rb
+- spec/railroad_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/peterhoeg/RailRoad
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A DOT diagram generator for Ruby on Rail applications
+test_files: 
+- spec/spec_helper.rb
+- spec/app_diagram_spec.rb
+- spec/railroad_spec.rb