rails_best_practices 1.0.1 → 1.1.0

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -34,6 +34,28 @@ describe RailsBestPractices::Prepares::ModelPrepare do
     lambda { runner.prepare('app/models/event_subscription.rb', content) }.should_not raise_error
   end
 
+  it "class_name with modules ::" do
+    content =<<-EOF
+    class Blog::Post < ActiveRecord::Base
+    end
+    EOF
+    runner.prepare("app/models/admin/post.rb", content)
+    models = RailsBestPractices::Prepares.models
+    models.should == ["Blog::Post"]
+  end
+
+  it "class_name with modules" do
+    content =<<-EOF
+    module Blog
+      class Post < ActiveRecord::Base
+      end
+    end
+    EOF
+    runner.prepare("app/models/admin/post.rb", content)
+    models = RailsBestPractices::Prepares.models
+    models.should == ["Blog::Post"]
+  end
+
   context "class_name" do
     it "should parse belongs_to" do
       content =<<-EOF

data/spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb

@@ -99,7 +99,7 @@ describe RailsBestPractices::Reviews::OveruseRouteCustomizationsReview do
   describe "rails3" do
     it "should overuse route customizations" do
       content = <<-EOF
-      RailsBestpracticesCom::Application.routes.draw do |map|
+      RailsBestpracticesCom::Application.routes.draw do
         resources :posts do
           member do
             post :create_comment
@@ -120,7 +120,7 @@ describe RailsBestPractices::Reviews::OveruseRouteCustomizationsReview do
 
     it "should overuse route customizations another way" do
       content = <<-EOF
-      RailsBestpracticesCom::Application.routes.draw do |map|
+      RailsBestpracticesCom::Application.routes.draw do
         resources :posts do
           post :create_comment, :on => :member
           update :update_comment, :on => :member
@@ -136,7 +136,7 @@ describe RailsBestPractices::Reviews::OveruseRouteCustomizationsReview do
 
     it "should not overuse route customizations without customization" do
       content = <<-EOF
-      RailsBestpracticesCom::Application.routes.draw do |map|
+      RailsBestpracticesCom::Application.routes.draw do
         resources :posts
       end
       EOF
@@ -146,7 +146,7 @@ describe RailsBestPractices::Reviews::OveruseRouteCustomizationsReview do
 
     it "should not overuse route customizations when customize route is only one" do
       content = <<-EOF
-      RailsBestpracticesCom::Application.routes.draw do |map|
+      RailsBestpracticesCom::Application.routes.draw do
         resources :posts do
           member do
             post :vote

data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb

@@ -0,0 +1,334 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::RestrictAutoGeneratedRoutesReview do
+  let(:runner) {
+    RailsBestPractices::Core::Runner.new(
+      :prepares => RailsBestPractices::Prepares::ControllerPrepare.new,
+      :reviews => RailsBestPractices::Reviews::RestrictAutoGeneratedRoutesReview.new
+    )
+  }
+
+  describe "resources" do
+    before :each do
+      content =<<-EOF
+      class PostsController < 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/posts_controller.rb', content)
+    end
+
+    describe "rails2" do
+      it "should restrict auto-generated routes" do
+        content =<<-EOF
+        ActionController::Routing::Routes.draw do |map|
+          map.resources :posts
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+      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]
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(0).errors
+      end
+
+      it "should not restrict auto-generated routes with except" do
+        content =<<-EOF
+        ActionController::Routing::Routes.draw do |map|
+          map.resources :posts, :except => :index
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(0).errors
+      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)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+        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)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+        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)
+          runner.should have(0).errors
+        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)
+          runner.should have(0).errors
+        end
+      end
+    end
+
+    describe "rails3" 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)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+      end
+
+      it "should not restrict auto-generated routes with only" do
+        content =<<-EOF
+        RailsBestPracticesCom::Application.routes.draw do
+          resources :posts, :only => [:show, :new, :create, :edit, :update, :destroy]
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(0).errors
+      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)
+        runner.should have(0).errors
+      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)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+        end
+      end
+
+      describe "namespace" do
+        it "should restrict auto-generated routes" 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)
+
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            namespace :admin do
+              resources :comments
+            end
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "config/routes.rb:3 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+        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)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update, :destroy])"
+        end
+
+        it "should not restrict auto-generated routes with only" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts, :only => [:show, :new, :create, :edit, :update, :destroy] do
+              resources :comments
+            end
+          end
+          EOF
+          runner.review('config/routes.rb', content)
+          runner.should have(0).errors
+        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)
+          runner.should have(0).errors
+        end
+      end
+    end
+  end
+
+  describe "resource" do
+    before :each do
+      content =<<-EOF
+      class AccountsController < ApplicationController
+        def show; end
+        def new; end
+        def create; end
+        def edit; end
+        def update; end
+      end
+      EOF
+      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)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update])"
+      end
+
+      it "should not restrict auto-generated routes with only" do
+        content =<<-EOF
+        ActionController::Routing::Routes.draw do |map|
+          map.resource :account, :only => [:show, :new, :create, :edit, :update]
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(0).errors
+      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)
+        runner.should have(0).errors
+      end
+    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)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "config/routes.rb:2 - restrict auto-generated routes (:only => [:show, :new, :create, :edit, :update])"
+      end
+
+      it "should not restrict auto-generated routes with only" do
+        content =<<-EOF
+        ActionController::Routing::Routes.draw do |map|
+          map.resource :account, :only => [:show, :new, :create, :edit, :update]
+        end
+        EOF
+        runner.review('config/routes.rb', content)
+        runner.should have(0).errors
+      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)
+        runner.should have(0).errors
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,12 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'rspec/expectations'
 require 'rails_best_practices'
 
