RubyGems - rails_best_practices - Versions diffs - 1.10.1 → 1.11.0 - Mend

rails_best_practices 1.10.1 → 1.11.0

Files changed (76) hide show

data/.gitignore CHANGED Viewed

@@ -3,6 +3,7 @@
 pkg/**
 *.gem
 .bundle
+Gemfile.lock
 rdoc/**
 doc/**
 .yardoc/**

data/README.md CHANGED Viewed

@@ -22,6 +22,11 @@ following template engines:
 rails_best_practices works well only in ruby 1.9.2 and ruby 1.9.3 so far.
+## External Introduction
+<http://ruby5.envylabs.com/episodes/257-episode-253-march-9th-2012/stories/2253-rails_best_practices>
+<http://railscasts.com/episodes/252-metrics-metrics-metrics>
 ## Usage
 At the root directory of rails app
@@ -111,11 +116,11 @@ Now you can customize this configuration file, the default configuration is as f
     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 }
@@ -127,7 +132,7 @@ Now you can customize this configuration file, the default configuration is as f
     OveruseRouteCustomizationsCheck: { customize_count: 3 }
     ProtectMassAssignmentCheck: {}
     RemoveEmptyHelpersCheck: {}
-    RemoveTabCheck: {}
+    #RemoveTabCheck: {}
     RemoveTrailingWhitespaceCheck: { }
     RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
     RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
@@ -137,11 +142,11 @@ Now you can customize this configuration file, the default configuration is as f
     RestrictAutoGeneratedRoutesCheck: { }
     SimplifyRenderInControllersCheck: {}
     SimplifyRenderInViewsCheck: {}
-    UseBeforeFilterCheck: { customize_count: 2 }
+    #UseBeforeFilterCheck: { customize_count: 2 }
     UseModelAssociationCheck: { }
     UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
     UseObserverCheck: { }
-    UseParenthesesInMethodDefCheck: {}
+    #UseParenthesesInMethodDefCheck: {}
     UseQueryAttributeCheck: { }
     UseSayWithTimeInMigrationsCheck: { }
     UseScopeAccessCheck: { }
@@ -237,4 +242,4 @@ Send us email: <team@railsbp.com>
 Copyright © 2009 - 2012 Richard Huang (flyerhzm@gmail.com), released under the MIT license
-[1]:https://github.com/railsbp/rails_best_practices/wiki/How-to-write-your-own-check-list
+[1]: https://github.com/railsbp/rails_best_practices/wiki/How-to-write-your-own-check-list

data/assets/result.html.erb CHANGED Viewed

@@ -22,18 +22,18 @@
         margin: 10px 0;
         font-size: 14px;
       }
-      table th, table td {
+      table.result th, table.result td {
         padding: 4px;
         border: 1px solid #D0D0D0;
       }
-      table th {
+      table.result th {
         background-color: #DFC;
         color: #337022;
       }
-      table td.filename {
+      table.result td.filename {
         color: #ED1556;
       }
-      table tr:hover {
+      table.result tr:hover {
         background-color: #FFFFC0;
       }
       ul {
@@ -48,6 +48,14 @@
        float: left;
       }
     </style>
+<%
+  def columnize(arr, col_count)
+    row_count = arr.size / col_count
+    row_count += 1 if arr.size % col_count > 0
+    cols = arr.each_slice(row_count).to_a
+    cols[0].zip(*cols[1..-1]).map(&:compact)
+  end
+%>
   </head>
   <body>
     <h1>rails_best_practices output</h1>
@@ -63,59 +71,73 @@
         Found <%= @errors.size %> warnings.
       <% end %>
     </p>
-    <ul>
-      <% @error_types.each do |error_type| %>
-        <li>
-            <input type="checkbox" id="<%= error_type.split(':').last %>" value="<%= error_type.split(':').last %>" />
-            <label for="<%= error_type.split(':').last%>"><%= error_type.split(':').last%></label>
-        </li>
-      <% end %>
-    </ul>
     <table>
+      <% columnize(@error_types, 3).each do |row| %>
+        <tr>
+          <% row.map { |error_type| error_type.split(':').last }.each do |error_type| %>
+            <td>
+              <input type="checkbox" class="error-type" id="<%= error_type %>" value="<%= error_type %>"
+              />&nbsp;<label for="<%= error_type %>"><%= error_type.sub(/(Check|Review)$/, '').gsub(/([a-z\d])([A-Z])/,'\1 \2') %></label>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
       <tr>
-        <th>Filename</th>
-        <th>Line Number</th>
-        <th>Warning Message</th>
-        <% if @hg %>
-          <th>Hg Commit</th>
-          <th>Hg Username</th>
-        <% elsif @git %>
-          <th>Git Commit</th>
-          <th>Git Username</th>
-        <% end %>
+        <td colspan="3">
+          <button id="show-all">Check all</button>
+          <button id="show-none">Uncheck all</button>
+        </td>
       </tr>
-      <% @errors.each do |error| %>
-        <tr class="<%= error.type.split(':').last %>">
-          <td class='filename'>
-            <% 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.short_filename %></a>
-            <% else %>
-              <%= error.short_filename %>
-            <% end %>
-          </td>
-          <td class='line'><%= error.line_number %></td>
-          <td class='message'>
-            <a href='<%= error.url %>' target='_blank'><%= error.message %></a>
-          </td>
+    </table>
+    <table class="result">
+      <thead>
+        <tr>
+          <th>Filename</th>
+          <th>Line Number</th>
+          <th>Warning Message</th>
           <% if @hg %>
-            <td class='hg_commit'><%= error.hg_commit %></td>
-            <td class='hg_usename'><%= error.hg_username %></td>
+            <th>Hg Commit</th>
+            <th>Hg Username</th>
           <% elsif @git %>
-            <td class='git_commit'><%= error.git_commit %></td>
-            <td class='git_usename'><%= error.git_username %></td>
+            <th>Git Commit</th>
+            <th>Git Username</th>
           <% end %>
         </tr>
-      <% end %>
+      </thead>
+      <tbody>
+        <% @errors.each do |error| %>
+          <tr class="<%= error.type.split(':').last %>">
+            <td class='filename'>
+              <% 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.short_filename %></a>
+              <% else %>
+                <%= error.short_filename %>
+              <% end %>
+            </td>
+            <td class='line'><%= error.line_number %></td>
+            <td class='message'>
+              <a href='<%= error.url %>' target='_blank'><%= error.message %></a>
+            </td>
+            <% if @hg %>
+              <td class='hg_commit'><%= error.hg_commit %></td>
+              <td class='hg_usename'><%= error.hg_username %></td>
+            <% elsif @git %>
+              <td class='git_commit'><%= error.git_commit %></td>
+              <td class='git_usename'><%= error.git_username %></td>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
     </table>
-    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
     <script type="text/javascript">
       $(function() {
         $('ul li').show();
-        $('input[type=checkbox]').prop('checked', true).click(function() {
+        $('input.error-type[type=checkbox]').prop('checked', true).click(function() {
           if ($(this).attr('checked')) {
             $(this).prop('checked', true);
             $('.'+$(this).val()).show();
@@ -124,6 +146,14 @@
             $('.'+$(this).val()).hide();
           }
         });
+        $('#show-all').click(function() {
+          $('input.error-type[type=checkbox]').prop('checked', true);
+          $('table.result tbody tr').show();
+        });
+        $('#show-none').click(function() {
+          $('input.error-type[type=checkbox]').prop('checked', false);
+          $('table.result tbody tr').hide();
+        });
       });
     </script>
   </body>

data/install_supported_rubies.sh CHANGED Viewed

@@ -1,7 +1,10 @@
 #!/bin/bash
 rubies=( 1.9.2 1.9.3 )
+gemset="rails_best_practices"
 for x in ${rubies[*]}
 do
   rvm install $x
   rvm $x && rvm gemset use global && gem install bundler
+  rvm --create $x@$gemset do bundle install
 done

data/lib/rails_best_practices.rb CHANGED Viewed

@@ -8,7 +8,7 @@
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
+# permit persons to whom the Software is furnished to do so, receiver to
 # the following conditions:
 #
 # The above copyright notice and this permission notice shall be
@@ -22,6 +22,7 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+require 'code_analyzer'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'

data/lib/rails_best_practices/analyzer.rb CHANGED Viewed

@@ -53,8 +53,6 @@ module RailsBestPractices
       Core::Runner.base_path = @path
       @runner = Core::Runner.new
-      @runner.debug = true if @options["debug"]
-      @runner.color = !@options["without-color"]
       analyze_source_codes
       analyze_vcs
@@ -79,7 +77,15 @@ module RailsBestPractices
     # @param [String] process the process name, lexical, prepare or review.
     def process(process)
       parse_files.each do |file|
-        @runner.send("#{process}_file", file)
+        begin
+          puts file if @options["debug"]
+          @runner.send(process, file, File.read(file))
+        rescue
+          if @options["debug"]
+            warning = "#{file} looks like it's not a valid Ruby file.  Skipping..."
+            plain_output(warning, 'red')
+          end
+        end
         @bar.inc if display_bar?
       end
       @runner.send("after_#{process}")
@@ -116,7 +122,7 @@ module RailsBestPractices
     # @param [Array] dirs what directories to expand
     # @return [Array] all files expanded
     def expand_dirs_to_files(*dirs)
-      extensions = ['rb', 'erb', 'rake', 'rhtml', 'haml', 'slim', 'builder', 'rxml']
+      extensions = ['rb', 'erb', 'rake', 'rhtml', 'haml', 'slim', 'builder', 'rxml', 'rabl']
       dirs.flatten.map { |entry|
         next unless File.exist? entry
@@ -140,10 +146,6 @@ module RailsBestPractices
       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
-      helpers.sort
-      others.sort
       return models + mailers + helpers + others
     end

data/lib/rails_best_practices/core.rb CHANGED Viewed

@@ -1,9 +1,7 @@
 # encoding: utf-8
 require 'rails_best_practices/core/check'
 require 'rails_best_practices/core/runner'
-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'
@@ -16,6 +14,4 @@ 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'
 require 'rails_best_practices/core_ext/erubis'

data/lib/rails_best_practices/core/check.rb CHANGED Viewed

@@ -2,78 +2,42 @@
 module RailsBestPractices
   module Core
     # A Check class that takes charge of checking the sexp.
-    class Check
+    class Check < CodeAnalyzer::Checker
       ALL_FILES = /.*/
