rails_best_practices 1.10.1 → 1.11.0

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -3,10 +3,10 @@ require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
   module Reviews
-    # Review a migration file to make sure to use say or say_with_time for customized data changes 
+    # Review a migration file to make sure to use say or say_with_time for customized data changes
     # to produce a more readable output.
     #
-    # See the best practice detials here 
+    # See the best practice detials here
     # http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log.
     #
     # Implementation:
@@ -19,31 +19,28 @@ module RailsBestPractices
     class UseSayWithTimeInMigrationsReview < Review
       interesting_nodes :defs
       interesting_files MIGRATION_FILES
+      url "http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log"
 
       WITH_SAY_METHODS = %w(say say_with_time)
 
-      def url
-        "http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log"
-      end
-
-      # check a class method define node to see if there are method calls that need to be wrapped by say 
+      # check a class method define node to see if there are method calls that need to be wrapped by say
       # or say_with_time.
       #
       # it will check the first block node,
       # if any method call whose message is not default migration methods in the block node,
       # then such method call should be wrapped by say or say_with_time
-      def start_defs(node)
+      add_callback :start_defs do |node|
         node.body.statements.each do |child_node|
           next if child_node.grep_nodes_count(sexp_type: [:fcall, :command], message: WITH_SAY_METHODS) > 0
 
-          subject_node = if :method_add_block == child_node.sexp_type
+          receiver_node = if :method_add_block == child_node.sexp_type
                            child_node[1]
                          elsif :method_add_arg == child_node.sexp_type
                            child_node[1]
                          else
                            child_node
                          end
-          if :call == subject_node.sexp_type
+          if :call == receiver_node.sexp_type
             add_error("use say with time in migrations", node.file, child_node.line)
           end
         end

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -18,23 +18,17 @@ module RailsBestPractices
     class UseScopeAccessReview < Review
       interesting_nodes :if, :unless, :elsif
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/3-use-scope-access"
-      end
+      url "http://rails-bestpractices.com/posts/3-use-scope-access"
 
       # check if node.
       #
       # if it is a method call compared with current_user or current_user.id,
       # and there is a redirect_to method call in the block body,
       # then it should be replaced by using scope access.
-      def start_if(node)
+      add_callback :start_if, :start_unless, :start_elsif do |node|
         add_error "use scope access" if current_user_redirect?(node)
       end
 
-      alias_method :start_unless, :start_if
-      alias_method :start_elsif, :start_if
-
       private
         # check a if node to see
         #
@@ -49,14 +43,14 @@ module RailsBestPractices
           end
           results = all_conditions.map do |condition_node|
             ["==", "!="].include?(condition_node.message.to_s) &&
-              (current_user?(condition_node.argument) || current_user?(condition_node.subject))
+              (current_user?(condition_node.argument) || current_user?(condition_node.receiver))
           end
           results.any? { |result| result == true } && node.body.grep_node(message: "redirect_to")
         end
 
         # check a call node to see if it uses current_user, or current_user.id.
         def current_user?(node)
-          "current_user" == node.to_s || ("current_user" == node.subject.to_s && "id" == node.message.to_s)
+          "current_user" == node.to_s || ("current_user" == node.receiver.to_s && "id" == node.message.to_s)
         end
     end
   end

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.10.1"
+  VERSION = "1.11.0"
 end

data/rails_best_practices.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_dependency("sexp_processor")
+  s.add_dependency("code_analyzer")
   s.add_dependency("progressbar")
   s.add_dependency("colored")
   s.add_dependency("erubis")

data/rails_best_practices.yml

@@ -1,11 +1,11 @@
 AddModelVirtualAttributeCheck: { }
 AlwaysAddDbIndexCheck: { }
 DryBundlerInCapistranoCheck: { }
-HashSyntaxCheck: { only_symbol: false, only_string: false }
+#HashSyntaxCheck: { }
 IsolateSeedDataCheck: { }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
-LongLineCheck: { max_line_length: 80 }
+#LongLineCheck: { max_line_length: 80 }
 MoveCodeIntoControllerCheck: { }
 MoveCodeIntoHelperCheck: { array_count: 3 }
 MoveCodeIntoModelCheck: { use_count: 2 }
