railroad 0.4.0 → 0.4.1

data/COPYING

@@ -1,14 +1,14 @@
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+=GNU GENERAL PUBLIC LICENSE
+Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
 
-			    Preamble
+==Preamble
 
-  The licenses for most software are designed to take away your
+The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
 License is intended to guarantee your freedom to share and change free
 software--to make sure the software is free for all its users.  This
@@ -18,48 +18,48 @@ using it.  (Some other Free Software Foundation software is covered by
 the GNU Library General Public License instead.)  You can apply it to
 your programs, too.
 
-  When we speak of free software, we are referring to freedom, not
+When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
 this service if you wish), that you receive source code or can get it
 if you want it, that you can change the software or use pieces of it
 in new free programs; and that you know you can do these things.
 
-  To protect your rights, we need to make restrictions that forbid
+To protect your rights, we need to make restrictions that forbid
 anyone to deny you these rights or to ask you to surrender the rights.
 These restrictions translate to certain responsibilities for you if you
 distribute copies of the software, or if you modify it.
 
-  For example, if you distribute copies of such a program, whether
+For example, if you distribute copies of such a program, whether
 gratis or for a fee, you must give the recipients all the rights that
 you have.  You must make sure that they, too, receive or can get the
 source code.  And you must show them these terms so they know their
 rights.
 
-  We protect your rights with two steps: (1) copyright the software, and
+We protect your rights with two steps: (1) copyright the software, and
 (2) offer you this license which gives you legal permission to copy,
 distribute and/or modify the software.
 
-  Also, for each author's protection and ours, we want to make certain
+Also, for each author's protection and ours, we want to make certain
 that everyone understands that there is no warranty for this free
 software.  If the software is modified by someone else and passed on, we
 want its recipients to know that what they have is not the original, so
 that any problems introduced by others will not reflect on the original
 authors' reputations.
 
-  Finally, any free program is threatened constantly by software
+Finally, any free program is threatened constantly by software
 patents.  We wish to avoid the danger that redistributors of a free
 program will individually obtain patent licenses, in effect making the
 program proprietary.  To prevent this, we have made it clear that any
 patent must be licensed for everyone's free use or not licensed at all.
 
-  The precise terms and conditions for copying, distribution and
+The precise terms and conditions for copying, distribution and
 modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-  0. This License applies to any program or other work which contains
+=GNU GENERAL PUBLIC LICENSE
+==TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0) This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
 under the terms of this General Public License.  The "Program", below,
 refers to any such program or work, and a "work based on the Program"
@@ -76,7 +76,7 @@ is covered only if its contents constitute a work based on the
 Program (independent of having been made by running the Program).
 Whether that is true depends on what the Program does.
 
-  1. You may copy and distribute verbatim copies of the Program's
+1) You may copy and distribute verbatim copies of the Program's
 source code as you receive it, in any medium, provided that you
 conspicuously and appropriately publish on each copy an appropriate
 copyright notice and disclaimer of warranty; keep intact all the
@@ -87,7 +87,7 @@ along with the Program.
 You may charge a fee for the physical act of transferring a copy, and
 you may at your option offer warranty protection in exchange for a fee.
 
-  2. You may modify your copy or copies of the Program or any portion
+2) You may modify your copy or copies of the Program or any portion
 of it, thus forming a work based on the Program, and copy and
 distribute such modifications or work under the terms of Section 1
 above, provided that you also meet all of these conditions:
@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -131,7 +131,7 @@ with the Program (or with a work based on the Program) on a volume of
 a storage or distribution medium does not bring the other work under
 the scope of this License.
 
-  3. You may copy and distribute the Program (or a work based on it,
+3) You may copy and distribute the Program (or a work based on it,
 under Section 2) in object code or executable form under the terms of
 Sections 1 and 2 above provided that you also do one of the following:
 
@@ -168,8 +168,8 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
-  4. You may not copy, modify, sublicense, or distribute the Program
+
+4) You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
 void, and will automatically terminate your rights under this License.
@@ -177,7 +177,7 @@ However, parties who have received copies, or rights, from you under
 this License will not have their licenses terminated so long as such
 parties remain in full compliance.
 
-  5. You are not required to accept this License, since you have not
+5) You are not required to accept this License, since you have not
 signed it.  However, nothing else grants you permission to modify or
 distribute the Program or its derivative works.  These actions are
 prohibited by law if you do not accept this License.  Therefore, by
