code_node 0.1.0 → 0.1.1

data/cog/generators/overview.rb

@@ -0,0 +1,49 @@
+require '/Users/kevin/bc/code_node/lib/code_node.rb'
+
+# Makes a graph of the project_source_path.
+# Nodes in the graph are clases and modules from your project.
+CodeNode.graph 'overview' do |g|
+
+  # Nodes
+  # =====
+
+  # Ignore nodes with no relations to other nodes
+  g.ignore &:island?
+
+  # Uncomment and change the value to ignore a specific node
+  # g.ignore 'Foo::Bar::Car'
+  
+  # Uncomment to ignore nodes named ClassMethods
+  # g.ignore /::ClassMethods$/
+
+  # Uncomment and change the value to ignore all nodes descending
+  # from a specific node
+  # g.ignore {|node| node.inherits_from? 'Foo::Bar::Car'}
+  
+  # Apply styles common to all classes
+  g.style :shape => 'ellipse', :fillcolor => '#cccccc', :fontcolor => :black do |node|
+    node.class?
+  end
+
+  # Apply styles common to all nodes
+  g.style :shape => 'box', :fillcolor => '#333333', :fontcolor => :white do |node|
+    node.module?
+  end
+  
+  # Apply more specific style here
+  # ...
+  
+  # Edges
+  # =====
+  #
+  # There is currently no way to style edges from the DSL.
+  # For now, there are only four categories of edges:
+  #  - containment
+  #  - inheritance
+  #  - inclusion
+  #  - extension
+  #
+  # They are style in the template. You can override the template
+  # and change the color if you like.
+  #   $ cog -t code_node template new -f code_node/graph.dot
+end

data/lib/code_node/ir/graph.rb

@@ -154,11 +154,17 @@ module CodeNode
           return if name.nil?
     
           node = if opt[:not_sure_if_nested]
-            if @scope.length > 1 && @scope[-2].find(name)
-              @scope[-2].find name
+            candidate = if name.is_a?(Array)
+              parts = name.dup
+              n = !@scope.empty? && @scope.last.find(parts.shift)
+              while n && !parts.empty?
+                n = n.find parts.shift
+              end
+              n
             else
-              Node.new name, :node_type => node_type
+              !@scope.empty? && @scope.last.find(name)
             end
+            candidate || Node.new(name, :node_type => node_type)
           else
             Node.new name, :parent => @scope.last, :node_type => node_type
           end

data/lib/code_node/ir/node.rb

@@ -105,14 +105,15 @@ module CodeNode
         # @param path [String] a class or module path in the form <tt>Foo::Bar::Car</tt>
         # @return [Boolean] does this node inherit from (directly or indirectly) a {#class?} node with the given {#path}? Note that a node inherits from itself according to this method. Recursively checks the ancestry of the node.
         def inherits_from?(path)
-          self.path == path || @inherits_from && (@inherits_from.path == path || @inherits_from.inherits_from?(path))
+          # TODO: need process all nodes first, marking for deletion on the first pass, because the superclass gets deleting and then the inherits from relation breaks down
+          self.path == path || @inherits_from && @inherits_from.inherits_from?(path)
         end
       
         # @return [Boolean] whether or not this node represents a singleton module. A singleton module is one which contains an <tt>extend self</tt> statement.
         def singleton?
           @singleton
         end
