routes_revealer 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64e0e44275c7f877cecf37e7d34915afeead933c
-  data.tar.gz: bf6b048942c1f62a652ae2d02ff9cd9f88f17955
+  metadata.gz: 38bf504deba5b0ef19a4ac783011b2e72c7ea704
+  data.tar.gz: 12b551cd56974368652737c7722edfa1bfb757d8
 SHA512:
-  metadata.gz: a14e5eda4df3c02f16e0ab4f3ccb6e819771db378c924ec976ccf7f14557c25d674c6a3576ae60c934799eeddd82965a36c76628dfe9adab2f2097182614036b
-  data.tar.gz: 97edd37c1d12fd031e4140a2a33bd8c66a00e8e0d65b06510818f98259b491b188527a32a2c641d2334cb889988b333c31340d74d6bd08c28ec524bc97ffbc2f
+  metadata.gz: 6489103ca721d33b27c636d9f9296e6a4808b71412ee3e3e497c0e485d666f0570e7c45a97c32e6593b4f119d2bca7410cf9c5f552a77c11993aa10aa1eff56b
+  data.tar.gz: 46b80c06d9be4df50bf5a042785316cbfb2d1dc0a1bd0b8fe52ca540fdfc7e1c0a95c7eb5b053a32c57ccbd933ffa611bc14ef7940f5619d9fdf30bcc33c71c5

data/app/controllers/routes_revealer/routes_controller.rb

@@ -15,6 +15,7 @@ module RoutesRevealer
     def index
       output = []
       output += [asset_route]
+      output += public_folder
       output += map_routes(Rails.application.routes.routes).flatten
       output.compact!.uniq!
       output.sort! if output
@@ -31,6 +32,17 @@ module RoutesRevealer
       Rails.application.class.config.assets.prefix
     end
 
+    def public_folder
+      files = Dir.glob('public/**/*')
+      files.map! do |file|
+        file[6..-1]
+      end
+      files.reject! do |file|
+        file.starts_with?(asset_route) || file == '/system'
+      end
+      files
+    end
+
     def map_routes(routes, prepend='')
       prepend = '' if prepend == '/'
       route_hash_array(routes).map do |route_hash|

data/lib/routes_revealer/version.rb

@@ -9,5 +9,5 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 module RoutesRevealer
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

data/spec/controllers/routes_controller_spec.rb

@@ -2,7 +2,7 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,36 +12,35 @@ require 'spec_helper'
 
 describe RoutesRevealer::RoutesController do
   describe '#index' do
+    let(:this_engine_string) { 'This::Engine' }
+    let(:that_engine_string) { 'That::Engine' }
 
-    let(:this_engine_string) { "This::Engine" }
-    let(:that_engine_string) { "That::Engine" }
+    let(:route1) { double('route1', path: '/1', verb: 'GET', reqs: 'controller#1') }
+    let(:route2) { double('route2', path: '/2', verb: 'POST', reqs: 'controller#2') }
+    let(:route3) { double('route3', path: '/3', verb: 'PUT', reqs: 'controller#3') }
+    let(:route4) { double('route4', path: '/4', verb: 'DELETE', reqs: 'controller#4') }
+    let(:route5) { double('route5', path: '/', verb: 'GET', reqs: this_engine_string) }
+    let(:route6) { double('route6', path: '/that', verb: 'GET', reqs: that_engine_string) }
+    let(:bad_route7) { double('bad_route7', path: '/routes', verb: 'HEAD', reqs: 'controller#route7') }
+    let(:bad_route8) { double('bad_route7', path: '/rails', verb: 'TRACE', reqs: 'controller#route8') }
 
-    let(:route1) { double("route1", path: "/1", verb: "GET", reqs: "controller#1") }
-    let(:route2) { double("route2", path: "/2", verb: "POST", reqs: "controller#2") }
-    let(:route3) { double("route3", path: "/3", verb: "PUT", reqs: "controller#3") }
-    let(:route4) { double("route4", path: "/4", verb: "DELETE", reqs: "controller#4") }
-    let(:route5) { double("route5", path: "/", verb: "GET", reqs: this_engine_string) }
-    let(:route6) { double("route6", path: "/that", verb: "GET", reqs: that_engine_string) }
-    let(:bad_route7) { double("bad_route7", path: "/routes", verb: "HEAD", reqs: "controller#route7") }
-    let(:bad_route8) { double("bad_route7", path: "/rails", verb: "TRACE", reqs: "controller#route8") }
-
-    let(:this_route1) { double("this_route1", path: "/t1", verb: "RAMBO", reqs: "this_controller#1") }
-    let(:this_route2) { double("this_route2", path: "/t2", verb: "ALWAYS", reqs: "this_controller#2") }
-    let(:that_route1) { double("that_route1", path: "/1", verb: "SHOOTS", reqs: "that_controller#1") }
-    let(:that_route2) { double("that_route2", path: "/2", verb: "WALNUTS", reqs: "that_controller#2") }
+    let(:this_route1) { double('this_route1', path: '/t1', verb: 'RAMBO', reqs: 'this_controller#1') }
+    let(:this_route2) { double('this_route2', path: '/t2', verb: 'ALWAYS', reqs: 'this_controller#2') }
+    let(:that_route1) { double('that_route1', path: '/1', verb: 'SHOOTS', reqs: 'that_controller#1') }
+    let(:that_route2) { double('that_route2', path: '/2', verb: 'WALNUTS', reqs: 'that_controller#2') }
 
     let(:routes) { [route1, route2, route3, route4, route5, route6, bad_route7, bad_route8] }
     let(:this_routes) { [this_route1, this_route2] }
     let(:that_routes) { [that_route1, that_route2] }
 
