mkgraph 1.1.0

data/README

@@ -0,0 +1,6 @@
+Mkgraph
+=======
+
+A class dependency visualiser
+
+

data/lib/mgopts.yml

@@ -0,0 +1,9 @@
+Log Options:
+  format: brief 	# brief or full
+  output: stderr	# stderr, stdout or file name
+  level: WARN			# INFO, WARN or FATAL
+Labels:
+  root: Entry Point
+  root comment: The Root Comment
+Output:
+  image name: view.png

data/lib/mkgraph.rb

@@ -0,0 +1,307 @@
+
+#
+## $Author :: Cliff
+## $Version:: 1v0
+##
+##
+#
+
+require 'rubygems'
+require 'graphviz'
+require 'tree'
+require 'logger'
+require 'yaml'
+
+#
+# Example  : Mkgraph#new <ruby.rb> - initialise 
+#            Mkgraph#run           - process file
+#            Mkgraph#make_image    - create the image file
+#            Mkgraph#show_image    - display the image file
+#
+# Arguments: The file to be visualised when creating a new instance
+#
+# Note     : A valid mgopts.yml must be in the working directory.
+# ==           You could copy a template file from the gem installation directory.
+#  
+
+class Mkgraph
+
+  #
+  # Initialise 
+  #
+  # Params: The name of the file to be processed
+  #
+  def initialize pattern
+
+    begin
+      $yml = YAML.load_file 'mgopts.yml'
+    rescue Exception => e
+      print e.message + "\n"
+      print "You could use the default \'mgopts.yml\' file in the installation\n"
+      print "directory as a template.\n"
+      print "Example:\n"
+
+      tip = <<-EOS
+        Log Options:
+          format: brief   # brief or full
+          output: stderr  # stderr, stdout or file name
+          level: WARN     # INFO, WARN or FATAL
+        Labels:
+          root: Entry Point
+          root comment: The Root Comment
+        Output:
+          image name: view.png      
+      EOS
+
+      puts "#{tip}"
+      exit 1
+    end
+
+    # puts $yml['sectionA']['user'] + "**************\n"
+    # puts $yml['sectionB']['file'] + "**************\n"
+    log_fmt = $yml['Log Options']['format']
+
+    log_opt = $yml['Log Options']['output']
+    case log_opt
+    when 'stderr'
+      log_op = $stderr
+    when 'stdout'
+      log_op = $stdout
+    else
+      log_op = log_opt
+    end
+
+    loglev = $yml['Log Options']['level']
+    case loglev
+    when 'INFO'
+      ll = Logger::INFO
+    when 'WARN'
+      ll = Logger::WARN
+    else
+      ll = Logger::FATAL
+    end
+
+    @file_pattern = pattern
+
+    $LOG = Logger.new(log_op).tap do |log|
+      log.progname = 'mkgraph'
+      log.level = ll # Logger::INFO # $yml['Log Options']['level']
+      if log_fmt == 'brief'
+        log.formatter = proc do |severity, datetime, progname, msg|
+          "#{progname}: #{msg}\n"
+        end
+      end
+    end
+
+    $LOG.info "Pattern: " + @file_pattern
+    # Rough test for OS TODO
+    if RUBY_PLATFORM.include?("linux") == false
+      $windows = true
+    else
+      $windows = false
+    end
+  end
+
+  #
+  # Does the work.
+  # Params: None
+  #
+  def run
+    end_count           = 0
+    end_expected        = 0            # how many ends before class end
+    class_end_expected  = 0            # how many class ends we expect (internal definitions)
+    cname               = ""
+    in_class            = false
+    parent_class_name   = nil
+    print_parent        = true
+
+    $iname = $yml['Output']['image name']
+
+    $root_node = Tree::TreeNode.new($yml['Labels']['root'], $yml['Labels']['root comment'])
+    tnode = $root_node
+
+    # Process all file matching @file_pattern
+    Dir.glob(@file_pattern) do |file|
+
+      $LOG.info "Looking at file - " + file
+      ignore = false
+
+      next if file == '.' or file == '..'
+
+      # Process each line in the file
+      File.open(file) do |f|
+        f.each_line do |line|
+
+          # Ignore =begin/=end blocks
+          if line.match(/^=end/) != nil
+            ignore = false
+          elsif line.match(/^=begin/) != nil
+            ignore = true
+          else
+            nil
+          end
+
+          next if ignore == true
+
+          # Process the line read from file
+          case line
+          when /^\s*#/
+            nil
+          when /\s*when.*new/     # only to avoid this situation HERE
+            nil
+          when /\'\.new/          # only to avoid the situation in line.split('.new')
+            nil
+          when /\.new/
+            name = line.split('.new')
+            cname = name[0].split.last
+            if in_class == true
+              $LOG.debug "NEW INSTANCE OF CLASS = [" + cname + "] created in class " + parent_class_name
+              tnode = proc_node tnode, parent_class_name, cname, false, false
+            else
+              if true == print_parent
+                $LOG.debug "NEW INSTANCE OF CLASS = [" + cname + "] created outside any parent class"
+                tnode = proc_node tnode, parent_class_name, cname, true, true
+              end
+            end
+          when /^\s*elsif/
+            nil
+          when /^\s*class[\s]+/
+            parent_class_name = line.split(' ')[1]
+            class_end_expected += 1
+            in_class = true
+            if print_parent == true
+              $LOG.info "Start of class " + parent_class_name
+            end
+            tnode = proc_node tnode, $root_node.name, parent_class_name, true, false
+          when /^\s*begin/
+            end_expected += 1
+          when /^.*if /
+            end_expected += 1
+          when /^\s*def /
+            end_expected += 1
+          when /^.* do/
+            end_expected += 1
+          when /^\s*case/
+            end_expected += 1
+          when /^\s*end[\s.]/
+            if end_expected == 0
+              if class_end_expected > 0
+                class_end_expected -= 1
+                in_class = false
+                if print_parent == true && parent_class_name != nil
+                  $LOG.info "End of class " + parent_class_name
+                end
+                parent_class_name = nil
+              end
+            else
+              end_expected -= 1
+            end
+          end      # case
+        end
+      end
+    end    
+  end
+
+  private
+  # Recursive method used to find a name (ID) in the Tree object
+  def find_leaf root, sname
+
+    $LOG.debug "find_leaf searching for: [" + sname + "] This Root is " + root.name
+    r = root
+
+    if root != nil && root.name != sname
+      root.children { |child|
+        r = find_leaf child, sname
+        break if r.name == sname
+      }
+    else
+      $LOG.info "NIL OR FOUND [" + root.name + "]"
+      r = root
+    end
+    $LOG.info "find_leaf returning: [" + r.name + "]"
+    r
+  end
+
+  # Process a line of interest i.e. when a class is being
+  # defined or instanciated etc. Called from the 'run' method
+  def proc_node root, par, child, join_to_root, used
+    begin
+      if join_to_root == true
+        if true == used
+           $root_node << Tree::TreeNode.new(child, "child")
+        else
+           $root_node << Tree::TreeNode.new(child, "orphan")
+        end
+      else
+        $LOG.info "NEED TO ATTACH " + child + " TO: " + par
+        r = find_leaf root, par
+        $LOG.info "AFTER FIND_LEAF: " + r.name
+        r << Tree::TreeNode.new(child, "used")
+      end
+    rescue Exception => e
+      $LOG.info e.message
+      $LOG.info "***** Processing node " + "None" + " --> " + child.to_s
+    end
+    # $root_node.printTree
+
+    root
+  end
+
+  # Recursive method to add elements from the Tree to the GraphViz Tree
+  def add_element g, root
+    if root.hasChildren? == true
+      root.children { |child|
+        add_element g, child
+      }
+    end
+
+    if root.isRoot?
+      g.add_node root.name, {:label => "{{" + root.name + "|" + root.content + "}|" + "Root}", :style => "filled", :fillcolor => "lightblue", :shape => "record", :color =>"black"}
+    else
+      g.add_node root.name , {:shape => "egg", :color =>"violet"}
+    end
+
+    if ! root.isRoot?
+      # Add an edge to the parent
+      if root.content == "orphan"
+        g.add_edge(root.parent.name, root.name, :label => root.parent.name + " contains " + root.name, :color => "red", :fontcolor => "red")
+      else
+        g.add_edge(root.parent.name, root.name, :label => root.parent.name + " uses " + root.name, :color => "blue", :fontcolor => "blue")
+      end
+
+    end
+    g
+  end
+
+  public
+  # Use Graphviz to create the image file
+  def make_image 
+    g = GraphViz.new( :G, :rankdir => "TB", :type => :digraph, :bgcolor => "lightgrey", :nodesep => 0.85, :normalize => true, :concentrate => true)
+    root = $root_node
+    g = add_element g, root
+    if $windows != true
+      res = system("rm " + $iname + " > /dev/null")
+    end
+    begin
+      g.output( :png => $iname)
+    rescue Exception => e
+      $LOG.warn e.message + "\n"
+    end
+  end
+
+  # Display the image file
+  def show_image 
+    begin
+      if $windows != true
+        res = system("pkill eog; " + $yml['Osdep']['viewer'] + " " + $iname + " > /dev/null 2>&1")
+      else
+        res = system("call " + $yml['Osdep']['viewer'] + " " + $iname)
+      end
+      if res == false
+        raise "Bad Command"
+      end
+    rescue Exception => e
+      $LOG.info e.message
+    end
+  end    
+end

