ruby-uml 0.2.2

data/README

@@ -0,0 +1,61 @@
+= Goal
+
+<tt>ruby-uml</tt> tries to trace different aspects of an existing application,
+which is intended to provide support for refactorisations by generating
+UML-graphs.
+
+<tt>ruby-uml</tt> is able to generate textual representations of the gathered
+informations.
+
+These representations include pic- or dot-code that can be converted to images
+by their corresponding applications.
+
+At this time <tt>ruby-uml</tt> is able to generate sequence- and class-diagrams.
+
+As you won't get that much information out of the trace, the resulting dot- or
+pic-files are intended to be as readable as possible, so that manual
+corrections/additions are made as easy as possible.
+
+= Dependencies
+== Gem dependencies:
+
+diff-lcs:: >= 1.1.2
+	
+== Other dependencies:
+
+ruby:: ruby-uml is tested with 1.8.5
+
+aspectr:: There are three aspectr projects known to me:
+
+          0.3.5:: http://sourceforge.net/projects/aspectr/
+          
+          0.3.6:: http://rubyforge.org/projects/aspectr/
+          
+          0.4.0:: http://sourceforge.net/projects/aspectr-fork/
+          
+          - None of them seem to be maintained anymore.
+          - Everyone provides the functionality needed for ruby-uml.
+          - Everyone seems to have issues on ruby 1.8.5.
+          In the additional folder i provide a patch for 0.4.0
+          which resolved all issues for me on linux and cygwin.
+	
+UMLGraph:: http://www.spinellis.gr/sw/umlgraph/
+
+           ruby-uml uses the sequence.pic file from the UMLGraph Project
+           for generating sequence-diagrams out of pic files.
+
+           ruby-uml is tested with 4.6.
+
+GNU Plotutils:: http://www.gnu.org/software/plotutils/
+
+                Plotutils 'pic2plot' is used for generating
+                sequence-diagram-images out of pic files.
+	              
+                ruby-uml is tested with 2.4.1.
+	
+Graphviz:: http://graphviz.org/
+
+           Grapphviz 'dot' command is used to generate class-diagram-images
+           out of dot files.
+           
+           ruby-uml is tested with 2.12.

data/additional/aspectr-0-4-0.patch

