code_node 0.0.1

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2012 Kevin Tonon
+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/cog/templates/code_node/generator.rb.erb

@@ -0,0 +1,8 @@
+<% if tool.explicit_require %>require '<%= tool.path %>'
+<% else %>require '<%= tool.name %>'
+<% end %>
+
+# Makes a graph of the project_source_path
+CodeNode.graph '<%= @name %>' do |g|
+  
+end

data/cog/templates/code_node/graph.dot.erb

@@ -0,0 +1,48 @@
+digraph
+{
+graph [rankdir="LR"]
+node [style="filled"]
+
+<% @graph.nodes.each do |node| %>
+<% if node.should_render? %>
+<%= node.key %> [label="<%= node.label %>" shape="<%= node.shape %>" fillcolor="<%= node.fillcolor %>" fontcolor="<%= node.fontcolor %>"];
+<% end %>
+<% end %>
+
+/* Contains */
+edge [color="#e8e8e8"]
+<% @graph.nodes.each do |node| %>
+<% if node.parent && node.should_render? && node.parent.should_render? %>
+<%= node.parent.key %> -> <%= node.key %>;
+<% end %>
+<% end %>
+
+/* Extended by */
+edge [color="#000000"]
+<% @graph.nodes.each do |node| %>
+<% node.extended_by.values.sort.each do |other| %>
+<% if node.should_render? && other.should_render? %>
+<%= node.key %> -> <%= other.key %>;
+<% end %>
+<% end %>
+<% end %>
+
+/* Includes */
+edge [color="#336699"]
+<% @graph.nodes.each do |node| %>
+<% node.includes.values.sort.each do |other| %>
+<% if node.should_render? && other.should_render? %>
+<%= node.key %> -> <%= other.key %>;
+<% end %>
+<% end %>
+<% end %>
+
+/* Inherits from */
+edge [color="#996633"]
+<% @graph.nodes.each do |node| %>
+<% if node.should_render? && node.inherits_from && node.inherits_from.should_render? %>
+<%= node.key %> -> <%= node.inherits_from.key %>;
+<% end %>
+<% end %>
+
+}

data/lib/code_node/cog_tool.rb

@@ -0,0 +1,15 @@
+require 'cog'
+
+# Register code_node as a tool with cog
+Cog::Config.instance.register_tool __FILE__ do |tool|
+
+  # Define how new code_node generators are created
+  #
+  # Add context as required by your generator template.
+  #
+  # When the block is executed, +self+ will be an instance of Cog::Config::Tool::GeneratorStamper
+  tool.stamp_generator do
+    stamp 'code_node/generator.rb', generator_dest, :absolute_destination => true
+  end
+  
+end

data/lib/code_node/dsl/graph_definer.rb

@@ -0,0 +1,13 @@
+module CodeNode
+  module DSL
+
+    class GraphDefiner
+
+      def initialize(graph)
+        @graph = graph
+      end
+      
+    end
+
+  end
+end

data/lib/code_node/dsl.rb

@@ -0,0 +1,7 @@
+require 'code_node/dsl/graph_definer.rb'
+
+module CodeNode
+  module DSL
+    
+  end
+end

data/lib/code_node/ir/class_node.rb

@@ -0,0 +1,22 @@
+require 'code_node/ir/node'
+
+module CodeNode
+  module IR
+    
+    class ClassNode < Node
+      def inherits_from=(super_node)
+        @inherits_from = super_node
+      end
+      def shape
+        :ellipse
+      end
+      def fillcolor
+        '#cccccc'
+      end
+      def fontcolor
+        '#000000'
+      end
+    end
+    
+  end  
+end

data/lib/code_node/ir/graph.rb