@@ -186,7 +186,7 @@ Program), you indicate your acceptance of this License to do so, and
 all its terms and conditions for copying, distributing or modifying
 the Program or works based on it.
 
-  6. Each time you redistribute the Program (or any work based on the
+6) Each time you redistribute the Program (or any work based on the
 Program), the recipient automatically receives a license from the
 original licensor to copy, distribute or modify the Program subject to
 these terms and conditions.  You may not impose any further
@@ -194,7 +194,7 @@ restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties to
 this License.
 
-  7. If, as a consequence of a court judgment or allegation of patent
+7) If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
@@ -225,8 +225,8 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
-  8. If the distribution and/or use of the Program is restricted in
+
+8) If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
 may add an explicit geographical distribution limitation excluding
@@ -234,7 +234,7 @@ those countries, so that distribution is permitted only in or among
 countries not thus excluded.  In such case, this License incorporates
 the limitation as if written in the body of this License.
 
-  9. The Free Software Foundation may publish revised and/or new versions
+9) The Free Software Foundation may publish revised and/or new versions
 of the General Public License from time to time.  Such new versions will
 be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
@@ -247,7 +247,7 @@ Software Foundation.  If the Program does not specify a version number of
 this License, you may choose any version ever published by the Free Software
 Foundation.
 
-  10. If you wish to incorporate parts of the Program into other free
+10) If you wish to incorporate parts of the Program into other free
 programs whose distribution conditions are different, write to the author
 to ask for permission.  For software which is copyrighted by the Free
 Software Foundation, write to the Free Software Foundation; we sometimes
@@ -255,9 +255,9 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-			    NO WARRANTY
+==NO WARRANTY
 
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+11) BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
@@ -267,7 +267,7 @@ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
 REPAIR OR CORRECTION.
 
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+12) IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
@@ -277,15 +277,15 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
+==END OF TERMS AND CONDITIONS
+
+=How to Apply These Terms to Your New Programs
 
-  If you develop a new program, and you want it to be of the greatest
+If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
 free software which everyone can redistribute and change under these terms.
 
-  To do so, attach the following notices to the program.  It is safest
+To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.

data/ChangeLog

@@ -1,3 +1,6 @@
+Version 0.4.1 (may 9 2008)
+- Fix a bug (class name treated as String).
+
 Version 0.4.0 (apr 25 2007)
 - Draw inheritance edges in reverse way
   (from superclass to subclass, with an arrow in the tail)

data/README

@@ -139,4 +139,6 @@ License, or (at your option) any later version.
 
 = Author
 
