rails_best_practices 1.5.3 → 1.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.5.3)
+    rails_best_practices (1.6.0)
       activesupport
       colored
       erubis

data/README.md

@@ -22,22 +22,24 @@ By default rails_best_practices will do parse codes in vendor, spec, test and fe
 
     $ rails_best_practices -h
     Usage: rails_best_practices [options]
-        -d, --debug                      Debug mode
+        -d, --debug                      debug mode
+            --silent                     silent mode
         -f, --format FORMAT              output format
             --without-color              only output plain text without color
             --with-textmate              open file by textmate in html format
             --with-mvim                  open file by mvim in html format
+            --with-github                open file on github in html format
             --with-git                   display git commit and git username in html format
             --with-hg                    display hg commit and hg username in html format
             --vendor                     include vendor files
             --spec                       include spec files
             --test                       include test files
             --features                   include features files
-        -x, --exclude PATTERNS           Don't analyze files matching a pattern
+        -x, --exclude PATTERNS           don't analyze files matching a pattern
                                          (comma-separated regexp list)
-        -g, --generate                   Generate configuration yaml
-        -v, --version                    Show this version
-        -h, --help                       Show this message
+        -g, --generate                   generate configuration yaml
+        -v, --version                    show this version
+        -h, --help                       show this message
 
 Resources
 ---------
@@ -112,7 +114,7 @@ Now you can customize this configuration file, the default configuration is as f
     UseObserverCheck: { }
     IsolateSeedDataCheck: { }
     AlwaysAddDbIndexCheck: { }
-    UseBeforeFilterCheck: { customize_count: 1 }
+    UseBeforeFilterCheck: { customize_count: 2 }
     MoveCodeIntoControllerCheck: { }
     MoveCodeIntoModelCheck: { use_count: 2 }
     MoveCodeIntoHelperCheck: { array_count: 3 }
@@ -129,6 +131,7 @@ Now you can customize this configuration file, the default configuration is as f
     RestrictAutoGeneratedRoutesCheck: { }
     RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
     RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
+    RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -173,11 +176,12 @@ Controller
 
 1. Use before_filter
 2. Simplify render in controllers
-3. Remove unused methods In controllers
+3. Remove unused methods in controllers
 
 Helper
 
 1. Remove empty helpers
+2. Remove unused methods in helpers
 
 View
 

data/assets/result.html.erb

@@ -84,12 +84,14 @@
       <% @errors.each do |error| %>
         <tr class="<%= error.type.split(':').last %>">
           <td class='filename'>
-            <% if @textmate %>
-              <a href='txmt://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.filename %></a>
+            <% if @github %>
+              <a href='https://github.com/<%= @github_name %>/blob/<%= @last_commit_id %>/<%= error.short_filename %>#L<%= error.first_line_number %>' target='_blank'><%= error.short_filename %></a>
+            <% elsif @textmate %>
+              <a href='txmt://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
             <% elsif @mvim %>
-              <a href='mvim://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.filename %></a>
+              <a href='mvim://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
             <% else %>
-              <%= error.filename %>
+              <%= error.short_filename %>
             <% end %>
           </td>
           <td class='line'><%= error.line_number %></td>

data/lib/rails_best_practices/analyzer.rb

@@ -45,22 +45,26 @@ module RailsBestPractices
     # @param [String] path the directory of rails project
     # @param [Hash] options
     def analyze
-      @options[:exclude] ||= []
+      @options["exclude"] ||= []
+      @options["output-file"] ||= "rails_best_practices_output.html"
 
       Core::Runner.base_path = @path
       @runner = Core::Runner.new
-      @runner.debug = true if @options['debug']
-      @runner.color = !@options['without-color']
+      @runner.debug = true if @options["debug"]
+      @runner.color = !@options["without-color"]
 
-      @bar = ProgressBar.new('Source Codes', parse_files.size * 3)
+      @bar = ProgressBar.new('Source Codes', parse_files.size * 3) if display_bar?
       ["lexical", "prepare", "review"].each { |process| send(:process, process) }
-      @runner.on_complete
-      @bar.finish
+      @bar.finish if display_bar?
+    end
+
+    def display_bar?
+      !@options["debug"] && !@options["silent"]
     end
 
     # Output the analyze result.
     def output
-      if @options['format'] == 'html'
+      if @options["format"] == 'html'
         if @options["with-hg"]
           load_hg_info
         elsif @options["with-git"]
@@ -81,8 +85,9 @@ module RailsBestPractices
     def process(process)
       parse_files.each do |file|
         @runner.send("#{process}_file", file)