-      CONTROLLER_FILES = /(controllers|cells)\/.*\.rb$/
+      CONTROLLER_FILES = /app\/(controllers|cells)\/.*\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
-      MODEL_FILES = /models\/.*\.rb$/
-      MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
-      VIEW_FILES = /(views|cells)\/.*\.(erb|haml|slim|builder|rxml)$/
-      PARTIAL_VIEW_FILES = /(views|cells)\/.*\/_.*\.(erb|haml|slim|builder|rxml)$/
+      MODEL_FILES = /app\/models\/.*\.rb$/
+      MAILER_FILES = /app\/models\/.*mailer\.rb$|app\/mailers\/.*\.rb/
+      VIEW_FILES = /app\/(views|cells)\/.*\.(erb|haml|slim|builder|rxml)$/
+      PARTIAL_VIEW_FILES = /app\/(views|cells)\/.*\/_.*\.(erb|haml|slim|builder|rxml)$/
       ROUTE_FILES = /config\/routes.*\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
-      HELPER_FILES = /helpers\/.*\.rb$/
+      HELPER_FILES = /app\/helpers\/.*\.rb$/
       DEPLOY_FILES = /config\/deploy.*\.rb/
       CONFIG_FILES = /config\/(application|environment|environments\/.*)\.rb/