@@ -17,7 +17,7 @@ NotUseTimeAgoInWordsCheck: { }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 ProtectMassAssignmentCheck: { }
 RemoveEmptyHelpersCheck: { }
-RemoveTabCheck: { }
+#RemoveTabCheck: { }
 RemoveTrailingWhitespaceCheck: { }
 RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
 RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
@@ -27,10 +27,10 @@ ReplaceInstanceVariableWithLocalVariableCheck: { }
 RestrictAutoGeneratedRoutesCheck: { }
 SimplifyRenderInControllersCheck: { }
 SimplifyRenderInViewsCheck: { }
-UseBeforeFilterCheck: { customize_count: 2 }
+#UseBeforeFilterCheck: { customize_count: 2 }
 UseModelAssociationCheck: { }
 UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
-UseParenthesesInMethodDefCheck: { }
+#UseParenthesesInMethodDefCheck: { }
 UseObserverCheck: { }
 UseQueryAttributeCheck: { }
 UseSayWithTimeInMigrationsCheck: { }

data/spec/rails_best_practices/core/check_spec.rb

@@ -4,73 +4,6 @@ module RailsBestPractices::Core
   describe Check do
     let(:check) { Check.new }
 
-    it "should get empty interesting nodes" do
-      check.interesting_nodes.should == []
-    end
-
-    it "should match none of interesting files" do
-      check.interesting_files.should == []
-    end
-
-    context "node_start" do
-      it "should call start_if" do
-        node = stub(sexp_type: :if)
-        check.should_receive(:send).with("start_if", node)
-        check.node_start(node)
-      end
-
-      it "should call start_call" do
-        node = stub(sexp_type: :call)
-        check.should_receive(:send).with("start_call", node)
-        check.node_start(node)
-      end
-
-      it "should print node if debug mode" do
-        node = stub(sexp_type: :call)
-        Check.class_eval { debug }
-        check.should_receive(:send).with("start_call", node)
-        check.should_receive(:ap).with(node)
-        check.node_start(node)
-        Check.class_eval { @debug = false }
-      end
-    end
-
-    context "node_end" do
-      it "should call end_if" do
-        node = stub(sexp_type: :if)
-        check.should_receive(:send).with("end_if", node)
-        check.node_end(node)
-      end
-
-      it "should call end_call" do
-        node = stub(sexp_type: :call)
-        check.should_receive(:send).with("end_call", node)
-        check.node_end(node)
-      end
-    end
-
-    context "callback" do
-      it "should add callback to start_call" do
-        execute = false
-        check.class.add_callback "start_call" do
-          execute = true
-        end
-        node = stub(sexp_type: :call)
-        check.node_start(node)
-        execute.should be_true
-      end
-
-      it "should ad callbacks to end_call" do
-        execute = false
-        check.class.add_callback "end_call" do
-          execute = true
-        end
-        node = stub(sexp_type: :call)
-        check.node_end(node)
-        execute.should be_true
-      end
-    end
-
     context "debug" do
       it "should be debug mode" do
         Check.debug

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -4,7 +4,6 @@ module RailsBestPractices
   module Prepares
     describe ControllerPrepare do
       let(:runner) { Core::Runner.new(prepares: [ControllerPrepare.new, HelperPrepare.new]) }
-      before(:each) { runner.whiny = true }
 
       context "methods" do
         it "should parse controller methods" do

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -5,10 +5,6 @@ module RailsBestPractices
     describe ModelPrepare do
       let(:runner) { Core::Runner.new(prepares: ModelPrepare.new) }
 
-      before :each do
-        runner.whiny = true
-      end
-
       context "models" do
         it "class_name with modules ::" do
           content =<<-EOF

data/spec/rails_best_practices/reviews/hash_syntax_review_spec.rb

@@ -16,15 +16,14 @@ module RailsBestPractices
         runner.errors[0].to_s.should == "app/models/user.rb:2 - change Hash Syntax to 1.9"
       end
 
-      it "should find 1.8 Hash with symbol" do
+      it "should not find 1.8 Hash with string" do
         content =<<-EOF
         class User < ActiveRecord::Base
           CONST = { "foo" => "bar" }
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:2 - change Hash Syntax to 1.9"
+        runner.should have(0).errors
       end
 
       it "should not alert on 1.9 Syntax" do
@@ -37,32 +36,6 @@ module RailsBestPractices
         runner.should have(0).errors
       end
 
-      it "should only check symbol syntax" do
-        runner = Core::Runner.new(reviews: HashSyntaxReview.new(only_symbol: true))
-        content =<<-EOF
-        class User < ActiveRecord::Base
-          SYMBOL_CONST = { :foo => :bar }
-          STRING_CONST = { "foo" => "bar" }
-        end
-        EOF
-        runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:2 - change Hash Syntax to 1.9"
-      end
-
-      it "should only check string syntax" do
-        runner = Core::Runner.new(reviews: HashSyntaxReview.new(only_string: true))
-        content =<<-EOF
-        class User < ActiveRecord::Base
-          SYMBOL_CONST = { :foo => :bar }
-          STRING_CONST = { "foo" => "bar" }
-        end
-        EOF
-        runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:3 - change Hash Syntax to 1.9"
-      end
-
       it "should ignore haml_out" do
         content =<<-EOF
 %div{ class: "foo1" }
@@ -83,7 +56,7 @@ module RailsBestPractices
 
       it "should not consider hash with charaters not valid for symbol" do
         content =<<-EOF
-        subject.stub(:` => 'Error')
+        receiver.stub(:` => 'Error')
         EOF
         runner.review('app/models/post.rb', content)
         runner.should have(0).errors

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -80,6 +80,28 @@ module RailsBestPractices
           runner.should have(0).errors
         end
 
+        it "should not remove unused methods for layout" do
+          content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts
+          end
+          EOF
+          runner.prepare('config/routes.rb', content)
+          content =<<-EOF
+          class PostsController < ActiveRecord::Base
+            layout :choose_layout
+            private
+              def choose_layout
+                "default"
+              end
+          end
+          EOF
+          runner.prepare('app/controllers/posts_controller.rb', content)
+          runner.review('app/controllers/posts_controller.rb', content)
+          runner.after_review
+          runner.should have(0).errors
+        end
+
         it "should not remove inherited_resources methods" do
           content =<<-EOF
           RailsBestPracticesCom::Application.routes.draw do

data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb

@@ -670,6 +670,25 @@ module RailsBestPractices
         end
       end
 
+      it "should not remove unused methods for rabl view" do
+        content =<<-EOF
+        class User
+          def first_name; end
+          def last_name; end
+        end
+        EOF
+        runner.prepare("app/models/user.rb", content)
+        runner.review("app/models/user.rb", content)
+        content =<<-EOF
+        node :full_name do |u|
+          u.first_name + " " + u.last_name
+        end
+        EOF
+        runner.review("app/views/users/show.json.rabl", content)
+        runner.after_review
+        runner.should have(0).errors
+      end
+
       it "should not skip :call as call message" do
         content =<<-EOF
         module DateRange

data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb

@@ -31,7 +31,7 @@ module RailsBestPractices
             <<-EOF
             class ProjectMailer < ActionMailer::Base
               def send_email(email)
-                subject       email.subject
+                receiver      email.receiver
                 from          email.from
                 recipients    email.recipients
                 sent_on       Time.now
@@ -145,7 +145,7 @@ module RailsBestPractices
             <<-EOF
             class ProjectMailer < ActionMailer::Base
               def send_email(email)
-                subject       email.subject
+                receiver      email.receiver
                 from          email.from
                 recipients    email.recipients
                 sent_on       Time.now

data/spec/spec_helper.rb

@@ -11,7 +11,3 @@ RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 end
-
-def parse_content(content)
-  Sexp.from_array(Ripper::SexpBuilder.new(content).parse)[1]
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sexp_processor
-  requirement: &70244299371240 !ruby/object:Gem::Requirement
+  name: code_analyzer
+  requirement: &70092487156320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299371240
+  version_requirements: *70092487156320
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70244299370320 !ruby/object:Gem::Requirement
+  requirement: &70092487155800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299370320
+  version_requirements: *70092487155800
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70244299368200 !ruby/object:Gem::Requirement
+  requirement: &70092487171640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299368200
+  version_requirements: *70092487171640
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70244299367020 !ruby/object:Gem::Requirement
+  requirement: &70092487171160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299367020
+  version_requirements: *70092487171160
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70244299365100 !ruby/object:Gem::Requirement
+  requirement: &70092487170620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299365100
+  version_requirements: *70092487170620
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70244299385840 !ruby/object:Gem::Requirement
+  requirement: &70092487170080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299385840
+  version_requirements: *70092487170080
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70244299384580 !ruby/object:Gem::Requirement
+  requirement: &70092487169640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244299384580
+  version_requirements: *70092487169640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70244299383080 !ruby/object:Gem::Requirement
+  requirement: &70092487169160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244299383080
+  version_requirements: *70092487169160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70244299380940 !ruby/object:Gem::Requirement
+  requirement: &70092487168720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244299380940
+  version_requirements: *70092487168720
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70244299379800 !ruby/object:Gem::Requirement
+  requirement: &70092487168240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244299379800
+  version_requirements: *70092487168240
 - !ruby/object:Gem::Dependency
   name: slim
-  requirement: &70244299399240 !ruby/object:Gem::Requirement
+  requirement: &70092487167780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244299399240
+  version_requirements: *70092487167780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70244299396840 !ruby/object:Gem::Requirement
+  requirement: &70092487167340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244299396840
+  version_requirements: *70092487167340
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -157,7 +157,6 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - MIT_LICENSE
 - README.md
@@ -170,7 +169,6 @@ files:
 - lib/rails_best_practices/command.rb
 - 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/configs.rb
 - lib/rails_best_practices/core/controllers.rb
 - lib/rails_best_practices/core/error.rb
@@ -182,12 +180,9 @@ files:
 - lib/rails_best_practices/core/model_attributes.rb
 - lib/rails_best_practices/core/models.rb
 - lib/rails_best_practices/core/modules.rb
-- lib/rails_best_practices/core/nil.rb
 - lib/rails_best_practices/core/routes.rb
 - lib/rails_best_practices/core/runner.rb
-- lib/rails_best_practices/core_ext/enumerable.rb
 - lib/rails_best_practices/core_ext/erubis.rb
-- lib/rails_best_practices/core_ext/sexp.rb
 - lib/rails_best_practices/lexicals.rb
 - lib/rails_best_practices/lexicals/long_line_check.rb
 - lib/rails_best_practices/lexicals/remove_tab_check.rb
@@ -243,7 +238,6 @@ files:
 - spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb
 - spec/rails_best_practices/analyzer_spec.rb
 - spec/rails_best_practices/core/check_spec.rb
-- spec/rails_best_practices/core/checking_visitor_spec.rb
 - spec/rails_best_practices/core/configs_spec.rb
 - spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
@@ -255,12 +249,9 @@ files:
 - spec/rails_best_practices/core/model_attributes_spec.rb
 - spec/rails_best_practices/core/models_spec.rb
 - spec/rails_best_practices/core/modules_spec.rb
-- spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/routes_spec.rb
 - spec/rails_best_practices/core/runner_spec.rb
-- spec/rails_best_practices/core_ext/enumerable_spec.rb
 - spec/rails_best_practices/core_ext/erubis_spec.rb
-- spec/rails_best_practices/core_ext/sexp_spec.rb
 - spec/rails_best_practices/lexicals/long_line_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
@@ -325,7 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3797206044319773055
+      hash: 3856057083839728963
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -342,7 +333,6 @@ test_files:
 - spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb
 - spec/rails_best_practices/analyzer_spec.rb
 - spec/rails_best_practices/core/check_spec.rb
-- spec/rails_best_practices/core/checking_visitor_spec.rb
 - spec/rails_best_practices/core/configs_spec.rb
 - spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
@@ -354,12 +344,9 @@ test_files:
 - spec/rails_best_practices/core/model_attributes_spec.rb
 - spec/rails_best_practices/core/models_spec.rb
 - spec/rails_best_practices/core/modules_spec.rb
-- spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/routes_spec.rb
 - spec/rails_best_practices/core/runner_spec.rb
-- spec/rails_best_practices/core_ext/enumerable_spec.rb
 - spec/rails_best_practices/core_ext/erubis_spec.rb
-- spec/rails_best_practices/core_ext/sexp_spec.rb
 - spec/rails_best_practices/lexicals/long_line_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb