helping_hand 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b45c6883bed2978de62c8530115267e2c6c169c
-  data.tar.gz: 038a7096844055ea62f8b3e607c1263289d4750f
+  metadata.gz: acc07a05586adc12af8e6682f46d9b23bf68aaf8
+  data.tar.gz: 23e8cf66c4f3a91363d3d3262bb2e275775e13c1
 SHA512:
-  metadata.gz: d05aa0e0a801436ff05fc4b1d4ebe7477cabc000aa0209dbac43188e286c26c59a6867bcdf651418df9e447671edf45a706b4fd57f55831a5965cc8b086798a7
-  data.tar.gz: 6f9f68bcd54d7baacd6bdc19d3e5b7781fb7d0944dd9fc9a267d4f024dac20d205373ffeb70cadf9ef1e709fbbc314820d999c93aef311074aa464f97b3065d9
+  metadata.gz: 630281e49f49512be003afc347349e30af17dced1d12680887d6424dd3c40ffdd0e53257b5a858d1e04acaf59bb84367bd8911a6614e18c8c3c53217c066e077
+  data.tar.gz: 57daeddab3e7142fd5ba11d6102cadafa08c9fa2ce3157bbe3a4b43e9e29364886fc73c543e705245ed4b90f2d78d1d1af784b81dcc5556ba214983ca8b756b4

data/lib/helping_hand.rb

@@ -1,8 +1,25 @@
 require "helping_hand/version"
 
 # Override the error templates path from Rails to serve our modified versions
-ActionDispatch::DebugExceptions::RESCUES_TEMPLATE_PATH = File.expand_path('../templates', __FILE__)
+ActionDispatch::DebugExceptions.send(:remove_const, :RESCUES_TEMPLATE_PATH)
+ActionDispatch::DebugExceptions.const_set(:RESCUES_TEMPLATE_PATH, File.expand_path('../templates', __FILE__))
 
 module HelpingHand
-  HOST = "https://helpinghand-rails.herokuapp.com/"
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.config
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    self.configuration
+  end
+
+  class Configuration
+    attr_accessor :host
+
+    def initialize
+      @host = "https://helpinghand-rails.herokuapp.com/"
+    end
+  end
 end

data/lib/helping_hand/version.rb

@@ -1,3 +1,3 @@
 module HelpingHand
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/templates/rescues/_request_and_response.html.erb

@@ -5,8 +5,20 @@
   <pre id="blame_trace" <%='style="display:none"' if hide %>><code><%= @exception.describe_blame %></code></pre>
 <% end %>
 
+<%
+  clean_params = @request.filtered_parameters.clone
+  clean_params.delete("action")
+  clean_params.delete("controller")
+
+  request_dump = clean_params.empty? ? 'None' : clean_params.inspect.gsub(',', ",\n")
+
+  def debug_hash(object)
+    object.to_hash.sort_by { |k, _| k.to_s }.map { |k, v| "#{k}: #{v.inspect rescue $!.message}" }.join("\n")
+  end unless self.class.method_defined?(:debug_hash)
+%>
+
 <h2 style="margin-top: 30px">Request</h2>
-<p><b>Parameters</b>:</p> <pre><%= debug_params(@request.filtered_parameters) %></pre>
+<p><b>Parameters</b>:</p> <pre><%= request_dump %></pre>
 
 <div class="details">
   <div class="summary"><a href="#" onclick="return toggleSessionDump()">Toggle session dump</a></div>
@@ -19,4 +31,4 @@
 </div>
 
 <h2 style="margin-top: 30px">Response</h2>
-<p><b>Headers</b>:</p> <pre><%= debug_headers(defined?(@response) ? @response.headers : {}) %></pre>
+<p><b>Headers</b>:</p> <pre><%= defined?(@response) ? @response.headers.inspect.gsub(',', ",\n") : 'None' %></pre>

data/lib/templates/rescues/layout.erb

@@ -177,7 +177,7 @@
     </div>
 
     <div class="flex-column">
-      <iframe src="<%= HelpingHand::HOST %>/exceptions/<%= URI.escape @exception.original_exception.class.to_s %>/messages/<%== URI.escape @exception.message %>/record">
+      <iframe src="<%= HelpingHand.config.host %>/exceptions/<%= URI.escape @exception.original_exception.class.to_s %>/messages/<%== URI.escape @exception.message %>/record">
       </iframe>
     </div>
   </div>

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