+      SKIP_FILES = /db\/schema.rb/
       def initialize(options={})
         options.each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end
-      # interesting nodes that the check will parse.
-      def interesting_nodes
-        self.class.interesting_nodes
-      end
-      # interesting files that the check will parse.
-      def interesting_files
-        self.class.interesting_files
-      end
       # check if the check will need to parse the node file.
       #
       # @param [String] the file name of node.
       # @return [Boolean] true if the check will need to parse the file.
       def parse_file?(node_file)
-        interesting_files.any? { |pattern| node_file =~ pattern }
-      end
-      # delegate to start_### according to the sexp_type, like
-      #
-      #     start_call
-      #     start_def
-      #
-      # @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
-        self.send("start_#{node.sexp_type}", node)
-      end
-      # delegate to end_### according to the sexp_type, like
-      #
-      #     end_call
-      #     end_def
-      #
-      # @param [Sexp] node
-      def node_end(node)
-        @node = node
-        self.send("end_#{node.sexp_type}", node)
-        Array(self.class.callbacks["end_#{node.sexp_type}"]).each do |callback|
-          self.instance_exec node, &callback
+        interesting_files.any? do |pattern|
+          if pattern == ALL_FILES
+            node_file =~ pattern && node_file !~ SKIP_FILES
+          else
+            node_file =~ pattern
+          end
         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