-        @bar.inc unless @options['debug']
+        @bar.inc if display_bar?
       end
+      @runner.send("after_#{process}")
     end
 
     # get all files for parsing.
@@ -94,12 +99,12 @@ module RailsBestPractices
         files = file_sort(files)
 
         # By default, tmp, vender, spec, test, features are ignored.
-        ['vendor', 'spec', 'test', 'features', 'tmp'].each do |pattern|
+        ["vendor", "spec", "test", "features", "tmp"].each do |pattern|
           files = file_ignore(files, "#{pattern}/") unless @options[pattern]
         end
 
         # Exclude files based on exclude regexes if the option is set.
-        @options[:exclude].each do |pattern|
+        @options["exclude"].each do |pattern|
           files = file_ignore(files, pattern)
         end
 
@@ -125,37 +130,22 @@ module RailsBestPractices
     end
 
 
-    # sort files, models first, then mailers, and sort other files by characters.
+    # sort files, models first, mailers, helpers, and then sort other files by characters.
     #
     # models and mailers first as for prepare process.
     #
     # @param [Array] files
     # @return [Array] sorted files
     def file_sort files
-      models = []
-      mailers = []
-      files.each do |a|
-        if a =~ Core::Check::MODEL_FILES
-          models << a
-        end
-      end
-      files.each do |a|
-        if a =~ Core::Check::MAILER_FILES
-          mailers << a
-        end
-      end
-      files.collect! do |a|
-        if a =~ Core::Check::MAILER_FILES || a =~ Core::Check::MODEL_FILES
-          #nil
-        else
-          a
-        end
-      end
-      files.compact!
+      models = files.find_all { |file| file =~ Core::Check::MODEL_FILES }
+      mailers = files.find_all { |file| file =~ Core::Check::MAILER_FILES }
+      helpers = files.find_all { |file| file =~ Core::Check::HELPER_FILES }
+      others = files.find_all { |file| file !~ Core::Check::MAILER_FILES && file !~ Core::Check::MODEL_FILES && file !~ Core::Check::HELPER_FILES }
       models.sort
       mailers.sort
-      files.sort
-      return models + mailers + files
+      helpers.sort
+      others.sort
+      return models + mailers + helpers + others
     end
 
     # ignore specific files.
@@ -180,7 +170,7 @@ module RailsBestPractices
 
     # load hg commit and hg username info.
     def load_hg_info
-      hg_progressbar = ProgressBar.new('Hg Info', @runner.errors.size)
+      hg_progressbar = ProgressBar.new('Hg Info', @runner.errors.size) if display_bar?
       @runner.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 == ""
@@ -188,14 +178,14 @@ module RailsBestPractices
           error.hg_username = hg_commit_username.split(/\ /)[0..-2].join(' ')
           error.hg_commit = hg_commit_username.split(/\ /)[-1]
         end
-        hg_progressbar.inc unless @options['debug']
+        hg_progressbar.inc if display_bar?
       end
-      hg_progressbar.finish
+      hg_progressbar.finish if display_bar?
     end
 
     # load git commit and git username info.
     def load_git_info
-      git_progressbar = ProgressBar.new('Git Info', @runner.errors.size)
+      git_progressbar = ProgressBar.new('Git Info', @runner.errors.size) if display_bar?
       @runner.errors.each do |error|
         git_info = `cd #{@runner.class.base_path}; git blame #{error.filename[@runner.class.base_path.size..-1]} | sed -n #{error.line_number.split(',').first}p`
         unless git_info == ""
@@ -203,19 +193,32 @@ module RailsBestPractices
           error.git_commit = git_commit.split(" ").first.strip
           error.git_username = git_username.strip
         end
-        git_progressbar.inc unless @options['debug']
+        git_progressbar.inc if display_bar?
       end
-      git_progressbar.finish
+      git_progressbar.finish if display_bar?
     end
 
     # output errors with html format.
     def output_html_errors
       require 'erubis'
-      template = File.read(File.join(File.dirname(__FILE__), "..", "..", "assets", "result.html.erb"))
+      template = @options["template"] ? File.read(File.expand_path(@options["template"])) : File.read(File.join(File.dirname(__FILE__), "..", "..", "assets", "result.html.erb"))
 
-      File.open("rails_best_practices_output.html", "w+") do |file|
+      if @options["with-github"]
+        last_commit_id = @options["last-commit-id"] ? @options["last-commit-id"] : `cd #{@runner.class.base_path}; git rev-parse HEAD`.chomp
+      end
+      File.open(@options["output-file"], "w+") do |file|
         eruby = Erubis::Eruby.new(template)