@@ -4,13 +4,13 @@
       <%= route[:name] %><span class='helper'>_path</span>
     <% end %>
   </td>
-  <td>
+  <td data-route-verb='<%= route[:verb] %>'>
     <%= route[:verb] %>
   </td>
-  <td data-route-path='<%= route[:path] %>'>
+  <td data-route-path='<%= route[:path] %>' data-regexp='<%= route[:regexp] %>'>
     <%= route[:path] %>
   </td>
-  <td>
-    <%=simple_format route[:reqs] %>
+  <td data-route-reqs='<%= route[:reqs] %>'>
+    <%= route[:reqs] %>
   </td>
 </tr>

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

@@ -81,87 +81,92 @@
 </table>
 
 <script type='text/javascript'>
-  // support forEarch iterator on NodeList
-  NodeList.prototype.forEach = Array.prototype.forEach;
+  // 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 there are any matched results in a section
-    function checkNoMatch(section, noMatchText) {
-      if (section.children.length <= 1) {
-        section.innerHTML += noMatchText;
-      }
+    // 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);
     }
 
-    // get JSON from url and invoke callback with result
-    function getJSON(url, success) {
-      var xhr = new XMLHttpRequest();
-      xhr.open('GET', url);
-      xhr.onload = function() {
-        if (this.status == 200)
-          success(JSON.parse(this.response));
-      };
-      xhr.send();
+    // 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);
     }
 
-    function delayedKeyup(input, callback) {
-      var timeout;
-      input.onkeyup = function(){
-        if (timeout) clearTimeout(timeout);
-        timeout = setTimeout(callback, 300);
+    // 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));
       }
     }
 
-    // remove params or fragments
+    // 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) {
-      return path.replace(/[#?].*/, '');
+      var path = path.charAt(0) == '/' ? path : "/" + path;
+      return path.replace(/\#.*|\?.*/, '');
     }
 
-    var pathElements = document.querySelectorAll('#route_table [data-route-path]'),
-        searchElem   = document.querySelector('#search'),
-        exactSection = document.querySelector('#exact_matches'),
-        fuzzySection = document.querySelector('#fuzzy_matches');
+    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 === "") {
-        exactSection.innerHTML = "";
-        fuzzySection.innerHTML = "";
+        setContent(exactMatches, "");
+        setContent(fuzzyMatches, "");
       }
     }
 
     // On key press perform a search for matching paths
-    delayedKeyup(searchElem, function() {
-      var path = sanitizePath(searchElem.value),
-          defaultExactMatch = '<tr><th colspan="4">Paths Matching (' + path +'):</th></tr>',
-          defaultFuzzyMatch = '<tr><th colspan="4">Paths Containing (' + path +'):</th></tr>',
+    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>';
 
-      if (!path)
-        return searchElem.onblur();
-
-      getJSON('/rails/info/routes?path=' + path, function(matches){
-        // Clear out results section
-        exactSection.innerHTML = defaultExactMatch;
-        fuzzySection.innerHTML = defaultFuzzyMatch;
-
-        // Display exact matches and fuzzy matches
-        pathElements.forEach(function(elem) {
-          var elemPath = elem.getAttribute('data-route-path');
-
-          if (matches['exact'].indexOf(elemPath) != -1)
-            exactSection.appendChild(elem.parentNode.cloneNode(true));
+      // Clear out results section
+      setContent(exactMatches, defaultExactMatch);
+      setContent(fuzzyMatches, defaultFuzzyMatch);
 
-          if (matches['fuzzy'].indexOf(elemPath) != -1)
-            fuzzySection.appendChild(elem.parentNode.cloneNode(true));
-        })
-
-        // Display 'No Matches' message when no matches are found
-        checkNoMatch(exactSection, noExactMatch);
-        checkNoMatch(fuzzySection, noFuzzyMatch);
+      // 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
@@ -169,20 +174,19 @@
 
     // Sets content for each element
     function setValOn(elems, val) {
-      elems.forEach(function(elem) {
-        elem.innerHTML = val;
+      each(elems, function(elem) {
+        setContent(elem, val);
       });
     }
 
     // Sets onClick event for each element
     function onClick(elems, func) {
-      elems.forEach(function(elem) {
+      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');

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helping_hand
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Oliver