-      
+
         # @return [Boolean] whether or not this node is an island. An island is a node with no connections to other nodes.
         def island?
           ([@parent, @inherits_from].all?(&:nil?) &&

data/lib/code_node/sexp_walker.rb

@@ -33,16 +33,18 @@ module CodeNode
             walk(c) if c.class == Sexp
           end
         end
-        if find_relations? && !@graph.scope.empty?
+        unless @graph.scope.empty?
           @graph.scope.last.contains node
         end
       elsif 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.extends node
-          else
-            @graph.scope.last.includes node
+        s.slice(3..-1).each do |mod_sexp|
+          node = @graph.node_for :module, mod_sexp, :not_sure_if_nested => true
+          unless node.nil?
+            if s[2] == :extend
+              @graph.scope.last.extends node
+            else
+              @graph.scope.last.includes node
+            end
           end
         end
       else

data/lib/code_node/spec_helpers.rb

@@ -0,0 +1,23 @@
+require 'cog/spec_helpers'
+require 'code_node/spec_helpers/runner'
+require 'code_node/spec_helpers/dot_file'
+
+module CodeNode
+  
+  # RSpec helpers specific to code_node
+  module SpecHelpers
+  end
+  
+end
+
+module Cog
+  
+  # Customizations to cog RSpec helpers for use with code_node
+  module SpecHelpers
+    
+    def spec_root
+      File.expand_path File.join(File.dirname(__FILE__), '..', '..', 'spec')
+    end
+    
+  end
+end

data/lib/code_node/spec_helpers/dot_file.rb

@@ -0,0 +1,114 @@
+module CodeNode
+  module SpecHelpers
+    
+    # Represents a generated dot file
+    class DotFile
+      
+      include Cog::SpecHelpers
+      
+      # @param name [String] name of the dotfile without the <tt>.dot</tt> extension. The file will be looked for in the lib subdirectory of the active fixture dir.
+      def initialize(name)
+        @filename = generated_file "#{name}.dot"
+        @nodes = {} # :node_type => []
+        @edges = {} # :edge_type => []
+        if File.exists? @filename
+          @i = 0
+          @lines = File.read(@filename).split "\n"
+          read_until '/* Module nodes */'
+          read_nodes :module
+          read_until '/* Class nodes */'
+          read_nodes :class
+          read_until '/* A contains B */'
+          read_edges :containment
+          read_until '/* A inherits from B */'
+          read_edges :inheritance
+          read_until '/* A includes B */'
+          read_edges :inclusion
+          read_until '/* A extends B */'
+          read_edges :extension
+        end
+      end
+      
+      # @return [Boolean] does the file exist?
+      def exists?
+        File.exists? @filename
+      end
+      
+      def has_match?(pattern)
+        if exists?
+          !!(pattern =~ File.read(@filename))
+        end
+      end
+      
+      def has_node?(path)
+        has_class?(path) || has_module?(path)
+      end
+      
+      def has_class?(path)
+        key = path.to_s.split('::').join '_'
+        @nodes[:class].member?(key)
+      end
+
+      def has_module?(path)
+        key = path.to_s.split('::').join '_'
+        @nodes[:module].member?(key)
+      end
+
+      def has_edge?(path1, path2)
+        has_containment?(path1, path2) || has_inheritance?(path1, path2) || has_inclusion?(path1, path2) || has_extension?(path1, path2)
+      end
+      
+      def has_containment?(path1, path2)
+        key1 = path1.to_s.split('::').join '_'
+        key2 = path2.to_s.split('::').join '_'
+        @edges[:containment].member?([key1, key2])
+      end
+
+      def has_inheritance?(path1, path2)
+        key1 = path1.to_s.split('::').join '_'
+        key2 = path2.to_s.split('::').join '_'
+        @edges[:inheritance].member?([key1, key2])
+      end
+
+      def has_inclusion?(path1, path2)
+        key1 = path1.to_s.split('::').join '_'
+        key2 = path2.to_s.split('::').join '_'
+        @edges[:inclusion].member?([key1, key2])
+      end
+
+      def has_extension?(path1, path2)
+        key1 = path1.to_s.split('::').join '_'
+        key2 = path2.to_s.split('::').join '_'
+        @edges[:extension].member?([key1, key2])
+      end
+      
+      private
+      
+      def read_nodes(type)
+        @nodes[type] ||= []
+        until (line = @lines[@i]).strip.empty?
+          /^([A-Za-z0-9_]+)/ =~ line
+          @nodes[type] << $1 unless $1.nil?
+          @i += 1
+        end
+      end
+      
+      def read_edges(type)
+        @edges[type] ||= []
+        until (line = @lines[@i]).strip.empty?
+          /^([A-Za-z0-9_]+)\s\-\>\s([A-Za-z0-9_]+)/ =~ line
+          @edges[type] << [$1, $2] unless $1.nil?
+          @i += 1
+        end
+      end
+      
+      def read_until(line)
+        while @lines[@i] != line && @i < @lines.length
+          @i += 1
+        end
+        @i += 1
+      end
+    end
+    
+  end
+end

data/lib/code_node/spec_helpers/runner.rb

@@ -0,0 +1,25 @@
+require 'open3'
+
+module Cog
+  module SpecHelpers
+    
+    class Runner
+      def initialize(app)
+        @cog = app
+        @tools = []
+      end
+    end
+    
+    class Invocation
+      
+      # Redefine exec for testing code_node
+      def exec(&block)
+        ENV['COG_TOOLS'] = File.expand_path File.join(File.dirname(__FILE__), '..', 'cog_tool.rb')
+        Open3.popen3 *@cmd do |i,o,e,t|
+          block.call i,o,e
+        end
+      end
+      
+    end
+  end
+end

data/lib/code_node/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: code_node
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-20 00:00:00 Z
+date: 2012-11-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cog
@@ -111,6 +111,7 @@ extra_rdoc_files: []
 
 files: 
 - LICENSE
+- cog/generators/overview.rb
 - cog/templates/code_node/generator.rb.erb
 - cog/templates/code_node/graph.dot.erb
 - cog/templates/code_node/node.dot.erb
@@ -122,6 +123,9 @@ files:
 - lib/code_node/ir/node_matcher.rb
 - lib/code_node/ir.rb
 - lib/code_node/sexp_walker.rb
+- lib/code_node/spec_helpers/dot_file.rb
+- lib/code_node/spec_helpers/runner.rb
+- lib/code_node/spec_helpers.rb
 - lib/code_node/version.rb
 - lib/code_node.rb
 homepage: https://github.com/ktonon/code_node