-        file.puts eruby.evaluate(:errors => @runner.errors, :error_types => error_types, :textmate => @options["with-textmate"], :mvim => @options["with-mvim"], :git => @options["with-git"], :hg => @options["with-hg"])
+        file.puts eruby.evaluate(
+          :errors => @runner.errors,
+          :error_types => error_types,
+          :textmate => @options["with-textmate"],
+          :mvim => @options["with-mvim"],
+          :github => @options["with-github"],
+          :github_name => @options["github-name"],
+          :last_commit_id => last_commit_id,
+          :git => @options["with-git"],
+          :hg => @options["with-hg"]
+        )
       end
     end
 

data/lib/rails_best_practices/command.rb

@@ -2,20 +2,26 @@
 require 'optparse'
 
 # Usage: rails_best_practices [options] path
-#    -d, --debug                      Debug mode
+#    -d, --debug                      debug mode
+#        --silent                     silent mode
 #    -f, --format FORMAT              output format
+#        --output-file FILE           output html file for the analyzing result
 #        --without-color              only output plain text without color
 #        --with-textmate              open file by textmate in html format
 #        --with-mvim                  open file by mvim in html format
+#        --with-github GITHUB_NAME    open file on github in html format, GITHUB_NAME is like flyerhzm/rails-bestpractices.com
+#        --with-git                   display git commit and username, only support html format
+#        --with-hg                    display hg commit and username, only support html format
+#        --template TEMPLATE          customize erb template
 #        --vendor                     include vendor files
 #        --spec                       include spec files
 #        --test                       include test files
 #        --features                   include features files
-#    -x, --exclude PATTERNS           Don't analyze files matching a pattern
+#    -x, --exclude PATTERNS           don't analyze files matching a pattern
 #                                     (comma-separated regexp list)
-#    -g, --generate                   Generate configuration yaml
-#    -v, --version                    Show this version
-#    -h, --help                       Show this message
+#    -g, --generate                   generate configuration yaml
+#    -v, --version                    show this version
+#    -h, --help                       show this message
 options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: rails_best_practices [options] path"
@@ -40,6 +46,15 @@ OptionParser.new do |opts|
     options["with-mvim"] = true
   end
 
+  opts.on("--with-github GITHUB_NAME", "open file on github in html format") do |github_name|
+    options["with-github"] = true
+    options["github-name"] = github_name
+  end
+
+  opts.on("--last-commit-id COMMIT_ID", "last commit id") do |commit_id|
+    options["last-commit-id"] = commit_id
+  end
+
   opts.on("--with-hg", "display hg commit and username, only support html format") do
     options["with-hg"] = true
   end
@@ -48,7 +63,19 @@ OptionParser.new do |opts|
     options["with-git"] = true
   end
 
-  ['vendor', 'spec', 'test', 'features'].each do |pattern|
+  opts.on("--template TEMPLATE", "customize erb template") do |template|
+    options["template"] = template
+  end
+
+  opts.on("--output-file OUTPUT_FILE", "output html file for the analyzing result") do |output_file|
+    options["output-file"] = output_file
+  end
+
+  opts.on("--silent", "silent mode") do
+    options["silent"] = true
+  end
+
+  ["vendor", "spec", "test", "features"].each do |pattern|
     opts.on("--#{pattern}", "include #{pattern} files") do
       options[pattern] = true
     end
@@ -67,20 +94,20 @@ OptionParser.new do |opts|
 
   opts.on("-x", "--exclude PATTERNS", "Don't analyze files matching a pattern", "(comma-separated regexp list)") do |list|
     begin
-      options[:exclude] = list.split(/,/).map{|x| Regexp.new x}
+      options["exclude"] = list.split(/,/).map{|x| Regexp.new x}
     rescue RegexpError => e
       raise OptionParser::InvalidArgument, e.message
     end
   end
 
   opts.on("-g", "--generate", "Generate configuration yaml") do
-    options[:generate] = true
+    options["generate"] = true
   end
 
   opts.parse!
 end
 
-if options[:generate]
+if options["generate"]
   RailsBestPractices::Analyzer.new(ARGV.first).generate
 else
   analyzer = RailsBestPractices::Analyzer.new(ARGV.first, options)

data/lib/rails_best_practices/core.rb

@@ -5,12 +5,14 @@ require 'rails_best_practices/core/checking_visitor'
 require 'rails_best_practices/core/error'
 require 'rails_best_practices/core/nil'
 require 'rails_best_practices/core/klasses'
