code-explorer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb4f5f3aec4c52c667605028d891dccf6bab2b6d
-  data.tar.gz: c3590e42ee2bf91facc0553fee487c19873b884c
+  metadata.gz: 37cc2f42a16925fac9f2dde64d9e2a174d915187
+  data.tar.gz: e016d6a05e33163a83a970f8a70b693ccff90fdd
 SHA512:
-  metadata.gz: 7757f66ac7088828f58beb5ddcfb84f84dd415e5680c5493a1f3bcc23e22c6e602b3f59a2aaf38eafe1eb641f289d1a10ae8dc8170d8078a55049119bc745436
-  data.tar.gz: d0e8a1630fdf7a037ffbced5fa1bf7daad69990d33377cc4daa8c41965e9b0632804784924e559a475a3154b670a0b031b0824701e312a4fc89594272762aa92
+  metadata.gz: c47e95b326b405eecbe74654071c93db23f4ffa32ddb7c99b4da13fc247d56989c20d9892b5abebd32140ec9d23a9bddc9c8190aa69af26bb67938b4aed15cbe
+  data.tar.gz: 8514c9663ddeebce427ba42c8f0d315d5213319df57855501e0778b169359cc4d4f22d3c1ecae7384bc4d3bf8ab5f801212005f97249fd11bcc66e00d5ac3e5c

data/README.md

@@ -1,16 +1,29 @@
-# Call Graph
+# Code Explorer
+
+## Tools
+
+### code-explorer
+
+Starts a local web server which lets you apply the other tools to all `*.rb`
+files in a directory subtree.
+
+### call-graph
 
 This makes a call graph among methods of a single Ruby file.
 
 I made it to help me orient myself in unfamiliar legacy code and to help
 identify cohesive parts that could be split out.
 
