RubyGems - rails_best_practices - Versions diffs - 1.1.0 → 1.2.0 - Mend

rails_best_practices 1.1.0 → 1.2.0

Files changed (46) hide show

data/.gitignore CHANGED Viewed

@@ -9,3 +9,4 @@ pkg/**
 rdoc/**
 doc/**
 .yardoc/**
+rails_best_practices_output.html

data/Gemfile.lock CHANGED Viewed

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

data/README.md CHANGED Viewed

@@ -133,6 +133,7 @@ Now you can customize this configuration file, the default configuration is as f
     RemoveEmptyHelpersCheck: {}
     RemoveTabCheck: {}
     RestrictAutoGeneratedRoutesCheck: { }
+    RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
 You can remove or comment one review to disable it, and you can change the options.
@@ -161,6 +162,7 @@ Model
 2. the Law of Demeter
 3. Use Observer
 4. Use Query Attribute
+5. Remove Unused Methods In Models (Experiment, not available by default configuration)
 Mailer

data/assets/result.html.erb CHANGED Viewed

@@ -3,7 +3,6 @@
   <head>
     <meta charset='UTF-8' />
     <title>Output of rails_best_practices</title>
     <style type="text/css">
       body {
         color: #333;
@@ -34,6 +33,10 @@
       table tr:hover {
         background-color: #FFFFC0;
       }
+      ul li {
+       list-style: none;
+       display: none;
+      }
     </style>
   </head>
   <body>
@@ -50,6 +53,11 @@
         Found <%= @errors.size %> errors.
       <% end %>
     </h2>
+    <ul>
+      <% @error_types.each do |error_type| %>
+        <li><input type="checkbox" value="<%= error_type.split(':').last %>" /><%= error_type.split(':').last %></li>
+      <% end %>
+    </ul>
     <table>
       <tr>
         <th>Filename</th>
@@ -57,7 +65,7 @@
         <th>Warning Message</th>
       </tr>
       <% @errors.each do |error| %>
-        <tr>
+        <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>
@@ -74,5 +82,20 @@
         </tr>
       <% end %>
     </table>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"></script>
+    <script type="text/javascript">
+      $(function() {
+        $('ul li').show();
+        $('input[type=checkbox]').prop('checked', true).click(function() {
+          if ($(this).attr('checked')) {
+            $(this).prop('checked', true);
+            $('.'+$(this).val()).show();
+          } else {
+            $(this).prop('checked', false);
+            $('.'+$(this).val()).hide();
+          }
+        });
+      });
+    </script>
   </body>
 </html>

data/lib/rails_best_practices.rb CHANGED Viewed

@@ -83,6 +83,7 @@ module RailsBestPractices
       @bar = ProgressBar.new('Analyzing', lexical_files.size + prepare_files.size + review_files.size)
       ["lexical", "prepare", "review"].each { |process| send(:process, process) }
+      @runner.on_complete
       @bar.finish
       if @options['format'] == 'html'
@@ -202,7 +203,7 @@ module RailsBestPractices
       files.reject { |file| file.index(pattern) }
     end
-    # output errors if exist.
+    # output errors on terminal.
     def output_terminal_errors
       @runner.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')
@@ -213,6 +214,21 @@ module RailsBestPractices
       end
     end
+    # output errors with html format.
+    def output_html_errors
+      require 'erubis'
+      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "result.html.erb"))
+      File.open("rails_best_practices_output.html", "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"])
+      end
+    end
+    # plain output with color.
+    #
+    # @param [String] message to output
+    # @param [String] color
     def plain_output(message, color)
       if @options["without-color"]
         puts message
@@ -221,14 +237,9 @@ module RailsBestPractices
       end
     end
-    def output_html_errors
-      require 'erubis'
-      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "result.html.erb"))
-      File.open("rails_best_practices_output.html", "w+") do |file|
-        eruby = Erubis::Eruby.new(template)
-        file.puts eruby.evaluate(:errors => @runner.errors, :textmate => @options["with-textmate"], :mvim => @options["with-mvim"])
-      end
+    # unique error types.
+    def error_types
+      @runner.errors.map(&:type).uniq
     end
   end
 end

data/lib/rails_best_practices/core.rb CHANGED Viewed

@@ -4,6 +4,7 @@ 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/models'
 require 'rails_best_practices/core/model_associations'
 require 'rails_best_practices/core/model_attributes'

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

@@ -3,6 +3,7 @@ module RailsBestPractices
   module Core
     # A Check class that takes charge of checking the sexp.
     class Check
       CONTROLLER_FILES = /controllers\/.*\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
@@ -13,12 +14,6 @@ module RailsBestPractices
       SCHEMA_FILE = /db\/schema\.rb/
       HELPER_FILES = /helpers.*\.rb$/
-      attr_reader :errors
-      def initialize
-        @errors = []
-      end
       # default interesting nodes.
       def interesting_nodes
         []
@@ -37,6 +32,9 @@ module RailsBestPractices
       # @param [Sexp] node
       def node_start(node)
         @node = node
+        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
@@ -49,14 +47,23 @@ module RailsBestPractices
       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
+        end
       end
       # add error if source code violates rails best practice.
-      #   error is the string message for violation of the rails best practice
-      #   file is the filename of source code
-      #   line is the line number of the source code which is reviewing
-      def add_error(error, file = @node.file, line = @node.line)
-        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error, url)
+      #
+      # @param [String] message, is the string message for violation of the rails best practice
+      # @param [String] file, is the filename of source code
+      # @param [Integer] line, is the line number of the source code which is reviewing
+      def add_error(message, file = @node.file, line = @node.line)
+        errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", message, self.class.to_s, url)
+      end
+      # errors that vialote the rails best practices.
+      def errors
+        @errors ||= []
       end
       # default url is empty.
@@ -84,31 +91,105 @@ module RailsBestPractices
         end
       end
-      module Classable
-        # remember module name.
-        def start_module(node)
-          modules << node.module_name
+      class <<self
+        # callbacks for start_xxx and end_xxx.
+        def callbacks
+          @callbacks ||= {}
         end
-        # end of the module.
-        def end_module(node)
-          modules.pop
+        # 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
         end
+      end
+      # Helper to parse the class name.
+      module Klassable
+        def self.included(base)
+          base.class_eval do
+            # remember module name
+            add_callback "start_module" do |node|
+              modules << node.module_name.to_s
+            end
+            # end of the module.
+            add_callback "end_module" do |node|
+              modules.pop
+            end
-        # get the class name with module name.
-        def class_name(node)
-          class_name = node.class_name.to_s
-          if modules.empty?
-            class_name
-          else
-            modules.map { |modu| "#{modu}::" }.join("") + class_name
+            # 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)
+            end
+            # end of the class
+            add_callback "end_class" do |node|
+              @klass = nil
+            end
           end
         end
+        # get the current class name.
+        def current_class_name
+          @klass.to_s
+        end
+        # get the current extend class name.
+        def current_extend_class_name
+          @klass.extend_class_name
+        end
+        # modules.
         def modules
           @moduels ||= []
         end
       end
+      # Helper to add callback after all files reviewed.
+      module Completeable
+        def self.included(base)
+          base.class_eval do
+            add_callback "end_class" do |node|
+              if "RailsBestPractices::Complete" == node.class_name.to_s
+                on_complete
+              end
+            end
+          end
+        end
+      end
+      # Helper to parse the access control.
+      module Accessable
+        def self.included(base)
+          base.class_eval do
+            # remember the current access control for methods.
+            add_callback "start_var_ref" 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|
+              @access_control = "public"
+            end
+            # set access control to "public" by default.
+            add_callback "start_module" do |node|
+              @access_control = "public"
+            end
+          end
+          # get the current acces control.
+          def current_access_control
+            @access_control
+          end
+        end
+      end
     end
   end
 end

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

@@ -1,7 +1,8 @@
 # encoding: utf-8
 module RailsBestPractices
   module Core
-    class Controllers < Array
+    # Controller classes.
+    class Controllers < Klasses
     end
   end
 end

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

@@ -5,12 +5,13 @@ module RailsBestPractices
     #
     # it indicates the filenname, line number and error message for the violation.
     class Error
-      attr_reader :filename, :line_number, :message, :url
+      attr_reader :filename, :line_number, :message, :type, :url
-      def initialize(filename, line_number, message, url = nil)
+      def initialize(filename, line_number, message, type, url = nil)
         @filename = filename
         @line_number = line_number
         @message = message
+        @type = type
         @url = url
       end

data/lib/rails_best_practices/core/klasses.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    # Klass container.
+    class Klasses < Array
+      # If include the class.
+      #
+      # @param [String] class name
+      # @return [Boolean] include or not
+      def include?(class_name)
+        find { |klass| klass.to_s == class_name }
+      end
+    end
+    # Class info includes clas name, extend class name and module names.
+    class Klass
+      attr_reader :class_name, :extend_class_name
+      def initialize(class_name, extend_class_name, modules)
+        @class_name = class_name
+        @extend_class_name = extend_class_name
+        @modules = modules.dup
+      end
+      def to_s
+        if @modules.empty?
+          @class_name
+        else
+          @modules.map { |modu| "#{modu}::" }.join("") + @class_name
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 # encoding: utf-8
 module RailsBestPractices
   module Core
-    class Mailers < Array
+    # Mailer classes.
+    class Mailers < Klasses
     end
   end
 end

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

@@ -1,24 +1,128 @@
 # encoding: utf-8
 module RailsBestPractices
   module Core
+    # Method container.
     class Methods
       def initialize
         @methods = {}
+        @possible_methods = {}
       end
-      def add_method(model_name, method_name)
-        @methods[model_name] ||= []
-        @methods[model_name] << method_name
+      # Add a method.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      # @param [Hash] method meta, file and line, {"file" => "app/models/post.rb", "line" => 5}
+      # @param [String] access control, public, protected or private
+      def add_method(class_name, method_name, meta={}, access_control="public")
+        return if class_name == ""
+        methods(class_name) << Method.new(class_name, method_name, access_control, meta)
+        if access_control == "public"
+          @possible_methods[method_name] = false
+        end
       end
-      def get_methods(model_name)
-        @methods[model_name] ||= []
-        @methods[model_name].to_a
+      # Get methods of a class.
+      #
+      # @param [String] class name
+      # @param [String] access control
+      # @return [Array] all methods of a class for such access control, if access control is nil, return all public/protected/private methods
+      def get_methods(class_name, access_control=nil)
+        if access_control
+          methods(class_name).select { |method| method.access_control == access_control }
+        else
+          methods(class_name)
+        end
       end
-      def has_method?(model_name, method_name)
-        @methods[model_name] ||= []
-        @methods[model_name].include? method_name
+      # If a class has a method.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      # @param [String] access control
+      # @return [Boolean] has a method or not
+      def has_method?(class_name, method_name, access_control=nil)
+        if access_control
+          !!methods(class_name).find { |method| method.method_name == method_name && method.access_control == access_control }
+        else
+          !!methods(class_name).find { |method| method.method_name == method_name }
+        end
+      end
+      # Mark parent class' method as used.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      def mark_extend_class_method_used(class_name, method_name)
+        klass = Prepares.klasses.find { |klass| klass.to_s == class_name }
+        if klass && klass.extend_class_name
+          mark_extend_class_method_used(klass.extend_class_name, method_name)
+          method = get_method(klass.extend_class_name, method_name)
+          method.mark_used if method
+        end
+      end
+      # remomber the method name, the method is probably be used for the class' public method.
+      #
+      # @param [String] method name
+      def possible_public_used(method_name)
+        @possible_methods[method_name] = true
+      end
+      # Get a method in a class.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      # @param [String] access control
+      # @return [Method] Method object
+      def get_method(class_name, method_name, access_control=nil)
+        if access_control
+          methods(class_name).find { |method| method.method_name == method_name && method.access_control == access_control }
+        else
+          methods(class_name).find { |method| method.method_name == method_name }
+        end
+      end
+      # Get all unused methods.
+      #
+      # @param [String] access control
+      # @return [Array] array of Method
+      def get_all_unused_methods(access_control=nil)
+        @methods.inject([]) { |unused_methods, (class_name, methods)|
+          unused_methods += if access_control
+            methods.select { |method| method.access_control == access_control && !method.used }
+          else
+            methods.select { |method| !method.used }
+          end
+        }.reject { |method| method.access_control == "public" && @possible_methods[method.method_name] }
+      end
+      private
+        # Methods of a class.
+        #
+        # @param [String] class name
+        # @return [Array] array of methods
+        def methods(class_name)
+          @methods[class_name] ||= []
+        end
+    end
+    # Method info includes class name, method name, access control, file, line, used.
+    class Method
+      attr_reader :access_control, :class_name, :method_name, :used, :file, :line
+      def initialize(class_name, method_name, access_control, meta)
+        @class_name = class_name
+        @method_name = method_name
+        @file = meta["file"]
+        @line = meta["line"]
+        @access_control = access_control
+        @used = false
+      end
+      # Mark this method as used.
+      def mark_used
+        @used = true
       end
     end
   end