@@ -0,0 +1,66 @@
+require 'code_node/ir/class_node'
+require 'code_node/ir/module_node'
+
+module CodeNode
+  module IR
+
+    class Graph
+
+      attr_reader :scope
+
+      def initialize
+        @nodes = {}
+        @scope = []
+      end
+
+      def node_for(node_type, s, opt={}, &block)
+        name = if s.is_a? Symbol
+          s
+        elsif s[0] == :const
+          s[1]
+        elsif s[0] == :colon2
+          x = []
+          while s[0] == :colon2
+            x << s[2] ; s = s[1]
+          end
+          x << s[1]
+          x.reverse
+        elsif s[0] == :self
+          @scope.last.mark_as_singleton
+          nil
+        end
+        return if name.nil?
+    
+        node = if opt[:not_sure_if_nested]
+          if @scope.length > 1 && @scope[-2].find(name)
+            @scope[-2].find name
+          else
+            (node_type == :module ? ModuleNode : ClassNode).new(name)
+          end
+        else
+          (node_type == :module ? ModuleNode : ClassNode).new(name, @scope.last)
+        end
+
+        node = self << node
+        unless block.nil? || node.nil?
+          @scope << node
+          block.call node
+          @scope.pop
+        end
+        node
+      end
+  
+      def <<(node)
+        @nodes[node.key] ||= node
+        @nodes[node.key]
+      end
+      def [](key)
+        @nodes[key]
+      end
+      def nodes
+        @nodes.values.sort
+      end
+    end
+    
+  end  
+end

data/lib/code_node/ir/module_node.rb

@@ -0,0 +1,26 @@
+require 'code_node/ir/node'
+
+module CodeNode
+  module IR
+
+    class ModuleNode < Node
+      def shape
+        :box
+      end
+      def fillcolor
+        if children["#{key}_ClassMethods"] && extended_by['ActiveSupport_Concern']
+          '#000000'
+        else
+          '#666666'
+        end
+      end
+      def fontcolor
+        '#ffffff'
+      end
+      def mark_as_singleton
+        @singleton = true
+      end
+    end
+    
+  end  
+end

data/lib/code_node/ir/node.rb

@@ -0,0 +1,51 @@
+module CodeNode
+  module IR
+    
+    class Node
+      attr_reader :name, :parent, :children, :includes, :extended_by, :inherits_from
+      def initialize(name, parent = nil)
+        parent_path = parent ? parent.instance_eval {@path} : []
+        @path = if name.is_a? Array
+          parent_path + name
+        else
+          parent_path + [name]
+        end
+        @name = @path.last
+        @parent = parent
+        parent.children[key] = self unless parent.nil?
+        @children = {}
+        @includes = {}
+        @extended_by = {}
+      end
+      def find(name)
+        key = (@path + [name].flatten).join '_'
+        @children[key] || (orphan? ? nil : @parent.find(name))
+      end
+      def key
+        @path.join '_'
+      end
+      def path
+        @path.join '::'
+      end
+      def label
+        orphan? ? path : name
+      end
+      def to_s
+        path
+      end
+      def <=>(other)
+        path <=> other.path
+      end
+      def orphan?
+        @parent.nil?
+      end
+      def derives_from?(k)
+        key == k || @inherits_from && (@inherits_from.key == k || @inherits_from.derives_from?(k))
+      end
+      def should_render?
+        !(orphan? && @children.empty? && @inherits_from.nil? && @extended_by.empty? && @includes.empty?) && key != 'ActiveSupport_Concern' && !derives_from?('ActiveRecord_ActiveRecordError') && name != :ClassMethods
+      end
+    end
+  
+  end
+end

data/lib/code_node/ir.rb

@@ -0,0 +1,9 @@
+require 'code_node/ir/class_node'
+require 'code_node/ir/module_node'
+require 'code_node/ir/graph'
+
+module CodeNode
+  # Intermediate representation
+  module IR
+  end
+end

data/lib/code_node/sexp_walker.rb

