rubrowser 0.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa463c82a9510b20cb22bf00daeac6fc23bfab95
-  data.tar.gz: a5b0c4b8aab45182208e7b5811c682a3fc64fca8
+  metadata.gz: 37e83a67859f66506295f0fdff3237407c2c9a6d
+  data.tar.gz: 2ab42f6e3208468743ad5722f130accf2849d101
 SHA512:
-  metadata.gz: b9c9d3ab34e424af0e497a973cb70a6f858d64e59bbb6e949a3c3c222dcb1ec38f26587e1c841cdea5b18312939c5c6dcc451ae771cf6cf2a3ec8f8b61336c9e
-  data.tar.gz: dc90749e99a239e0815139671b152b3ad27f819b5233db28029014de5934be7b4dd0023aac29031d68f65df40687996c7d10decc88bdc6ba86577bfa1e90cbbe
+  metadata.gz: 2e47b9d43b0e0a71a6a58b678960c6d72b869503e1efddc4221f1ff015631f15883f35e0a76b17c2aa72f7889e730d13339c133791071909e9f2bae3cb4909ef
+  data.tar.gz: eed29f968098beebbe11e6abfd8987be1f2c162d5bda4ab5d389f157895ed6d22dfe52461a6f9d7e1f161e95efd0aef8f7a3adb076542b5f066734084570174c

data/Gemfile.lock

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

data/bin/rubrowser

@@ -3,21 +3,15 @@ $LOAD_PATH.push File.expand_path('../../lib', __FILE__)
 
 require 'optparse'
 require 'rubrowser'
-require 'rubrowser/server'
+require 'rubrowser/renderer'
 
 options = {
-  port: 9000,
   files: ARGV.empty? ? ['.'] : ARGV
 }
 
 OptionParser.new do |opts|
   opts.banner = "Usage: #{__FILE__} [options] [file] ..."
 
-  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
     puts "Rubrowser #{Rubrowser::VERSION}"
     exit
@@ -29,4 +23,4 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-Rubrowser::Server.start(options)
+puts Rubrowser::Renderer.call(options)

data/lib/rubrowser/{server.rb → renderer.rb}

@@ -1,45 +1,27 @@
-require 'webrick'
 require 'erb'
 require 'rubrowser/data'
 require 'rubrowser/formatter/json'
 
 module Rubrowser
-  class Server < WEBrick::HTTPServer
+  class Renderer
     # Accepted options are:
-    # port: port number for the server
     # files: list of file paths to parse
-    def self.start(options = {})
-      new(options).start
+    def self.call(options = {})
+      new(options).call
+    end
+
+    def call
+      erb :index
     end
 
     private
 
     include ERB::Util
 
-    ROUTES = {
-      '/' => :root,
-      '/data.json' => :data
-    }.freeze
-
     attr_reader :files
 
     def initialize(options)
-      super Port: options[:port]
       @files = options[:files]
-
-      mount_proc '/' do |req, res|
-        res.body = router(req.path)
-      end
-    end
-
-    def router(path)
-      return file(path) if file?(path)
-      return send(ROUTES[path]) if ROUTES.key?(path)
-      'Route not found.'
-    end
-
-    def root
-      erb :index
     end
 
     def data
@@ -48,13 +30,8 @@ module Rubrowser
       formatter.call
     end
 
-    def file?(path)
-      path = resolve_file_path("/public#{path}")
-      File.file?(path)
-    end
-
     def file(path)
-      File.read(resolve_file_path("/public#{path}"))
+      File.read(resolve_file_path("/public/#{path}"))
     end
 
     def erb(template)

data/lib/rubrowser/version.rb

@@ -1,3 +1,3 @@
 module Rubrowser
-  VERSION = '0.3.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/public/css/application.css

@@ -6,15 +6,6 @@ html, body, .dependency_graph, .dependency_graph svg{
     font: 10px sans-serif;
 }
 
-.loading{
-    position: absolute;
-    top: 30px;
-    left: 0px;
-    text-align: center;
-    width: 100%;
-    font-size: 3rem;
-}
-
 .link {
   fill: none;
   stroke: #666;
@@ -77,7 +68,6 @@ text.type{
     width: 200px;
     background: white;
     border-right: 1px solid #ddd;
-    display: none;
     overflow: auto;
 }
 

data/public/javascript/application.js

@@ -1,9 +1,3 @@
-d3.json("/data.json", function(error, data) {
-  parseGraph(data);
-  $('.loading').hide();
-  $('.toolbox').show();
-});
-
 var classForCircular = function(d) {
   return d.circular ? 'circular' : '';
 };
@@ -172,3 +166,5 @@ var parseGraph = function(data){
   };
   $(document).trigger('graph-rendered');
 };
+
+parseGraph(data);

data/readme.md

