rubrowser 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b96b57265b40b9d6be08133f053972d10052ba5f1e977a24d6c0ffb14aa0e5c
-  data.tar.gz: 47438b460b1f3276bc21c9f80ec3b95b34771a498c0601c8c85a4ceb5acc7912
+  metadata.gz: e67fd969c9155da49e88d2cc1fd703ac364064841a3800ad03c70bc7c922bfc7
+  data.tar.gz: 478c3f44d920a685109f24630e17658f3854adc3db675596baa285e4ec8e4538
 SHA512:
-  metadata.gz: c6260b25527525ec6d2a67c8c691b681f24ba03cbff1630bfb631ded4f09ea73f129c3727d4501343b2d18f38318903f1ae99900c342b51a9cfcbd0842d676e9
-  data.tar.gz: 887c3e30156229cfac868468020ca48a47fc1d72358b44554341a4f19f732c92317fe5df02e6056bd765ae3c41306e3ebc19b51588915046f87b1073371e5018
+  metadata.gz: 454bcb581e7fa255cce469d2b82f4321aa0d9f2cf127d2439a99ab437836028587d05a75214b224e1930c971c8b93739aa85838f1a3588658c3909c9d7c84d50
+  data.tar.gz: 5281d603a1ab859d8609fb05a04ecb63b923beb65977e89ce628a8e6716d17c817eae2ec43e53496f377d348aced37f923374022cf9b5540191157a332bc0f25

data/.rubrowser

@@ -0,0 +1 @@
+[{"id":"Rubrowser::Data","x":905.0088057752334,"y":437.04147016200284},{"id":"Rubrowser","x":712.6220053486966,"y":770.3251873644217},{"id":"Rubrowser::Formatter::JSON","x":1114.4368770370438,"y":560.0312580369882},{"id":"Rubrowser::Formatter","x":1113.6584254066838,"y":601.6487084046246},{"id":"Graph","x":1115.7752854976002,"y":436.6211350242928},{"id":"Rubrowser::Parser::Definition::Base","x":-8.218934126737395,"y":322.74585638398685},{"id":"Rubrowser::Parser::Definition","x":-191.1839782278871,"y":318.6377197576412},{"id":"Rubrowser::Parser","x":713.688310910547,"y":660.9646559993857},{"id":"Rubrowser::Parser::Definition::Class","x":186.15033111747857,"y":246.30753307276427},{"id":"Rubrowser::Parser::Definition::Module","x":188.36911863082037,"y":324.35744429623855},{"id":"Rubrowser::Parser::Directory","x":786.9998045114313,"y":239.74214301898786},{"id":"Rubrowser::Parser::Factory","x":788.0050388528484,"y":325.70343641742613},{"id":"Rubrowser::Parser::File::Builder","x":506.8969046429671,"y":189.48025894394402},{"id":"Rubrowser::Parser::File","x":505.82216034587793,"y":322.6733725221146},{"id":"Rubrowser::Parser::Relation::Base","x":185.12905462589924,"y":402.5519743127113},{"id":"Rubrowser::Parser::Relation","x":187.0097719718301,"y":461.8654698954514},{"id":"Rubrowser::Renderer","x":905.2158605930458,"y":560.8807631671766}]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubrowser (2.4.0)
+    rubrowser (2.5.0)
       parser (~> 2.3, >= 2.3.0)
 
 GEM

data/lib/rubrowser/version.rb

@@ -1,3 +1,3 @@
 module Rubrowser
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/public/css/application.css

@@ -40,15 +40,21 @@ text.type{
     opacity: 0.1;
 }
 
-.type_ignored, .name_ignored{
+.ignored{
     display: none;
 }
 
-.highlighted, .name_highlighted, .type_highlighted{
+.highlighted,
+.highlighted_by_namespace,
+.highlighted_by_path,
+.highlighted_by_type{
     fill: #008ef3;
 }
 
-.highlighted circle, .name_highlighted circle, .type_highlighted circle{
+.highlighted circle,
+.highlighted_by_namespace circle,
+.highlighted_by_path circle,
+.highlighted_by_type circle{
     stroke: #008ef3;
 }
 

data/public/javascript/application.js

@@ -10,13 +10,22 @@ var svg = d3.select(".dependency_graph svg"),
     .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, circular: d.circular }; }),
