passages 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f37c423eff6bfd9da867704180a01ca6abcc650f
-  data.tar.gz: e9689b0ea723de0b76c90e9e10ae59f429ec4840
+  metadata.gz: 91ad2eb2bfd8de3cb90f430b52679748b6458249
+  data.tar.gz: 2dc1db09ec74c6815f2d5b5b3c236d714b952ee5
 SHA512:
-  metadata.gz: 743b38a9e68e39887fa93529191793d70af8721e8df2113929a6daf95357ae423c4f07ae903f18e4f6dd93c10d92942b5265d0ad49277e705b8a5f37129edf73
-  data.tar.gz: eac0cf7983556bf5383b6372928fb84df773ba3bcd4db2b309a912f36a87ea12bda5d50d6efdd546c21b2b6a63f488685e549a6e97269c1dad431187b0386772
+  metadata.gz: 4aab33a5ca1ade95fa46865311fd94d9f4bae52fb2079a3dbb78df90ad7a99879e0ba2edba6542fd92c2693b344f234acba823273734cc261253806319673989
+  data.tar.gz: bd078de0461d8dd8367848ebd25a6fdcafd8c19f270282edcf693dd2c348a8563f9518aff855e6cfd6b1f64d3dfdd5a5c25423b8addedc2a0536fe673d84dc49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    passages (0.1.0)
+    passages (0.2.0)
       rails (~> 4.0)
 
 GEM

data/README.md

@@ -8,6 +8,10 @@ This Rails Engine adds the ability to search over different attributes of Ruby o
 
 For example, an internal (or very permissive external) API can now expose a single page that will answer simple questions like: *"What was the HTTP verb for the `/users/clear_password` route?"* or *"Does a v2 or v3 version for this route exist?"*.
 
+## Demo
+
+![Demo](demo.gif)
+
 ## Install
 
 In your `Gemfile`
@@ -19,13 +23,13 @@ gem 'passages'
 
 `bundle install`
 
-The `Passages` engine will **prepend** a `/passages` route to the application's routes.
+The `Passages` engine will **prepend** a `/passages` route to the application's routes. This means that if a project's `routes.rb` specifically defines a `/passages` route, the `Passages` Engine will not overwrite that.
 
 Visiting `/passages` will display a search box and list of all known routes in an application.
 
 ## Authorization
 
-Since there is no environment dependent checks, the `/passages` page uses configurable http basic authentication.
+Since there are no environment dependent checks, the `/passages` page uses configurable http basic authentication.
 
 Default username: **username**
 

data/app/assets/javascripts/passages/application.js

@@ -1,13 +1,36 @@
 //= require jquery-2.1.4.min
 
-DomElements = {
+var Highlighter  = {
+  highlight: function(result, terms) {
+    $.each(terms.split(' '), function(index, term) {
+      if(term.length > 0 ) {
+        $.each(result.find('td'), function(index, element) {
+          if ($(element).find('span').length == 0){
+            var existingHtml = $(element).html();
+            var replacedHtml = existingHtml.replace(new RegExp("(" + term + ")", "i"), "<span class='highlighted'>$1</span>");
+            $(element).html(replacedHtml);
+          }
+          else {
+            $.each($('element').contents(), function(index, content) {
+              if(content.nodeType == 3) { // nodeType == 3 means it is not a child node
+                $(content).html($(content).html().replace(new RegExp("(" + term + ")", "i"), "<span class='highlighted'>$1</span>"));
+              }
+            });
+          }
+        });
+      }
+    });
+  }
+};
+
+DomElement = {
   matchingTerm: 'table.matching-term'
 };
 
 function clearAndHideResultTable() {
   var header = $('table.matching-term .header');
-  $(DomElements.matchingTerm).html(header);
-  $(DomElements.matchingTerm).hide();
+  $(DomElement.matchingTerm).html(header);
+  $(DomElement.matchingTerm).hide();
 }
 
 function hideNoResults() {
@@ -20,28 +43,36 @@ function showNoResults(searchTerm) {
 
 function showResultTable() {
   hideNoResults();
-  $(DomElements.matchingTerm).show();
+  $(DomElement.matchingTerm).show();
 }
 
 function searchResults(query) {
   clearAndHideResultTable();
-  return $('[data-search*=' + query).parent('tr');
-}
+  var terms = query.split(' ');
+  var parents = [];
 
-function highlight(element, term) {
-  var existing = $(element).html();
-  var bolded = existing.replace(new RegExp("(" + term + ")", "i"), "<span class='highlighted'>$1</span>");
-  $(element).html(bolded)
+  $.each(terms, function(index, el) {
+    if (parents.length == 0) {
+      parents = $('[data-search*=' + el + ']').parent('tr');
+    }
+    else if(el.length > 0) {
+      $.each(parents, function(index, parent) {
+        if($(parent).find($('[data-search*=' + el + ']')).length == 0) {
+          parents[index] = null;
+        }
+      });
+    }
+  });
+
+  return parents
 }
 
-function addToResultTable(result, searchTerm){
+function addToResultTable(result, searchTerms){
   showResultTable();
   var table = $('.matching-term');
   var lastChild = table.find('tr:last');
 
-  $.each(result.children(), function(index, element) {
-    highlight(element, searchTerm);
-  });
+  Highlighter.highlight(result, searchTerms);
 
   if(lastChild.length == 0) {
     table.html(result);

data/app/controllers/passages/routes_controller.rb

@@ -6,7 +6,9 @@ require 'passages/engine_route_collection'
 
 module Passages
   class RoutesController < ActionController::Base
-    http_basic_authenticate_with name: Passages.username, password: Passages.password
+    unless Passages.no_auth?
+      http_basic_authenticate_with name: Passages.username, password: Passages.password
+    end
 
     layout false
 

data/config/initializers/basic_auth.rb

@@ -7,5 +7,13 @@ module Passages
     ENV['passages_password'] || 'password'
   end
 
-  module_function :username, :password
+  def no_auth=(no_auth)
+    @no_auth = no_auth
+  end
+
+  def no_auth?
+    @no_auth.nil? || @no_auth
+  end
+
+  module_function :username, :password, :no_auth=, :no_auth?
 end

data/version.rb

@@ -1,6 +1,6 @@
 module Passages
-  MAJOR = 0
-  MINOR = 2
+  MAJOR = 1
+  MINOR = 0
   TINY = 0
 
   VERSION = [MAJOR, MINOR, TINY].join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passages
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,6 +61,7 @@ files:
 - config/initializers/assets.rb
 - config/initializers/basic_auth.rb
 - config/routes.rb
+- demo.gif
 - lib/passages.rb
 - lib/passages/engine.rb
 - lib/passages/engine_route.rb