@@ -2,26 +2,41 @@
 
 [![Gem Version](https://badge.fury.io/rb/rubrowser.svg)](https://badge.fury.io/rb/rubrowser)
 
-a visualizer for ruby code (rails or otherwise), it analyze your code and extract the modules definitions and used classes/modules and render all these information as a directed force graph using D3.
+
+
+a visualizer for ruby code (rails or otherwise), it analyze your code and
+extract the modules definitions and used classes/modules and render all these
+information as a directed force graph using D3.
+
+### Note:
+
+Starting from version 2.0.0 the project is no longer an http server, it
+generates one HTML file that is self-contained, data and script and html in one
+file, so you can generate it in your CI build and publish it as part of your
+documentation
 
 this project is so small that the visualization looks like so
 
 ![rubrowser visualization](http://i.imgur.com/5mbshee.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 listed inside this module/class and link them together.
+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
+listed inside this module/class and link them together.
 
 Here are some output examples
 
-| Gem        | Visualization    |
-| ------------- |:-------------:|
-| rack-1.6.4/lib      | ![rake](http://i.imgur.com/4UsCo0a.png) |
-| actioncable-5.0.0/lib      | ![acioncable](http://i.imgur.com/Q0Xqjsz.png) |
-| railties-5.0.0/lib      | ![railties](http://i.imgur.com/31g10a1.png) |
+| Gem                   | Visualization                                 |
+| -------------         | :-------------:                               |
+| rack-1.6.4/lib        | ![rake](http://i.imgur.com/4UsCo0a.png)       |
+| actioncable-5.0.0/lib | ![acioncable](http://i.imgur.com/Q0Xqjsz.png) |
+| railties-5.0.0/lib    | ![railties](http://i.imgur.com/31g10a1.png)   |
 
 there are couple things you need to keep in mind:
 
-* if your file doesn't have a valid ruby syntax it won't be parsed and will print warning.
-* if you reference a class that is not defined in your project it won't be in the graph, we only display the graph of classes/modules you defined
+* if your file doesn't have a valid ruby syntax it won't be parsed and will
+  print warning.
+* if you reference a class that is not defined in your project it won't be in
+  the graph, we only display the graph of classes/modules you defined
 * it statically analyze the code so meta programming is out of question in here
 * rails associations are meta programming so forget it :smile:
 
@@ -37,7 +52,6 @@ gem install rubrowser
 
 ```
 Usage: rubrowser [options] [file] ...
-    -p, --port=PORT                  Specify port number for server, default = 9000
     -v, --version                    Print Rubrowser version
     -h, --help                       Prints this help
 ```
@@ -46,25 +60,33 @@ if you run it without any options
 ```
 rubrowser
 ```
-it'll analyze the current directory and open port 9000, so you can access the graph from `localhost:9000`
+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
+```
 
 ## Features
 
 * interactive graph, you can pull any node to fix it to some position
 * to release node double click on it
 * 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
+* 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
 * ignore nodes of certain type (modules/classes)
 * hide namespaces
 * hide relations
 * change graph appearance (collision radius)
 * stop animation immediately
-* Module/class circle size on the graph will be relative to module number of lines in your code
+* 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?
 
-Because i didn't find a good visualization tool to make me understand ruby projects when I join a new one.
+Because i didn't find a good visualization tool to make me understand ruby
+projects when I join a new one.
 
-it's great when you want to get into an open source project and visualize the structure to know where to work and the relations between modules/classes.
+it's great when you want to get into an open source project and visualize the
+structure to know where to work and the relations between modules/classes.

data/views/index.erb

@@ -3,14 +3,12 @@
   <head>
     <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
     <title>Rubrowser</title>
-    <link href='/css/application.css' media='all' rel='stylesheet'>
+    <link media='all' rel='stylesheet'>
+    <style><%= file('css/application.css') %></style>
   </head>
   <body>
     <div class='dependency_graph'>
       <svg></svg>
-      <div class="loading">
-        Parsing files...
-      </div>
     </div>
     <div class="toolbox">
       <div class="panel">
@@ -49,10 +47,13 @@
       </div>
     </div>
 
-    <script src='/javascript/lodash.js' type='text/javascript'></script>
-    <script src='/javascript/d3.js' type='text/javascript'></script>
-    <script src='/javascript/jquery.js' type='text/javascript'></script>
-    <script src='/javascript/application.js' type='text/javascript'></script>
-    <script src='/javascript/toolbox.js' type='text/javascript'></script>
+    <script src='https://unpkg.com/lodash@4.17.4/lodash.min.js' type='text/javascript'></script>
+    <script src='https://unpkg.com/d3@4.13.0/build/d3.min.js' type='text/javascript'></script>
+    <script src='https://unpkg.com/jquery@3.3.1/dist/jquery.min.js' type='text/javascript'></script>
+    <script type='text/javascript'>
+     var data = <%= data %>
+    </script>
+    <script type='text/javascript'><%= file('javascript/application.js') %></script>
+    <script type='text/javascript'><%= file('javascript/toolbox.js') %></script>
   </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubrowser
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -130,7 +130,7 @@ files:
 - lib/rubrowser/parser/file.rb
 - lib/rubrowser/parser/file/builder.rb
 - lib/rubrowser/parser/relation/base.rb
-- lib/rubrowser/server.rb
+- lib/rubrowser/renderer.rb
 - lib/rubrowser/version.rb
 - public/css/application.css
 - public/javascript/application.js