web-console 2.0.0.beta3 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afe33c91afb082074dd982930c4aef140c279c9e
-  data.tar.gz: e77676a84dde11dae828446db54974a79fbe3896
+  metadata.gz: fc8e319e9b1f84cf82daa49aad866ae6c93c615a
+  data.tar.gz: 60bc79a8546eee3b05d9566c1a146267575fd2b6
 SHA512:
-  metadata.gz: 8180671dcf6b9227a3f0c1d1ccf5397f8926734b91a2586bf83f4a2f06b9b1fd7de58f10a13731108493459111c4a522ffde51c14dd668aa2f90255c7e0c6ce1
-  data.tar.gz: fbed5ea4aa571865488f344f94b35d05f81b39174f52ddab726f43cbb77274f91aedd1ef72d904a611848082d5f57f920b891614a5610a6755a498a319613eee
+  metadata.gz: a2b3ec02cc16ec9ac3ec0ea28ac408e481a31db218dccdd9da149f543052051312133afd6ca690cd1ce581d162c6bb9b3b91f7bd4a6ec058e5b5ba8964dd00bb
+  data.tar.gz: bbd5a609a1dcca7cfbf1d95c0ada4ce8cb697720669864996f26d29809ce36c23dca95b54ddb6a67ec422d4d3f533b4200c65fe10e2c6d04842c8d087c5f51f8

data/README.markdown

@@ -57,7 +57,7 @@ _Web Console_ has been tested on the following rubies.
 There is an experimental _JRuby_ 1.7 support. See Installation section for more
 information.
 
-_Rubunius_ in 1.9 mode may work, but it hasn't been explicitly tested.
+_Rubinius_ in 1.9 mode may work, but it hasn't been explicitly tested.
 
 _Web Console_ is built explicitly for _Rails 4_. Check out the
 [web-console-rails3] project for a _Rails 3_ compatible build.
@@ -69,17 +69,7 @@ To install it in your current application, add the following to your `Gemfile`.
 
 ```ruby
 group :development do
-  gem 'web-console', '2.0.0.beta2'
-end
-```
-
-For _JRuby_ support, you need to add an unreleased version of
-`binding_of_caller`.
-
-```ruby
-group :development do
-  gem 'web-console', '2.0.0.beta2'
-  gem 'binding_of_caller', github: 'banister/binding_of_caller'
+  gem 'web-console', '2.0.0.beta3'
 end
 ```
 
@@ -288,11 +278,18 @@ end
 You may also change the font, which is following the CSS font property syntax.
 By default it is `large DejaVu Sans Mono, Liberation Mono, monospace`.
 
-Shout-out
----------
+Credits
+-------
+
+* Shoutout to [Charlie Somerville] for [better_errors]! Most of the exception
+  binding code is coming straight out of the [better_errors] project.
+
+* _Web Console_ wouldn't be possible without the work [John Mair] put in
+  [binding_of_caller]. This is the technology that let us execute a console
+  right where an error occured.
 
-Great thanks to [Charlie Somerville] for [better_errors]! Most of the exception
-binding code is coming straight out of the [better_errors] project.
+* Thanks to [Charles Oliver Nutter] for all the JRuby feedback and support he
+  has given us.
 
 FAQ
 ---
@@ -307,18 +304,6 @@ is even slower. Read more about the problem at the _JRuby_ [wiki].
 
 ### I'm running JRuby and there's no console on the default error page.
 
-_JRuby_ support in the default error page requires the latest is experimental
-and requires an unreleased version of `web-console` and `binding_of_caller`.
-
-To try it out, put this in your Gemfile.
-
-```ruby
-group :development do
-  gem 'web-console', github: 'rails/web-console'
-  gem 'binding_of_caller', github: 'banister/binding_of_caller'
-end
-```
-
 You would also have to run you Rails server in JRuby's interpreted mode. Enable
 it with code snippet below, then start your development Rails server with
 `rails server`, as usual.
