rails_best_practices 1.9.1 → 1.10.0

data/spec/rails_best_practices/lexicals/long_line_check_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module RailsBestPractices
+  module Lexicals
+    describe LongLineCheck do
+
+      it "should find long lines" do
+        runner = Core::Runner.new(lexicals: LongLineCheck.new)
+        content =<<-EOF
+class User < ActiveRecord::Base
+# 81 Chars
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+# 80 Chars
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+end
+EOF
+        content.gsub!("\n", "\t\n")
+        runner.lexical('app/models/user.rb', content)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "app/models/user.rb:3 - line is longer than 80 characters (81 characters)"
+      end
+      it "should find long lines with own max size" do
+        runner = Core::Runner.new(lexicals: LongLineCheck.new('max_line_length' => 90))
+        content =<<-EOF
+class User < ActiveRecord::Base
+# 91 Chars
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+# 90 Chars
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+end
+EOF
+        content.gsub!("\n", "\t\n")
+        runner.lexical('app/models/user.rb', content)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "app/models/user.rb:3 - line is longer than 90 characters (91 characters)"
+      end
+      it "should not check non .rb files" do
+        runner = Core::Runner.new(lexicals: LongLineCheck.new)
+        content = "
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+"
+        runner.lexical('app/views/users/index.html.erb', content)
+        runner.should have(0).errors
+      end
+    end
+  end
+end

data/spec/rails_best_practices/lexicals/remove_tab_check_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Lexicals
     describe RemoveTabCheck do
-      let(:runner) { Core::Runner.new(:lexicals => RemoveTabCheck.new) }
+      let(:runner) { Core::Runner.new(lexicals: RemoveTabCheck.new) }
 
       it "should remove tab" do
         content =<<-EOF

data/spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Lexicals
     describe RemoveTrailingWhitespaceCheck do
-      let(:runner) { Core::Runner.new(:lexicals => RemoveTrailingWhitespaceCheck.new) }
+      let(:runner) { Core::Runner.new(lexicals: RemoveTrailingWhitespaceCheck.new) }
 
       it "should remove trailing whitespace" do
         content =<<-EOF

data/spec/rails_best_practices/prepares/config_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe ConfigPrepare do
-      let(:runner) { Core::Runner.new(:prepares => ConfigPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: ConfigPrepare.new) }
 
       context "configs" do
         it "should parse configs" do

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe ControllerPrepare do
-      let(:runner) { Core::Runner.new(:prepares => [ControllerPrepare.new, HelperPrepare.new]) }
+      let(:runner) { Core::Runner.new(prepares: [ControllerPrepare.new, HelperPrepare.new]) }
       before(:each) { runner.whiny = true }
 
       context "methods" do

data/spec/rails_best_practices/prepares/helper_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe HelperPrepare do
-      let(:runner) { Core::Runner.new(:prepares => HelperPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: HelperPrepare.new) }
 
       context "methods" do
         it "should parse helper methods" do

data/spec/rails_best_practices/prepares/mailer_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe MailerPrepare do
-      let(:runner) { Core::Runner.new(:prepares => MailerPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: MailerPrepare.new) }
 
       it "should parse mailer names" do
         content =<<-EOF

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe ModelPrepare do
-      let(:runner) { Core::Runner.new(:prepares => ModelPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: ModelPrepare.new) }
 
       before :each do
         runner.whiny = true
@@ -267,7 +267,7 @@ module RailsBestPractices
         it "should treat named_scope as method" do
           content =<<-EOF
           class Post < ActiveRecord::Base
-            named_scope :active, :conditions => {:active => true}
+            named_scope :active, conditions: {active: true}
           end
           EOF
           runner.prepare("app/models/post.rb", content)
@@ -278,7 +278,7 @@ module RailsBestPractices
         it "should treat scope as method" do
           content =<<-EOF
           class Post < ActiveRecord::Base
