rails_best_practices 1.4.0 → 1.5.0

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 gemspec
 
 gem "ripper", :platform => :mri_18
+if RUBY_PLATFORM =~ /darwin/i
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.4.0)
+    rails_best_practices (1.5.0)
       activesupport
       colored
       erubis
@@ -16,10 +16,19 @@ GEM
     colored (1.2)
     diff-lcs (1.1.2)
     erubis (2.7.0)
+    growl (1.0.3)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.7)
+      guard (>= 0.8.4)
+    guard-spork (0.3.2)
+      guard (>= 0.8.4)
+      spork (>= 0.8.4)
     haml (3.1.3)
     i18n (0.5.0)
     progressbar (0.9.1)
     rake (0.8.7)
+    rb-fsevent (0.4.3.1)
     ripper (1.0.2)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
@@ -30,16 +39,22 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
     sexp_processor (3.0.5)
-    watchr (0.7)
+    spork (0.9.0.rc9)
+    thor (0.14.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
+  growl
+  guard
+  guard-rspec
+  guard-spork
   haml
   rails_best_practices!
   rake
+  rb-fsevent
   ripper
   rspec
-  watchr
+  spork (= 0.9.0.rc9)

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'spork', :rspec_env => { 'RAILS_ENV' => 'test' }, :cucumber => false, :test_unit => false, :bundler => false do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch(%r{^config/environments/.+\.rb$})
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb')
+end
+
+
+guard 'rspec', :version => 2, :all_after_pass => false, :all_on_start => false, :cli => "--color --format nested --fail-fast --drb" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,7 +1,11 @@
 rails_best_practices
 ====================
 
-rails_best_practices is a code metric tool to check the quality of rails codes.
+[![Build Status](https://secure.travis-ci.org/flyerhzm/rails_best_practices.png)](http://travis-ci.org/flyerhzm/rails_best_practices)
+
+[![Click here to lend your support to: rails-bestpractices.com and make a donation at www.pledgie.com !](https://www.pledgie.com/campaigns/12057.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12057)
+
+rails_best_practices is a code metric tool to check the quality of rails codes. It supports both activerecord and mongoid from version 1.5.0.
 
 Usage
 -----
@@ -69,18 +73,6 @@ or add in Gemfile
 
     gem "rails_best_practices"
 
-if you still want to use rails_best_practices gem in ruby 1.8, please add ripper gem dependency before rails_best_practices.
-
-Ruby 1.8
-
-    gem install ripper
-    gem install rails_best_practices
-
-or add in Gemfile
-
-    gem "ripper"
-    gem "rails_best_practices"
-
 Issue
 -----
 

data/lib/rails_best_practices.rb

@@ -22,14 +22,15 @@
 # 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 'rubygems'
+require 'fileutils'
+
 require 'progressbar'
 require 'colored'
+
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
 require 'rails_best_practices/core'
-require 'fileutils'
 
 # RailsBestPractices helps you to analyze your rails code, according to best practices on http://rails-bestpractices.
 # if it finds any violatioins to best practices, it will give you some readable suggestions.

data/lib/rails_best_practices/core.rb

@@ -15,3 +15,4 @@ require 'rails_best_practices/core/routes'
 
 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

@@ -3,19 +3,24 @@ module RailsBestPractices
   module Core
     # A Check class that takes charge of checking the sexp.
     class Check
-
       ALL_FILES = /.*/
-      CONTROLLER_FILES = /controllers\/.*\.rb$/
+      CONTROLLER_FILES = /(controllers|cells)\/.*\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
       MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
-      VIEW_FILES = /views\/.*\.(erb|haml)$/
-      PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
+      VIEW_FILES = /(views|cells)\/.*\.(erb|haml)$/
+      PARTIAL_VIEW_FILES = /(views|cells)\/.*\/_.*\.(erb|haml)$/
       ROUTE_FILES = /config\/routes.*\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
       HELPER_FILES = /helpers\/.*\.rb$/
       DEPLOY_FILES = /config\/deploy.*\.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
@@ -221,9 +226,14 @@ module RailsBestPractices
               when "alias_method_chain"
                 method, feature = *node.arguments.all.map(&:to_s)
                 call_method("#{method}_with_#{feature}")
+              when /(before|after)_/
+                node.arguments.all.each { |argument| mark_used(argument) }
               else
                 mark_used(node.message)
-                node.arguments.all.each { |argument| mark_used(argument) }
+                last_argument = node.arguments.all.last
+                if last_argument.present? && :bare_assoc_hash == last_argument.sexp_type
+                  last_argument.hash_values.each { |argument_value| mark_used(argument_value) }
+                end
               end
             end
 
@@ -254,7 +264,7 @@ module RailsBestPractices
               when "try"
                 mark_used(node.arguments.all.first)
               when "send"
-                if [:symbol_literal, :string_literal].include?(node.arguments.all[0].sexp_type)
+                if [:symbol_literal, :string_literal].include?(node.arguments.all.first.sexp_type)
                   mark_used(node.arguments.all.first)
                 end
               else
@@ -310,6 +320,27 @@ module RailsBestPractices
         end
       end
 
+      # Helper to check except methods.
+      module Exceptable
+        def self.included(base)
+          base.class_eval do
+            def except_methods
+              @except_methods + internal_except_methods
+            end
+
+            # check if the method is in the except methods list.
+            def excepted?(method)
+              except_methods.any? do |except_method|
+                class_name, method_name = except_method.split('#')
+                (class_name == '*' && method_name == method.method_name) ||
+                  (method_name == '*' && class_name == method.class_name) ||
+                  (class_name == method.class_name && method_name == method.method_name)
+              end
+            end
+          end
+        end
+      end
+
       # Helper to parse the access control.
       module Accessable
         def self.included(base)

data/lib/rails_best_practices/core/routes.rb

@@ -17,7 +17,9 @@ module RailsBestPractices
 
       def initialize(namespaces, controller_name, action_name)
         @namespaces = namespaces
-        @controller_name = controller_name
+        entities = controller_name.split('/')
+        @namespaces += entities[0..-2] if entities.size > 1
+        @controller_name = entities.last
         @action_name = action_name
       end
 

data/lib/rails_best_practices/core/runner.rb

@@ -1,11 +1,8 @@
 # encoding: utf-8
-require 'rubygems'
-require 'ripper'
-require 'erubis'
 require 'yaml'
+require 'ripper'
 require 'active_support/inflector'
 require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/try'
 
 module RailsBestPractices
   module Core
@@ -151,12 +148,12 @@ module RailsBestPractices
         # @param [String] filename is the filename of the erb or haml code.
         # @param [String] content is the source code of erb or haml file.
         def parse_erb_or_haml(filename, content)
-          if filename =~ /.*\.erb|.*\.rhtml$/
-            content = Erubis::Eruby.new(content).src
+          if filename =~ /.*\.erb$|.*\.rhtml$/
+            content = Erubis::OnlyRuby.new(content).src
           elsif filename =~ /.*\.haml$/
             begin
               require 'haml'
-              content = Haml::Engine.new(content).precompiled
+              content = Haml::Engine.new(content, {:ugly => true}).precompiled
               # remove \xxx characters
               content.gsub!(/\\\d{3}/, '')
             rescue LoadError

data/lib/rails_best_practices/core_ext/erubis.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require 'erubis'
+
+module Erubis
+  class OnlyRuby < Eruby
+    def add_preamble(src)
+    end
+
+    def add_text(src, text)
+      src << text.gsub(/[^\s;]/, '')
+    end
+
+    def add_stmt(src, code)
+      src << code
+      src << ";"
+    end
+
+    def add_expr_literal(src, code)
+      src << code
+      src << ";"
+    end
+
+    def add_expr_escaped(src, code)
+      src << code
+      src << ";"
+    end
+
+    def add_expr_debug(src, code)
+      src << code
+      src << ";"
+    end
+
+    def add_postamble(src)
+    end
+  end
+end

data/lib/rails_best_practices/core_ext/sexp.rb

@@ -26,7 +26,7 @@ class Sexp
       :alias, :symbol_literal, :symbol, :aref].include? sexp_type
       self[1].line
     elsif :array == sexp_type
-      array_values[0].line
+      array_values.first.line
     else
       self.last.first if self.last.is_a? Array
     end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -48,7 +48,7 @@ module RailsBestPractices
       # restrict actions for inherited_resources
       def start_command(node)
         if @inherited_resources && "actions" ==  node.message.to_s
-          if "all" == node.arguments.all[0].to_s
+          if "all" == node.arguments.all.first.to_s
             @actions = DEFAULT_ACTIONS
             option_argument = node.arguments.all[1]
             if :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value("except")

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -11,15 +11,16 @@ module RailsBestPractices
       interesting_nodes :class, :def, :command, :var_ref, :alias
       interesting_files MODEL_FILES
 
-      ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many)
+      ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many embeds_many embeds_one embedded_in)
 
       def initialize
         @models = Prepares.models
         @model_associations = Prepares.model_associations
+        @model_attributes = Prepares.model_attributes
         @methods = Prepares.model_methods
       end
 
-      # check class node to remember the last class name.
+      # remember the class name.
       def start_class(node)
         if "ActionMailer::Base" != current_extend_class_name
           @models << @klass
@@ -59,12 +60,17 @@ module RailsBestPractices
       def start_command(node)
         case node.message.to_s
         when *%w(named_scope scope alias_method)
-          method_name = node.arguments.all[0].to_s
+          method_name = node.arguments.all.first.to_s
           @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
         when "alias_method_chain"
           method, feature = *node.arguments.all.map(&:to_s)
           @methods.add_method(current_class_name, "#{method}_with_#{feature}", {"file" => node.file, "line" => node.line}, current_access_control)
           @methods.add_method(current_class_name, "#{method}", {"file" => node.file, "line" => node.line}, current_access_control)
+        when "field"
+          arguments = node.arguments.all
+          attribute_name = arguments.first.to_s
+          attribute_type = arguments.last.hash_value("type").present? ? arguments.last.hash_value("type").to_s : "String"
+          @model_attributes.add_attribute(current_class_name, attribute_name, attribute_type)
         when *ASSOCIATION_METHODS
           remember_association(node)
         else
@@ -81,9 +87,9 @@ module RailsBestPractices
         # remember associations, with class to association names.
         def remember_association(node)
           association_meta = node.message.to_s
-          association_name = node.arguments.all[0].to_s
-          arguments_node = node.arguments.all[1]
-          if arguments_node && :bare_assoc_hash == arguments_node.sexp_type
+          association_name = node.arguments.all.first.to_s
+          arguments_node = node.arguments.all.last
+          if arguments_node.hash_value("class_name").present?
             association_class = arguments_node.hash_value("class_name").to_s
           end
           association_class ||= association_name.classify

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -24,10 +24,22 @@ module RailsBestPractices
         when "resource"
           add_resource_routes(node)
         when "get", "post", "put", "delete"
-          action_name = node.arguments.all.first.to_s
-          @routes.add_route(current_namespaces, current_resource_name, action_name)
+          first_argument = node.arguments.all.first
+          if current_controller_name.present?
+            action_name = first_argument.to_s
+            @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
+              controller_name, action_name = route_node.to_s.split('#')
+            else
+              controller_name, action_name = first_argument.to_s.split('/')
+            end
+            @routes.add_route(current_namespaces, controller_name.underscore, action_name)
+          end
         when "match", "root"
           options = node.arguments.all.last
+          return if :string_literal == options.sexp_type
           if options.hash_value("controller").present?
             controller_name = options.hash_value("controller").to_s
             action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
@@ -55,9 +67,11 @@ module RailsBestPractices
           # nothing to do
         else
           options = node.arguments.all.last
-          controller_name = options.hash_value("controller").to_s
+          if options.hash_value("controller").present?
+            @controller_name = options.hash_value("controller").to_s
+          end
           action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
-          @routes.add_route(current_namespaces, controller_name, action_name)
+          @routes.add_route(current_namespaces, current_controller_name, action_name)
         end
       end
 
@@ -65,6 +79,11 @@ module RailsBestPractices
       def start_method_add_block(node)
         if "namespace" == node.message.to_s
           @namespaces << node.arguments.all.first.to_s
+        elsif "with_options" == node.message.to_s
+          argument = node.arguments.all.last
+          if :bare_assoc_hash == argument.sexp_type && argument.hash_value("controller").present?
+            @controller_name = argument.hash_value("controller").to_s
+          end
         end
       end
 
@@ -80,27 +99,27 @@ module RailsBestPractices
         def add_#{route_name}_routes(node)
           resource_names = node.arguments.all.select { |argument| :symbol_literal == argument.sexp_type }
           resource_names.each do |resource_name|
-            @resource_name = node.arguments.all.first.to_s
+            @controller_name = node.arguments.all.first.to_s
             options = node.arguments.all.last
             if options.hash_value("controller").present?
-              @resource_name = options.hash_value("controller").to_s
+              @controller_name = options.hash_value("controller").to_s
             end
             action_names = if options.hash_value("only").present?
                              get_#{route_name}_actions(options.hash_value("only").to_object)
                            elsif options.hash_value("except").present?
-                             self.class.const_get(:#{route_name.upcase}_ACTIONS) - get_#{route_name}_actions(options.hash_value("except").to_object)
+                             self.class.const_get(:#{route_name.to_s.upcase}_ACTIONS) - get_#{route_name}_actions(options.hash_value("except").to_object)
                            else
-                             self.class.const_get(:#{route_name.upcase}_ACTIONS)
+                             self.class.const_get(:#{route_name.to_s.upcase}_ACTIONS)
                            end
-            Array(action_names).each do |action_name|
-              @routes.add_route(current_namespaces, current_resource_name, action_name)
+            action_names.each do |action_name|
+              @routes.add_route(current_namespaces, current_controller_name, action_name)
             end
 
             member_routes = options.hash_value("member")
             if member_routes.present?
               action_names = :array == member_routes.sexp_type ? member_routes.to_object : member_routes.hash_keys
               action_names.each do |action_name|
-                @routes.add_route(current_namespaces, current_resource_name, action_name)
+                @routes.add_route(current_namespaces, current_controller_name, action_name)
               end
             end
 
@@ -108,7 +127,7 @@ module RailsBestPractices
             if collection_routes.present?
               action_names = :array == collection_routes.sexp_type ? collection_routes.to_object : collection_routes.hash_keys
               action_names.each do |action_name|
-                @routes.add_route(current_namespaces, current_resource_name, action_name)
+                @routes.add_route(current_namespaces, current_controller_name, action_name)
               end
             end
           end
@@ -117,11 +136,11 @@ module RailsBestPractices
         def get_#{route_name}_actions(action_names)
           case action_names
           when "all"
-            self.class.const_get(:#{route_name.upcase}_ACTIONS)
+            self.class.const_get(:#{route_name.to_s.upcase}_ACTIONS)
           when "none"
             []
           else
-            action_names
+            Array(action_names)
           end
         end
 
@@ -134,8 +153,8 @@ module RailsBestPractices
         @namespaces.dup
       end
 
-      def current_resource_name
-        @resource_name
+      def current_controller_name
+        @controller_name
       end
     end
   end