ruby-codegraph 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jan Xie (jan.h.xie@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,25 @@
+Graph For Your Ruby Code
+========================
+
+Use `graphviz` to generate class inheritance graph for your ruby code.
+
+Usage
+-----
+
+Basic usage:
+
+```shell
+> codegraph <dir>
+> open output.png
+```
+
+Get help:
+
+```shell
+> codegraph -h
+```
+
+Copyright
+---------
+
+[MIT License](https://github.com/janx/codegraph/blob/master/LICENSE)

data/bin/codegraph

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'optparse'
+require 'codegraph'
+
+options = {
+  graph_name: 'Code Graph',
+  engine: 'dot',
+  type: 'inheritance',
+  output: 'output',
+  format: 'png'
+}
+
+OptionParser.new do |opts|
+  opts.banner = <<USAGE
+Usage:
+
+  codegraph [options] <directory>
+
+USAGE
+
+  opts.separator "Options:"
+
+  opts.on("-n", "--name [NAME]", "Specify graph name") do |v|
+    options[:graph_name] = v
+  end
+
+  opts.on("-o", "--output [FILE]", "Specify a output file") do |v|
+    options[:output] = v
+  end
+
+  opts.on("-f", "--format [FORMAT]", "Specify the format of output, default to PNG") do |v|
+    options[:format] = v
+  end
+
+  opts.on("-t", "--type [TYPE]", %w(inheritance), "Graph type (inheritance). Default to inheritance") do |v|
+    options[:type] = v
+  end
+
+  opts.on("-e", "--engine [ENGINE]", %w(dot neato twopi fdp circo), "Layout engine for graphviz (dot, neato, twopi, fdp, circo), default to dot") do |v|
+    options[:engine] = v
+  end
+
+  opts.on("-v", "--version", "Show version") do |v|
+    puts "CodeGraph v#{CodeGraph::VERSION}"
+  end
+end.parse!
+
+if ARGV.size < 1
+  STDERR.puts "Error: You must supply a directory. Type 'codegraph -h' to get more information."
+  exit 1
+end
+
+klass = CodeGraph.const_get(options[:type].capitalize)
+graph = klass.new(ARGV[0], options)
+graph.generate

data/lib/codegraph/inheritance.rb

@@ -0,0 +1,72 @@
+module CodeGraph
+
+  class Inheritance
+
+    CLASS_REGEXP = /class\s+([A-Z][\w:]*)(?:\s*<\s*([A-Z][\w:]*))?/
+
+    def initialize(dir, options={})
+      @dir = dir
+      @options = options
+      @nodes = {}
+      @edges = {}
+
+      @g = GraphViz.new(
+        @options[:graph_name],
+        label: label,
+        type: :digraph,
+        use: @options[:engine],
+        rankdir: 'RL'
+      )
+    end
+
+    def generate
+      directory_scan
+      output
+    end
+
+    private
+
+    def label
+      "#{@options[:graph_name]} for #{File.expand_path @dir} at #{Time.now}"
+    end
+
+    def directory_scan
+      Dir["#{@dir}/**/*.rb"].each {|rb| class_scan(rb)}
+    end
+
+    def class_scan(file)
+      File.readlines(file).each do |line|
+        _, klass, parent = line.match(CLASS_REGEXP).to_a
+        if klass
+          add_node(klass)
+          if parent
+            add_node(parent)
+            add_edge(klass, parent)
+          end
+        end
+      end
+    end
+
+    def add_node(name)
+      if !@nodes.has_key?(name)
+        @nodes[name] = @g.add_nodes(name, shape: 'box')
+      end
+    end
+
+    def add_edge(from, to)
+      @edges[from] ||= {}
+      from_node, to_node = @nodes[from], @nodes[to]
+      if from_node && to_node && !@edges[from].has_key?(to)
+        @edges[from][to] = @g.add_edges(from_node, to_node, arrowhead: 'onormal')
+      end
+    end
+
+    def output
+      output_file = @options[:output]
+      output_file = "#{output_file}.#{@options[:format]}" if output_file !~ /\.#{@options[:format]}$/
+      @g.output(@options[:format] => output_file)
+    end
+
+  end
+
+end

data/lib/codegraph/version.rb

@@ -0,0 +1,3 @@
+module CodeGraph
+  VERSION = "0.0.1"
+end

data/lib/codegraph.rb

@@ -0,0 +1,3 @@
+require 'graphviz'
+require 'codegraph/version'
+require 'codegraph/inheritance'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ruby-codegraph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jan Xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Use codegraph to generate all kinds of graphviz graphs for you code,
+  to visualize things like class hierarchy.
+email:
+- jan.h.xie@gmail.com
+executables:
+- codegraph
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/codegraph.rb
+- lib/codegraph/version.rb
+- lib/codegraph/inheritance.rb
+- bin/codegraph
+- LICENSE
+- README.markdown
+homepage: https://github.com/janx/codegraph
+licenses: []
+post_install_message: 
+rdoc_options: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Generate graphviz graphs for your code.
+test_files: []