@@ -330,9 +315,6 @@ export JRUBY_OPTS=-J-Djruby.compile.mode=OFF
 # export JRUBY_OPTS=--dev
 ```
 
-_(Please, note that we don't guarantee master to be stable and we
-will appreciate any issue reports!)_
-
 ### Changing the colors is broken.
 
 Some of the style sheets may be cached on the file system. Run
@@ -350,4 +332,7 @@ The interactive console executes Ruby code. Invoking `instance_variables` and
   [web-console-rails3]: https://github.com/gsamokovarov/web-console-rails3
   [wiki]: https://github.com/jruby/jruby/wiki/Improving-startup-time#avoid-spawning-sub-rubies
   [better_errors]: https://github.com/charliesome/better_errors
+  [binding_of_caller]: https://github.com/banister/binding_of_caller
   [Charlie Somerville]: https://github.com/charliesome
+  [John Mair]: https://github.com/banister
+  [Charles Oliver Nutter]: https://github.com/headius

data/app/assets/javascripts/web_console/console_sessions.js

@@ -17,6 +17,7 @@ var AJAXTransport = (function(WebConsole) {
       configuration: options.url
     } : options.url;
 
+    this.uid = options.uid;
     this.pendingInput  = '';
 
     this.initializeEventHandlers();
@@ -38,8 +39,7 @@ var AJAXTransport = (function(WebConsole) {
   AJAXTransport.prototype.createRequest = function(method, url, options) {
     options || (options = {});
 
-    var request = new XMLHttpRequest;
-    request.open(method, url);
+    var params = '';
 
     if (typeof options.form === 'object') {
       var content = [], form = options.form;
@@ -49,15 +49,25 @@ var AJAXTransport = (function(WebConsole) {
         content.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
       }
 
+      params = content.join('&');
+      if (method === 'GET' ? '?' : '') params = '?' + params;
+    }
+
+    var request = new XMLHttpRequest;
+    request.open(method, method === 'GET' ? url + params : url);
+
+    if (params && method != 'GET') {
       request.setRequestHeader('Content-Type', FORM_MIME_TYPE);
-      request.data = content.join('&');
+      request.data = params;
     }
 
     return request;
   };
 
   AJAXTransport.prototype.pollForPendingOutput = function() {
-    var request = this.createRequest('GET', this.url.pendingOutput);
+    var request = this.createRequest('GET', this.url.pendingOutput, {
+      form: { uid: this.uid }
+    });
 
     var self = this;
     request.onreadystatechange = function() {
@@ -90,7 +100,7 @@ var AJAXTransport = (function(WebConsole) {
     this.sendingInput = true;
 
     var request = this.createRequest('PUT', this.url.input, {
-      form: { input: this.pendingInput + input }
+      form: { input: this.pendingInput + input, uid: this.uid }
     });
 
     // Clear the pending input.
@@ -117,7 +127,7 @@ var AJAXTransport = (function(WebConsole) {
     if (this.disconnected) return;
 
     var request = this.createRequest('PUT', this.url.configuration, {
-      form: { width: cols, height: rows }
+      form: { width: cols, height: rows, uid: this.uid }
     });
 
     // Just send the configuration and don't care about any output.

data/app/controllers/web_console/console_sessions_controller.rb

@@ -10,26 +10,30 @@ module WebConsole
       render json: exception, status: :unprocessable_entity
     end
 
+    rescue_from ConsoleSession::Unauthorized do |exception|
+      render json: exception, status: :unauthorized
+    end
+
     def index
       @console_session = ConsoleSession.create
     end
 
     def input
-      @console_session = ConsoleSession.find(params[:id])
+      @console_session = ConsoleSession.find_by_pid_and_uid(params[:id], params[:uid])
       @console_session.send_input(console_session_params[:input])
 
       render nothing: true
     end
 
     def configuration
-      @console_session = ConsoleSession.find(params[:id])
+      @console_session = ConsoleSession.find_by_pid_and_uid(params[:id], params[:uid])
       @console_session.configure(console_session_params)
 
       render nothing: true
     end
 
     def pending_output
-      @console_session = ConsoleSession.find(params[:id])
+      @console_session = ConsoleSession.find_by_pid_and_uid(params[:id], params[:uid])
 
       render json: { output: @console_session.pending_output }
     end
@@ -37,7 +41,7 @@ module WebConsole
     private
 
       def console_session_params
-        params.permit(:id, :input, :width, :height)
+        params.permit(:id, :uid, :input, :width, :height)
       end
   end
 end

data/app/models/web_console/console_session.rb

@@ -24,6 +24,9 @@ module WebConsole
     # Raised when an operation transition to an invalid state.
     Invalid = Class.new(Error)
 
+    # Raised when a request doesn't know the slave process uid.
+    Unauthorized = Class.new(Error)
+
     class << self
       # Finds a session by its pid.
       #
@@ -32,6 +35,16 @@ module WebConsole
         INMEMORY_STORAGE[pid.to_i] or raise Unavailable, 'Session unavailable'
       end
 
+      # Finds a session by its pid.
+      #
+      # Raises WebConsole::ConsoleSession::Expired if there is no such session.
+      # Raises WebConsole::ConsoleSession::Unauthorized if uid doesn't match.
+      def find_by_pid_and_uid(pid, uid)
+        find(pid).tap do |console_session|
+          raise Unauthorized if console_session.uid != uid
+        end
+      end
+
       # Creates an already persisted consolse session.
       #
       # Use this method if you need to persist a session, without providing it

data/app/views/web_console/console_sessions/index.html.erb

@@ -9,7 +9,9 @@
         input: "<%= web_console.input_console_session_path(@console_session) %>",
         pendingOutput: "<%= web_console.pending_output_console_session_path(@console_session) %>",
         configuration: "<%= web_console.configuration_console_session_path(@console_session) %>"
-      }
+      },
+
+      uid: "<%= @console_session.uid %>"
     }
   };
 </script>

data/lib/action_dispatch/debug_exceptions.rb

@@ -5,9 +5,9 @@ module ActionDispatch
     def call(env)
       request = Request.new(env)
 
-      if request.put? && m = env["PATH_INFO"].match(%r{/repl_sessions/(?<id>.+?)\z})
+      if request.put? && request.xhr? && m = env["PATH_INFO"].match(%r{/repl_sessions/(?<id>.+?)\z})
         update_repl_session(m[:id], request.params[:input])
-      elsif request.post? && m = env["PATH_INFO"].match(%r{/repl_sessions/(?<id>.+?)/trace\z})
+      elsif request.post? && request.xhr? && m = env["PATH_INFO"].match(%r{/repl_sessions/(?<id>.+?)/trace\z})
         change_stack_trace(m[:id], request.params[:frame_id])
       else
         middleware_call(env)
@@ -52,8 +52,8 @@ module ActionDispatch
         traces = traces_from_wrapper(wrapper)
         extract_sources = wrapper.extract_sources
         console_session = WebConsole::REPLSession.create(
-          binding: binding_from_exception(exception),
-          binding_stack: exception.__web_console_bindings_stack
+          binding: exception.bindings.first,
+          binding_stack: exception.bindings
         )
         log_error(env, wrapper)
 
@@ -107,9 +107,5 @@ module ActionDispatch
           full_trace: application_trace + framework_trace
         }
       end
-
-      def binding_from_exception(exception)
-        exception.__web_console_bindings_stack[0]
-      end
   end
 end

data/lib/action_dispatch/exception_wrapper.rb

@@ -10,7 +10,7 @@ module ActionDispatch
           file: file,
           line_number: line_number
         }
-      end
+      end if exception.backtrace
     end
   end
 end

data/lib/action_dispatch/templates/rescues/_web_console.html.erb

@@ -36,11 +36,12 @@
       // Add CSS styles dynamically. This probably doesnt work for IE <8.
       var style = document.createElement('style');
       style.type = 'text/css';
-      style.innerHTML = "#console { position: fixed; bottom: 0; width: 100%; height: 150px; border: 1px solid; padding-bottom: 20px; } " +
-        "#console div.console-inner { height: 100%; overflow: auto; background: #333; padding: 10px; } " +
-        "#console div.console-prompt-box { color: #fff; } " +
-        "#console div.console-message { color: #1ad027; } " +
-        "#console div.console-focus span.console-cursor { background:#fefefe; color:#333; font-weight:bold; }";
+      style.innerHTML =
+        "#console { position: fixed; left: 0; bottom: 0; width: 100%; height: 150px; border: 1px solid; padding-bottom: 20px; } " +
+        "#console div.console-inner { font-family: monospace; font-size: 11px; height: 100%; overflow: auto; background: #333; padding: 10px; } " +
+        "#console div.console-prompt-box { color: #FFF; } " +
+        "#console div.console-message { color: #1AD027; } " +
+        "#console div.console-focus span.console-cursor { background: #FEFEFE; color: #333; font-weight: bold; }";
       document.getElementsByTagName('head')[0].appendChild(style);
 
       /**
@@ -361,16 +362,16 @@
         var _this = this;
         var xhr = new XMLHttpRequest();
         var url = consoleDiv.dataset.remotePath;
-        var params = "input=" + line;
+        var params = "input=" + encodeURIComponent(line);
 
         xhr.open("PUT", url, true);
-        xhr.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
+        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+        xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
         xhr.send(params);
 
         xhr.onreadystatechange = function() {
           if(xhr.readyState == 4 && xhr.status == 200) {
             var response = JSON.parse(xhr.responseText);
-            console.log(response.output);
             _this.writeOutput(response.output);
           }
         }

data/lib/action_dispatch/templates/routes/_route.html.erb

@@ -0,0 +1,16 @@
+<tr class='route_row' data-helper='path'>
+  <td data-route-name='<%= route[:name] %>'>
+    <% if route[:name].present? %>
+      <%= route[:name] %><span class='helper'>_path</span>
+    <% end %>
+  </td>
+  <td data-route-verb='<%= route[:verb] %>'>
+    <%= route[:verb] %>
+  </td>
+  <td data-route-path='<%= route[:path] %>' data-regexp='<%= route[:regexp] %>'>
+    <%= route[:path] %>
+  </td>
+  <td data-route-reqs='<%= route[:reqs] %>'>
+    <%= route[:reqs] %>
+  </td>
+</tr>

data/lib/action_dispatch/templates/routes/_table.html.erb

@@ -0,0 +1,200 @@
+<% content_for :style do %>
+  #route_table {
+    margin: 0 auto 0;
+    border-collapse: collapse;
+  }
+
+  #route_table thead tr {
+    border-bottom: 2px solid #ddd;
+  }
+
+  #route_table thead tr.bottom {
+    border-bottom: none;
+  }
+
+  #route_table thead tr.bottom th {
+    padding: 10px 0;
+    line-height: 15px;
+  }
+
+  #route_table tbody tr {
+    border-bottom: 1px solid #ddd;
+  }
+
+  #route_table tbody tr:nth-child(odd) {
+    background: #f2f2f2;
+  }
+
+  #route_table tbody.exact_matches,
+  #route_table tbody.fuzzy_matches {
+    background-color: LightGoldenRodYellow;
+    border-bottom: solid 2px SlateGrey;
+  }
+
+  #route_table tbody.exact_matches tr,
+  #route_table tbody.fuzzy_matches tr {
+    background: none;
+    border-bottom: none;
+  }
+
+  #route_table td {
+    padding: 4px 30px;
+  }
+
+  #path_search {
+    width: 80%;
+    font-size: inherit;
+  }
+<% end %>
+
+<table id='route_table' class='route_table'>
+  <thead>
+    <tr>
+      <th>Helper</th>
+      <th>HTTP Verb</th>
+      <th>Path</th>
+      <th>Controller#Action</th>
+    </tr>
+    <tr class='bottom'>
+      <th><%# Helper %>
+        <%= link_to "Path", "#", 'data-route-helper' => '_path',
+                    title: "Returns a relative path (without the http or domain)" %> /
+        <%= link_to "Url", "#", 'data-route-helper' => '_url',
+                    title: "Returns an absolute url (with the http and domain)"   %>
+      </th>
+      <th><%# HTTP Verb %>
+      </th>
+      <th><%# Path %>
+        <%= search_field(:path, nil, id: 'search', placeholder: "Path Match") %>
+      </th>
+      <th><%# Controller#action %>
+      </th>
+    </tr>
+  </thead>
+  <tbody class='exact_matches' id='exact_matches'>
+  </tbody>
+  <tbody class='fuzzy_matches' id='fuzzy_matches'>
+  </tbody>
+  <tbody>
+    <%= yield %>
+  </tbody>
+</table>
+
+<script type='text/javascript'>
+  // Iterates each element through a function
+  function each(elems, func) {
+    if (!elems instanceof Array) { elems = [elems]; }
+    for (var i = 0, len = elems.length; i < len; i++) {
+      func(elems[i]);
+    }
+  }
+
+  // Sets innerHTML for an element
+  function setContent(elem, text) {
+    elem.innerHTML = text;
+  }
+
+  // Enables path search functionality
+  function setupMatchPaths() {
+    // Check if the user input (sanitized as a path) matches the regexp data attribute
+    function checkExactMatch(section, elem, value) {
+      var string = sanitizePath(value),
+          regexp = elem.getAttribute("data-regexp");
+
+      showMatch(string, regexp, section, elem);
+    }
+
+    // Check if the route path data attribute contains the user input
+    function checkFuzzyMatch(section, elem, value) {
+      var string = elem.getAttribute("data-route-path"),
+          regexp = value;
+
+      showMatch(string, regexp, section, elem);
+    }
+
+    // Display the parent <tr> element in the appropriate section when there's a match
+    function showMatch(string, regexp, section, elem) {
+      if(string.match(RegExp(regexp))) {
+        section.appendChild(elem.parentNode.cloneNode(true));
+      }
+    }
+
+    // Check if there are any matched results in a section
+    function checkNoMatch(section, defaultText, noMatchText) {
+      if (section.innerHTML === defaultText) {
+        setContent(section, defaultText + noMatchText);
+      }
+    }
+
+    // Ensure path always starts with a slash "/" and remove params or fragments
+    function sanitizePath(path) {
+      var path = path.charAt(0) == '/' ? path : "/" + path;
+      return path.replace(/\#.*|\?.*/, '');
+    }
+
+    var regexpElems     = document.querySelectorAll('#route_table [data-regexp]'),
+        searchElem      = document.querySelector('#search'),
+        exactMatches    = document.querySelector('#exact_matches'),
+        fuzzyMatches    = document.querySelector('#fuzzy_matches');
+
+    // Remove matches when no search value is present
+    searchElem.onblur = function(e) {
+      if (searchElem.value === "") {
+        setContent(exactMatches, "");
+        setContent(fuzzyMatches, "");
+      }
+    }
+
+    // On key press perform a search for matching paths
+    searchElem.onkeyup = function(e){
+      var userInput         = searchElem.value,
+          defaultExactMatch = '<tr><th colspan="4">Paths Matching (' + escape(sanitizePath(userInput)) +'):</th></tr>',
+          defaultFuzzyMatch = '<tr><th colspan="4">Paths Containing (' + escape(userInput) +'):</th></tr>',
+          noExactMatch      = '<tr><th colspan="4">No Exact Matches Found</th></tr>',
+          noFuzzyMatch      = '<tr><th colspan="4">No Fuzzy Matches Found</th></tr>';
+
+      // Clear out results section
+      setContent(exactMatches, defaultExactMatch);
+      setContent(fuzzyMatches, defaultFuzzyMatch);
+
+      // Display exact matches and fuzzy matches
+      each(regexpElems, function(elem) {
+        checkExactMatch(exactMatches, elem, userInput);
+        checkFuzzyMatch(fuzzyMatches, elem, userInput);
+      })
+
+      // Display 'No Matches' message when no matches are found
+      checkNoMatch(exactMatches, defaultExactMatch, noExactMatch);
+      checkNoMatch(fuzzyMatches, defaultFuzzyMatch, noFuzzyMatch);
+    }
+  }
+
+  // Enables functionality to toggle between `_path` and `_url` helper suffixes
+  function setupRouteToggleHelperLinks() {
+
+    // Sets content for each element
+    function setValOn(elems, val) {
+      each(elems, function(elem) {
+        setContent(elem, val);
+      });
+    }
+
+    // Sets onClick event for each element
+    function onClick(elems, func) {
+      each(elems, function(elem) {
+        elem.onclick = func;
+      });
+    }
+
+    var toggleLinks = document.querySelectorAll('#route_table [data-route-helper]');
+    onClick(toggleLinks, function(){
+      var helperTxt   = this.getAttribute("data-route-helper"),
+          helperElems = document.querySelectorAll('[data-route-name] span.helper');
+
+      setValOn(helperElems, helperTxt);
+    });
+  }
+
+  setupMatchPaths();
+  setupRouteToggleHelperLinks();
+</script>