rails_best_practices 0.4.4 → 0.4.5

data/README.textile

@@ -24,6 +24,9 @@ Usage: rails_best_practices [options]
         --spec                       include spec files
         --test                       include test files
         --stories                    include stories files
+    -x, --exclude PATTERNS           Don't analyze files matching a pattern
+                                     (comma-separated regexp list)
+    -v, --version                    Show this version
     -h, --help                       Show this message
 </code></pre>
 
@@ -85,6 +88,7 @@ MoveCodeIntoModelCheck: { }
 MoveCodeIntoHelperCheck: { array_count: 3 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 DryBundlerInCapistranoCheck: { }
+UseSayWithTimeInMigrationsCheck: { }
 </code></pre>
 
 *************************************************
@@ -112,6 +116,7 @@ h2. Implementation
 * Migration
 ## Isolating Seed Data
 ## Always add DB index
+## Use Say with Time in Migrations
 
 * Controller
 ## Use before_filter

data/lib/rails_best_practices.rb

@@ -11,6 +11,12 @@ module RailsBestPractices
       ['vendor', 'spec', 'test', 'stories', 'features'].each do |pattern|
         files = ignore_files(files, "#{pattern}/") unless options[pattern]
       end
+      
+      # Exclude files based on exclude regexes if the option is set.
+      for pattern in options[:exclude]
+        files = ignore_files(files, pattern)
+      end
+      
       files
     end
   

data/lib/rails_best_practices/checks.rb

@@ -19,3 +19,4 @@ require 'rails_best_practices/checks/move_code_into_model_check'
 require 'rails_best_practices/checks/move_code_into_helper_check'
 require 'rails_best_practices/checks/replace_instance_variable_with_local_variable_check'
 require 'rails_best_practices/checks/dry_bundler_in_capistrano_check'
+require 'rails_best_practices/checks/use_say_with_time_in_migrations_check'

data/lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb

@@ -6,7 +6,7 @@ module RailsBestPractices
     # Check config/deploy.rb file to make sure using the bundler's capistrano recipe.
     #
     # Implementation: check the method call,
-    # if there is a call "namespace :bundler", then it should use bundler's capistrano recipe.
+    # if there is a method call "namespace" with argument ":bundler", then it should use bundler's capistrano recipe.
     class DryBundlerInCapistranoCheck < Check
 
       def interesting_nodes

data/lib/rails_best_practices/checks/use_say_with_time_in_migrations_check.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a migration file to make sure to use say_with_time for customized data changes to produce a more readable output.
+    #
+    # Implementation: check if there are any first level messages called in self.up and self.down except say_with_time and default migration messages (such as :add_column and :create_table)
+    class UseSayWithTimeInMigrationsCheck < Check
+
+      DEFAULT_MIGRATION_MESSAGES = [:add_column, :add_index, :add_timestamps, :change_column, :change_column_default, :change_table, :create_table, :drop_table, :remove_column, :remove_index, :remove_timestamps, :rename_column, :rename_index, :rename_table]
+
+      def interesting_nodes
+        [:defs]
+      end
+
+      def interesting_files
+        MIGRATION_FILES
+      end
+
+      def evaluate_start(node)
+        block_body = node.grep_nodes(:node_type => :block).first.body
+        block_body.each do |iter|
+          if :call == iter[1].node_type and !(DEFAULT_MIGRATION_MESSAGES << :say_with_time).include? iter[1].message
+            add_error("use say with time in migrations", iter[1].file, iter[1].line)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/command.rb

@@ -18,7 +18,8 @@ OptionParser.new do |opts|
   end
   
   opts.on_tail('-v', '--version', 'Show this version') do
-    puts File.read(File.dirname(__FILE__) + '/../../VERSION')
+    require 'rails_best_practices/version'
+    puts RailsBestPractices::VERSION
     exit
   end
 
@@ -26,6 +27,14 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
+  
+  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}
+    rescue RegexpError => e
+      raise OptionParser::InvalidArgument, e.message
+    end
+  end
 
   opts.parse!
 end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end
 

data/rails_best_practices.yml