+    dup_definitions = data.definitions.map(function(d){
+      return {
+        id: d.namespace,
+        file: d.file,
+        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'),
-        circular: group[0].circular
+        circular: group[0].circular,
+        files: group.map(function(d){ return d.file; })
       };
     }).value(),
     namespaces = definitions.map(function(d){ return d.id; }),

data/public/javascript/toolbox.js

@@ -51,11 +51,25 @@ rubrowser.node.on('click', function(d){
 // --------------------------------
 $(document).on('change', '#highlight_by_namespace', function(){
   var highlights_entries = $(this).val().trim();
-  var highlights = highlights_entries.split("\n");
+  var highlights = _(highlights_entries.split("\n"));
 
-  rubrowser.node.classed('name_highlighted', function(d){
+  rubrowser.node.classed('highlighted_by_namespace', function(d){
     if(highlights_entries.length == 0){ return false; }
-    return highlights.filter(function(i){ return d.id.indexOf(i) > -1; }).length > 0;
+    return highlights.some(function(i){ return d.id.indexOf(i) > -1; });
+  });
+});
+
+$(document).on('change', '#highlight_by_file_path', function(){
+  var highlights_entries = $(this).val().trim();
+  var highlights = _(highlights_entries.split("\n"));
+
+  rubrowser.node.classed('highlighted_by_path', function(d){
+    if(highlights_entries.length == 0){ return false; }
+    return highlights.some(function(i){
+      return _(d.files).some(function(f) {
+        return f.indexOf(i) > -1;
+      });
+    });
   });
 });
 
@@ -63,7 +77,7 @@ $(document).on('change', '#highlight_modules, #highlight_classes', function(){
   var modules_highlighted = $('#highlight_modules').is(':checked'),
       classes_highlighted = $('#highlight_classes').is(':checked');
 
-  rubrowser.node.classed('type_highlighted', function(d){
+  rubrowser.node.classed('highlighted_by_type', function(d){
     return (d.type == 'Module' && modules_highlighted) || (d.type == 'Class' && classes_highlighted);
   });
 });
@@ -71,51 +85,91 @@ $(document).on('change', '#highlight_modules, #highlight_classes', function(){
 // --------------------------------
 // Ignore Panel
 // --------------------------------
+var ignoring_functions = {};
+
+function updateNodes() {
+
+  function ignoreNode(d) {
+    return _(ignoring_functions).some(function(ignoring_function) {
+      return ignoring_function(d);
+    });
+  }
+
+  function notIgnoreNode(d){
+    return !ignoreNode(d);
+  }
+  function ignoreRelation(r){
+    return ignoreNode(r.source) || ignoreNode(r.target);
+  }
+
+  function notIgnoreRelation(r){
+    return !ignoreRelation(r);
+  }
+
+  var filtered_definitions = rubrowser.definitions.filter(notIgnoreNode);
+  rubrowser.simulation.nodes(filtered_definitions);
+  rubrowser.node.classed('ignored', ignoreNode);
+
+  var filtered_relations = rubrowser.relations.filter(notIgnoreRelation);
+  rubrowser.simulation.force("link").links(filtered_relations);
+  rubrowser.link.classed('ignored', ignoreRelation);
+}
+
 $(document).on('change', '#ignore_by_namespace', function(){
   var ignores_entries = $(this).val().trim();
   var ignores = ignores_entries.split("\n");
 
-  // filtering definitions
-  var filtered_definitions = rubrowser.definitions.filter(function(d){
-    if(ignores_entries.length == 0){ return true; }
-    return ignores.filter(function(i){ return d.id.indexOf(i) > -1; }).length == 0;
-  })
-
-  rubrowser.simulation
-    .nodes(filtered_definitions)
+  if(ignores_entries.length == 0){
+    delete ignoring_functions["ignore_by_name"];
+  }else{
+    ignoring_functions["ignore_by_name"] = function(d){
+      return ignores.some(function(i){ return d.id.indexOf(i) > -1; });
+    }
+  }
 
-  rubrowser.node.classed('name_ignored', function(d){
-    if(ignores_entries.length == 0){ return false; }
-    return ignores.filter(function(i){ return d.id.indexOf(i) > -1; }).length > 0;
-  });
+  updateNodes();
+});
 
-  // filtering relations
-  var filtered_relations = rubrowser.relations.filter(function(d){
-      if(ignores_entries.length == 0){ return true; }
-      return ignores.filter(function(i){ return d.source.id.indexOf(i) > -1 || d.target.id.indexOf(i) > -1; }).length == 0;
-  })
+$(document).on('change', '#ignore_by_file_path', function(){
+  var ignores_entries = $(this).val().trim();
+  var ignores = ignores_entries.split("\n");
 
-  rubrowser.simulation
-    .force("link")
-    .links(filtered_relations);
+  if(ignores_entries.length == 0){
+    delete ignoring_functions["ignore_by_file_path"];
+  }else{
+    ignoring_functions["ignore_by_file_path"] = function(d){
+      return ignores.some(function(i){
+        return _(d.files).every(function(f){
+          return f.indexOf(i) > -1;
+        });
+      });
+    }
+  }
 
-  rubrowser.link.classed('name_ignored', function(d){
-    if(ignores_entries.length == 0){ return false; }
-    return ignores.filter(function(i){ return d.source.id.indexOf(i) > -1 || d.target.id.indexOf(i) > -1; }).length > 0;
-  });
+  updateNodes();
 });
 
 $(document).on('change', '#ignore_modules, #ignore_classes', function(){
   var modules_ignored = $('#ignore_modules').is(':checked'),
       classes_ignored = $('#ignore_classes').is(':checked');
 
-  rubrowser.node.classed('type_ignored', function(d){
-    return (d.type == 'Module' && modules_ignored) || (d.type == 'Class' && classes_ignored);
-  });
-  rubrowser.link.classed('type_ignored', function(d){
-    return ((d.source.type == 'Module' && modules_ignored) || (d.source.type == 'Class' && classes_ignored)) ||
-      ((d.target.type == 'Module' && modules_ignored) || (d.target.type == 'Class' && classes_ignored));
-  });
+  if( modules_ignored ){
+    ignoring_functions["ignore_modules"] = function(d) {
+      return d.type == 'Module';
+    }
+  }else{
+    delete ignoring_functions["ignore_modules"];
+  }
+
+  if( classes_ignored ){
+    ignoring_functions["ignore_classes"] = function(d) {
+      return d.type == 'Class';
+    }
+  }else{
+    delete ignoring_functions["ignore_classes"];
+  }
+
+  updateNodes();
 });
 
 // --------------------------------
@@ -140,6 +194,22 @@ $(document).on('click', "#pause_simulation", function(){
     rubrowser.simulation.stop();
 });
 
+$(document).on('click', "#fix_all", function(){
+  rubrowser.node.classed("fixed", true);
+  rubrowser.node.each(function(d){
+    d.fx = d.x;
+    d.fy = d.y;
+  });
+});
+
+$(document).on('click', "#release_all", function(){
+  rubrowser.node.classed("fixed", false);
+  rubrowser.node.each(function(d){
+    delete d["fx"];
+    delete d["fy"];
+  });
+});
+
 $(document).on('click', "#download_layout", function(){
   var json = JSON.stringify(rubrowser.state.get());
   var element = document.createElement('a');

data/readme.md

@@ -17,7 +17,7 @@ documentation
 
 this project is so small that the visualization looks like so
 
-![rubrowser visualization](http://i.imgur.com/5mbshee.png)
+![rubrowser visualization](https://i.imgur.com/2tWrl2s.png)
 
 the idea is that the project opens every `.rb` file and parse it with `parser`
 gem then list all modules and classes definitions, and all constants that are
@@ -63,12 +63,37 @@ if you run it without any options
 ```
 rubrowser
 ```
-it'll analyze the current directory and print out an HTML file, so you can write it to a file, and open it in your browser
+
+it'll analyze the current directory and print out an HTML file, so you can write
+it to a file, and open it in your browser
 
 ```
 rubrowser > output.html
 ```
 
+## Using a saved layout
+
+When you move classes/modules in the graph to fix them in one place, then you
+refresh the page, you'll reset the graph again.
+
+for that reason there is a button to download the current graph state as json file (fixed
+nodes positions), when you generate the graph again you can pass that file to
+rubrowser to embed it inside the output HTML file.
+
+```
+rubrowser -l layout.json
+```
+
+I recommend putting that file in your project and name it `.rubrowser` in that
+case it'll be easy to use it whenever you generate the graph.
+
+```
+rubrowser -l .rubrowser
+```
+
+So that in the future probably rubrowser can pick the file automatically, if you
+follow that naming, your project will be ready in that case.
+
 ## Features
 
 * interactive graph, you can pull any node to fix it to some position
@@ -76,16 +101,21 @@ rubrowser > output.html
 * zoom and pan with mouse or touch pad
 * highlight node and all related nodes, it'll make it easier for you to see what
   depends and dependencies of certain class
-* ignore node by name
+* highlight nodes by names or file path
+* ignore node by name, or file path
 * ignore nodes of certain type (modules/classes)
 * hide namespaces
 * hide relations
 * change graph appearance (collision radius)
 * stop animation immediately
+* fix all nodes in position or release all fixed nodes
 * Module/class circle size on the graph will be relative to module number of
   lines in your code
 * cyclical dependencies are marked in red
-* after you move nodes around, you can download the layout as a file, then provide it when generating the graph file again with `-l file.json` it will embed the layout in the file and the graph will have the same layout by default.
+* after you move nodes around, you can download the layout as a file, then
+  provide it when generating the graph file again with `-l file.json` it will
+  embed the layout in the file and the graph will have the same layout by
+  default.
 
 ## Why?
 

data/views/toolbox.erb

@@ -1,16 +1,20 @@
 <div class="toolbox">
-  <div class="card mt-2">
+  <div class="card ml-2 mt-2">
     <div class="card-header">Node Details</div>
     <div class="card-body" id="information_panel">
       Please click on any node.
     </div>
   </div>
-  <div class="card mt-2">
+  <div class="card ml-2 mt-2">
     <div class="card-header">Search</div>
     <div class="card-body">
       <label class="form-label">Namespace</label>
       <textarea id="highlight_by_namespace" class="form-control" rows="5"></textarea>
     </div>
+    <div class="card-body">
+      <label class="form-label">File Path</label>
+      <textarea id="highlight_by_file_path" class="form-control" rows="5"></textarea>
+    </div>
     <div class="card-body">
       <div class="form-check">
         <input type="checkbox" class="form-check-input" id="highlight_modules"/>
@@ -22,12 +26,16 @@
       </div>
     </div>
   </div>
-  <div class="card mt-2">
+  <div class="card ml-2 mt-2">
     <div class="card-header">Ignore</div>
     <div class="card-body">
       <label>Namespace</label>
       <textarea id="ignore_by_namespace" class="form-control" rows="5"></textarea>
     </div>
+    <div class="card-body">
+      <label>File Path</label>
+      <textarea id="ignore_by_file_path" class="form-control" rows="5"></textarea>
+    </div>
     <div class="card-body">
       <div class="form-check">
         <input type="checkbox" class="form-check-input" id="ignore_modules"/>
@@ -39,11 +47,13 @@
       </div>
     </div>
   </div>
-  <div class="card mt-2">
+  <div class="card ml-2 mt-2">
     <div class="card-header">Display</div>
     <div class="card-body">
       <button type="button" id="download_layout" class="btn btn-secondary btn-block">Download layout</button>
       <button type="button" id="pause_simulation" class="btn btn-secondary btn-block">Pause animation</button>
+      <button type="button" id="fix_all" class="btn btn-secondary btn-block">Fix all</button>
+      <button type="button" id="release_all" class="btn btn-secondary btn-block">Release all</button>
     </div>
     <div class="card-body">
       <label class="form-label">Force Collide</label>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubrowser
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -112,6 +112,7 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubrowser"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE