rails_best_practices 1.9.0 → 1.9.1

data/.travis.yml

@@ -1 +1,4 @@
-rvm: 1.9.3
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,13 +1,10 @@
 source "http://rubygems.org"
 gemspec
 
-gem "ripper", :platform => :mri_18
-
 if RUBY_PLATFORM =~ /darwin/i
   gem 'rb-fsevent'
   gem 'growl'
 end
 
-gem 'spork', '0.9.0.rc9'
 gem 'guard'
 gem 'guard-rspec'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.9.0)
+    rails_best_practices (1.9.1)
       activesupport
+      awesome_print
       colored
       erubis
       i18n
@@ -12,7 +13,10 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.10)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.0.2)
     colored (1.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
@@ -22,11 +26,11 @@ GEM
     guard-rspec (0.5.7)
       guard (>= 0.8.4)
     haml (3.1.3)
-    i18n (0.5.0)
-    progressbar (0.9.1)
+    i18n (0.6.0)
+    multi_json (1.2.0)
+    progressbar (0.11.0)
     rake (0.9.2.2)
     rb-fsevent (0.4.3.1)
-    ripper (1.0.2)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -35,11 +39,10 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
-    sexp_processor (3.0.5)
+    sexp_processor (3.2.0)
     slim (1.0.4)
       temple (~> 0.3.4)
       tilt (~> 1.3.2)
-    spork (0.9.0.rc9)
     temple (0.3.4)
     thor (0.14.6)
     tilt (1.3.3)
@@ -56,7 +59,5 @@ DEPENDENCIES
   rails_best_practices!
   rake
   rb-fsevent
-  ripper
   rspec
   slim
-  spork (= 0.9.0.rc9)

data/README.md

@@ -63,6 +63,8 @@ Resources
 
 Homepage: <http://rails-bestpractices.com>
 
+Online Service: <http://railsbp.com>
+
 Github: <http://github.com/railsbp/rails_best_practices>
 
 RDoc: <http://rdoc.rails-bestpractices.com>

data/lib/rails_best_practices/analyzer.rb

@@ -3,6 +3,8 @@ require 'fileutils'
 
 require 'progressbar'
 require 'colored'
+require 'ap'
+
 
 module RailsBestPractices
   # RailsBestPractices Analyzer helps you to analyze your rails code, according to best practices on http://rails-bestpractices.
@@ -15,7 +17,7 @@ module RailsBestPractices
   #
   # After analyzing, output the violations.
   class Analyzer
-    attr_accessor :runner
+    attr_accessor :runner, :errors_filter_block
 
     DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "rails_best_practices.yml")
 
@@ -54,23 +56,15 @@ module RailsBestPractices
       @runner.debug = true if @options["debug"]
       @runner.color = !@options["without-color"]
 
-      @bar = ProgressBar.new('Source Codes', parse_files.size * 3) if display_bar?
-      ["lexical", "prepare", "review"].each { |process| send(:process, process) }
-      @bar.finish if display_bar?
-    end
+      analyze_source_codes
+      analyze_vcs
 
-    def display_bar?
-      !@options["debug"] && !@options["silent"]
+      errors_filter_block.call(errors) if errors_filter_block
     end
 
     # Output the analyze result.
     def output
       if @options["format"] == 'html'
-        if @options["with-hg"]
-          load_hg_info
-        elsif @options["with-git"]
-          load_git_info
-        end
         output_html_errors
       else
         output_terminal_errors
@@ -172,19 +166,19 @@ module RailsBestPractices
 
     # output errors on terminal.
     def output_terminal_errors
-      @runner.errors.each { |error| plain_output(error.to_s, 'red') }
+      errors.each { |error| plain_output(error.to_s, 'red') }
       plain_output("\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.", 'green')
-      if @runner.errors.empty?
+      if errors.empty?
         plain_output("\nNo warning found. Cool!", 'green')
       else
-        plain_output("\nFound #{@runner.errors.size} warnings.", 'red')
+        plain_output("\nFound #{errors.size} warnings.", 'red')
       end
     end
 
     # load hg commit and hg username info.
     def load_hg_info
-      hg_progressbar = ProgressBar.new('Hg Info', @runner.errors.size) if display_bar?
-      @runner.errors.each do |error|
+      hg_progressbar = ProgressBar.new('Hg Info', errors.size) if display_bar?
+      errors.each do |error|
         hg_info = `cd #{@runner.class.base_path}; hg blame -lvcu #{error.filename[@runner.class.base_path.size..-1].gsub(/^\//, "")} | sed -n /:#{error.line_number.split(',').first}:/p`
         unless hg_info == ""
           hg_commit_username = hg_info.split(':')[0].strip
@@ -198,9 +192,9 @@ module RailsBestPractices
 
     # load git commit and git username info.
     def load_git_info
-      git_progressbar = ProgressBar.new('Git Info', @runner.errors.size) if display_bar?
+      git_progressbar = ProgressBar.new('Git Info', errors.size) if display_bar?
       start = @runner.class.base_path =~ /\/$/ ? @runner.class.base_path.size : @runner.class.base_path.size + 1
