rubrowser 2.5.0 → 2.9.0

data/readme.md

@@ -1,7 +1,7 @@
-# Rubrowser
+# Rubrowser (Ruby Browser)
 
 [![Gem Version](https://badge.fury.io/rb/rubrowser.svg)](https://badge.fury.io/rb/rubrowser)
-
+[![Build Status](https://travis-ci.org/emad-elsaid/rubrowser.svg?branch=master)](https://travis-ci.org/emad-elsaid/rubrowser)
 
 
 a visualizer for ruby code (rails or otherwise), it analyze your code and
@@ -17,7 +17,7 @@ documentation
 
 this project is so small that the visualization looks like so
 
-![rubrowser visualization](https://i.imgur.com/2tWrl2s.png)
+![rubrowser visualization](https://i.imgur.com/zKjc7G5.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
@@ -54,7 +54,9 @@ gem install rubrowser
 Usage: rubrowser [options] [file] ...
     -o, --output=FILE                output file page, if not specified output will be written to stdout
     -l, --layout=FILE                layout file to apply on the resulting graph
+    -s, --server=SERVER:PORT         rubrowser server for execution monitoring
     -T, --no-toolbox                 Don't display toolbox on the page
+    -j, --json                       Do export data as JSON instead of HTML
     -v, --version                    Print Rubrowser version
     -h, --help                       Prints this help
 ```
@@ -71,6 +73,30 @@ it to a file, and open it in your browser
 rubrowser > output.html
 ```
 
+## Monitoring your application execution
+
+Add rubrowser to your ruby project `Gemfile`
+```
+gem 'rubrowser'
+```
+
+Add the following code before your application runs, if it's a rails project
+this should be an initializer
+
+```
+Rubrowser::Monitor.run(path: Rails.root.to_s, port: 8080)
+```
+
+path is your code path, and port is the execution websocket server port, the
+server will open that port and announce any execution happens to the code inside
+your project directory.
+
+now generate a rubrowser HTML output that connect to your server
+
+```
+rubrowser -slocalhost:8080 > output.html
+```
+
 ## Using a saved layout
 
 When you move classes/modules in the graph to fix them in one place, then you
@@ -94,8 +120,16 @@ 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.
 
+## Export data for use in external tools
+
+```
+rubrowser -j|jq '.'
+```
+
+
 ## Features
 
+* trace your execution in realtime on the graph
 * 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

data/rubrowser.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rubrowser/version'
 
@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = 'rubrowser'
   s.version     = Rubrowser::VERSION
   s.authors     = ['Emad Elsaid']
-  s.email       = ['blazeeboy@gmail.com']
-  s.homepage    = 'https://github.com/blazeeboy/rubrowser'
+  s.email       = ['emad.elsaid.hamed@gmail.com']
+  s.homepage    = 'https://github.com/emad-elsaid/rubrowser'
   s.summary     = 'A ruby interactive dependency graph visualizer'
   s.description = 'A ruby interactive dependency graph visualizer'
   s.license     = 'MIT'
@@ -19,9 +19,13 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  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_runtime_dependency 'parser'
+  s.add_runtime_dependency 'puma'
+  s.add_runtime_dependency 'litecable'
+  s.add_runtime_dependency 'websocket'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'byebug'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rspec'

data/views/index.erb

@@ -26,5 +26,12 @@
       <%= erb :toolbox %>
       <script type='text/javascript'><%= file('javascript/toolbox.js') %></script>
     <% end %>
+
+    <% if server %>
+      <script type='text/javascript'>
+       server = "ws://<%= server %>";
+       <%= file('javascript/websocket.js') %>
+      </script>
+    <% end %>
   </body>
 </html>

data/views/toolbox.erb

@@ -1,10 +1,4 @@
 <div class="toolbox">
-  <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 ml-2 mt-2">
     <div class="card-header">Search</div>
     <div class="card-body">
@@ -69,3 +63,5 @@
     </div>
   </div>
 </div>
+
+<div id="information_panel" class="card"></div>

metadata

@@ -1,63 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: rubrowser
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Emad Elsaid
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
   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: '2.3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: litecable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket
+  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.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +138,7 @@ dependencies:
         version: '0'
 description: A ruby interactive dependency graph visualizer
 email:
-- blazeeboy@gmail.com
+- emad.elsaid.hamed@gmail.com
 executables:
 - rubrowser
 extensions: []
@@ -113,6 +149,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubrowser"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -120,9 +157,12 @@ files:
 - _config.yml
 - bin/rubrowser
 - lib/rubrowser.rb
+- lib/rubrowser/channel.rb
+- lib/rubrowser/connection.rb
 - lib/rubrowser/data.rb
 - lib/rubrowser/formatter/json.rb
 - lib/rubrowser/graph.rb
+- lib/rubrowser/monitor.rb
 - lib/rubrowser/parser/definition/base.rb
 - lib/rubrowser/parser/definition/class.rb
 - lib/rubrowser/parser/definition/module.rb
@@ -132,19 +172,22 @@ files:
 - lib/rubrowser/parser/file/builder.rb
 - lib/rubrowser/parser/relation/base.rb
 - lib/rubrowser/renderer.rb
+- lib/rubrowser/server.rb
+- lib/rubrowser/trace.rb
 - lib/rubrowser/version.rb
 - public/css/application.css
 - public/javascript/application.js
 - public/javascript/toolbox.js
+- public/javascript/websocket.js
 - readme.md
 - rubrowser.gemspec
 - views/index.erb
 - views/toolbox.erb
-homepage: https://github.com/blazeeboy/rubrowser
+homepage: https://github.com/emad-elsaid/rubrowser
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,9 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A ruby interactive dependency graph visualizer
 test_files: []