-Yes, it is quick and dirty.
+### class-dependencies
+
+Identifies fully qualified class names and makes an inheritance graph
 
 ## Requirements
 
 - [parser gem](https://github.com/whitequark/parser)
 - [Graphviz](http://www.graphviz.org/)
+- Sinatra
+- Cheetah
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/class-dependencies

@@ -5,11 +5,12 @@
 require "parser/current"
 require "pp"
 
+require "code_explorer/consts"
 require "code_explorer/dot"
 
 def main
   asts = ARGV.map {|fn| ast_for_filename(fn)}
-  cs = Consts.new
+  cs = CodeExplorer::Consts.new
   cs.report_modules(asts)
   graph = cs.superclasses
   puts dot_from_hash(graph)
@@ -20,158 +21,4 @@ def ast_for_filename(fn)
   Parser::CurrentRuby.parse(ruby)
 end
 
-# ruby [String] a ruby program
-# @return a dot graph string
-def dep_graph(ast)
-  Consts.new.report_modules(ast)
-  dot_from_hash({})
-end
-
-# tracks what constants are resolvable
-class ConstBinding
-  def initialize(fqname, parent = nil)
-    @fqname = fqname
-    @parent = parent
-    @known = {}
-  end
-
-  # @return [ConstBinding] the new scope
-  def open_namespace(fqname)
-    ns = @known[fqname]
-    if ns.is_a? ConstBinding
-      # puts "(reopening #{fqname})"
-    else
-      ns = self.class.new(fqname, self)
-      @known[fqname] = ns
-    end
-    ns
-  end
-
-  # @return [ConstBinding] the parent scope
-  def close_namespace
-    @parent
-  end
-
-  def declare_const(fqname)
-    if @known[fqname]
-#      puts "warning: #{fqname} already declared"
-    end
-    @known[fqname] = :const
-  end
-
-  def resolve_declared_const(name)
-    if @fqname.empty?
-      name
-    else
-      "#{@fqname}::#{name}"
-    end
-  end
-
-  def resolve_used_const(name)
-#    puts "resolving #{name} in #{@fqname}, known #{@known.inspect}"
-    candidate = resolve_declared_const(name)
-    if @known.include?(candidate)
-      candidate
-    elsif @parent
-      @parent.resolve_used_const(name)
-    else
-      name
-    end
-  end
-end
-
-class Consts < Parser::AST::Processor
-  include AST::Sexp
-
-  # @return [ConstBinding]
-  attr_reader :cb
-  # @return [Hash{String => Array<String>}]
-  attr_reader :superclasses
-
-  def initialize
-    @cb = ConstBinding.new("")
-    @superclasses = {}
-  end
-
-  def report_modules(asts)
-    Array(asts).each do |ast|
-      process(ast)
-    end
-  end
-
-  def const_name_from_sexp(node)
-    case node.type
-    when :self
-      "self"
-    when :cbase
-      ""
-    when :const, :casgn
-      parent, name, _maybe_value = *node
-      if parent
-        const_name_from_sexp(parent) + "::#{name}"
-      else
-        name.to_s
-      end
-    else
-      raise "Unexpected #{node.type}"
-    end
-  end
-
-  def new_scope(name, &block)
-    @cb = cb.open_namespace(name)
-    block.call
-    @cb = cb.close_namespace
-  end
-
-  def on_module(node)
-    name, _body = *node
-    name = cb.resolve_declared_const(const_name_from_sexp(name))
-#    puts "module #{name}"
-
-    new_scope(name) do
-      super
-    end
-  end
-
-  def on_class(node)
-    name, parent, _body = *node
-    parent ||= s(:const, s(:cbase), :Object)
-
-    name   = cb.resolve_declared_const(const_name_from_sexp(name))
-    parent = cb.resolve_used_const(const_name_from_sexp(parent))
-#    puts "class #{name} < #{parent}"
-
-    @superclasses[name] = [parent]
-
-    new_scope(name) do
-      super
-    end
-  end
-
-  def on_sclass(node)
-    parent, _body = *node
-
-    parent = const_name_from_sexp(parent)
-    name = "<< #{parent}" # cheating
-#    puts "class #{name}"
-
-    new_scope(name) do
-      super
-    end
-  end
-
-  def on_casgn(node)
-    name = cb.resolve_declared_const(const_name_from_sexp(node))
-    cb.declare_const(name)
-#    puts "casgn #{name}"
-  end
-
-  def on_const(node)
-    name = const_name_from_sexp(node)
-    fqname = cb.resolve_used_const(name)
-#    puts "CONST #{fqname}"
-  end
-
-end
-
 main

data/bin/code-explorer

@@ -4,6 +4,7 @@ require "sinatra"
 require "cheetah"
 
 require "code_explorer/call_graph"
+require "code_explorer/consts"
 require "code_explorer/numbered_lines"
 
 def path_link(prefix, path, text)
@@ -16,11 +17,40 @@ configure do
 end
 
 get "/" do
+  page = ""
+
+  page << path_link("", "class-inheritance", "Class inheritance in /lib/")
+  page << "<hr>\n"
+
   files = Dir.glob("**/*.rb").sort
-  files.map do |f|
+  page << files.map do |f|
     path_link("/files", f, f) + " " +
       path_link("/call-graph", f, "call graph")
   end.join("<br>\n")
+  page
+end
+
+def ast_for_filename(fn)
+  ruby = File.read(fn)
+  Parser::CurrentRuby.parse(ruby)
+end
+
+def serve_dot(dot)
+  type = :svg
+  graph = Cheetah.run(["dot", "-T#{type}"], stdin: dot, stdout: :capture)
+
+  content_type type
+  graph
+end
+
+get "/class-inheritance" do
+  files = Dir.glob("lib/**/*.rb").sort
+  asts = files.map {|fn| ast_for_filename(fn)}
+  cs = CodeExplorer::Consts.new
+  cs.report_modules(asts)
+  graph = cs.superclasses
+
+  serve_dot(dot_from_hash(graph))
 end
 
 get "/files/*" do |path|
@@ -31,9 +61,5 @@ end
 get "/call-graph/*" do |path|
   dot = call_graph(path)
 
-  type = :svg
-  graph = Cheetah.run(["dot", "-T#{type}"], stdin: dot, stdout: :capture)
-
-  content_type type
-  graph
+  serve_dot(dot)
 end

data/lib/code_explorer/const_binding.rb

@@ -0,0 +1,54 @@
+module CodeExplorer
+  # tracks what constants are resolvable
+  class ConstBinding
+    def initialize(fqname, parent = nil)
+      @fqname = fqname
+      @parent = parent
+      @known = {}
+    end
+
+    # @return [ConstBinding] the new scope
+    def open_namespace(fqname)
+      ns = @known[fqname]
+      if ns.is_a? ConstBinding
+        # puts "(reopening #{fqname})"
+      else
+        ns = self.class.new(fqname, self)
+        @known[fqname] = ns
+      end
+      ns
+    end
+
+    # @return [ConstBinding] the parent scope
+    def close_namespace
+      @parent
+    end
+
+    def declare_const(fqname)
+      if @known[fqname]
+        #      puts "warning: #{fqname} already declared"
+      end
+      @known[fqname] = :const
+    end
+
+    def resolve_declared_const(name)
+      if @fqname.empty?
+        name
+      else
+        "#{@fqname}::#{name}"
+      end
+    end
+
+    def resolve_used_const(name)
+      #    puts "resolving #{name} in #{@fqname}, known #{@known.inspect}"
+      candidate = resolve_declared_const(name)
+      if @known.include?(candidate)
+        candidate
+      elsif @parent
+        @parent.resolve_used_const(name)
+      else
+        name
+      end
+    end
+  end
+end

data/lib/code_explorer/consts.rb

@@ -0,0 +1,96 @@
+require_relative "const_binding"
+
+module CodeExplorer
+  class Consts < Parser::AST::Processor
+    include AST::Sexp
+
+    # @return [ConstBinding]
+    attr_reader :cb
+    # @return [Hash{String => Array<String>}]
+    attr_reader :superclasses
+
+    def initialize
+      @cb = ConstBinding.new("")
+      @superclasses = {}
+    end
+
+    def report_modules(asts)
+      Array(asts).each do |ast|
+        process(ast)
+      end
+    end
+
+    def const_name_from_sexp(node)
+      case node.type
+      when :self
+        "self"
+      when :cbase
+        ""
+      when :const, :casgn
+        parent, name, _maybe_value = *node
+        if parent
+          const_name_from_sexp(parent) + "::#{name}"
+        else
+          name.to_s
+        end
+      else
+        raise "Unexpected #{node.type}"
+      end
+    end
+
+    def new_scope(name, &block)
+      @cb = cb.open_namespace(name)
+      block.call
+      @cb = cb.close_namespace
+    end
+
+    def on_module(node)
+      name, _body = *node
+      name = cb.resolve_declared_const(const_name_from_sexp(name))
+      #    puts "module #{name}"
+
+      new_scope(name) do
+        super
+      end
+    end
+
+    def on_class(node)
+      name, parent, _body = *node
+      parent ||= s(:const, s(:cbase), :Object)
+
+      name   = cb.resolve_declared_const(const_name_from_sexp(name))
+      parent = cb.resolve_used_const(const_name_from_sexp(parent))
+      #    puts "class #{name} < #{parent}"
+
+      @superclasses[name] = [parent]
+
+      new_scope(name) do
+        super
+      end
+    end
+
+    def on_sclass(node)
+      parent, _body = *node
+
+      parent = const_name_from_sexp(parent)
+      name = "<< #{parent}" # cheating
+      #    puts "class #{name}"
+
+      new_scope(name) do
+        super
+      end
+    end
+
+    def on_casgn(node)
+      name = cb.resolve_declared_const(const_name_from_sexp(node))
+      cb.declare_const(name)
+      #    puts "casgn #{name}"
+    end
+
+    def on_const(node)
+      name = const_name_from_sexp(node)
+      fqname = cb.resolve_used_const(name)
+      #    puts "CONST #{fqname}"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code-explorer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Vidner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -69,6 +69,8 @@ files:
 - bin/code-explorer
 - bin/required-files
 - lib/code_explorer/call_graph.rb
+- lib/code_explorer/const_binding.rb
+- lib/code_explorer/consts.rb
 - lib/code_explorer/dot.rb
 - lib/code_explorer/numbered_lines.rb
 - lib/code_explorer/version.rb