@@ -98,7 +62,7 @@ module RailsBestPractices
       #
       # @return [String] the url of rails best practice
       def url
-        ""
+        self.class.url
       end
       # method_missing to catch all start and end process for each node type, like
@@ -120,30 +84,8 @@ module RailsBestPractices
       end
       class <<self
-        def interesting_nodes(*nodes)
-          @interesting_nodes ||= []
-          @interesting_nodes += nodes
-          @interesting_nodes.uniq
-        end
-        def interesting_files(*file_patterns)
-          @interesting_files ||= []
-          @interesting_files += file_patterns
-          @interesting_files.uniq
-        end
-        # callbacks for start_xxx and end_xxx.
-        def callbacks
-          @callbacks ||= {}
-        end
-        # add a callback.
-        #
-        # @param [String] name, callback name, can be start_xxx or end_xxx
-        # @param [Proc] block, be executed when callbacks are called
-        def add_callback(name, &block)
-          callbacks[name] ||= []
-          callbacks[name] << block
+        def url(url=nil)
+          url ?  @url = url : @url
         end
         def debug?
@@ -162,23 +104,23 @@ module RailsBestPractices
             interesting_nodes :module, :class
             # remember module name
-            add_callback "start_module" do |node|
+            add_callback :start_module do |node|
               classable_modules << node.module_name.to_s
             end
             # end of the module.
-            add_callback "end_module" do |node|
+            add_callback :end_module do |node|
               classable_modules.pop
             end
             # remember the class anem
-            add_callback "start_class" do |node|
+            add_callback :start_class do |node|
               @klass = Core::Klass.new(node.class_name.to_s, node.base_class.to_s, classable_modules)
             end
             # end of the class
-            add_callback "end_class" do |node|
-              @klass = nil
+            add_callback :end_class do |node|
+              #@klass = nil
             end
           end
         end
@@ -206,12 +148,12 @@ module RailsBestPractices
             interesting_nodes :module
             # remember module name
-            add_callback "start_module" do |node|
+            add_callback :start_module do |node|
               moduleable_modules << node.module_name.to_s
             end
             # end of module
-            add_callback "end_module" do |node|
+            add_callback :end_module do |node|
               moduleable_modules.pop
             end
           end
@@ -228,24 +170,6 @@ module RailsBestPractices
         end
       end
-      # Helper to add callback after all files reviewed.
-      module Afterable
-        def self.included(base)
-          base.class_eval do
-            interesting_nodes :class
-            interesting_files /rails_best_practices\.after_(prepare|review)/
-            add_callback "end_class" do |node|
-              if "RailsBestPractices::AfterPrepare" == node.class_name.to_s
-                after_prepare
-              elsif "RailsBestPractices::AfterReview" == node.class_name.to_s
-                after_review
-              end
-            end
-          end
-        end
-      end
       # Helper to add callbacks to mark the methods are used.
       module Callable
         def self.included(base)