data/test/test_mkgraph.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -W0
+
+require 'rubygems'
+require 'test/unit'
+require 'mkgraph'
+
+$LOAD_PATH <<'.'<<'lib'
+
+
+me = File::basename($0)
+
+if ARGV.size > 0
+  file_pattern = ARGV[0]
+  if file_pattern == "me"
+    file_pattern = me
+    me = "XXXXX"
+    print "me = " + me
+  else
+	if ! File.exist?(ARGV[0])
+	  print "Cannot find file " + ARGV[0] + "\n"
+	  exit 1
+	end
+  end
+else
+  file_pattern = "**/*.rb"
+end
+
+# print "File pattern is " + file_pattern + "\n"
+a = Mkgraph.new file_pattern
+
+a.run
+
+a.make_image
+
+exit 0
+

data/test/tt.rb

@@ -0,0 +1,61 @@
+
+a = A.new
+E.new
+
+class E
+  def initialize
+  end
+end
+
+class A
+  def initialize
+  end
+
+  def m1
+    d = D.new  
+    E.new
+  end
+
+  def m2
+    b = B.new
+  end
+end
+
+class B
+  def initialize
+  end
+
+  def m1
+    A.new
+  end
+
+  def m2
+    C.new
+  end
+end
+
+class C
+  def initialize
+    A.new
+    B.new
+  end
+end
+
+
+class D
+  def initialize
+    # E.new
+  end
+end
+
+class l
+  def initialize
+  end
+end
+
+=begin
+class p
+  def initialize
+  end
+end  
+=end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mkgraph
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Cliff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+- !ruby/object:Gem::Dependency
+  name: tree
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: Create class dependancy graph. This is only partially complete.
+email: cliff@dev.win.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mkgraph.rb
+- test/test_mkgraph.rb
+- test/tt.rb
+- lib/mgopts.yml
+- README
+homepage: http://dev.win.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --title
+- Mkgraph
+- --main
+- README
+- --line-numbers
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: Dependancy Graph
+test_files: []