routing_report 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +33 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/routing_report/railtie.rb +5 -0
- data/lib/routing_report/report.rb +66 -0
- data/lib/routing_report/version.rb +3 -0
- data/lib/routing_report.rb +6 -0
- data/lib/tasks/routing_report.rake +13 -0
- data/routing_report.gemspec +30 -0
- metadata +143 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ee1286ed0cdad0ab96322b7a23e84863e9f057d7
|
4
|
+
data.tar.gz: 70f9de0afd6ce58106750ec27affbd3915977aaf
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 46ca680057343d604a9e72075a759af2a807aea3257cebb21fc98276c514d3e29afbfa0b1da34c944bb74ce7ef988c4c453aab67b74fb48acdfe44bb06401243
|
7
|
+
data.tar.gz: d0aaf53b81a72380e29a008d5c8ec9f1c6ab6bd02abda189754192e8f154a4bb89c79865116e6ab26d7c8fa3f86c2daf1b9fce13a1e60d6057e6ac1296ab5c9a
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Rob Watson
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# routing_report
|
2
|
+
|
3
|
+
Identify cruft in a Rails app.
|
4
|
+
|
5
|
+
Detects:
|
6
|
+
|
7
|
+
* routes with no matching controller actions
|
8
|
+
* controller actions with no matching routes
|
9
|
+
|
10
|
+
## Installation
|
11
|
+
|
12
|
+
Add this line to your application's Gemfile:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
gem 'routing_report'
|
16
|
+
```
|
17
|
+
|
18
|
+
And then execute:
|
19
|
+
|
20
|
+
$ bundle
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
`bundle exec rake routing_report:run`
|
25
|
+
|
26
|
+
## Contributing
|
27
|
+
|
28
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/rfwatson/routing_report.
|
29
|
+
|
30
|
+
## License
|
31
|
+
|
32
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
33
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "routing_report"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
require 'terminal-table'
|
2
|
+
|
3
|
+
module RoutingReport
|
4
|
+
class Report
|
5
|
+
def initialize(base_class: Object, routes: [])
|
6
|
+
@base_class, @routes = base_class, routes
|
7
|
+
end
|
8
|
+
|
9
|
+
def print(to: STDOUT)
|
10
|
+
print_table('Routes without actions', routes_without_actions, to)
|
11
|
+
print_table('Actions without routes', actions_without_routes, to)
|
12
|
+
end
|
13
|
+
|
14
|
+
def routes_without_actions
|
15
|
+
routes.each_with_object([]) do |route, accum|
|
16
|
+
controller_name = route.defaults[:controller]
|
17
|
+
action_name = route.defaults[:action]
|
18
|
+
|
19
|
+
if controller_name && action_name
|
20
|
+
begin
|
21
|
+
controller = "#{controller_name}_controller".classify.constantize
|
22
|
+
rescue NameError
|
23
|
+
accum << "#{controller_name}##{action_name}"
|
24
|
+
next
|
25
|
+
end
|
26
|
+
|
27
|
+
# get all superclasses that descend from ActionController::Base
|
28
|
+
# this allows us to avoid false positives when routes are fulfilled by
|
29
|
+
# actions in a superclass:
|
30
|
+
matching_controllers = controller.ancestors.select { |c| c < base_class }
|
31
|
+
|
32
|
+
unless matching_controllers.any? { |c| c.public_instance_methods(false).include?(action_name.to_sym) }
|
33
|
+
accum << "#{controller_name}##{action_name}"
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end.sort
|
37
|
+
end
|
38
|
+
|
39
|
+
def actions_without_routes
|
40
|
+
base_class.descendants.each_with_object([]) do |controller_class, accum|
|
41
|
+
controller_name = controller_class.name.underscore.match(/\A(.*)_controller\z/)[1]
|
42
|
+
|
43
|
+
controller_class.public_instance_methods(false).each do |method|
|
44
|
+
unless routes.any? { |r| r.defaults[:controller] == controller_name && r.defaults[:action] == method.to_s }
|
45
|
+
accum << "#{controller_name}##{method.to_s}"
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end.sort
|
49
|
+
end
|
50
|
+
|
51
|
+
private
|
52
|
+
attr_reader :routes, :base_class
|
53
|
+
|
54
|
+
def print_table(title, rows, to)
|
55
|
+
count = rows.size
|
56
|
+
rows << "No #{title.downcase} detected" if rows.none?
|
57
|
+
|
58
|
+
to.puts Terminal::Table.new(
|
59
|
+
headings: ["#{title} (#{count})"],
|
60
|
+
rows: rows.map { |r| [r] },
|
61
|
+
style: { width: 80 }
|
62
|
+
)
|
63
|
+
to.puts
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
namespace :routing_report do
|
2
|
+
task :run => :environment do
|
3
|
+
# pre-load all controllers:
|
4
|
+
Dir.glob(Rails.root.join('app', 'controllers', '**', '*_controller.rb')).each do |path|
|
5
|
+
require_dependency(path)
|
6
|
+
end
|
7
|
+
|
8
|
+
RoutingReport::Report.new(
|
9
|
+
base_class: ActionController::Base,
|
10
|
+
routes: Rails.application.routes.set
|
11
|
+
).print
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'routing_report/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "routing_report"
|
8
|
+
spec.version = RoutingReport::VERSION
|
9
|
+
spec.authors = ["Rob Watson"]
|
10
|
+
spec.email = ["rob@mixlr.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Identify unused routes and controller actions in Rails apps}
|
13
|
+
spec.homepage = "https://github.com/rfwatson/routing_report"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
17
|
+
f.match(%r{^(test|spec|features)/})
|
18
|
+
end
|
19
|
+
spec.bindir = "exe"
|
20
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_dependency 'terminal-table', '~> 1.8'
|
24
|
+
spec.add_dependency 'activesupport', '~> 3'
|
25
|
+
|
26
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
29
|
+
spec.add_development_dependency 'byebug', '~> 9'
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,143 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: routing_report
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Rob Watson
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-07-20 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: terminal-table
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.8'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.8'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: activesupport
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '3'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '3'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.14'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.14'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '3.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '3.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: byebug
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '9'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '9'
|
97
|
+
description:
|
98
|
+
email:
|
99
|
+
- rob@mixlr.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".gitignore"
|
105
|
+
- ".rspec"
|
106
|
+
- ".travis.yml"
|
107
|
+
- Gemfile
|
108
|
+
- LICENSE.txt
|
109
|
+
- README.md
|
110
|
+
- Rakefile
|
111
|
+
- bin/console
|
112
|
+
- bin/setup
|
113
|
+
- lib/routing_report.rb
|
114
|
+
- lib/routing_report/railtie.rb
|
115
|
+
- lib/routing_report/report.rb
|
116
|
+
- lib/routing_report/version.rb
|
117
|
+
- lib/tasks/routing_report.rake
|
118
|
+
- routing_report.gemspec
|
119
|
+
homepage: https://github.com/rfwatson/routing_report
|
120
|
+
licenses:
|
121
|
+
- MIT
|
122
|
+
metadata: {}
|
123
|
+
post_install_message:
|
124
|
+
rdoc_options: []
|
125
|
+
require_paths:
|
126
|
+
- lib
|
127
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: '0'
|
137
|
+
requirements: []
|
138
|
+
rubyforge_project:
|
139
|
+
rubygems_version: 2.6.12
|
140
|
+
signing_key:
|
141
|
+
specification_version: 4
|
142
|
+
summary: Identify unused routes and controller actions in Rails apps
|
143
|
+
test_files: []
|