@@ -253,22 +177,22 @@ module RailsBestPractices
             interesting_nodes :call, :fcall, :var_ref, :vcall, :command_call, :command, :alias, :bare_assoc_hash, :method_add_arg
             # remembe the message of call node.
-            add_callback "start_call" do |node|
+            add_callback :start_call do |node|
               mark_used(node.message)
             end
             # remembe the message of fcall node.
-            add_callback "start_fcall" do |node|
+            add_callback :start_fcall do |node|
               mark_used(node.message)
             end
             # remembe name of var_ref node.
-            add_callback "start_var_ref" do |node|
+            add_callback :start_var_ref do |node|
               mark_used(node)
             end
             # remembe name of vcall node.
-            add_callback "start_vcall" do |node|
+            add_callback :start_vcall do |node|
               mark_used(node)
             end
@@ -279,7 +203,7 @@ module RailsBestPractices
             # remember the message of command node.
             # remember the argument of alias_method and alias_method_chain as well.
-            add_callback "start_command" do |node|
+            add_callback :start_command do |node|
               case node.message.to_s
               when *skip_command_callback_nodes
                 # nothing
@@ -300,12 +224,12 @@ module RailsBestPractices
             end
             # remembe the message of command call node.
-            add_callback "start_command_call" do |node|
+            add_callback :start_command_call do |node|
               mark_used(node.message)
             end
             # remember the old method of alias node.
-            add_callback "start_alias" do |node|
+            add_callback :start_alias do |node|
               mark_used(node.old_method)
             end
@@ -314,14 +238,14 @@ module RailsBestPractices
             #     def to_xml(options = {})
             #       super options.merge(exclude: :visible, methods: [:is_discussion_conversation])
             #     end
-            add_callback "start_bare_assoc_hash" do |node|
+            add_callback :start_bare_assoc_hash do |node|
               if node.hash_keys.include? "methods"
                 mark_used(node.hash_value("methods"))
               end
             end
             # remember the first argument for try and send method.
-            add_callback "start_method_add_arg" do |node|
+            add_callback :start_method_add_arg do |node|
               case node.message.to_s
               when "try"
                 mark_used(node.arguments.all.first)
@@ -368,21 +292,21 @@ module RailsBestPractices
             interesting_files CONTROLLER_FILES
             # check if the controller is inherit from InheritedResources::Base.
-            add_callback "start_class" do |node|
+            add_callback :start_class do |node|
               if "InheritedResources::Base" == current_extend_class_name
                 @inherited_resources = true
               end
             end
             # check if there is a DSL call inherit_resources.
-            add_callback "start_var_ref" do |node|
+            add_callback :start_var_ref do |node|
               if "inherit_resources" == node.to_s
                 @inherited_resources = true
               end
             end
             # check if there is a DSL call inherit_resources.
-            add_callback "start_vcall" do |node|
+            add_callback :start_vcall do |node|
               if "inherit_resources" == node.to_s
                 @inherited_resources = true
               end
@@ -424,26 +348,26 @@ module RailsBestPractices
             interesting_nodes :var_ref, :vcall, :class, :module
             # remember the current access control for methods.
-            add_callback "start_var_ref" do |node|
+            add_callback :start_var_ref do |node|
               if %w(public protected private).include? node.to_s
                 @access_control = node.to_s
               end
             end
             # remember the current access control for methods.
-            add_callback "start_vcall" do |node|
+            add_callback :start_vcall do |node|
               if %w(public protected private).include? node.to_s
                 @access_control = node.to_s
               end
             end
             # set access control to "public" by default.
-            add_callback "start_class" do |node|
+            add_callback :start_class do |node|
               @access_control = "public"
             end
             # set access control to "public" by default.
-            add_callback "start_module" do |node|
+            add_callback :start_module do |node|
               @access_control = "public"
             end
           end