passages 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca4bb9df54319e3bd96465b6b28bfad0ace42970
-  data.tar.gz: 8af7f485c8eb5dd4cc09ac5f8956c0df720b824c
+  metadata.gz: 67624b8b5e3463b0f208b14a7b83b07e2bec4ce8
+  data.tar.gz: 9b5f496d76095f08336886d7eee03ac48604e5f0
 SHA512:
-  metadata.gz: ef7b145f7cbbd63e91c7eb6c5a626512c9a69e284f0b5d7fd0a962e711c979b13b9467a17c2353b3d74b4d8739dec73ecb3b211bbb35797f2128538814cefad1
-  data.tar.gz: cf7469e8ab678be9a644c0fd0f741e64a22959968c108153686072744e7d7bd38d7fae67cd98c516f576e49946de9726910dec9e2907eeabc7dcdf8193224b42
+  metadata.gz: 6ac021c052780b84ba0139bdd6043a875b98396d855f411c224d31309b0469cdd2895930ac6705582322e614cf8c94404d5921139e3ed2c0db509c92b017172a
+  data.tar.gz: cc6056f8aadc10df93ec9b52f55194707e9063b57532566fe5b815be41b60dfe9abda08792ca7edc23ae7ad69fe22c87e30c7e8dd97627ae93771668fbb00c39

data/.travis.yml

@@ -5,4 +5,6 @@ rvm:
   - 2.2.2
   - 2.3.0
 
-script: bundle exec rspec spec
+script:
+  - bundle exec rspec spec
+  - bundle exec rubocop

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    passages (1.3.0)
+    passages (1.4.0)
       rails (~> 4.0)
 
 GEM
@@ -43,6 +43,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     arel (6.0.3)
+    ast (2.2.0)
     builder (3.2.2)
     diff-lcs (1.2.5)
     erubis (2.7.0)
@@ -56,9 +57,12 @@ GEM
       mime-types (>= 1.16, < 3)
     mime-types (2.6.2)
     mini_portile (0.6.2)
-    minitest (5.8.1)
+    minitest (5.8.3)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    parser (2.3.0.7)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -86,6 +90,7 @@ GEM
       activesupport (= 4.2.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
     rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -100,6 +105,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.7.5)
     sprockets (3.3.5)
       rack (> 1, < 3)
     sprockets-rails (2.3.3)
@@ -110,6 +122,7 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unicode-display_width (1.0.2)
 
 PLATFORMS
   ruby
@@ -117,3 +130,7 @@ PLATFORMS
 DEPENDENCIES
   passages!
   rspec (~> 3.2)
+  rubocop (= 0.39.0)
+
+BUNDLED WITH
+   1.11.2

data/app/controllers/passages/routes_controller.rb

@@ -5,6 +5,8 @@ require 'passages/route_collection'
 require 'passages/engine_route_collection'
 
 module Passages
+  # Single Rails controller responsible for
+  #  collecting instance variables and rendering the Engine's main page
   class RoutesController < ActionController::Base
     layout false
 
@@ -28,20 +30,24 @@ module Passages
 
     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) }
+        routes = engine.routes.routes.routes.map do |route|
+          EngineRoute.new(route, engine.name)
+        end
 
         { 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) }
+      @passages_rails_routes ||= Rails.application.routes.routes.map do |route|
+        Route.from_raw_route(route)
+      end
     end
 
     def mount_routes
-      {}.tap do |_mount_routes|
+      {}.tap do |mount_route_hash|
         passages_rails_routes.each do |route|
-          _mount_routes[route.engine_name] = route if route.is_a?(MountRoute)
+          mount_route_hash[route.engine_name] = route if route.is_a?(MountRoute)
         end
       end
     end

data/config/config.rb

@@ -1,10 +1,12 @@
+# Define the Passages namespace
 module Passages
+  # Central configuration class
   class Config
     attr_accessor :automount
     attr_writer :no_auth
 
     def no_auth?
-      !!@no_auth
+      @no_auth.present?
     end
   end
 

data/config/initializers/basic_auth.rb

@@ -1,3 +1,5 @@
+# Authentication methods that access environment variables
+#  and expose config.no_auth?
 module Passages
   def username
     ENV['passages_username'] || ENV['PASSAGES_USERNAME'] || 'username'

data/lib/passages/engine.rb

@@ -1,12 +1,21 @@
 module Passages
+  # Engine class, subclass of Rails::Engine and the heart of
+  #  namespace isolation, asset precompiliation hooks and
+  #  authentication concerns.
   class Engine < ::Rails::Engine
     isolate_namespace Passages
 
-    initializer "passages.assets.precompile" do |app|
+    # Necessary for rake assets:precompile in a main application
+    #  to compile this Engine's assets as well
+    initializer 'passages.assets.precompile' do |app|
       app.config.assets.precompile += %w(application.css application.js)
     end
 
-    initializer 'passages', after: :load_config_initializers do |app|
+    # Optionally mount the /passages route at an applications top
+    #  level.
+    #
+    # Optionally allow basic authentication
+    initializer 'passages', after: :load_config_initializers do
       if Passages.config.automount
         Rails.application.routes.prepend do
           mount Passages::Engine, at: '/passages'
@@ -14,7 +23,9 @@ module Passages
       end
 
       unless Passages.config.no_auth?
-        Passages::RoutesController.http_basic_authenticate_with name: Passages.username, password: Passages.password
+        Passages::RoutesController.http_basic_authenticate_with(
+          name: Passages.username,
+          password: Passages.password)
       end
     end
   end

data/lib/passages/engine_route.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext'
 
 module Passages
+  # DelegateClass of internal RouteWrapper class within ActionDispatch
   class EngineRoute < DelegateClass(ActionDispatch::Routing::RouteWrapper)
     attr_reader :engine_name
 

data/lib/passages/engine_route_collection.rb

@@ -2,9 +2,11 @@ require_relative 'route'
 require_relative 'route_collection'
 
 module Passages
+  # Specialized collection class inherited from RouteCollection specifically
+  #  for routes of Engines (this Engine included)
   class EngineRouteCollection < RouteCollection
-    def initialize(_routes)
-      @routes = _routes.reject { |h| h[:routes].all?(&:internal?) }
+    def initialize(routes)
+      @routes = routes.reject { |h| h[:routes].all?(&:internal?) }
     end
   end
 end

data/lib/passages/mount_route.rb

@@ -1,4 +1,6 @@
 module Passages
+  # Special DelegateClass of ActionDispatch's RouteWrapper for
+  #  an Engine's mount route. i.e. /passages for this Engine
   class MountRoute < DelegateClass(ActionDispatch::Routing::RouteWrapper)
     def initialize(route, app)
       @app = app

data/lib/passages/route.rb

@@ -3,15 +3,16 @@ require 'action_dispatch/routing/inspector'
 require_relative 'mount_route'
 
 module Passages
+  # Main DelegateClass used for decoration and discerning if a route is
+  #  a "regular" route or a mount route
   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]
+        %w(name verb controller action path)
       end
 
       def from_raw_route(raw_route)
@@ -29,16 +30,20 @@ module Passages
       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)
+        app(route_app) if app(route_app).ancestors.include?(Rails::Engine)
       rescue
         nil
       end
+
+      def app(route_app)
+        @app ||= begin
+          if route_app.class == Class
+            route_app
+          else
+            route_app.try(:app)
+          end
+        end
+      end
     end
   end
 end

data/lib/passages/route_collection.rb

@@ -1,13 +1,15 @@
 require_relative 'route'
 
 module Passages
+  # Enumerable to iterate through and select only external routes
+  #  for the main application to display
   class RouteCollection
     include Enumerable
 
     attr_reader :routes
 
-    def initialize(_routes)
-      @routes = _routes.reject { |r| r.internal? }
+    def initialize(routes)
+      @routes = routes.reject(&:internal?)
     end
 
     def each(&block)

data/lib/passages.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH << File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH << File.dirname(__FILE__) + '/../config'
 
+# Define the Passages namespace module
 module Passages
 end
 

data/passages.gemspec

@@ -6,8 +6,11 @@ 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.summary       = 'Display and search capabilities for Ruby on Rails routes'
+  s.description   = '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/passages'
@@ -15,10 +18,11 @@ Gem::Specification.new do |s|
 
   s.require_paths = %w(lib app)
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = s.files.grep(/^spec\//)
+  s.test_files    = s.files.grep(%r{^spec/})
 
   s.required_ruby_version = '>= 2.0.0'
   s.add_dependency 'rails', '~> 4.0'
 
   s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'rubocop', '0.39.0'
 end

data/spec/config/config_spec.rb

@@ -3,18 +3,18 @@ require 'spec_helper'
 module Passages
   describe Config do
     describe '#no_auth?' do
-      context '@basic_auth is a truthy value' do
+      context '@no_auth is a truthy value' do
         [true, 'yes', ['1'], { a: :b }].each do |value|
-          it "#{ value } returns true" do
+          it "#{value} returns true" do
             Passages.config.no_auth = value
             expect(Passages.config.no_auth?).to eq(true)
           end
         end
       end
 
-      context '@basic_auth is a falsey value' do
+      context '@no_auth is a falsey value' do
         [false, nil].each do |value|
-          it "#{ value } returns false" do
+          it "#{value} returns false" do
             Passages.config.no_auth = value
             expect(Passages.config.no_auth?).to eq(false)
           end

data/spec/config/initializers/basic_auth_spec.rb

@@ -16,7 +16,9 @@ describe Passages do
         let(:upper_username) { 'THISISANUPPERUSERNAME' }
         before do
           allow(ENV).to receive(:[]).with('passages_username') { nil }
-          allow(ENV).to receive(:[]).with('PASSAGES_USERNAME') { upper_username }
+          allow(ENV).to receive(:[]).with('PASSAGES_USERNAME') do
+            upper_username
+          end
         end
 
         it 'uses the ENV var' do
@@ -47,7 +49,9 @@ describe Passages do
         let(:upper_password) { 'THISISANUPPERPASSWORD' }
         before do
           allow(ENV).to receive(:[]).with('passages_password') { nil }
-          allow(ENV).to receive(:[]).with('PASSAGES_PASSWORD') { upper_password }
+          allow(ENV).to receive(:[]).with('PASSAGES_PASSWORD') do
+            upper_password
+          end
         end
 
         it 'uses the ENV var' do

data/spec/controllers/passages/routes_controller_spec.rb

@@ -7,7 +7,6 @@ require_relative '../../../app/controllers/passages/routes_controller'
 
 module Passages
   describe RoutesController do
-
     describe '#routes' do
       before do
         allow(subject).to receive(:application_routes) { anything }
@@ -38,7 +37,10 @@ module Passages
 
     describe '!#passages_rails_routes' do
       it 'calls deep into the Rails routes' do
-        expect(Rails).to receive_message_chain(:application, :routes, :routes) { [] }
+        expect(Rails)
+          .to receive_message_chain(:application, :routes, :routes) do
+            []
+          end
         subject.send(:passages_rails_routes)
       end
     end

data/spec/lib/passages/engine_route_collection_spec.rb

@@ -13,10 +13,14 @@ module Passages
         allow(fake_route).to receive(:internal?) { false }
       end
 
-      subject { described_class.new([{engine: engine_name, routes: [fake_route]}]) }
+      subject do
+        described_class.new([{ engine: engine_name, routes: [fake_route] }])
+      end
 
       it 'adds the engine name to each route' do
-        expect(subject.routes.all? { |route| route[:engine] == engine_name }).to eq(true)
+        expect(subject.routes).to be_all do |route|
+          route[:engine] == engine_name
+        end
       end
 
       context 'all an engine\'s routes are internal' do
@@ -27,13 +31,19 @@ module Passages
       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 }]) }
+        subject do
+          described_class.new([{ engine: engine_name, routes: routes }])
+        end
+        let(:another_fake_route) do
+          instance_double(EngineRoute, internal?: false)
+        end
+        let(:routes) { [fake_route, another_fake_route] }
 
         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).to be_all do |r|
+            r[:engine] == engine_name
+          end
           expect(subject.routes.first[:routes]).to eq(routes)
         end
       end

data/spec/lib/passages/mount_route_spec.rb

@@ -19,8 +19,8 @@ module Passages
     end
 
     [:internal?, :path].each do |method|
-      describe "##{ method }" do
-        it "responds to #{ method }" do
+      describe "##{method}" do
+        it "responds to #{method}" do
           expect(subject).to respond_to(method)
         end
       end

data/spec/lib/passages/route_collection_spec.rb

@@ -6,7 +6,9 @@ module Passages
     let(:fake_route) { instance_double(Passages::Route) }
 
     before do
-      allow_any_instance_of(described_class).to receive(:main_app_name) { 'SomeGreatApp' }
+      allow_any_instance_of(described_class).to receive(:main_app_name) do
+        'SomeGreatApp'
+      end
       allow(fake_route).to receive(:internal?) { false }
     end
 
@@ -34,7 +36,7 @@ module Passages
 
         context 'internal and external routes exist' do
           let(:another_fake_route) { instance_double(Passages::Route) }
-          subject { described_class.new([fake_route, another_fake_route])}
+          subject { described_class.new([fake_route, another_fake_route]) }
 
           before do
             allow(another_fake_route).to receive(:internal?) { false }

data/spec/lib/passages/route_spec.rb

@@ -42,7 +42,9 @@ module Passages
 
     describe '.from_raw_route' do
       let(:raw_route) { anything }
-      before { allow(described_class).to receive(:mount_route_class) { mount_class } }
+      before do
+        allow(described_class).to receive(:mount_route_class) { mount_class }
+      end
 
       context 'mount class is present' do
         let(:mount_class) { anything }

data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passages
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,9 +38,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: 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.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: |-
+  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.
 email: yesbeckjs@gmail.com
 executables: []
 extensions: []