rdepend 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3554b4b1d7f92ffb10ab23a4448d0ac688360dd9
-  data.tar.gz: d7ce6651c48d344354ca76e17d90bc565ee96d22
+  metadata.gz: 5f7a2efdd9fdd2cc0310465cac7a761bb95e403e
+  data.tar.gz: 98dbb422eaa304892d3e6e867d3172b1f6273693
 SHA512:
-  metadata.gz: 69a016abcc816a5acfb306a55d649559032e6857bfe54cce1edb9e4f4ed39573c335afa0743673e063d36ad591b73d0b7270d73790d0406e7922d75eb3661684
-  data.tar.gz: 979f0ce215b0ea2b1f6a1ae8f29b8fc74fdf2ee9138e9b520fac8c811909bc2c754a1499eb50d56dfd02c3a3959477907f49791e28ac0db0151ca739ed81dd9e
+  metadata.gz: 60c1b739a32928b6ccb592fffcf98f67edc58e9c8b6930d0762b5f2cca81484d699bb37848b5a8b17870711550e1d1b0a3bba1a9dc47871cd6e1f874743edd76
+  data.tar.gz: 008ea25590dbffccaebbdf9105cf1737b8e5699030e8de43b8dfbceaa8b7089bd43ed5b7483341ae080a3865bb6dd45a36045736df620fa972c4291ad2302a8a

data/README.md

@@ -4,9 +4,9 @@ Mind that this Gem is very experimental, a work in progress
 
 It generates a graph visualization of the dependencies in your codebase.
 
-A lot of incoming links are good, as that means that a function/module is
+A lot of incoming links is good, as that means that a module is
 re-used a lot.
-A lot of outgoing links a bad, as that means that that part of the code has
+A lot of outgoing links is bad, as that means that that part of the code has
 a lot of dependencies.
 
 See also http://www.whiteboxtest.com/information-flow-metrics.php
@@ -36,6 +36,8 @@ Rdepend.with_trace do
 end
 ```
 
+or
+
 ```ruby
 Rdepend.trace
 @een = Een.new

data/lib/rdepend/printer.rb

@@ -1,71 +1,27 @@
 # encoding: utf-8
-
 require 'set'
 
 module Rdepend
-  # Generates a graphviz graph in dot format.
-  # To use the dot printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::Printer.new(result)
-  #   printer.print(STDOUT)
-  #
-  # You can use either dot viewer such as GraphViz, or the dot command line tool
-  # to reformat the output into a wide variety of outputs:
-  #
-  #   dot -Tpng graph.dot > graph.png
-  #
   class Printer < RubyProf::AbstractPrinter
     CLASS_COLOR = '"#666666"'
     EDGE_COLOR  = '"#666666"'
 
-    # Creates the Printer using a RubyProf::Result.
     def initialize(result)
       super(result)
       @seen_methods = Set.new
     end
 
-    # Print a graph report to the provided output.
-    #
-    # output - Any IO object, including STDOUT or a file. The default value is
-    # STDOUT.
-    #
-    # options - Hash of print options.  See #setup_options
-    # for more information.
-    #
-    # When profiling results that cover a large number of method calls it
-    # helps to use the :min_percent option, for example:
-    #
-    #   Printer.new(result).print(STDOUT, :min_percent=>5)
-    #
-    def print(output = STDOUT, options = {})
+    def print(output, options = {})
       setup_options(options)
-      add('digraph "Profile" {')
-      #add("label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
-      add("labelloc=t;")
-      add("labeljust=l;")
+      add('digraph "Profile" {', 'labelloc=t;', 'labeljust=l;')
       print_threads
       add('}')
-      if output == STDOUT
-        @output = File.open(output, 'w')
-      else
-        File.open(output, 'w') { |file| file.write(@contents.join("\n")) }
-      end
+      File.open(output, 'w') { |file| file.write(@contents.join("\n")) }
       `dot -Tsvg #{output} > #{output}.svg`
     end
 
     private
 
-    # Something of a hack, figure out which constant went with the
-    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
-    # forget what measurement was made.
-    def mode_name
-      RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
-    end
-
     def print_threads
       @result.threads.each do |thread|
         add("subgraph \"Thread #{thread.id}\" {")
@@ -75,20 +31,12 @@ module Rdepend
       end
     end
 
-    # Determines an ID to use to represent the subject in the Dot file.
-    def dot_id(subject)
-      subject.object_id
-    end
-
     def print_thread(thread)
-      total_time = thread.total_time
       thread.methods.sort_by(&sort_method).reverse_each do |method|