-Javier Smaldone (javier -at- smaldone -dot- com -dot- ar)
+Javier Smaldone 
+(javier -at- smaldone -dot- com -dot- ar, http://blog.smaldone.com.ar )
+

data/bin/railroad

@@ -16,7 +16,7 @@
 
 APP_NAME       = "railroad"
 APP_HUMAN_NAME = "RailRoad"
-APP_VERSION    = [0,4,0]
+APP_VERSION    = [0,4,1]
 COPYRIGHT      = "Copyright (C) 2007 Javier Smaldone"
 
 require 'railroad/options_struct'

data/lib/railroad/app_diagram.rb

@@ -32,10 +32,14 @@ class AppDiagram
         exit 2
       end
     end
- 
-    STDERR.print "Generating DOT graph\n" if @options.verbose
-
-    STDOUT.print @graph.to_dot 
+    
+    if @options.xmi 
+        STDERR.print "Generating XMI diagram\n" if @options.verbose
+    	STDOUT.print @graph.to_xmi
+    else
+        STDERR.print "Generating DOT graph\n" if @options.verbose
+        STDOUT.print @graph.to_dot 
+    end
 
     if @options.output
       STDOUT.reopen(old_stdout)

data/lib/railroad/controllers_diagram.rb

@@ -10,7 +10,7 @@ require 'railroad/app_diagram'
 class ControllersDiagram < AppDiagram
  
   def initialize(options)
-    options.exclude.map! {|e| e = "app/controllers/" + e}
+    options.exclude.map! {|e| "app/controllers/" + e}
     super options
     @graph.diagram_type = 'Controllers'
   end
@@ -76,7 +76,6 @@ class ControllersDiagram < AppDiagram
     # Generate the inheritance edge (only for ApplicationControllers)
     if @options.inheritance && 
        (ApplicationController.subclasses.include? current_class.name)
-       # REVERSE INHERITANCE (CHECK)
       @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end
   end # process_class

data/lib/railroad/diagram_graph.rb

@@ -39,6 +39,12 @@ class DiagramGraph
            @edges.map{|e| dot_edge e[0], e[1], e[2], e[3]}.join +
            dot_footer
   end
+  
+  # Generate XMI diagram (not yet implemented)
+  def to_xmi
+     STDERR.print "Sorry. XMI output not yet implemented.\n\n"
+     return ""
+  end
 
   private
 
@@ -58,7 +64,7 @@ class DiagramGraph
   # Build diagram label
   def dot_label
     return "\t_diagram_info [shape=\"plaintext\", " +
-           "label=\"Diagram: #{@diagram_type}\\l" +
+           "label=\"#{@diagram_type} diagram\\l" +
            "Date: #{Time.now.strftime "%b %d %Y - %H:%M"}\\l" + 
            "Migration version: " +
            "#{ActiveRecord::Migrator.current_version}\\l" +
@@ -106,8 +112,6 @@ class DiagramGraph
       when 'many-many'
            options += 'taillabel="n", headlabel="n", arrowtail="normal"'
       when 'is-a'
-# REVERSE INHERITANCE (CHECK)
-#           options += 'arrowhead="onormal"'
            options += 'arrowhead="none", arrowtail="onormal"'
     end
     return "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
@@ -115,7 +119,7 @@ class DiagramGraph
 
   # Quotes a class name
   def quote(name)
-    '"' + name + '"'
+    '"' + name.to_s + '"'
   end
   
 end # class DiagramGraph

data/lib/railroad/models_diagram.rb

@@ -10,7 +10,7 @@ require 'railroad/app_diagram'
 class ModelsDiagram < AppDiagram
 
   def initialize(options)
-    options.exclude.map! {|e| e = "app/models/" + e}
+    options.exclude.map! {|e| "app/models/" + e}
     super options 
     @graph.diagram_type = 'Models'
     # Processed habtm associations
@@ -90,7 +90,6 @@ class ModelsDiagram < AppDiagram
     if @options.inheritance && generated && 
        (current_class.superclass != ActiveRecord::Base) &&
        (current_class.superclass != Object)
-       # REVERSE INHERITANCE (CHECK)
       @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end      
 

data/lib/railroad/options_struct.rb

@@ -25,7 +25,7 @@ class OptionsStruct < OpenStruct
                      :hide_private => false,
                      :transitive => false,
                      :verbose => false,
-                     # :xmi => false,
+                     :xmi => false,
                      :command => '' }
     super(init_options)
   end # initialize
@@ -57,11 +57,10 @@ class OptionsStruct < OpenStruct
               "  (produce messages to STDOUT)") do |v|
         self.verbose = v
       end
-      # TODO: Add XMI output.
-      # opts.on("-x", "--xmi", "Produce XMI instead of DOT", 
-      #         "  (for UML tools)") do |x|
-      #   self.xmi = x
-      # 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", 

data/rake.gemspec

@@ -1,7 +1,7 @@
 require 'rubygems'
 SPEC = Gem::Specification.new do |s|
   s.name         = "railroad"
-  s.version      = "0.4.0"
+  s.version      = "0.4.1"
   s.author       = "Javier Smaldone"
   s.email        = "javier@smaldone.com.ar"
   s.homepage     = "http://railroad.rubyforge.org"

metadata

@@ -1,33 +1,27 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: railroad
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2007-04-25 00:00:00 -03:00
-summary: A DOT diagram generator for Ruby on Rail applications
-require_paths: 
-- lib
-email: javier@smaldone.com.ar
-homepage: http://railroad.rubyforge.org
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: railroad
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.4.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Javier Smaldone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-09 00:00:00 -03:00
+default_executable: railroad
+dependencies: []
+
+description: 
+email: javier@smaldone.com.ar
+executables: 
+- railroad
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
 files: 
 - lib/railroad/models_diagram.rb
 - lib/railroad/app_diagram.rb
@@ -38,18 +32,31 @@ files:
 - COPYING
 - rake.gemspec
 - README
-test_files: []
-
+has_rdoc: true
+homepage: http://railroad.rubyforge.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- COPYING
-executables: 
-- railroad
-extensions: []
-
+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: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: A DOT diagram generator for Ruby on Rail applications
+test_files: []