-            scope :active, where(:active => true)
+            scope :active, where(active: true)
           end
           EOF
           runner.prepare("app/models/post.rb", content)
@@ -370,7 +370,7 @@ module RailsBestPractices
         it "should raised for finder_sql option" do
           content =<<-EOF
           class EventSubscription < ActiveRecord::Base
-            has_many :event_notification_template, :finder_sql => ?
+            has_many :event_notification_template, finder_sql: ?
           end
           EOF
           content.sub!('?', '\'SELECT event_notification_templates.* from event_notification_templates where event_type_id=#{event_type_id} and delivery_method_id=#{delivery_method_id}\'')

data/spec/rails_best_practices/prepares/route_prepare_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe RoutePrepare do
-      let(:runner) { Core::Runner.new(:prepares => RoutePrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: RoutePrepare.new) }
 
       context "rails2" do
         context "resources" do
@@ -33,7 +33,7 @@ module RailsBestPractices
           it "should add resources route with explict controller" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :controller => :blog_posts
+              map.resources :posts, controller: :blog_posts
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -45,7 +45,7 @@ module RailsBestPractices
           it "should add resources route with only option" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :only => [:index, :show, :new, :create]
+              map.resources :posts, only: [:index, :show, :new, :create]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -57,7 +57,7 @@ module RailsBestPractices
           it "should add resources route with except option" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :except => [:edit, :update, :destroy]
+              map.resources :posts, except: [:edit, :update, :destroy]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -66,10 +66,10 @@ module RailsBestPractices
             routes.map(&:to_s).should == ["PostsController#index", "PostsController#show", "PostsController#new", "PostsController#create"]
           end
 
-          it "should not add resources routes with :only => :none" do
+          it "should not add resources routes with only: :none" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :only => :none
+              map.resources :posts, only: :none
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -77,10 +77,10 @@ module RailsBestPractices
             routes.size.should == 0
           end
 
-          it "should not add resources routes with :except => :all" do
+          it "should not add resources routes with except: :all" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :except => :all
+              map.resources :posts, except: :all
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -91,7 +91,7 @@ module RailsBestPractices
           it "should add resource routes with hash collection/member routes" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :only => [:show], :collection => { :list => :get }, :member => { :create => :post, :update => :put, :destroy => :delete }
+              map.resources :posts, only: [:show], collection: { list: :get }, member: { create: :post, update: :put, destroy: :delete }
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -103,7 +103,7 @@ module RailsBestPractices
           it "should add resource routes with array collection/member routes" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resources :posts, :only => [:show], :collection => [:list], :member => [:create, :update, :destroy]
+              map.resources :posts, only: [:show], collection: [:list], member: [:create, :update, :destroy]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -130,7 +130,7 @@ module RailsBestPractices
             ActionController::Routing::Routes.draw do |map|
               map.namespace :admin do |admin|
                 admin.namespace :test do |test|
-                  test.resources :posts, :only => [:index]
+                  test.resources :posts, only: [:index]
                 end
               end
             end
@@ -168,7 +168,7 @@ module RailsBestPractices
           it "should add resource route with only option" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resource :posts, :only => [:show, :new, :create]
+              map.resource :posts, only: [:show, :new, :create]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -180,7 +180,7 @@ module RailsBestPractices
           it "should add resource route with except option" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resource :posts, :except => [:edit, :update, :destroy]
+              map.resource :posts, except: [:edit, :update, :destroy]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -189,10 +189,10 @@ module RailsBestPractices
             routes.map(&:to_s).should == ["PostsController#show", "PostsController#new", "PostsController#create"]
           end
 
-          it "should not add resource routes with :only => :none" do
+          it "should not add resource routes with only: :none" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resource :posts, :only => :none
+              map.resource :posts, only: :none
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -200,10 +200,10 @@ module RailsBestPractices
             routes.size.should == 0
           end
 
-          it "should not add resource routes with :except => :all" do
+          it "should not add resource routes with except: :all" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.resource :posts, :except => :all
+              map.resource :posts, except: :all
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -215,7 +215,7 @@ module RailsBestPractices
         it "should add connect route" do
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|
-            map.connect 'vote', :controller => "votes", :action => "create", :method => :post
+            map.connect 'vote', controller: "votes", action: "create", method: :post
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -226,7 +226,7 @@ module RailsBestPractices
         it "should add connect route with all actions" do
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|
-            map.connect 'internal/:action/*whatever', :controller => "internal"
+            map.connect 'internal/:action/*whatever', controller: "internal"
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -237,7 +237,7 @@ module RailsBestPractices
         it "should add named route" do
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|
-            map.login '/player/login', :controller => 'sessions', :action => 'new', :conditions => { :method => :get }
+            map.login '/player/login', controller: 'sessions', action: 'new', conditions: { method: :get }
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -248,8 +248,8 @@ module RailsBestPractices
         it "should add named route with with_options" do
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|
-            map.with_options(:controller => "admin_session") do |session|
-              session.login '/login', :action => 'new', :method => :get
+            map.with_options(controller: "admin_session") do |session|
+              session.login '/login', action: 'new', method: :get
             end
           end
           EOF
@@ -262,7 +262,7 @@ module RailsBestPractices
           content =<<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.resources :posts
-            map.stop 'sprints/stop', :controller => 'sprints', :action => 'stop'
+            map.stop 'sprints/stop', controller: 'sprints', action: 'stop'
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -299,7 +299,7 @@ module RailsBestPractices
           it "should add resources route with explict controller" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :controller => :blog_posts
+              resources :posts, controller: :blog_posts
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -311,7 +311,7 @@ module RailsBestPractices
           it "should add resources route with only option" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :only => [:index, :show, :new, :create]
+              resources :posts, only: [:index, :show, :new, :create]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -323,7 +323,7 @@ module RailsBestPractices
           it "should add resources route with except option" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :except => [:edit, :update, :destroy]
+              resources :posts, except: [:edit, :update, :destroy]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -332,10 +332,10 @@ module RailsBestPractices
             routes.map(&:to_s).should == ["PostsController#index", "PostsController#show", "PostsController#new", "PostsController#create"]
           end
 
-          it "should not add resources routes with :only => :none" do
+          it "should not add resources routes with only: :none" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :only => :none
+              resources :posts, only: :none
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -343,10 +343,10 @@ module RailsBestPractices
             routes.size.should == 0
           end
 
-          it "should not add resources routes with :except => :all" do
+          it "should not add resources routes with except: :all" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :except => :all
+              resources :posts, except: :all
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -357,7 +357,7 @@ module RailsBestPractices
           it "should add connect route" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.connect 'vote', :controller => "votes", :action => "create", :method => :post
+              map.connect 'vote', controller: "votes", action: "create", method: :post
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -368,7 +368,7 @@ module RailsBestPractices
           it "should add named route" do
             content =<<-EOF
             ActionController::Routing::Routes.draw do |map|
-              map.login '/player/login', :controller => 'sessions', :action => 'new', :conditions => { :method => :get }
+              map.login '/player/login', controller: 'sessions', action: 'new', conditions: { method: :get }
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -404,7 +404,7 @@ module RailsBestPractices
           it "should add resource route with only option" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resource :posts, :only => [:show, :new, :create]
+              resource :posts, only: [:show, :new, :create]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -416,7 +416,7 @@ module RailsBestPractices
           it "should add resource route with except option" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resource :posts, :except => [:edit, :update, :destroy]
+              resource :posts, except: [:edit, :update, :destroy]
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -425,10 +425,10 @@ module RailsBestPractices
             routes.map(&:to_s).should == ["PostsController#show", "PostsController#new", "PostsController#create"]
           end
 
-          it "should not add resource routes with :only => :none" do
+          it "should not add resource routes with only: :none" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resource :posts, :only => :none
+              resource :posts, only: :none
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -436,10 +436,10 @@ module RailsBestPractices
             routes.size.should == 0
           end
 
