rails_best_practices 1.15.7 → 1.16.0

data/README.md

@@ -7,22 +7,22 @@
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 [![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](https://pledgie.com/campaigns/12057.png?skin_name=chrome)](https://pledgie.com/campaigns/12057)
 
-rails_best_practices is a code metric tool to check the quality of rails code.
+rails_best_practices is a code metric tool to check the quality of Rails code.
 
-it supports following ORM/ODMs:
+It supports the following ORM/ODMs:
 
 * activerecord
 * mongoid
 * mongomapper
 
-following template engines:
+And the following template engines:
 
 * erb
 * haml
 * slim
 * rabl
 
-rails_best_practices works well only in ruby 1.9.3, 2.0.0, and 2.1.0 so far.  It is incompatible with ruby 1.8.
+rails_best_practices supports Ruby 1.9.3 or newer.
 
 ## External Introduction
 
@@ -32,29 +32,29 @@ rails_best_practices works well only in ruby 1.9.3, 2.0.0, and 2.1.0 so far.  It
 
 ## Usage
 
-At the root directory of rails app
+At the root directory of a Rails app, run:
 
     rails_best_practices .
 
-or html output
+Or for HTML output:
 
     rails_best_practices -f html .
 
-By default rails_best_practices will do parse codes in vendor, spec, test and features directories.
+By default rails_best_practices will parse code in the `vendor`, `spec`, `test` and `features` directories.
 
-### Excluding folders
+### Excluding directories
 
-To exclude folder simply call it with -e or --exclude
+To exclude a directory simply call it with `-e` or `--exclude`:
 
     rails_best_practices -e "db/migrate" .
 
-To exclude multiple folders, separate them with comma
+To exclude multiple directories, separate them with comma:
 
     rails_best_practices -e "db/migrate,vendor" .
 
-### Other command line options
+### Other command-line options
 
-To see full list of commandline options call:
+To see the full list of command-line options, run:
 
     $ rails_best_practices -h
 
@@ -89,7 +89,7 @@ Homepage: <http://rails-bestpractices.com>
 
 Online Service: <http://railsbp.com>
 
-Github: <http://github.com/railsbp/rails_best_practices>
+GitHub: <http://github.com/railsbp/rails_best_practices>
 
 RDoc: <http://rdoc.rails-bestpractices.com>
 
@@ -103,11 +103,9 @@ Issue Tracker: <http://github.com/railsbp/rails_best_practices/issues>
 
 ## Install
 
-rails_best_practices gem is rewritten based on ripper instead of ruby_parser to support ruby 1.9 new syntax.
-
     gem install rails_best_practices
 
-or add in Gemfile
+or add it to the Gemfile
 
     gem "rails_best_practices"
 
@@ -115,27 +113,27 @@ or add in Gemfile
 
 Install <https://github.com/asuth/subl-handler>
 
-## Issue
+## Issues
 
-If you install the rails_best_practices with bundler-installed github-sourced gem, please use the following command instead.
+If you install the rails_best_practices with bundler-installed GitHub-sourced gem, please use the following command instead.
 
     bundle exec rails_best_practices .
 
-If you got NoMethodError or any syntax error, you should use debug mode to detect which file rails_best_practices is parsing and getting the error.
+If you encounter a NoMethodError exception, or a syntax error, you can use debug mode to discover which file is to blame:
 
     rails_best_practices -d .
 
-Then give me the error stack and the source code of the file that rails_best_practices is parsing error.
+That will provide the error's stack trace and the source code of the file which is causing the error.
 
-## Customize Configuration
+## Custom Configuration
 
-First run
+First run:
 
     rails_best_practices -g
 
 to generate `rails_best_practices.yml` file.
 
-Now you can customize this configuration file, the default configuration is as follows:
+Now you can customize this configuration file. The default configuration is as follows:
 
     AddModelVirtualAttributeCheck: { }
     AlwaysAddDbIndexCheck: { }
@@ -179,7 +177,7 @@ Now you can customize this configuration file, the default configuration is as f
     UseScopeAccessCheck: { }
     UseTurboSprocketsRails3Check: { }
 
-You can remove or comment one review to disable it, and you can change the options.
+You can remove or comment a review to disable it, and you can change the options.
 
 You can apply the `ignored_files` option on any rule by giving a regexp or array of regexps describing the path of the files you don't want to be checked:
 
@@ -208,7 +206,7 @@ RESTful Conventions
 Model
 
 1. Keep finders on their own model (rails2 only)
-2. the law of demeter
+2. The law of demeter
 3. Use observer
 4. Use query attribute
 5. Remove unused methods in models
@@ -221,12 +219,12 @@ Mailer
 Migration
 
 1. Isolating seed data
-2. Always add db index
+2. Always add database index
 3. Use say with time in migrations
 
 Controller
 
-1. Use before_filter (disabled by default)
+1. Use `before_filter` (disabled by default)
 2. Simplify render in controllers
 3. Remove unused methods in controllers
 
@@ -246,21 +244,21 @@ View
 
 Deployment
 
-1. Dry bundler in capistrano
-2. Speed up assets precompile with turbo-sprockets-rails3
+1. Dry bundler in Capistrano
+2. Speed up assets precompilation with turbo-sprockets-rails3
 
 Other
 
 1. Remove trailing whitespace
 2. Remove tab (disabled by default)
 3. Hash syntax (disabled by default)
-4. Use parentheses in method def (disabled by default)
+4. Use parentheses in method definition (disabled by default)
 5. Long line (disabled by default)
 6. Not rescue exception
 
-## Write Your Own Check List
+## Write Your Own Checklist
 
-If you want to write your own check list (some check list only for your rails projects), please read this first, [How to write your own check list?][1]
+If you want to write your own checklist (some checklist only for your Rails projects), please read this first, [How to write your own check list?][1]
 
 ## Contribute
 
@@ -268,7 +266,7 @@ If you want to add your rails best practices into the gem, please post your best
 
 ## Contact Us
 
-We provide rails consulting services, you can contact us by twitter or email.
+We provide Rails consulting services, you can contact us by Twitter or email.
 
 Follow us on twitter: <http://twitter.com/railsbp>
 

data/Rakefile

@@ -6,6 +6,7 @@ Bundler.setup
 require "rake"
 require "rspec"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "rails_best_practices/version"
@@ -14,5 +15,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
-task :default => :spec
+RuboCop::RakeTask.new
+
+task :default => [:spec, :rubocop]
 task :test => :spec

data/lib/rails_best_practices.rb

@@ -2,6 +2,7 @@
 require 'code_analyzer'
 require 'require_all'
 require 'rails_best_practices/core'
+require 'rails_best_practices/colorize'
 require 'rails_best_practices/analyzer'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'

data/lib/rails_best_practices/analyzer.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'colored'
 require 'fileutils'
 require 'json'
 require 'ruby-progressbar'
@@ -308,13 +307,13 @@ module RailsBestPractices
       if @options["without-color"]
         puts message
       else
-        puts message.send(color)
+        puts Colorize.send(color, message)
       end
     end
 
     # analyze source codes.
     def analyze_source_codes
-      @bar = ProgressBar.create(:title => 'Source Codes', :total => parse_files.size * 3) if display_bar?
+      @bar = ProgressBar.create(:title => 'Source Code', :total => parse_files.size * 3) if display_bar?
       ["lexical", "prepare", "review"].each { |process| send(:process, process) }
       @bar.finish if display_bar?
     end

data/lib/rails_best_practices/colorize.rb

@@ -0,0 +1,11 @@
+module RailsBestPractices
+  class Colorize
+    def self.red(message)
+      "\e[31m#{message}\e[0m"
+    end
+
+    def self.green(message)
+      "\e[32m#{message}\e[0m"
+    end
+  end
+end

data/lib/rails_best_practices/core/modules.rb

@@ -3,28 +3,28 @@ module RailsBestPractices
   module Core
     # Module container
     class Modules < Array
-      # add module decendant.
+      # add module descendant.
       #
       # @param [String] module name
-      # @param [String] decendant name
-      def add_module_decendant(module_name, decendant)
+      # @param [String] descendant name
+      def add_module_descendant(module_name, descendant)
         mod = find { |mod| mod.to_s == module_name }
-        mod.add_decendant(decendant) if mod
+        mod.add_descendant(descendant) if mod
       end
     end
 
     # Module info include module name and module spaces.
     class Mod
-      attr_reader :decendants
+      attr_reader :descendants
 
       def initialize(module_name, modules)
         @module_name = module_name
         @modules = modules
-        @decendants = []
+        @descendants = []
       end
 
-      def add_decendant(decendant)
-        @decendants << decendant
+      def add_descendant(descendant)
+        @descendants << descendant
       end
 
       def to_s

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -54,7 +54,7 @@ module RailsBestPractices
       # restrict actions for inherited_resources
       add_callback :start_command do |node|
         if "include" == node.message.to_s
-          @helpers.add_module_decendant(node.arguments.all.first.to_s, current_class_name)
+          @helpers.add_module_descendant(node.arguments.all.first.to_s, current_class_name)
         elsif @inherited_resources && "actions" ==  node.message.to_s
           if "all" == node.arguments.all.first.to_s
             @actions = DEFAULT_ACTIONS
@@ -87,9 +87,9 @@ module RailsBestPractices
 
       # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.
       add_callback :after_check do
-        decendants = @helpers.map(&:decendants).flatten
-        if decendants.present?
-          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *decendants.map { |decendant| %r|#{decendant.underscore}| }
+        descendants = @helpers.map(&:descendants).flatten
+        if descendants.present?
+          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *descendants.map { |descendant| %r|#{descendant.underscore}| }
         end
       end
     end

data/lib/rails_best_practices/reviews/check_destroy_return_value_review.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Reviews
+    # Review all code to make sure we either check the return value of "destroy"
+    # or use "destroy!"
+    #
+    # Review process:
+    #   Track which nodes are used by 'if', 'unless', '&&' nodes etc. as we pass them by.
+    #   Check all "save" calls to check the return value is used by a node we have visited.
+    class CheckDestroyReturnValueReview < Review
+      include Classable
+      interesting_nodes :call, :command_call, :method_add_arg, :if, :ifop, :elsif, :unless, :if_mod, :unless_mod, :assign, :binary
+      interesting_files ALL_FILES
+
+      add_callback :start_if, :start_ifop, :start_elsif, :start_unless, :start_if_mod, :start_unless_mod do |node|
+        @used_return_value_of = node.conditional_statement.all_conditions
+      end
+
+      add_callback :start_assign do |node|
+        @used_return_value_of = node.right_value
+      end
+
+      add_callback :start_binary do |node|
+        # Consider anything used in an expression like "A or B" as used
+        if %w(&& || and or).include?(node[2].to_s)
+          all_conditions = node.all_conditions
+          # if our current binary is a subset of the @used_return_value_of
+          # then don't overwrite it
+          already_included = @used_return_value_of &&
+            (all_conditions - @used_return_value_of).empty?
+
+          @used_return_value_of = node.all_conditions unless already_included
+        end
+      end
+
+      def return_value_is_used? node
+        return false unless @used_return_value_of
+        node == @used_return_value_of or @used_return_value_of.include?(node)
+      end
+
+      def model_classnames
+        @model_classnames ||= models.map(&:to_s)
+      end
+
+      add_callback :start_call, :start_command_call, :start_method_add_arg do |node|
+        unless @already_checked == node
+          message = node.message.to_s
+          if message.eql? 'destroy'
+            unless return_value_is_used? node
+              add_error "check '#{message}' return value or use '#{message}!'"
+            end
+          end
+          if node.sexp_type == :method_add_arg
+            @already_checked = node[1]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/check_save_return_value_review.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 module RailsBestPractices
   module Reviews
-    # Review all code to make sure we either check the return value of "save"
-    # or use "save!"
+    # Review all code to make sure we either check the return value of "save", "update_attributes"
+    # and "create" or use "save!", "update_attributes!", or "create!", respectively.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/
     #
@@ -57,7 +57,7 @@ module RailsBestPractices
           elsif message == 'create'
             # We're only interested in 'create' calls on model classes:
             possible_receiver_classes = [node.receiver.to_s] + classable_modules.map do |mod|
-                "#{mod}::#{node.receiver.to_s}"
+                "#{mod}::#{node.receiver}"
               end
             unless (possible_receiver_classes & model_classnames).empty?
               add_error "use 'create!' instead of 'create' as the latter may not always save"

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -7,19 +7,19 @@ module RailsBestPractices
     #
     # Review process:
     #   remember all method calls in helpers.
-    #   if they are not called in views or helpers,
+    #   if they are not called in views, helpers, or controllers
     #   then they are unused methods in helpers.
     class RemoveUnusedMethodsInHelpersReview < Review
       include Moduleable
       include Callable
       include Exceptable
 
-      interesting_files HELPER_FILES, VIEW_FILES
+      interesting_files HELPER_FILES, VIEW_FILES, CONTROLLER_FILES
 
       def initialize(options={})
         super
         @helper_methods = Prepares.helper_methods
-        self.class.interesting_files Prepares.helpers.map(&:decendants)
+        self.class.interesting_files Prepares.helpers.map(&:descendants)
       end
 
       # get all unused methods at the end of review process

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -45,6 +45,7 @@ module RailsBestPractices
         # @param [String] name method name in action_mailer
         def rails2_canonical_mailer_views?(name)
           return true if mailer_files(name).length == 0
+          return true if mailer_files(name).none? { |filename| filename.index 'text.html' }
           mailer_files(name).any? { |filename| filename.index 'text.html' } &&
             mailer_files(name).any? { |filename| filename.index 'text.plain' }
         end
@@ -54,6 +55,7 @@ module RailsBestPractices
         # @param [String] name method name in action_mailer
         def rails3_canonical_mailer_views?(name)
           return true if mailer_files(name).length == 0
+          return true if mailer_files(name).none? { |filename| filename.index 'html' }
           mailer_files(name).any? { |filename| filename.index 'html' } &&
             mailer_files(name).any? { |filename| filename.index 'text' }
         end

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency("activesupport")
   s.add_dependency("code_analyzer", ">= 0.4.3")
-  s.add_dependency("colored")
   s.add_dependency("erubis")
   s.add_dependency("i18n")
   s.add_dependency("require_all")
@@ -30,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("slim")
   s.add_development_dependency("bundler")
   s.add_development_dependency("awesome_print")
+  s.add_development_dependency("rubocop", "= 0.30.1")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")