+require 'rails_best_practices/core/modules'
 require 'rails_best_practices/core/models'
 require 'rails_best_practices/core/model_associations'
 require 'rails_best_practices/core/model_attributes'
 require 'rails_best_practices/core/mailers'
 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_ext/sexp'

data/lib/rails_best_practices/core/check.rb

@@ -8,8 +8,8 @@ module RailsBestPractices
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
       MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
-      VIEW_FILES = /(views|cells)\/.*\.(erb|haml)$/
-      PARTIAL_VIEW_FILES = /(views|cells)\/.*\/_.*\.(erb|haml)$/
+      VIEW_FILES = /(views|cells)\/.*\.(erb|haml|builder)$/
+      PARTIAL_VIEW_FILES = /(views|cells)\/.*\/_.*\.(erb|haml|builder)$/
       ROUTE_FILES = /config\/routes.*\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
       HELPER_FILES = /helpers\/.*\.rb$/
@@ -67,6 +67,9 @@ module RailsBestPractices
         end
       end
 
+      def after_prepare; end
+      def after_review; end
+
       # add error if source code violates rails best practice.
       #
       # @param [String] message, is the string message for violation of the rails best practice
@@ -135,24 +138,24 @@ module RailsBestPractices
       end
 
       # Helper to parse the class name.
-      module Klassable
+      module Classable
         def self.included(base)
           base.class_eval do
             interesting_nodes :module, :class
 
             # remember module name
             add_callback "start_module" do |node|
-              modules << node.module_name.to_s
+              classable_modules << node.module_name.to_s
             end
 
             # end of the module.
             add_callback "end_module" do |node|
-              modules.pop
+              classable_modules.pop
             end
 
             # remember the class anem
             add_callback "start_class" do |node|
-              @klass = Core::Klass.new(node.class_name.to_s, node.base_class.to_s, modules)
+              @klass = Core::Klass.new(node.class_name.to_s, node.base_class.to_s, classable_modules)
             end
 
             # end of the class
@@ -172,27 +175,53 @@ module RailsBestPractices
           @klass.extend_class_name
         end
 
+        # modules.
+        def classable_modules
+          @class_moduels ||= []
+        end
+      end
+
+      # Helper to parse the module name.
+      module Moduleable
+        def self.included(base)
+          base.class_eval do
+            interesting_nodes :module
+
+            # remember module name
+            add_callback "start_module" do |node|
+              moduleable_modules << node.module_name.to_s
+            end
+
+            # end of module
+            add_callback "end_module" do |node|
+              moduleable_modules.pop
+            end
+          end
+        end
+
         # get the current module name.
         def current_module_name
-          modules.join("::")
+          moduleable_modules.join("::")
         end
 
         # modules.
-        def modules
-          @moduels ||= []
+        def moduleable_modules
+          @moduleable_moduels ||= []
         end
       end
 
       # Helper to add callback after all files reviewed.
-      module Completeable
+      module Afterable
         def self.included(base)
           base.class_eval do
             interesting_nodes :class
-            interesting_files /rails_best_practices\.complete/
+            interesting_files /rails_best_practices\.after_(prepare|review)/
 
             add_callback "end_class" do |node|
-              if "RailsBestPractices::Complete" == node.class_name.to_s
-                on_complete
+              if "RailsBestPractices::AfterPrepare" == node.class_name.to_s
+                after_prepare
+              elsif "RailsBestPractices::AfterReview" == node.class_name.to_s
+                after_review
               end
             end
           end
@@ -294,12 +323,13 @@ module RailsBestPractices
                 call_method(method_name)
               end
 
-              def call_method(method_name, class_name=current_class_name)
-                if methods.has_method?(class_name, method_name)
-                  methods.get_method(class_name, method_name).mark_used
+              def call_method(method_name, class_name=nil)
+                name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
+                if methods.has_method?(name, method_name)
+                  methods.get_method(name, method_name).mark_used
                 end
-                methods.mark_parent_class_method_used(class_name, method_name)
-                methods.mark_subclasses_method_used(class_name, method_name)
+                methods.mark_parent_class_method_used(name, method_name)
+                methods.mark_subclasses_method_used(name, method_name)
                 methods.possible_public_used(method_name)
               end
           end
@@ -347,6 +377,10 @@ module RailsBestPractices
                   (class_name == method.class_name && method_name == method.method_name)
               end
             end
+
+            def internal_except_methods
+              raise NoMethodError.new "no method internal_except_methods"
+            end
           end
         end
       end