@@ -18,3 +18,4 @@ MoveCodeIntoModelCheck: { }
 MoveCodeIntoHelperCheck: { array_count: 3 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 DryBundlerInCapistranoCheck: { }
+UseSayWithTimeInMigrationsCheck: { }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 +08:00
+date: 2010-10-10 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +30,12 @@ dependencies:
         - 0
         - 4
         version: 2.0.4
-  requirement: *id001
-  type: :runtime
   name: ruby_parser
   prerelease: false
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,12 +46,12 @@ dependencies:
         - 2
         - 4
         version: 1.2.4
-  requirement: *id002
-  type: :runtime
   name: ruby2ruby
   prerelease: false
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,12 +62,12 @@ dependencies:
         - 9
         - 0
         version: 0.9.0
-  requirement: *id003
-  type: :runtime
   name: progressbar
   prerelease: false
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,12 +77,12 @@ dependencies:
         - 1
         - 2
         version: "1.2"
-  requirement: *id004
-  type: :runtime
   name: colored
   prerelease: false
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -95,12 +95,12 @@ dependencies:
         - beta
         - 22
         version: 2.0.0.beta.22
-  requirement: *id005
-  type: :development
   name: rspec
   prerelease: false
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -111,10 +111,25 @@ dependencies:
         - 0
         - 18
         version: 3.0.18
-  requirement: *id006
-  type: :development
   name: haml
   prerelease: false
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  name: watchr
+  prerelease: false
+  type: :development
+  version_requirements: *id007
 description: a code metric tool for rails codes, written in Ruby.
 email: 
 - flyerhzm@gmail.com
@@ -126,37 +141,38 @@ extra_rdoc_files:
 - MIT_LICENSE
 - README.textile
 files: 
-- lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
-- lib/rails_best_practices/checks/always_add_db_index_check.rb
-- lib/rails_best_practices/checks/check.rb
-- lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb
-- lib/rails_best_practices/checks/isolate_seed_data_check.rb
+- lib/rails_best_practices.rb
+- lib/rails_best_practices/version.rb
+- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
+- lib/rails_best_practices/checks/use_model_association_check.rb
 - lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
+- lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
+- lib/rails_best_practices/checks/use_say_with_time_in_migrations_check.rb
 - lib/rails_best_practices/checks/law_of_demeter_check.rb
+- lib/rails_best_practices/checks/use_scope_access_check.rb
 - lib/rails_best_practices/checks/move_code_into_controller_check.rb
-- lib/rails_best_practices/checks/move_code_into_helper_check.rb
-- lib/rails_best_practices/checks/move_code_into_model_check.rb
-- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
 - lib/rails_best_practices/checks/move_model_logic_into_model_check.rb
-- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
 - lib/rails_best_practices/checks/not_use_default_route_check.rb
-- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
 - lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb
+- lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb
+- lib/rails_best_practices/checks/isolate_seed_data_check.rb
+- lib/rails_best_practices/checks/always_add_db_index_check.rb
 - lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb
-- lib/rails_best_practices/checks/use_before_filter_check.rb
-- lib/rails_best_practices/checks/use_model_association_check.rb
+- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
+- lib/rails_best_practices/checks/move_code_into_helper_check.rb
 - lib/rails_best_practices/checks/use_observer_check.rb
-- lib/rails_best_practices/checks/use_scope_access_check.rb
+- lib/rails_best_practices/checks/check.rb
+- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
+- lib/rails_best_practices/checks/use_before_filter_check.rb
+- lib/rails_best_practices/checks/move_code_into_model_check.rb
+- lib/rails_best_practices/core.rb
 - lib/rails_best_practices/checks.rb
-- lib/rails_best_practices/command.rb
 - lib/rails_best_practices/core/checking_visitor.rb
 - lib/rails_best_practices/core/core_ext.rb
 - lib/rails_best_practices/core/error.rb
-- lib/rails_best_practices/core/runner.rb
 - lib/rails_best_practices/core/visitable_sexp.rb
-- lib/rails_best_practices/core.rb
-- lib/rails_best_practices/version.rb
-- lib/rails_best_practices.rb
+- lib/rails_best_practices/core/runner.rb
+- lib/rails_best_practices/command.rb
 - rails_best_practices.yml
 - MIT_LICENSE
 - README.textile