-    let(:this_engine) { double("this_engine", routes: double("routes", routes: this_routes))}
-    let(:that_engine) { double("that_engine", routes: double("routes", routes: that_routes))}
-
+    let(:this_engine) { double('this_engine', routes: double('routes', routes: this_routes)) }
+    let(:that_engine) { double('that_engine', routes: double('routes', routes: that_routes)) }
+    let(:public_folder) { ['public/zzz/public.txt','public/assets/example.otf','public/system'] }
     let(:route_wrapper) { ActionDispatch::Routing::RouteWrapper }
 
     before do
       allow(Rails).to receive_message_chain(:application, :routes, :routes).and_return(routes)
-      allow(Rails).to receive_message_chain(:application, :class, :config, :assets, :prefix).and_return("/assets")
+      allow(Rails).to receive_message_chain(:application, :class, :config, :assets, :prefix).and_return('/assets')
 
       allow(Module).to receive(:const_get).with(this_engine_string).and_return(this_engine)
       allow(Module).to receive(:const_get).with(that_engine_string).and_return(that_engine)
@@ -60,21 +59,42 @@ describe RoutesRevealer::RoutesController do
 
       allow(route_wrapper).to receive(:new).with(that_route1).and_return(that_route1)
       allow(route_wrapper).to receive(:new).with(that_route2).and_return(that_route2)
+      allow(Dir).to receive(:glob).with('public/**/*').and_return(public_folder)
 
       get :index
     end
 
     it { expect(response.status).to eq 200 }
-    it { expect(JSON.parse(response.body).length).to eq 9 }
-    it { expect(JSON.parse(response.body)[0]).to eq "/1" }
-    it { expect(JSON.parse(response.body)[1]).to eq "/2" }
-    it { expect(JSON.parse(response.body)[2]).to eq "/3" }
-    it { expect(JSON.parse(response.body)[3]).to eq "/4" }
-    it { expect(JSON.parse(response.body)[4]).to eq "/assets" }
-    it { expect(JSON.parse(response.body)[5]).to eq "/t1" }
-    it { expect(JSON.parse(response.body)[6]).to eq "/t2" }
-    it { expect(JSON.parse(response.body)[7]).to eq "/that/1" }
-    it { expect(JSON.parse(response.body)[8]).to eq "/that/2" }
+    it { expect(JSON.parse(response.body).length).to eq 10 }
+    it { expect(JSON.parse(response.body)[0]).to eq '/1' }
+    it { expect(JSON.parse(response.body)[1]).to eq '/2' }
+    it { expect(JSON.parse(response.body)[2]).to eq '/3' }
+    it { expect(JSON.parse(response.body)[3]).to eq '/4' }
+    it { expect(JSON.parse(response.body)[4]).to eq '/assets' }
+    it { expect(JSON.parse(response.body)[5]).to eq '/t1' }
+    it { expect(JSON.parse(response.body)[6]).to eq '/t2' }
+    it { expect(JSON.parse(response.body)[7]).to eq '/that/1' }
+    it { expect(JSON.parse(response.body)[8]).to eq '/that/2' }
+    it { expect(JSON.parse(response.body)[9]).to eq '/zzz/public.txt' }
+
+    context 'Rails app includes a public folder' do
+      let(:public_folder) do
+        ['public/robots.txt','public/humans.txt','public/dir/something.txt', 'public/assets/boom.png']
+      end
+      it 'adds the contents of the public folder' do
+        expect(JSON.parse(response.body).length).to eq 12
+      end
+      it { expect(JSON.parse(response.body)[5]).to eq '/dir/something.txt' }
+      it { expect(JSON.parse(response.body)[6]).to eq '/humans.txt' }
+      it { expect(JSON.parse(response.body)[7]).to eq '/robots.txt' }
+    end
+
+    context 'Rails app has an empty / non existant public folder' do
+      let(:public_folder) { [] }
 
+      it 'adds no additional entries' do
+        expect(JSON.parse(response.body).length).to eq 9
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routes_revealer
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - The CareerBuilder.com Consumer Development teams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails