routes_dont_work 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cdc3f3bb10c9d198432e4be5d3aac146fc01c68
+  data.tar.gz: 8beaa937a7bd12868b11dc3d561a264881fc3f4e
+SHA512:
+  metadata.gz: e5487c86ad54b75d714b823dc765d260ae7ac71df786d336177a02ad6987de817b00dfaaef4bfef6520ca8b44278fb40c953ead247d478ed764d479447e0d119
+  data.tar.gz: 659baea02a4e5768300b812cf04a86d751eb5ee8e6a66b2efd341800b5510cd908dc04b4c51ec454e34449d7d6bc0446dd8b62e9bbdc7b8f759a6dda8a92e9f3

data/README.md

@@ -0,0 +1,57 @@
+routes_dont_work provides a test to ensure that all the routes in your Rails app actually route to something. In
+particular, it tests that:
+
+- The referenced controller exists.
+- The controller has a public method named the same as the action, or a view exists in the view lookup path for that
+controller.
+
+A very common case of broken routes is the use of RESTful routes without defining all the actions (index, show, new, create, edit, update, and destroy). If you don't need all of these actions, you can use the [`only` and `except` options of the `resources` block](http://guides.rubyonrails.org/routing.html#restricting-the-routes-created).
+
+After routes_dont_work identifies these routes, you should fix or remove them. Be careful if removing, because if, for example, you have a view that generates a link with the broken route, removing the route without removing the reference will make the view raise an exception.
+
+## Usage
+
+Include routes_dont_work in your Gemfile in the 'test' group.
+```ruby
+group :test do
+  gem 'routes_dont_work'
+end
+```
+
+For rspec, include the 'routes_dont_work' shared example in one of your tests, for example:
+
+```ruby
+require 'spec_helper'
+require 'routes_dont_work/rspec'
+
+describe 'routes' do
+  include_examples 'routes_dont_work'
+end
+```
+
+If this was in routes.rb,
+
+```ruby
+  get 'this_doesnt_exist' => 'fake_controller/fake_action'
+```
+
+your test suite would fail with:
+
+```
+Failures:
+
+  1) routes has no broken routes
+     Failure/Error: expect(RoutesDontWork::RouteChecker.get_broken_routes(Rails.application)).to be_empty
+       expected `[{:action=>"this_doesnt_exist", :controller=>"fake_controller/fake_action", :path=>"/this_doesnt_exist(.:format)"}].empty?` to return true, got false
+     Shared Example Group: "routes_dont_work" called from ./spec/controllers/routes_spec.rb:5
+     # ~/routes_dont_work/lib/routes_dont_work/rspec.rb:5:in `block (2 levels) in <top (required)>'
+```
+
+
+## Limitations
+
+- routes_dont_work will only check the existence of the controller/action/view. It will not guarantee that any request for
+the routes will succeed.
+- Your app may have special dynamic craziness that can confuse routes_dont_work. You should verify that what
+routes_dont_work says is true.
+- routes_dont_work currently only works with rspec. Feel free to contribute changes to support other frameworks.

data/lib/routes_dont_work.rb

@@ -0,0 +1 @@
+require 'routes_dont_work/route_checker'

data/lib/routes_dont_work/route_checker.rb

@@ -0,0 +1,32 @@
+module RoutesDontWork
+  class RouteChecker
+    class << self
+      def get_broken_routes(app)
+        broken_routes = app.routes.routes.select do |r|
+          controller_name = r.defaults[:controller].try(:camelize)
+
+          # There's some built-in Rails ones like /assets that have no controller. Ignore those.
+          next false if controller_name.nil?
+
+          action_name = r.defaults[:action]
+
+          begin
+            controller_class = (controller_name + 'Controller').constantize
+          rescue NameError
+            # Controller doesn't exist
+            next true
+          end
+
+          # Controller exists, but action doesn't? Note that this correctly handles cases where there is no method on a
+          # controller, but a view exists at the right place.
+          next controller_class.new.method_for_action(action_name).nil?
+        end
+
+        # Just to get a readable error if it fails
+        broken_routes.map!{|r| r.defaults.merge(path: r.path.spec.to_s)}
+
+        return broken_routes
+      end
+    end
+  end
+end

data/lib/routes_dont_work/rspec.rb

@@ -0,0 +1,7 @@
+require 'routes_dont_work/route_checker'
+
+RSpec.shared_examples "routes_dont_work" do
+  it 'has no broken routes' do
+    expect(RoutesDontWork::RouteChecker.get_broken_routes(Rails.application)).to be_empty
+  end
+end

data/lib/routes_dont_work/version.rb

@@ -0,0 +1,5 @@
+module RoutesDontWork
+  module Version
+    STRING = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: routes_dont_work
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Barnabe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide a test to check if all the routes in a Rails app go to a controller
+  or view
+email: jason.barnabe@canadadrugs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/routes_dont_work.rb
+- lib/routes_dont_work/route_checker.rb
+- lib/routes_dont_work/rspec.rb
+- lib/routes_dont_work/version.rb
+homepage: https://github.com/canadadrugs/routes_dont_work
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: routes_dont_work-1.0.0
+test_files: []
+has_rdoc: