rubrowser 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd6da7e91cc1f4b7e50ba33d062baa579f2054d5
-  data.tar.gz: 400349b68d33f44c42c0b7571318eab0ec675c96
+  metadata.gz: 663f1d03a44347696b31955a262839e433933415
+  data.tar.gz: fcd25e95549c33597fc2635ab9304d3a8c6296da
 SHA512:
-  metadata.gz: be689e37c1507f092ad03e735e78e6464b2f63100e42c134e70fda6350277881cb5ab87d812a34504928bd3e6be72db8565712c9b5731261804159d73ff5650a
-  data.tar.gz: b21b259b207cabe0c822012a04b4e6ecdc5070685403c94d35f0712d61c47a8ad74b70465893d33e48f1e599ea91f8c95fa347ab2a273042f103a7edbbb3f9fd
+  metadata.gz: a950758287c25f65f648e029e180846ab6624c0df49b4a48cc5d3415bcca13c7de1f3ede57be426a6158b154f57089f7006dff2925c086c08357afb28baf6cf1
+  data.tar.gz: dafc101e84347031ac0f59eb14c5bdad3929e11f0956c4c822d34c363b4dbcfde14d207815eb72249f276deb78a9db5d93636b9f85b8543e8015734824c4a78d

data/.gitignore

@@ -1,2 +1,5 @@
 tmp/
-pkg/
+pkg/
+.DS_Store
+.idea
+.byebug_history

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
 Style/Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,24 +1,55 @@
 PATH
   remote: .
   specs:
-    rubrowser (0.2.7)
+    rubrowser (0.3.0)
       parser (~> 2.3, >= 2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.2.0)
+    byebug (9.0.6)
+    diff-lcs (1.3)
+    parallel (1.12.0)
     parser (2.4.0.0)
       ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
     rake (10.4.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.14)
+  byebug
   rake (~> 10.0)
+  rspec
+  rubocop
   rubrowser!
 
 BUNDLED WITH
-   1.14.5
+   1.15.2

data/Rakefile

@@ -1,10 +1,18 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+task :server do
+  ruby './bin/rubrowser'
 end
 
-task default: :test
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task all: %I[spec rubocop] do
+end
+
+task default: :all

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/bin/rubrowser

@@ -5,7 +5,7 @@ require 'optparse'
 require 'rubrowser'
 require 'rubrowser/server'
 
-OPTIONS = {
+options = {
   port: 9000,
   files: ARGV.empty? ? ['.'] : ARGV
 }
@@ -13,8 +13,9 @@ OPTIONS = {
 OptionParser.new do |opts|
   opts.banner = "Usage: #{__FILE__} [options] [file] ..."
 
-  opts.on('-pPORT', '--port=PORT', 'Specify port number for server, default = 9000') do |port|
-    OPTIONS[:port] = port.to_i
+  message = 'Specify port number for server, default = 9000'
+  opts.on('-pPORT', '--port=PORT', message) do |port|
+    options[:port] = port.to_i
   end
 
   opts.on('-v', '--version', 'Print Rubrowser version') do
@@ -28,4 +29,4 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-Rubrowser::Server.start(OPTIONS)
+Rubrowser::Server.start(options)

data/lib/rubrowser/data.rb

@@ -1,30 +1,24 @@
 require 'rubrowser/parser/factory'
+require 'rubrowser/graph'
 
 module Rubrowser
   class Data
+    attr_reader :definitions, :relations
+
     def initialize(files)
       @files = files
-      @parsed = false
       parse
     end
 
-    def definitions
-      @_definitions ||= parsers.map(&:definitions).reduce(:+).to_a
-    end
-
-    def relations
-      @_relations ||= parsers.map(&:relations).reduce(:+).to_a
-    end
-
     private
 
-    attr_reader :files, :parsed
-    alias parsed? parsed
-
     def parse
-      return if parsed?
       parsers.each(&:parse)
-      @parsed = true
+
+      @definitions ||= parsers.map(&:definitions).reduce(:+).to_a
+      @relations ||= parsers.map(&:relations).reduce(:+).to_a
+
+      mark_circular_dependencies
     end
 
     def parsers
@@ -32,5 +26,44 @@ module Rubrowser
         Rubrowser::Parser::Factory.build(file)
       end
     end
+
+    def mark_circular_dependencies
+      components = make_components
+      @definitions.each do |definition|
+        if components.include?(definition.namespace.first.to_s)
+          definition.set_circular
+        end
+      end
+
+      @relations.each do |relation|
+        relation.set_circular if circular_relation?(components, relation)
+      end
+    end
+
+    def make_components
+      graph = Graph.new { |h, k| h[k] = [] }
+
+      @relations.each do |relation|
+        graph[relation.caller_namespace.to_s] <<
+          relation.resolve(definitions).to_s
+      end
+
+      find_coupled_components(graph)
+    end
+
+    def find_coupled_components(graph)
+      graph
+        .strongly_connected_components
+        .select { |c| c.length > 1 }
+        .flatten
+        .to_set
+    end
+
+    def circular_relation?(components, relation)
+      components.include?(relation.namespace.to_s) &&
+        components.include?(relation.caller_namespace.to_s)
+    end
+
+    attr_reader :files
   end
 end

data/lib/rubrowser/formatter/json.rb

@@ -10,7 +10,9 @@ module Rubrowser
       def call
         {
           definitions: data.definitions.map { |d| definition_as_json(d) },
-          relations: data.relations.map { |r| relation_as_json(r, data.definitions) }
+          relations: data.relations.map do |r|
+            relation_as_json(r, data.definitions)
+          end
         }.to_json
       end
 
@@ -22,6 +24,7 @@ module Rubrowser
         {
           type: demoularize(definition.class.name),
           namespace: definition.to_s,
+          circular: definition.circular?,
           file: definition.file,
           line: definition.line,
           lines: definition.lines
@@ -35,6 +38,7 @@ module Rubrowser
           resolved_namespace: relation.resolve(definitions).to_s,
           caller: relation.caller_namespace.to_s,
           file: relation.file,
+          circular: relation.circular?,
           line: relation.line
         }
       end

data/lib/rubrowser/graph.rb

@@ -0,0 +1,11 @@
+require 'tsort'
+
+class Graph < Hash
+  include TSort
+
+  alias tsort_each_node each_key
+
+  def tsort_each_child(node, &block)
+    fetch(node) { [] }.each(&block)
+  end
+end

data/lib/rubrowser/parser/definition/base.rb

@@ -9,6 +9,7 @@ module Rubrowser
           @file = file
           @line = line
           @lines = lines
+          @circular = false
         end
 
         def name
@@ -23,6 +24,14 @@ module Rubrowser
           namespace.empty?
         end
 
+        def circular?
+          @circular
+        end
+
+        def set_circular
+          @circular = true
+        end
+
         def ==(other)
           namespace == other.namespace
         end

data/lib/rubrowser/parser/file.rb

@@ -19,22 +19,29 @@ module Rubrowser
 
       def parse
         return unless valid_file?(file)
+        constants = constants_from_file
+
+        @definitions = constants[:definitions]
+        @relations = constants[:relations]
+      rescue ::Parser::SyntaxError
+        warn "SyntaxError in #{file}"
+      end
+
+      def constants_from_file
         contents = ::File.read(file)
 
         buffer = ::Parser::Source::Buffer.new(file, 1)
         buffer.source = contents.force_encoding(Encoding::UTF_8)
 
+        ast = parser.parse(buffer)
+        parse_block(ast)
+      end
+
+      def parser
         parser = ::Parser::CurrentRuby.new(Builder.new)
         parser.diagnostics.ignore_warnings = true
         parser.diagnostics.all_errors_are_fatal = false
-
-        ast = parser.parse(buffer)
-        constants = parse_block(ast)
-
-        @definitions = constants[:definitions]
-        @relations = constants[:relations]
-      rescue ::Parser::SyntaxError
-        warn "SyntaxError in #{file}"
+        parser
       end
 
       def valid_file?(file)
@@ -58,26 +65,25 @@ module Rubrowser
 
       def parse_module(node, parents = [])
         namespace = ast_consts_to_array(node.children.first, parents)
-        definition = Definition::Module.new(
-          namespace,
-          file: file,
-          line: node.loc.line,
-          lines: node.loc.last_line - node.loc.line + 1
-        )
+        definition = build_definition(Definition::Module, namespace, node)
         constants = { definitions: [definition] }
         children_constants = parse_array(node.children[1..-1], namespace)
 
         merge_constants(children_constants, constants)
       end
 
-      def parse_class(node, parents = [])
-        namespace = ast_consts_to_array(node.children.first, parents)
-        definition = Definition::Class.new(
+      def build_definition(klass, namespace, node)
+        klass.new(
           namespace,
           file: file,
           line: node.loc.line,
           lines: node.loc.last_line - node.loc.line + 1
         )
+      end
+
+      def parse_class(node, parents = [])
+        namespace = ast_consts_to_array(node.children.first, parents)
+        definition = build_definition(Definition::Class, namespace, node)
         constants = { definitions: [definition] }
         children_constants = parse_array(node.children[1..-1], namespace)
 
@@ -111,7 +117,7 @@ module Rubrowser
 
       def ast_consts_to_array(node, parents = [])
         return parents unless valid_node?(node) &&
-                              [:const, :cbase].include?(node.type)
+                              %I[const cbase].include?(node.type)
         ast_consts_to_array(node.children.first, parents) + [node.children.last]
       end
 

data/lib/rubrowser/parser/relation/base.rb

@@ -11,6 +11,7 @@ module Rubrowser
           @caller_namespace = caller_namespace
           @file = file
           @line = line
+          @is_circular = false
         end
 
         def namespace
@@ -21,6 +22,14 @@ module Rubrowser
           Definition::Base.new(@caller_namespace, file: file, line: line)
         end
 
+        def circular?
+          @is_circular
+        end
+
+        def set_circular
+          @is_circular = true
+        end
+
         def resolve(definitions)
           possibilities.find do |possibility|
             definitions.any? { |definition| definition == possibility }
@@ -29,7 +38,8 @@ module Rubrowser
 
         def ==(other)
           namespace == other.namespace &&
-            caller_namespace == other.caller_namespace
+            caller_namespace == other.caller_namespace &&
+            circular? == other.circular?
         end
 
         private

data/lib/rubrowser/version.rb

@@ -1,3 +1,3 @@
 module Rubrowser
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/public/css/application.css

@@ -27,6 +27,10 @@ circle {
   stroke-width: 1.5px;
 }
 
+.circular {
+    stroke: #FF0000;
+}
+
 .fixed circle {
   stroke-width: 3px;
 }

data/public/javascript/application.js

@@ -4,6 +4,10 @@ d3.json("/data.json", function(error, data) {
   $('.toolbox').show();
 });
 
+var classForCircular = function(d) {
+  return d.circular ? 'circular' : '';
+};
+
 var parseGraph = function(data){
   var svg = d3.select(".dependency_graph svg"),
       $svg = $('.dependency_graph svg'),
@@ -13,16 +17,17 @@ var parseGraph = function(data){
         .on("start", dragstarted)
         .on("drag", dragged)
       .on("end", dragended),
-      dup_definitions = data.definitions.map(function(d){ return {id: d.namespace, type: d.type, lines: d.lines }; }),
+      dup_definitions = data.definitions.map(function(d){ return {id: d.namespace, type: d.type, lines: d.lines, circular: d.circular }; }),
       definitions = _(dup_definitions).groupBy('id').map(function(group) {
         return {
           id: group[0].id,
           type: group[0].type,
-          lines: _(group).sumBy('lines')
+          lines: _(group).sumBy('lines'),
+          circular: group[0].circular
         };
       }).value(),
       namespaces = definitions.map(function(d){ return d.id; }),
-      relations = data.relations.map(function(d){ return {source: d.caller, target: d.resolved_namespace }; }),
+      relations = data.relations.map(function(d){ return {source: d.caller, target: d.resolved_namespace, circular: d.circular}; }),
       max_lines = _.maxBy(definitions, 'lines').lines,
       max_circle_r = 50;
 
@@ -58,7 +63,7 @@ var parseGraph = function(data){
         .selectAll("path")
         .data(relations)
         .enter().append("path")
-        .attr("class", 'link')
+        .attr("class", function(d) { return 'link ' + classForCircular(d); })
         .attr("marker-end", function(d){ return "url(#" + d.target.id + ")"; }),
       node = container.append("g")
         .attr("class", "nodes")
@@ -69,7 +74,8 @@ var parseGraph = function(data){
         .on("dblclick", dblclick),
       circle = node
         .append("circle")
-        .attr("r", function(d) { return d.lines / max_lines * max_circle_r + 6; }),
+        .attr("r", function(d) { return d.lines / max_lines * max_circle_r + 6; })
+        .attr("class", function (d) { return classForCircular(d) ; }),
       type = node
         .append("text")
         .attr("class", "type")

data/readme.md

@@ -60,11 +60,8 @@ it'll analyze the current directory and open port 9000, so you can access the gr
 * hide relations
 * change graph appearance (collision radius)
 * stop animation immediately
-
-
-## Tests?
-
-What tests? :smile:
+* Module/class circle size on the graph will be relative to module number of lines in your code
+* cyclical dependencies are marked in red
 
 ## Why?
 

data/rubrowser.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'parser', '~> 2.3', '>= 2.3.0'
   s.add_development_dependency 'bundler', '~> 1.14'
   s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubrowser
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -58,6 +58,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A ruby interactive dependency graph visualizer
 email:
 - blazeeboy@gmail.com
@@ -67,15 +109,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - Rakefile
+- _config.yml
 - bin/rubrowser
 - lib/rubrowser.rb
 - lib/rubrowser/data.rb
 - lib/rubrowser/formatter/json.rb
+- lib/rubrowser/graph.rb
 - lib/rubrowser/parser/definition/base.rb
 - lib/rubrowser/parser/definition/class.rb
 - lib/rubrowser/parser/definition/module.rb