rails_best_practices 1.18.1 → 1.19.0

data/spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb

@@ -142,7 +142,7 @@ module RailsBestPractices
         it "should not protect mass assignment for activerecord 4" do
           content =<<-EOF
   GEM
-    remote: http://rubygems.org
+    remote: https://rubygems.org
     specs:
       activerecord (4.0.0)
           EOF
@@ -158,7 +158,7 @@ module RailsBestPractices
         it "should protect mass assignment for activerecord 3" do
           content =<<-EOF
   GEM
-    remote: http://rubygems.org
+    remote: https://rubygems.org
     specs:
       activerecord (3.2.13)
           EOF

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -153,6 +153,27 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#list)")
         end
 
+        it "should not remove inline routes" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts, only: :none do
+              get :display, :list, on: :member
+            end
+          end
+          EOF
+          runner.prepare('config/routes.rb', content)
+          content =<<-EOF
+          class PostsController < ApplicationController
+            def display; end
+            def list; end
+          end
+          EOF
+          runner.prepare('app/controllers/posts_controller.rb', content)
+          runner.review('app/controllers/posts_controller.rb', content)
+          runner.after_review
+          expect(runner.errors.size).to eq(0)
+        end
+
         it "should not remove unused methods if all actions are used in route" do
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|

data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb

@@ -20,131 +20,125 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
         end
 
-        describe "rails2" do
+        it "should restrict auto-generated routes" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])")
+        end
+
+        it "should not restrict auto-generated routes with only" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts, only: %w(show new create edit update destroy)
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should not restrict auto-generated routes with except" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts, except: :index
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        describe "specify a controller" do
           it "should restrict auto-generated routes" do
             content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resources :posts
+            RailsBestPracticesCom::Application.routes.draw do
+              resources :articles, controller: "posts"
             end
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])")
+            expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes articles (except: [:index])")
           end
+        end
 
-          it "should not restrict auto-generated routes with only" do
+        describe "namespace" do
+          before do
             content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, only: [:show, :new, :create, :edit, :update, :destroy]
+            class Admin::CommentsController < ApplicationController
+              def show; end
+              def new; end
+              def create; end
+              def edit; end
+              def update; end
+              def destroy; end
             end
             EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+            runner.prepare('app/controllers/admin/comments_controller.rb', content)
           end
 
-          it "should not restrict auto-generated routes with except" do
+          it "should restrict auto-generated routes" do
             content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, except: :index
+            RailsBestPracticesCom::Application.routes.draw do
+              namespace :admin do
+                resources :comments
+              end
             end
             EOF
             runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+            expect(runner.errors.size).to eq(1)
+            expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
           end
 
-          it "should not restrict auto-generated routes with only: :none" do
+          it "should restrict auto-generated routes with scope :module" do
             content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, only: :none
+            RailsBestPracticesCom::Application.routes.draw do
+              scope module: :admin do
+                resources :comments
+              end
             end
             EOF
             runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+            expect(runner.errors.size).to eq(1)
+            expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
           end
 
-          it "should not restrict auto-generated routes with except: :all" do
+          it "should restrict auto-generated routes with resources :module" do
             content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, except: :all
+            RailsBestPracticesCom::Application.routes.draw do
+              resources :comments, module: :admin
             end
             EOF
             runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
-          end
-
-          describe "specify a controller" do
-            it "should restrict auto-generated routes" do
-              content =<<-EOF
-              ActionController::Routing::Routes.draw do |map|
-                map.resources :articles, controller: "posts"
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes articles (except: [:index])")
-            end
+            expect(runner.errors.size).to eq(1)
+            expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes admin/comments (except: [:index])")
           end
+        end
 
-          describe "nested routes" do
-            before :each do
-              content =<<-EOF
-              class CommentsController < ApplicationController
-                def index; end
-                def show; end
-                def new; end
-                def create; end
-                def edit; end
-                def update; end
-                def destroy; end
-              end
-              EOF
-              runner.prepare('app/controllers/comments_controller.rb', content)
-            end
-
-            it "should restrict auto-generated routes" do
-              content =<<-EOF
-              ActionController::Routing::Routes.draw do |map|
-                map.resources :posts do |post|
-                  post.resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])")
-            end
-
-            it "should not restrict auto-generated routes with only" do
-              content =<<-EOF
-              ActionController::Routing::Routes.draw do |map|
-                map.resources :posts, only: [:show, :new, :create, :edit, :update, :destroy] do |post|
-                  post.resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(0)
-            end
-
-            it "should not restrict auto-generated routes with except" do
-              content =<<-EOF
-              ActionController::Routing::Routes.draw do |map|
-                map.resources :posts, except: :index do |post|
-                  post.resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(0)
+        describe "nested routes" do
+          before :each do
+            content =<<-EOF
+            class CommentsController < ApplicationController
+              def index; end
+              def show; end
+              def new; end
+              def create; end
+              def edit; end
+              def update; end
+              def destroy; end
             end
+            EOF
+            runner.prepare('app/controllers/comments_controller.rb', content)
           end
-        end
 
-        describe "rails3" do
           it "should restrict auto-generated routes" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts
+              resources :posts do
+                resources :comments
+              end
             end
             EOF
             runner.review('config/routes.rb', content)
@@ -155,7 +149,9 @@ module RailsBestPractices
           it "should not restrict auto-generated routes with only" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, only: %w(show new create edit update destroy)