@@ -0,0 +1,40 @@
+module CodeNode
+  
+  class SexpWalker
+    def initialize(graph, sexp)
+      @graph = graph
+      @root = sexp
+    end
+    def walk(purpose, s = nil)
+      s ||= @root
+      if [:module, :class].member?(s[0])
+        @graph.node_for(s[0], s[1]) do |node|
+          if purpose == :find_relations && s[0] == :class && !s[2].nil?
+            super_node = @graph.node_for :class, s[2], :not_sure_if_nested => true
+            unless super_node.nil?
+              node.inherits_from = super_node
+            end
+          end
+          rest = s[0] == :module ? s.slice(2..-1) : s.slice(3..-1)
+          rest.each do |c|
+            walk(purpose, c) if c.class == Sexp
+          end
+        end
+      elsif purpose == :find_relations && s[0] == :call && s.length >= 4 && [:extend, :include].member?(s[2]) && !@graph.scope.empty?
+        node = @graph.node_for :module, s[3], :not_sure_if_nested => true
+        unless node.nil?
+          if s[2] == :extend
+            @graph.scope.last.extended_by[node.key] = node
+          else
+            @graph.scope.last.includes[node.key] = node
+          end
+        end
+      else
+        s.slice(1..-1).each do |c|
+          walk(purpose, c) if c.class == Sexp
+        end
+      end
+    end
+  end
+  
+end

data/lib/code_node/version.rb

@@ -0,0 +1,5 @@
+module Code_node 
+  unless const_defined? :VERSION
+    VERSION = '0.0.1'
+  end
+end

data/lib/code_node.rb

@@ -0,0 +1,55 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+require 'code_node/version'
+require 'code_node/dsl'
+require 'code_node/ir'
+require 'code_node/sexp_walker'
+require 'cog'
+require 'ruby_parser'
+
+# Create Class and Module graphs for Ruby prjects
+module CodeNode
+  
+  extend Cog::Generator
+  
+  # @param graph_name [String] name of the dot file to generate (without +.dot+ extension)
+  # @option opt [Symbol] :ruby_version (:ruby19) either <tt>:ruby18</tt> or <tt>:ruby19</tt>, indicating which parser to use
+  # @yield [GraphDefinition] define rules for creating the graph
+  def self.graph(graph_name, opt={}, &block)
+    root = Cog::Config.instance.project_source_path
+    @graph = IR::Graph.new
+    graph_definer = DSL::GraphDefiner.new @graph
+    block.call graph_definer
+
+    rp = case opt[:ruby_version]
+    when :ruby18
+      Ruby18Parser.new
+    else
+      Ruby19Parser.new
+    end
+
+    sexp = []
+    [:find_nodes, :find_relations].each_with_index do |purpose, pass|
+      puts "#{(pass+1).ordinalize} pass: #{purpose.to_s.gsub('_', ' ')}".color(:cyan)
+      Dir.glob("#{root}/**/*.rb").each_with_index do |filename, i|
+        sexp[i] ||= begin
+          rp.parse(File.read filename)
+        rescue Racc::ParseError
+          STDERR.write "{filename.relative_to_project_root}, skipped...\n".color(:red)
+          nil
+        end
+        if sexp[i]
+          walker = SexpWalker.new @graph, sexp[i]
+          walker.walk purpose
+        end
+      end
+    end
+    
+    # Activate code_node while rendering templates
+    # so that cog will be able to find code_node templates
+    Cog::Config.instance.activate_tool 'code_node' do
+      stamp 'code_node/graph.dot', "#{graph_name}.dot"
+    end
+    
+    nil
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: code_node
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin Tonon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cog
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: 
+email: kevin@betweenconcepts.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- cog/templates/code_node/generator.rb.erb
+- cog/templates/code_node/graph.dot.erb
+- lib/code_node/cog_tool.rb
+- lib/code_node/dsl/graph_definer.rb
+- lib/code_node/dsl.rb
+- lib/code_node/ir/class_node.rb
+- lib/code_node/ir/graph.rb
+- lib/code_node/ir/module_node.rb
+- lib/code_node/ir/node.rb
+- lib/code_node/ir.rb
+- lib/code_node/sexp_walker.rb
+- lib/code_node/version.rb
+- lib/code_node.rb
+homepage: http://betweenconcepts.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- code_node
+- -ri
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Create Class and Module graphs for Ruby projects
+test_files: []
+