-          it "should not add resource routes with :except => :all" do
+          it "should not add resource routes with except: :all" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resource :posts, :except => :all
+              resource :posts, except: :all
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -450,13 +450,13 @@ module RailsBestPractices
           it "should add resource routes with get/post/put/delete routes" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :only => [:show] do
-                get :list, :on => :collection
+              resources :posts, only: [:show] do
+                get :list, on: :collection
                 collection do
                   get :search
                   match :available
                 end
-                post :create, :on => :member
+                post :create, on: :member
                 member do
                   put :update
                 end
@@ -472,7 +472,7 @@ module RailsBestPractices
           it "should add custom resources routes with {}" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :only => [:show] { get :inactive, :on => :collection }
+              resources :posts, only: [:show] { get :inactive, on: :collection }
             end
             EOF
             runner.prepare('config/routes.rb', content)
@@ -484,7 +484,7 @@ module RailsBestPractices
           it "should add resources routes with get %w() routes" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
-              resources :posts, :only => [:show] do
+              resources :posts, only: [:show] do
                 collection do
                   get *%w(latest popular)
                 end
@@ -515,7 +515,7 @@ module RailsBestPractices
             RailsBestPracticesCom::Application.routes.draw do
               namespace :admin do
                 namespace :test do
-                  resources :posts, :only => [:index]
+                  resources :posts, only: [:index]
                 end
               end
             end
@@ -530,7 +530,7 @@ module RailsBestPractices
             RailsBestPracticesCom::Appllication.routes.draw do
               namespace :something do
                 get *%w(route_one route_two)
-                get :route_three, :action => "custom_action"
+                get :route_three, action: "custom_action"
               end
             end
             EOF
@@ -542,17 +542,17 @@ module RailsBestPractices
           it "should add route with scope" do
             content =<<-EOF
               RailsBestPracticesCom::Application.routes.draw do
-                scope :module => "admin" do
-                  resources :posts, :only => [:index]
+                scope module: "admin" do
+                  resources :posts, only: [:index]
                 end
-                resources :discussions, :only => [:index], :module => "admin"
+                resources :discussions, only: [:index], module: "admin"
                 scope "/admin" do
-                  resources :comments, :only => [:index]
+                  resources :comments, only: [:index]
                 end
                 scope "/:username", controller: :users do
                   get '/' => :show
                   scope 'topic' do
-                    get 'preview', :as => 'preview_user', :action => 'preview'
+                    get 'preview', as: 'preview_user', action: 'preview'
                   end
                 end
               end
@@ -576,7 +576,7 @@ module RailsBestPractices
             post '/posts' => 'posts#create'
             put '/posts/:id' => 'posts#update'
             delete '/post/:id' => 'posts#destroy'
-            get '/agb' => 'high_voltage/pages#show', :id => 'agb'
+            get '/agb' => 'high_voltage/pages#show', id: 'agb'
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -611,7 +611,7 @@ module RailsBestPractices
         it "should add match route with all actions" do
           content =<<-EOF
           RailsBestPracticesCom::Application.routes.draw do
-            match 'internal/:action/*whatever', :controller => "internal"
+            match 'internal/:action/*whatever', controller: "internal"
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -622,7 +622,7 @@ module RailsBestPractices
         it "should add root route" do
           content =<<-EOF
           RailsBestPracticesCom::Application.routes.draw do
-            root :to => 'home#index'
+            root to: 'home#index'
           end
           EOF
           runner.prepare('config/routes.rb', content)
@@ -682,7 +682,7 @@ module RailsBestPractices
         it "should not parse wrong route" do
           content =<<-EOF
           RailsBestPracticesCom::Application.routes.draw do
-            match ':controller/:action' => '#index', :as => :auto_complete
+            match ':controller/:action' => '#index', as: :auto_complete
           end
           EOF
           runner.prepare('config/routes.rb', content)