+              resources :posts, only: %w(show new create edit update destroy) do
+                resources :comments
+              end
             end
             EOF
             runner.review('config/routes.rb', content)
@@ -165,132 +161,14 @@ module RailsBestPractices
           it "should not restrict auto-generated routes with except" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, except: :index
+              resources :posts, except: :index do
+                resources :comments
+              end
             end
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(0)
           end
-
-          describe "specify a controller" do
-            it "should restrict auto-generated routes" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                resources :articles, controller: "posts"
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes articles (except: [:index])")
-            end
-          end
-
-          describe "namespace" do
-            before do
-              content =<<-EOF
-              class Admin::CommentsController < ApplicationController
-                def show; end
-                def new; end
-                def create; end
-                def edit; end
-                def update; end
-                def destroy; end
-              end
-              EOF
-              runner.prepare('app/controllers/admin/comments_controller.rb', content)
-            end
-
-            it "should restrict auto-generated routes" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                namespace :admin do
-                  resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
-            end
-
-            it "should restrict auto-generated routes with scope :module" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                scope module: :admin do
-                  resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
-            end
-
-            it "should restrict auto-generated routes with resources :module" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                resources :comments, module: :admin
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes admin/comments (except: [:index])")
-            end
-          end
-
-          describe "nested routes" do
-            before :each do
-              content =<<-EOF
-              class CommentsController < ApplicationController
-                def index; end
-                def show; end
-                def new; end
-                def create; end
-                def edit; end
-                def update; end
-                def destroy; end
-              end
-              EOF
-              runner.prepare('app/controllers/comments_controller.rb', content)
-            end
-
-            it "should restrict auto-generated routes" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                resources :posts do
-                  resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])")
-            end
-
-            it "should not restrict auto-generated routes with only" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                resources :posts, only: %w(show new create edit update destroy) do
-                  resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(0)
-            end
-
-            it "should not restrict auto-generated routes with except" do
-              content =<<-EOF
-              RailsBestPracticesCom::Application.routes.draw do
-                resources :posts, except: :index do
-                  resources :comments
-                end
-              end
-              EOF
-              runner.review('config/routes.rb', content)
-              expect(runner.errors.size).to eq(0)
-            end
-          end
         end
       end
 
@@ -308,83 +186,93 @@ module RailsBestPractices
           runner.prepare('app/controllers/accounts_controller.rb', content)
         end
 
-        describe "rails2" do
-          it "should restrict auto-generated routes" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes account (except: [:destroy])")
+        it "should restrict auto-generated routes" do
+          content =<<-EOF
+          ActionController::Routing::Routes.draw do |map|
+            map.resource :account
           end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes account (except: [:destroy])")
+        end
 
-          it "should not restrict auto-generated routes with only" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account, only: %w(show new create edit update)
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+        it "should not restrict auto-generated routes with only" do
+          content =<<-EOF
+          ActionController::Routing::Routes.draw do |map|
+            map.resource :account, only: %w(show new create edit update)
           end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
 
-          it "should not restrict auto-generated routes with except" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account, except: :destroy
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+        it "should not restrict auto-generated routes with except" do
+          content =<<-EOF
+          ActionController::Routing::Routes.draw do |map|
+            map.resource :account, except: :destroy
           end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
         end
 
-        describe "rails3" do
-          it "should restrict auto-generated routes" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes account (except: [:destroy])")
-          end
+        it "should not check ignored files" do
+          runner = Core::Runner.new(prepares: Prepares::ControllerPrepare.new,
+                                    reviews: RestrictAutoGeneratedRoutesReview.new(ignored_files: /config\/routes\.rb/))
 
-          it "should not restrict auto-generated routes with only" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account, only: %w(show new create edit update)
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+          content =<<-EOF
+          ActionController::Routing::Routes.draw do |map|
+            map.resource :account
           end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+      end
 
-          it "should not restrict auto-generated routes with except" do
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account, except: :destroy
+      context 'api_only = true' do
+        let(:runner) { Core::Runner.new(prepares: [Prepares::ConfigPrepare.new, Prepares::ControllerPrepare.new], reviews: RestrictAutoGeneratedRoutesReview.new) }
+
+        before do
+          content =<<-EOF
+          module RailsBestPracticesCom
+            class Application < Rails::Application
+              config.api_only = true
             end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
           end
+          EOF
+          runner.prepare('config/application.rb', content)
+          content =<<-EOF
+          class PostsController < ApplicationController
+            def show; end
+            def create; end
+            def update; end
+            def destroy; end
+          end
+          EOF
+          runner.prepare('app/controllers/posts_controller.rb', content)
+        end
 
-          it "should not check ignored files" do
-            runner = Core::Runner.new(prepares: Prepares::ControllerPrepare.new,
-                                      reviews: RestrictAutoGeneratedRoutesReview.new(ignored_files: /config\/routes\.rb/))
+        it "should restrict auto-generated routes" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])")
+        end
 
-            content =<<-EOF
-            ActionController::Routing::Routes.draw do |map|
-              map.resource :account
-            end
-            EOF
-            runner.review('config/routes.rb', content)
-            expect(runner.errors.size).to eq(0)
+        it "should not restrict auto-generated routes with only" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts, only: %w(show create update destroy)
           end
+          EOF
+          runner.review('config/routes.rb', content)
+          expect(runner.errors.size).to eq(0)
         end
       end
     end