@@ -0,0 +1,53 @@
+diff -uNr aspectr-0-4-0-orig/install.rb aspectr-0-4-0/install.rb
+--- aspectr-0-4-0-orig/install.rb	2007-02-10 15:36:50.229995653 +0100
++++ aspectr-0-4-0/install.rb	2007-02-10 16:02:55.456951649 +0100
+@@ -8,7 +8,7 @@
+ $libdir = File.join(CONFIG["libdir"], "ruby", $version)
+ 
+ $bindir =  CONFIG["bindir"]
+-$sitedir = CONFIG["sitedir"]
++$sitedir = CONFIG["sitelibdir"]
+ 
+ installdir = "" # Use top-level! Is this good?
+ 
+diff -uNr aspectr-0-4-0-orig/lib/aspectr.rb aspectr-0-4-0/lib/aspectr.rb
+--- aspectr-0-4-0-orig/lib/aspectr.rb	2007-02-10 15:36:50.238995384 +0100
++++ aspectr-0-4-0/lib/aspectr.rb	2007-02-10 15:38:00.062553460 +0100
+@@ -27,7 +27,7 @@
+     AROUND = :AROUND
+ 
+     def initialize(never_wrap = "^$ ")
+-      @never_wrap = /^__|^send$|^id$|^class$|#{never_wrap}/
++      @never_wrap = /^__|^send$|^id$|^object_id$|^class$|#{never_wrap}/
+     end
+ 
+     def wrap(target, pre, post, *args, &condition)
+@@ -146,7 +146,7 @@
+ 	    aspect.send(advice, method, *args)
+ 	  rescue Exception
+ 	    a = $!
+-	    raise AspectRException, "#{a.type} '#{a}' in advice #{advice}"
++	    raise AspectRException, "#{a.class} '#{a}' in advice #{advice}"
+ 	  end
+ 	end
+       end
+@@ -201,8 +201,8 @@
+ 	    begin
+ 	     exit_status = nil
+ 	     #{__aop_advice_call_syntax(PRE, method, args)}
+-	     exit_status = []
+-	     return (exit_status.push(#{__aop_around_advice_call_syntax(method, mangled_method, args)}).last)
++	     exit_status = #{__aop_around_advice_call_syntax(method, mangled_method, args)}
++             return exit_status
+ 	    rescue Exception
+ puts \"got exception: \#{$!}\"
+ 	     exit_status = true
+@@ -246,7 +246,7 @@
+       end
+       
+       def __aop_mangle(method)
+-	"__aop__#{self.object_id}_#{method.object_id}"['-'] = '_'
++	"__aop__#{self.object_id}_#{method.object_id}".gsub(/-/, '_')
+       end
+       
+       def __aop_alias(new, old, private = true)

data/bin/sequence_diagram_diff

@@ -0,0 +1,183 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require 'rubygems'
+gem 'diff-lcs'
+require 'diff/lcs'
+
+# limitations:
+# only one command per line
+
+# finds used object_names in array
+def find_used_object_names(array)
+  result = []
+  array.each do |line|
+    case line.strip
+    when /^(object|placeholder_object|pobject|actor|complete|active|inactive|delete|lifeline_constraint|lconstraint|lconstraint_below|begin_frame|end_frame|comment|connect_to_comment)[ ]*\(([^\), ]+)/
+      result << $2
+    when /^(message|return_message|rmessage|create_message|cmessage|destroy_message|dmessage)[ ]*\(([^, ]+),([^\), ]+)/
+      result << $2
+      result << $3
+    end
+  end
+  result.uniq
+end
+
+# find left- and rightmost object from used in objects
+# objects is array with order
+def find_frame_objects(used, objects)
+  indexes = used.collect { |u| objects.index(u) }
+  return objects[indexes.min], objects[indexes.max]
+end
+
+def find_lines(array, regexp)
+  result = []
+  array.each do |line|
+    case line.strip
+    when regexp
+      result << line
+    end
+  end
+  result
+end
+
+# finds lines with object_definitions
+def find_object_definitions(array)
+  find_lines array, /^(object|placeholder_object|pobject|actor)[ ]*\(/
+end
+
+def find_copies(array)
+  find_lines array, /^copy/
+end
+
+def find_object_completions(array)
+  find_lines array, /^complete[ ]*\(/
+end
+
+def find_messages(array)
+  find_lines array, /^(message|return_message|rmessage|create_message|cmessage|destroy_message|dmessage|active|inactive|delete|lifeline_constraint|lconstraint|lconstraint_below|begin_frame|end_frame|comment|connect_to_comment)[ ]*\(/
+end
+
+def find_variables(array)
+  find_lines array, /=/
+end
+
+def read_file(name)
+  IO.readlines(name)
+end
+
+def write_file(name, content)
+  open(name, 'w') do |f|
+    f.write content
+  end
+end
+
+def make_frame(content, all, name, label)
+  result = []
+  unless content.empty?
+	  bonds = find_frame_objects(find_used_object_names(content), all)
+		name = "#{name}_#{$frame_count += 1}"
+    result << "step();\n"
+    result << "begin_frame(#{bonds.first}, #{name}, \"#{label}\");\n"
+    result << "step();\n"
+    result += content
+    result << "step();\n"
+    result << "end_frame(#{bonds.last}, #{name});\n"
+    result << "step();\n"
+  end
+  result
+end
+
+def prepare_messages(left, right, all_objects)
+  result = []
+  eins = []
+  zwei = []
+  Diff::LCS.sdiff(left, right).each do |line|
+    case line.action
+    when '='
+      result << make_frame(eins, all_objects, 'Eins', $options[:left_title])
+      result << make_frame(zwei, all_objects, 'Zwei', $options[:right_title])
+			eins = []
+			zwei = []
+      result << line.old_element
+    when '!'
+      eins << line.old_element
+      zwei << line.new_element
+    when '+'
+      zwei << line.new_element
+    when '-'
+      eins << line.old_element 
+    end
+  end
+  result << make_frame(eins, all_objects, 'Eins', $options[:left_title])
+  result << make_frame(zwei, all_objects, 'Zwei', $options[:right_title])
+  result
+end
+
+
+
+
+
+$options = {
+  :left_title => 'before',
+  :right_title => 'after'
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #$0 [options] file1 file2"
+  
+  opts.on('--left-title MANDATORY', 'Title of left file') do |string|
+    $options[:left_title] = string
+  end
+  
+  opts.on('--right-title MANDATORY', 'Title of right file') do |string|
+    $options[:right_title] = string
+  end
+  
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+  
+end.parse!
+
+if ARGV.length != 2
+  puts 'Too view Files given'
+  exit
+end
+
+$frame_count = 0
+
+f1  = read_file(ARGV[0])
+v1  = find_variables(f1)
+c1  = find_copies(f1)
+od1 = find_object_definitions(f1)
+m1  = find_messages(f1)
+oc1 = find_object_completions(f1)
+
+f2  = read_file(ARGV[1])
+v2  = find_variables(f2)
+c2  = find_copies(f2)
+od2 = find_object_definitions(f2)
+m2  = find_messages(f2)
+oc2 = find_object_completions(f2)
+
+# so werden neue zeilen von File 2 an erste angehängt
+c  = (c1 + c2).uniq
+v  = (v1 + v2).uniq
+od = (od1 + od2).uniq
+o  = find_used_object_names(od)
+oc = (oc1 + oc2).uniq
+
+result = []
+result << ".PS\n"
+result += c
+result += v
+result += od
+result << "step();\n"
+result += prepare_messages(m1, m2, o)
+result << "step();\n"
+result += oc
+result << "\n.PE"
+puts result

data/examples/class_diagram_example.rb

@@ -0,0 +1,69 @@
+$:.push '../lib'
+
+require 'uml/class_diagram'
+
+module Automotive
+
+  class Car
+    def drive
+      2
+    end
+    
+    def steer
+      'hard'
+    end
+    
+    def honk
+      'toot'
+    end
+  end
+  
+  module FourWheelDrive
+    def drive
+      4
+    end
+  end
+  
+  module ServoSteering
+    def steer
+      'easy'
+    end
+  end
+  
+  class Rover < Car
+    include FourWheelDrive
+    include ServoSteering
+    
+    def honk
+      'roar'
+    end
+  end
+
+  class Mini < Car
+  end
+  
+  class Garage < Array
+    def impress_neighbours
+      each do |car|
+        car.honk
+      end
+    end
+  end
+
+end
+
+cd = UML::ClassDiagram.new :show_private_methods => false,
+  :show_protected_methods => false,
+  :show_public_methods => true,
+  :cluster_packages => true,
+  :include => [/^Automotive/]
+
+cd.include Automotive::Mini
+
+garage = Automotive::Garage.new
+garage << Automotive::Rover.new
+garage.impress_neighbours
+
+File.open('class_diagram_example.dot', 'w') { |file|
+  file.write cd.to_dot
+}

data/examples/highlevel_backtracer_example.rb

@@ -0,0 +1,47 @@
+$:.push '../lib'
+
+require 'uml/highlevel_backtracer'
+require 'temperature'
+
+ts = TempSensor.new
+ta = TempAlarm.new(ts)
+
+class HighlevelTest
+
+  def initialize
+    @tracer = UML::HighlevelBacktracer.new
+    @tracer.add_observer self
+  end
+  
+  def include(*args)
+    @tracer.include(*args)
+  end
+  
+  def update(event, tracer)
+    right = tracer.call_stack[-1]
+    left = tracer.call_stack[-2]
+    case event
+    when :call
+      if left
+        print "#{left[:real_klass]}.#{left[:method_symbol]}"
+      end
+        print " -> "
+      print "#{right[:real_klass]}.#{right[:method_symbol]}"
+      puts  "(#{right[:args].join(',')})"
+    when :return
+      if left
+        print "#{left[:real_klass]}.#{left[:method_symbol]}"
+      end
+        print " <- "
+      print "#{right[:real_klass]}.#{right[:method_symbol]}"
+      puts
+    end
+  end
+  
+end
+
+tracer = HighlevelTest.new
+tracer.include ts, :run, :changed, :notify_observers
+tracer.include ta, :update
+
+ts.run(25)

data/examples/sequence_diagram_example

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# generate sequence-diagram with old version of a library
+ruby -rtemperature_old sequence_diagram_generator.rb >sequence_diagram_example_old.pic
+pic2plot -Tps sequence_diagram_example_old.pic >sequence_diagram_example_old.ps
+
+# generate sequence-diagram with new version of a library
+ruby -rtemperature_new sequence_diagram_generator.rb >sequence_diagram_example_new.pic
+pic2plot -Tps sequence_diagram_example_new.pic >sequence_diagram_example_new.ps
+
+# generate combined sequence_diagram out the two
+../bin/sequence_diagram_diff sequence_diagram_example_old.pic sequence_diagram_example_new.pic >sequence_diagram_example.pic
+pic2plot -Tps sequence_diagram_example.pic >sequence_diagram_example.ps

data/examples/sequence_diagram_generator.rb

@@ -0,0 +1,41 @@
+$:.push '../lib'
+
+require 'uml/sequence_diagram'
+
+def callback(p)
+  case p
+  when Fixnum, TrueClass, FalseClass
+    p.to_s
+  when NilClass
+    'nil'
+  when Array
+    '[' << p.collect(&method(:callback)).join(',') << ']'
+  else
+    p.class
+  end
+end
+
+sd = UML::SequenceDiagram.new(
+  :split_inherited     => true,
+  :multiple_activation => true,
+  :use_create_message  => true,
+  :object_sequence     => ['Actor', 'TempSensor', 'Observable', 'Dummy', 'TempAlarm'],
+  :pic_variables       => {
+    :boxwid  =>  0.85,
+    :movewid =>  0.85,
+    :maxpswid => 50,
+    :maxpsht  => 50,
+  },
+  :parameter_callback => method(:callback)
+)
+
+ts = TempSensor.new
+
+sd.include ts, :run, :changed, :notify_observers, :add_observer
+sd.include TempAlarm, :update, :initialize
+sd.include IO, :puts
+
+ta = TempAlarm.new ts
+ts.run 27
+
+puts sd.to_pic