+RSpec.configure do |config|
+  config.after do
+    RailsBestPractices::Prepares.clear
+  end
+end
+
 def parse_content(content)
   Sexp.from_array(Ripper::SexpBuilder.new(content).parse)[1]
 end

metadata

@@ -2,7 +2,7 @@
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-24 00:00:00 +08:00
+date: 2011-10-06 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ruby_parser
+  name: sexp_processor
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -25,7 +25,7 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ruby-progressbar
+  name: progressbar
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -58,7 +58,7 @@ dependencies:
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: haml
+  name: i18n
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -69,7 +69,7 @@ dependencies:
   prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: activesupport
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -80,18 +80,18 @@ dependencies:
   prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: rake
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: rspec
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -102,7 +102,7 @@ dependencies:
   prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: watchr
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -113,7 +113,7 @@ dependencies:
   prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: watchr
+  name: haml
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -148,13 +148,15 @@ files:
 - .gitignore
 - .rspec.example
 - .rvmrc.example
+- .travis.yml
 - .watchr
 - .watchr.example
 - Gemfile
+- Gemfile.lock
 - MIT_LICENSE
 - README.md
 - Rakefile
-- assets/result.html.haml
+- assets/result.html.erb
 - autotest/discover.rb
 - bin/rails_best_practices
 - install_supported_rubies.sh
@@ -163,8 +165,10 @@ files:
 - lib/rails_best_practices/core.rb
 - lib/rails_best_practices/core/check.rb
 - lib/rails_best_practices/core/checking_visitor.rb
+- lib/rails_best_practices/core/controllers.rb
 - lib/rails_best_practices/core/error.rb
 - lib/rails_best_practices/core/mailers.rb
+- lib/rails_best_practices/core/methods.rb
 - lib/rails_best_practices/core/model_associations.rb
 - lib/rails_best_practices/core/model_attributes.rb
 - lib/rails_best_practices/core/models.rb
@@ -176,6 +180,7 @@ files:
 - lib/rails_best_practices/lexicals/remove_tab_check.rb
 - lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb
 - lib/rails_best_practices/prepares.rb
+- lib/rails_best_practices/prepares/controller_prepare.rb
 - lib/rails_best_practices/prepares/mailer_prepare.rb
 - lib/rails_best_practices/prepares/model_prepare.rb
 - lib/rails_best_practices/prepares/schema_prepare.rb
@@ -197,6 +202,7 @@ files:
 - lib/rails_best_practices/reviews/remove_empty_helpers_review.rb
 - lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb
 - lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb
+- lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb
 - lib/rails_best_practices/reviews/review.rb
 - lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb
 - lib/rails_best_practices/reviews/simplify_render_in_views_review.rb
@@ -213,7 +219,9 @@ files:
 - rake_rubies.sh
 - spec/rails_best_practices/core/check_spec.rb
 - spec/rails_best_practices/core/checking_visitor_spec.rb
+- spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/methods_spec.rb
 - spec/rails_best_practices/core/model_associations_spec.rb
 - spec/rails_best_practices/core/model_attributes_spec.rb
 - spec/rails_best_practices/core/models_spec.rb
@@ -222,6 +230,7 @@ files:
 - spec/rails_best_practices/core_ext/sexp_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
+- spec/rails_best_practices/prepares/controller_prepare_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
@@ -242,6 +251,7 @@ files:
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
+- spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb
 - spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb
 - spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb
@@ -281,7 +291,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -611443156274023641
+      hash: -4549595437881865702
       segments: 
       - 0
       version: "0"
@@ -301,7 +311,9 @@ summary: a code metric tool for rails codes.
 test_files: 
 - spec/rails_best_practices/core/check_spec.rb
 - spec/rails_best_practices/core/checking_visitor_spec.rb
+- spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/methods_spec.rb
 - spec/rails_best_practices/core/model_associations_spec.rb
 - spec/rails_best_practices/core/model_attributes_spec.rb
 - spec/rails_best_practices/core/models_spec.rb
@@ -310,6 +322,7 @@ test_files:
 - spec/rails_best_practices/core_ext/sexp_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
+- spec/rails_best_practices/prepares/controller_prepare_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
@@ -330,6 +343,7 @@ test_files:
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
+- spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb
 - spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb
 - spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb