rdepend 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3554b4b1d7f92ffb10ab23a4448d0ac688360dd9
+  data.tar.gz: d7ce6651c48d344354ca76e17d90bc565ee96d22
+SHA512:
+  metadata.gz: 69a016abcc816a5acfb306a55d649559032e6857bfe54cce1edb9e4f4ed39573c335afa0743673e063d36ad591b73d0b7270d73790d0406e7922d75eb3661684
+  data.tar.gz: 979f0ce215b0ea2b1f6a1ae8f29b8fc74fdf2ee9138e9b520fac8c811909bc2c754a1499eb50d56dfd02c3a3959477907f49791e28ac0db0151ca739ed81dd9e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/Gemfile.lock
+/doc/
+/pkg/
+/tmp/
+/ext/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.dot.svg
+*.dot

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rdepend.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 jarra
+
+MIT License
+
+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.md

@@ -0,0 +1,51 @@
+# Ꝛdepend
+
+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
+re-used a lot.
+A lot of outgoing links a 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rdepend'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rdepend
+
+## Usage
+
+```ruby
+Rdepend.with_trace do
+  @een = Een.new
+  @een.start
+end
+```
+
+```ruby
+Rdepend.trace
+@een = Een.new
+@een.start
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rdepend/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/example.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+require File.expand_path(File.dirname(__FILE__) + '/lib/rdepend.rb')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/een.rb')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/twee.rb')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/drie.rb')
+
+=begin
+Rdepend.with_trace do
+  @een = Een.new
+  @een.start
+end
+=end
+
+Rdepend.trace
+@een = Een.new
+@een.start

data/fixtures/drie.rb

@@ -0,0 +1,7 @@
+class Drie
+  def initialize
+  end
+
+  def vier
+  end
+end

data/fixtures/een.rb

@@ -0,0 +1,9 @@
+class Een
+  def initialize
+    Twee.twee
+  end
+
+  def start
+    Drie.new.vier
+  end
+end

data/fixtures/twee.rb

@@ -0,0 +1,12 @@
+class Twee
+  def initialize
+  end
+
+  def self.twee
+    new.drie
+  end
+
+  def drie
+    Drie.new
+  end
+end

data/lib/rdepend.rb

@@ -0,0 +1,7 @@
+require 'ruby-graphviz'
+require 'ruby-prof'
+
+require_relative 'rdepend/version'
+require_relative 'rdepend/printer'
+require_relative 'rdepend/trace'
+require_relative 'rdepend/main'

data/lib/rdepend/main.rb

@@ -0,0 +1,13 @@
+module Rdepend
+  def self.with_trace(&block)
+    Rdepend::Trace.exec(&block)
+  end
+
+  def self.trace
+    Rdepend::Trace.init
+  end
+
+  def self.stop
+    Rdepend::Trace.stop
+  end
+end

data/lib/rdepend/printer.rb

@@ -0,0 +1,129 @@
+# 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 = {})
+      setup_options(options)
+      add('digraph "Profile" {')
+      #add("label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
+      add("labelloc=t;")
+      add("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
+      `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}\" {")
+        print_thread(thread)
+        add("}")
+        print_classes(thread)
+      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}%)\"];")
+        @seen_methods << method
+        print_edges(total_time, method)
+      end
+    end
+
+    def print_classes(thread)
+      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}
+        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("}")
+        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}];")
+      end
+    end
+
+    # Silly little helper for printing to the @output
+    def add(str)
+      (@contents ||= []) << str
+    end
+  end
+end

data/lib/rdepend/trace.rb

@@ -0,0 +1,30 @@
+at_exit do
+  Rdepend::Trace.halt_with_message
+end
+
+module Rdepend
+  class Trace
+    def self.exec(&block)
+      self.start
+      yield
+      self.stop
+    end
+
+    def self.init
+      RubyProf.start
+    end
+
+    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")
+    end
+
+    def self.halt_with_message
+      puts "⏳  Exiting, but writing an Ꝛdepend graph first, so please wait!"
+      self.stop
+    end
+  end
+end

data/lib/rdepend/trace_event.rb

@@ -0,0 +1,54 @@
+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

data/lib/rdepend/version.rb

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

data/rdepend.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rdepend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rdepend'
+  spec.version       = Rdepend::VERSION
+  spec.authors       = ['jarra']
+  spec.email         = ['suhrawardi@gmail.com']
+  spec.summary       = %q(generates a graph visualization of the dependencies in your codebase)
+  spec.description   = %q(a work in progress, use it at your own risk)
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r(^bin/)) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r(^(test|spec|features)/))
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'ruby-graphviz'
+  spec.add_dependency 'ruby-prof'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rdepend
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jarra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: a work in progress, use it at your own risk
+email:
+- suhrawardi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example.rb
+- fixtures/drie.rb
+- fixtures/een.rb
+- fixtures/twee.rb
+- lib/rdepend.rb
+- lib/rdepend/main.rb
+- lib/rdepend/printer.rb
+- lib/rdepend/trace.rb
+- lib/rdepend/trace_event.rb
+- lib/rdepend/version.rb
+- rdepend.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: generates a graph visualization of the dependencies in your codebase
+test_files: []