passages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47e75e77bbe676fe75044de45fd56441e7c11a2b
+  data.tar.gz: f6d446dab10cf91edbd16cacb326d75a70bfa5f3
+SHA512:
+  metadata.gz: 7bc750e7f13b7ee420c77c129095c69193b6f35a1bc481925431244fbccaca33ae993ee5c3e416b880b0855156630e73240eb8fdc6b83bafb5b8b9824c9db32d
+  data.tar.gz: 01bd77ac13587d13301a5a31bbddc8b8cf0e9da4616233e1da1f779bf16854f2747c65f3c2bcf851a720eb97c6ddd56cf7d9cb0f513eca506f03be2cd8d8ddda

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-*
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.2.1
+  - 2.2.2
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    passages (0.0.1)
+      rails (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.2)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sprockets (3.3.5)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  passages!
+  rspec (~> 3.2)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jake Yesbeck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+## Roots
+
+![Build Status](https://travis-ci.org/yez/roots.svg?branch=master)
+
+Route display and search for Ruby on Rails applications.
+
+## Install
+
+In your `Gemfile`
+
+```ruby
+source 'https://rubygems.org'
+gem 'roots'
+```
+
+`bundle install`
+
+The `Roots` engine will **prepend** a `/roots` route to the application
+
+Visiting `/roots` will

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

@@ -0,0 +1,74 @@
+//= require jquery-2.1.4.min
+
+DomElements = {
+  matchingTerm: 'table.matching-term'
+};
+
+function clearAndHideResultTable() {
+  var header = $('table.matching-term .header');
+  $(DomElements.matchingTerm).html(header);
+  $(DomElements.matchingTerm).hide();
+}
+
+function hideNoResults() {
+  $('.no-results').hide();
+}
+
+function showNoResults(searchTerm) {
+  $('.no-results').html('No results match "' + searchTerm + '"').show();
+}
+
+function showResultTable() {
+  hideNoResults();
+  $(DomElements.matchingTerm).show();
+}
+
+function searchResults(query) {
+  clearAndHideResultTable();
+  return $('[data-search*=' + query).parent('tr');
+}
+
+function highlight(element, term) {
+  var existing = $(element).html();
+  var bolded = existing.replace(new RegExp("(" + term + ")", "i"), "<span class='highlighted'>$1</span>");
+  $(element).html(bolded)
+}
+
+function addToResultTable(result, searchTerm){
+  showResultTable();
+  var table = $('.matching-term');
+  var lastChild = table.find('tr:last');
+
+  $.each(result.children(), function(index, element) {
+    highlight(element, searchTerm);
+  });
+
+  if(lastChild.length == 0) {
+    table.html(result);
+  }
+  else {
+    lastChild.after(result);
+  }
+}
+
+$(document).on('ready', function(){
+  $('input[name=search]').keyup(function(event){
+    var searchTerm = event.target.value;
+    if(searchTerm.length > 0) {
+      hideNoResults();
+      var results = searchResults(searchTerm.toLowerCase());
+      if (results.length > 0) {
+        $.each(results, function(index, value){
+          addToResultTable($(value).clone(), searchTerm);
+        });
+      }
+      else {
+        showNoResults(searchTerm);
+      }
+    }
+    else {
+      hideNoResults();
+      clearAndHideResultTable();
+    }
+  });
+});

data/app/assets/stylesheets/passages/application.css

@@ -0,0 +1,20 @@
+/*
+*= require bootstrap.min
+*/
+
+.vertical-spacer {
+  height: 20px;
+}
+
+.no-results {
+  display: none;
+  color: red;
+}
+
+.matching-term {
+  display: none;
+}
+
+.highlighted {
+  font-weight: bold;
+}

data/app/controllers/passages/routes_controller.rb

@@ -0,0 +1,49 @@
+require 'passages/route'
+require 'passages/engine_route'
+require 'passages/mount_route'
+require 'passages/route_collection'
+require 'passages/engine_route_collection'
+
+module Passages
+  class RoutesController < ActionController::Base
+    layout false
+
+    def routes
+      @routes = application_routes
+      @engine_routes = engine_routes
+      @mount_routes = mount_routes
+    end
+
+    private
+
+    def engine_routes
+      EngineRouteCollection.new(mounted_engine_routes)
+    end
+
+    def application_routes
+      routes = passages_rails_routes.reject { |route| route.is_a?(MountRoute) }
+
+      RouteCollection.new(routes)
+    end
+
+    def mounted_engine_routes
+      @mounted_engine_routes ||= ::Rails::Engine.subclasses.map do |engine|
+        routes = engine.routes.routes.routes.map { |route| EngineRoute.new(route, engine.name) }
+
+        { engine: engine.name, routes: routes }
+      end.compact
+    end
+
+    def passages_rails_routes
+      @passages_rails_routes ||= Rails.application.routes.routes.map { |route| Route.from_raw_route(route) }
+    end
+
+    def mount_routes
+      {}.tap do |_mount_routes|
+        passages_rails_routes.each do |route|
+          _mount_routes[route.engine_name] = route if route.is_a?(MountRoute)
+        end
+      end
+    end
+  end
+end

data/app/views/passages/routes/_route.html.erb

@@ -0,0 +1,7 @@
+<tr>
+  <% Passages::Route.attributes_for_display.each do |attribute| %>
+    <td data-search='<%= route.send(attribute).downcase %>' data-matching-attribute='<%=attribute%>'>
+      <%= route.send(attribute) %>
+    </td>
+  <% end %>
+</tr>

data/app/views/passages/routes/_routes_header.html.erb

@@ -0,0 +1,5 @@
+<tr class='header'>
+  <% Passages::Route.attributes_for_display.each do |header| %>
+    <th><%= header.titleize %></th>
+  <% end %>
+</tr>

data/app/views/passages/routes/routes.html.erb

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <%= stylesheet_link_tag 'passages/application', media: 'all' %>
+  <%= javascript_include_tag 'passages/application' %>
+  <title>Passages</title>
+</head>
+  <body class='container'>
+    <div class = 'row'>
+      <div class='col-xs-12 vertical-spacer'></div>
+    </div>
+
+    <div class ='row'>
+      <div class='col-xs-6 '>
+        <input class='form-control' name='search' type='text' placeholder='Route Matching...'/>
+      </div>
+    </div>
+
+    <div class = 'row'>
+      <div class='col-xs-12 vertical-spacer'></div>
+    </div>
+
+    <div class = 'row'>
+      <div class='col-xs-12'>
+        <h3 class='no-results'></h3>
+        <table class='matching-term table table-striped table-bordered'>
+          <%= render partial: 'routes_header', locals: { collection: @route_collection } %>
+        </table>
+      </div>
+    </div>
+
+    <div class = 'row'>
+      <div class ='col-xs-12 '>
+        <% if @engine_routes.present? %>
+          <h3>Engine Routes</h3>
+            <% @engine_routes.each do |engine_hash| %>
+              <table class='table table-striped table-bordered'>
+                <tr>
+                  <td colspan='2'><b>Routes for Engine:</b> <%= engine_hash[:engine] %></td>
+                  <td colspan='3'><b>Mounted at:</b> <%= @mount_routes[engine_hash[:engine]].path %></td>
+                </tr>
+                <%= render partial: 'routes_header', locals: { collection: engine_hash[:routes] } %>
+                <% engine_hash[:routes].each do |route| %>
+                  <%= render partial: 'route', locals: { route: route } %>
+                <% end %>
+              </table>
+            <% end %>
+          <% end %>
+        <h3>App Routes</h3>
+          <table class='table table-striped table-bordered'>
+            <%= render partial: 'routes_header', locals: { collection: @route_collection } %>
+            <% @routes.each do |route| %>
+              <%= render partial: 'route', locals: { route: route } %>
+            <% end %>
+          </table>
+      </div>
+    </div>
+  </body>
+</html>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.version = '1.0'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Passages::Engine.routes.draw do
+  root to: 'routes#routes'
+end

data/lib/passages/engine.rb

@@ -0,0 +1,11 @@
+module Passages
+  class Engine < ::Rails::Engine
+     isolate_namespace Passages
+
+     initializer 'passages', before: :load_config_initializers do |app|
+      Rails.application.routes.prepend do
+        mount Passages::Engine, at: '/passages'
+      end
+    end
+  end
+end

data/lib/passages/engine_route.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext'
+
+module Passages
+  class EngineRoute < DelegateClass(ActionDispatch::Routing::RouteWrapper)
+    attr_reader :engine_name
+
+    def initialize(raw_route, engine_name)
+      @engine_name = engine_name
+
+      super(ActionDispatch::Routing::RouteWrapper.new(raw_route))
+    end
+  end
+end

data/lib/passages/engine_route_collection.rb

@@ -0,0 +1,10 @@
+require_relative 'route'
+require_relative 'route_collection'
+
+module Passages
+  class EngineRouteCollection < RouteCollection
+    def initialize(_routes)
+      @routes = _routes.reject { |h| h[:routes].all?(&:internal?) }
+    end
+  end
+end

data/lib/passages/mount_route.rb

@@ -0,0 +1,12 @@
+module Passages
+  class MountRoute < DelegateClass(ActionDispatch::Routing::RouteWrapper)
+    def initialize(route, app)
+      @app = app
+      super(ActionDispatch::Routing::RouteWrapper.new(route))
+    end
+
+    def engine_name
+      @app.name
+    end
+  end
+end

data/lib/passages/route.rb

@@ -0,0 +1,44 @@
+require 'active_support/core_ext'
+require 'action_dispatch/routing/inspector'
+require_relative 'mount_route'
+
+module Passages
+  class Route < DelegateClass(ActionDispatch::Routing::RouteWrapper)
+
+    def initialize(route)
+      super(ActionDispatch::Routing::RouteWrapper.new(route))
+    end
+
+    class << self
+      def attributes_for_display
+        %w[name verb controller action path]
+      end
+
+      def from_raw_route(raw_route)
+        mount_class = mount_route_class(raw_route)
+
+        if mount_class.nil?
+          new(raw_route)
+        else
+          MountRoute.new(raw_route, mount_class)
+        end
+      end
+
+      private
+
+      def mount_route_class(route)
+        route_app = route.app
+
+        app = if route_app.class == Class
+          route_app
+        else
+          route_app.try(:app)
+        end
+
+        app if app.ancestors.include?(Rails::Engine)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/passages/route_collection.rb

@@ -0,0 +1,23 @@
+require_relative 'route'
+
+module Passages
+  class RouteCollection
+    include Enumerable
+
+    attr_reader :routes
+
+    def initialize(_routes)
+      @routes = _routes.reject { |r| r.internal? }
+    end
+
+    def each(&block)
+      Array(routes).each(&block)
+    end
+
+    private
+
+    def main_app_name
+      Rails.application.class.name
+    end
+  end
+end

data/lib/passages.rb

@@ -0,0 +1,5 @@
+require 'passages/engine'
+require 'controllers/passages/routes_controller'
+
+module Passages
+end

data/passages.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+$LOAD_PATH << File.dirname(__FILE__) + '/app'
+
+require './version'
+
+Gem::Specification.new do |s|
+  s.name          = 'passages'
+  s.version       = Passages::VERSION
+  s.summary       = %q{Display and search capabilities for Ruby on Rails routes}
+  s.description   = %q{Rails Engine to make internal routes searchable and discoverable for more than just the name of the route. All aspects of a route are searchable from the HTTP verb to the paramters a route supports.}
+  s.authors       = ['Jake Yesbeck']
+  s.email         = 'yesbeckjs@gmail.com'
+  s.homepage      = 'https://github.com/yez/roots'
+  s.license       = 'MIT'
+
+  s.require_paths = %w(lib app)
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(/^spec\//)
+
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency 'rails', '~> 4.0'
+
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

data/spec/controllers/passages/routes_controller_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'action_dispatch/routing'
+require 'rails'
+
+require_relative '../../../lib/passages/engine'
+require_relative '../../../app/controllers/passages/routes_controller'
+
+module Passages
+  describe RoutesController do
+
+    describe '#routes' do
+      before do
+        allow(subject).to receive(:application_routes) { anything }
+        allow(subject).to receive(:engine_routes) { anything }
+        allow(subject).to receive(:mount_routes) { anything }
+        subject.routes
+      end
+
+      it 'sets @routes' do
+        expect(subject.instance_variable_get(:@routes)).to_not be_nil
+      end
+
+      it 'sets @engine_routes' do
+        expect(subject.instance_variable_get(:@engine_routes)).to_not be_nil
+      end
+
+      it 'sets @mount_routes' do
+        expect(subject.instance_variable_get(:@mount_routes)).to_not be_nil
+      end
+    end
+
+    describe '!#engine_routes' do
+      it 'calls mounted_engine_routes' do
+        expect(subject).to receive(:mounted_engine_routes) { [] }
+        subject.send(:engine_routes)
+      end
+    end
+
+    describe '!#passages_rails_routes' do
+      it 'calls deep into the Rails routes' do
+        expect(Rails).to receive_message_chain(:application, :routes, :routes) { [] }
+        subject.send(:passages_rails_routes)
+      end
+    end
+  end
+end

data/spec/lib/passages/engine_route_collection_spec.rb

@@ -0,0 +1,42 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/passages/engine_route'
+require_relative '../../../lib/passages/engine_route_collection'
+
+module Passages
+  describe EngineRouteCollection do
+    describe '#initialize' do
+      let(:fake_route) { instance_double(EngineRoute) }
+      let(:engine_name) { 'Whatever' }
+
+      before do
+        allow(fake_route).to receive(:engine_name) { engine_name }
+        allow(fake_route).to receive(:internal?) { false }
+      end
+
+      subject { described_class.new([{engine: engine_name, routes: [fake_route]}]) }
+
+      it 'adds the engine name to each route' do
+        expect(subject.routes.all? { |route| route[:engine] == engine_name }).to eq(true)
+      end
+
+      context 'all an engine\'s routes are internal' do
+        it 'does not add it to the ivar' do
+          allow(fake_route).to receive(:internal?) { true }
+          expect(subject.routes).to be_empty
+        end
+      end
+
+      context 'only some of an engine\'s routes are internal' do
+        let(:another_fake_route) { instance_double(EngineRoute, internal?: false) }
+        let(:routes) { [fake_route, another_fake_route]}
+        subject { described_class.new([{engine: engine_name, routes: routes }]) }
+
+        it 'adds the engine to the ivar' do
+          expect(subject.routes).to_not be_empty
+          expect(subject.routes.all? { |r| r[:engine] == engine_name }).to eq(true)
+          expect(subject.routes.first[:routes]).to eq(routes)
+        end
+      end
+    end
+  end
+end