-        total_percentage = (method.total_time/total_time) * 100
-        next if total_percentage < min_percent
         name = method_name(method).split("#").last
-        add("#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];")
+        add("#{method.object_id} [label=\"#{name}\"];")
         @seen_methods << method
-        print_edges(total_time, method)
+        print_edges(method)
       end
     end
 
@@ -96,34 +44,27 @@ module Rdepend
       grouped = {}
       thread.methods.each{|m| grouped[m.klass_name] ||= []; grouped[m.klass_name] << m}
       grouped.each do |cls, methods2|
-        # Filter down to just seen methods
-        big_methods = methods2.select{|m| @seen_methods.include? m}
+        big_methods = methods2.select { |m| @seen_methods.include?(m) }
         if !big_methods.empty?
           add("subgraph cluster_#{cls.object_id} {")
-          add("label = \"#{cls}\";")
-          add("fontcolor = #{CLASS_COLOR};")
-          add("fontsize = 16;")
-          add("color = #{CLASS_COLOR};")
-          big_methods.each do |m|
-            add("#{m.object_id};")
-          end
+          add("label = \"#{cls}\";", "fontcolor = #{CLASS_COLOR};")
+          add("fontsize = 16;", "color = #{CLASS_COLOR};")
+          big_methods.each { |m| add("#{m.object_id};") }
           add("}")
         end
       end
     end
 
-    def print_edges(total_time, method)
-      method.aggregate_children.sort_by(&:total_time).reverse.each do |child|
-        target_percentage = (child.target.total_time / total_time) * 100.0
-        next if target_percentage < min_percent
-        # Get children method
-        add("#{dot_id(method)} -> #{dot_id(child.target)} [label=\"#{child.called}/#{child.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];")
+    def print_edges(method)
+      method.aggregate_children.each do |child|
+        label = "#{child.called}/#{child.target.called}"
+        label = "label=\"#{label}\" fontsize=10 fontcolor=#{EDGE_COLOR}"
+        add("#{method.object_id} -> #{child.target.object_id} [#{label}];")
       end
     end
 
-    # Silly little helper for printing to the @output
-    def add(str)
-      (@contents ||= []) << str
+    def add(*args)
+      @contents = (@contents || []) + [args].flatten
     end
   end
 end

data/lib/rdepend/trace.rb

@@ -1,11 +1,7 @@
-at_exit do
-  Rdepend::Trace.halt_with_message
-end
-
 module Rdepend
   class Trace
     def self.exec(&block)
-      self.start
+      self.init
       yield
       self.stop
     end
@@ -17,9 +13,8 @@ module Rdepend
     def self.stop
       result = RubyProf.stop
       result.eliminate_methods!([/Integer#times/])
-      printer = Rdepend::Printer.new(result)
       puts "Writing Ꝛdepend graph to #{$0}.dot.svg"
-      printer.print("#{$0}.dot")
+      Rdepend::Printer.new(result).print("#{$0}.dot")
     end
 
     def self.halt_with_message
@@ -28,3 +23,7 @@ module Rdepend
     end
   end
 end
+
+at_exit do
+  Rdepend::Trace.halt_with_message
+end

data/lib/rdepend/version.rb

@@ -1,3 +1,3 @@
 module Rdepend
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdepend
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - jarra
@@ -88,7 +88,6 @@ files:
 - lib/rdepend/main.rb
 - lib/rdepend/printer.rb
 - lib/rdepend/trace.rb
-- lib/rdepend/trace_event.rb
 - lib/rdepend/version.rb
 - rdepend.gemspec
 homepage: ''

data/lib/rdepend/trace_event.rb

@@ -1,54 +0,0 @@
-Rdepend::TraceEvent = Struct.new(:event_type, :defined_class,
-                                 :method_id, :path, :lineno) do
-  def event_class
-    "Rdepend::Event::#{event_type.to_s.classify}".constantize
-  end
-
-  def key
-    "#{path}:#{method_id}"
-  end
-
-  def root?
-    method_id == '<main>'
-  end
-
-  def defined_class
-    self[:defined_class].to_s
-  end
-
-  def instance?
-    !klass?
-  end
-
-  def klass?
-    defined_class =~ /^#<(Module|Class):\w*.*>$/
-  end
-
-  def klass
-    name.klass
-  end
-
-  def method
-    name.method
-  end
-
-  def label
-    if root?
-      'main'
-    else
-      method_id
-    end
-  end
-
-  private
-
-  def name
-    if root?
-      Rdepend::Event::RootName.new(self)
-    elsif instance?
-      Rdepend::Event::InstanceName.new(self)
-    else
-      Rdepend::Event::KlassName.new(self)
-    end
-  end
-end