-      @runner.errors.each do |error|
+      errors.each do |error|
         git_info = `cd #{@runner.class.base_path}; git blame -L #{error.line_number.split(',').first},+1 #{error.filename[start..-1]}`
         unless git_info == ""
           git_commit, git_username = git_info.split(/\d{4}-\d{2}-\d{2}/).first.split("(")
@@ -223,7 +217,7 @@ module RailsBestPractices
       File.open(@options["output-file"], "w+") do |file|
         eruby = Erubis::Eruby.new(template)
         file.puts eruby.evaluate(
-          :errors => @runner.errors,
+          :errors => errors,
           :error_types => error_types,
           :textmate => @options["with-textmate"],
           :mvim => @options["with-mvim"],
@@ -248,9 +242,34 @@ module RailsBestPractices
       end
     end
 
+    # analyze source codes.
+    def analyze_source_codes
+      @bar = ProgressBar.new('Source Codes', parse_files.size * 3) if display_bar?
+      ["lexical", "prepare", "review"].each { |process| send(:process, process) }
+      @bar.finish if display_bar?
+    end
+
+    # analyze version control system info.
+    def analyze_vcs
+      if @options["format"] == 'html'
+        load_git_info if @options["with-git"]
+        load_hg_info if @options["with-hg"]
+      end
+    end
+
+    # if disaply progress bar.
+    def display_bar?
+      !@options["debug"] && !@options["silent"]
+    end
+
     # unique error types.
     def error_types
-      @runner.errors.map(&:type).uniq
+      errors.map(&:type).uniq
+    end
+
+    # delegate errors to runner
+    def errors
+      @runner.errors
     end
   end
 end

data/lib/rails_best_practices/core.rb

@@ -14,6 +14,7 @@ require 'rails_best_practices/core/methods'
 require 'rails_best_practices/core/controllers'
 require 'rails_best_practices/core/helpers'
 require 'rails_best_practices/core/routes'
+require 'rails_best_practices/core/configs'
 
 require 'rails_best_practices/core_ext/sexp'
 require 'rails_best_practices/core_ext/enumerable'

data/lib/rails_best_practices/core/check.rb

@@ -14,6 +14,7 @@ module RailsBestPractices
       SCHEMA_FILE = /db\/schema\.rb/
       HELPER_FILES = /helpers\/.*\.rb$/
       DEPLOY_FILES = /config\/deploy.*\.rb/
+      CONFIG_FILES = /config\/(application|environment|environments\/.*)\.rb/
 
       def initialize(options={})
         options.each do |key, value|
@@ -47,6 +48,9 @@ module RailsBestPractices
       # @param [Sexp] node
       def node_start(node)
         @node = node
+        if self.class.debug?
+          ap node
+        end
         Array(self.class.callbacks["start_#{node.sexp_type}"]).each do |callback|
           self.instance_exec node, &callback
         end
@@ -141,6 +145,14 @@ module RailsBestPractices
           callbacks[name] ||= []
           callbacks[name] << block
         end
+
+        def debug?
+          @debug == true
+        end
+
+        def debug
+          @debug = true
+        end
       end
 
       # Helper to parse the class name.

data/lib/rails_best_practices/core/configs.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Configs < Hash
+    end
+  end
+end

data/lib/rails_best_practices/core/error.rb

@@ -6,7 +6,7 @@ module RailsBestPractices
     # it indicates the filenname, line number and error message for the violation.
     class Error
       attr_reader :filename, :line_number, :message, :type, :url
-      attr_accessor :git_commit, :git_username, :hg_commit, :hg_username
+      attr_accessor :git_commit, :git_username, :hg_commit, :hg_username, :highlight
 
       def initialize(options={})
         @filename = options[:filename]
@@ -18,6 +18,7 @@ module RailsBestPractices
         @git_username = options[:git_username]
         @hg_commit = options[:hg_commit]
         @hg_username = options[:hg_username]
+        @highlight = false
       end
 
       def short_filename

data/lib/rails_best_practices/core/routes.rb

@@ -8,7 +8,7 @@ module RailsBestPractices
       # @param [String] controller name
       # @param [String] action name
       def add_route(namespaces, controller_name, action_name)
-        if controller_name.present?
+        if namespaces.present? || controller_name.present?
           self << Route.new(namespaces, controller_name, action_name)
         end
       end
@@ -19,14 +19,20 @@ module RailsBestPractices
 
       def initialize(namespaces, controller_name, action_name)
         @namespaces = namespaces
-        entities = controller_name.split('/')
-        @namespaces += entities[0..-2] if entities.size > 1
-        @controller_name = entities.last
+        if controller_name
+          entities = controller_name.split('/')
+          @namespaces += entities[0..-2] if entities.size > 1
+          @controller_name = entities.last
+        end
         @action_name = action_name
       end
 
       def controller_name_with_namespaces
-        namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + "#{controller_name.camelize}Controller"
+        if controller_name
+          namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + "#{controller_name.camelize}Controller"
+        else
+          namespaces.map { |namespace| namespace.camelize }.join("::") + "Controller"
+        end
       end
 
       def to_s

data/lib/rails_best_practices/core/runner.rb

@@ -3,7 +3,11 @@ require 'yaml'
 require 'ripper'
 require 'active_support/inflector'
 require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/try'
+begin
+  require 'active_support/core_ext/object/try'
+rescue LoadError
+  require 'active_support/core_ext/try'
+end
 
 module RailsBestPractices
   module Core
@@ -113,7 +117,7 @@ module RailsBestPractices
       #
       # @return [Array] all errors from lexicals and reviews
       def errors
-        (@reviews + @lexicals).collect {|check| check.errors}.flatten
+        @errors ||= (@reviews + @lexicals).collect {|check| check.errors}.flatten
       end
 
       def after_lexical; end

data/lib/rails_best_practices/core_ext/sexp.rb

@@ -503,7 +503,7 @@ class Sexp
   def statements
     stmts = []
     node = case sexp_type
-           when :do_block
+           when :do_block, :brace_block
              self[2]
            when :bodystmt
              self[1]
@@ -788,6 +788,8 @@ class Sexp
       self[1].to_s[0..-2]
     when :aref
       "#{self[1]}[#{self[2]}]"
+    when :call, :field
+      "#{self.subject}.#{self.message}"
     else
       ""
     end

data/lib/rails_best_practices/prepares.rb

@@ -5,6 +5,7 @@ require 'rails_best_practices/prepares/schema_prepare'
 require 'rails_best_practices/prepares/controller_prepare'
 require 'rails_best_practices/prepares/route_prepare'
 require 'rails_best_practices/prepares/helper_prepare'
+require 'rails_best_practices/prepares/config_prepare'
 
 module RailsBestPractices
   module Prepares
@@ -53,6 +54,10 @@ module RailsBestPractices
         @routes ||= Core::Routes.new
       end
 
+      def configs
+        @configs ||= Core::Configs.new
+      end
+
       # Clear all prepare objects.
       def clear
         instance_variables.each do |instance_variable|

data/lib/rails_best_practices/prepares/config_prepare.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Prepares
+    class ConfigPrepare < Core::Check
+      interesting_nodes :assign
+      interesting_files CONFIG_FILES
+
+      def initialize
+        @configs = Prepares.configs
+      end
+
+      def start_assign(node)
+        if node.left_value.grep_node(:sexp_type => [:vcall, :var_ref], :to_s => "config").present?
+          @configs[node.left_value.to_s] = node.right_value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
   module Prepares
     # Remembber routes.
     class RoutePrepare < Core::Check
-      interesting_nodes :command, :command_call, :method_add_block, :do_block
+      interesting_nodes :command, :command_call, :method_add_block, :do_block, :brace_block
       interesting_files ROUTE_FILES
 
       RESOURCES_ACTIONS = %w(index show new create edit update destroy)
@@ -29,23 +29,37 @@ module RailsBestPractices
           second_argument = node.arguments.all[1]
           if @controller_names.last
             if :bare_assoc_hash == first_argument.sexp_type
-              action_name = first_argument.hash_values.first.to_s
+              action_names = [first_argument.hash_values.first.to_s]
+            elsif :array == first_argument.sexp_type
+              action_names = first_argument.array_values.map(&:to_s)
             else
-              action_name = first_argument.to_s
+              action_names = [first_argument.to_s]
+            end
+            action_names.each do |action_name|
+              @routes.add_route(current_namespaces, current_controller_name, action_name)
             end
-            @routes.add_route(current_namespaces, current_controller_name, action_name)
           else
             if :bare_assoc_hash == first_argument.sexp_type
               route_node = first_argument.hash_values.first
               # do not parse redirect block
               return if :method_add_arg == route_node.sexp_type
               controller_name, action_name = route_node.to_s.split('#')
-            elsif :bare_assoc_hash == second_argument.try(:sexp_type) && second_argument.hash_value("to")
-              controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
+            elsif :array == first_argument.sexp_type
+              first_argument.array_values.map(&:to_s).each do |action_node|
+                @routes.add_route(current_namespaces, controller_name, action_node.to_s)
+              end
+              return
+            elsif :bare_assoc_hash == second_argument.try(:sexp_type)
+              if second_argument.hash_value("to").present?
+                controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
+              else
+                controller_name = current_controller_name
+                action_name = second_argument.hash_value("action")
+              end
             else
               controller_name, action_name = first_argument.to_s.split('/')
             end
-            @routes.add_route(current_namespaces, controller_name.underscore, action_name)
+            @routes.add_route(current_namespaces, controller_name.try(:underscore), action_name)
           end
         when "match", "root"
           options = node.arguments.all.last
@@ -143,6 +157,9 @@ module RailsBestPractices
         @controller_names.pop
       end
 
+      alias_method :start_brace_block, :start_do_block
+      alias_method :end_brace_block, :end_do_block
+
       [:resources, :resource].each do |route_name|
         class_eval <<-EOF
         def add_#{route_name}_routes(node)