rails_best_practices 0.3.0 → 0.3.1

data/README.textile

@@ -30,6 +30,19 @@ rails_best_practices .
 
 notice the period at the end, it can be the relative or absolute path of your rails app.
 
+And default rails_best_practices will do parse codes in vendor, spec, test and stories directories. If you need, see the command options:
+
+<pre><code>
+$ rails_best_practices -h
+Usage: rails_best_practices [options]
+    -d, --debug                      Debug mode
+        --vendor                     include vendor files
+        --spec                       include spec files
+        --test                       include test files
+        --stories                    include stories files
+    -h, --help                       Show this message
+</code></pre>
+
 *************************************************
 
 h2. Customize Configuration
@@ -97,7 +110,7 @@ h2. Progress
 
 * Lesson 5. Controller
 ## [-Use before_filter-]
-## DRY Controller
+## [-DRY Controller-] # not implement, use http://github.com/josevalim/inherited_resources
 
 * Lesson 6. View
 ## [-Move code into controller-]

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/rails_best_practices/checks/check.rb

@@ -8,8 +8,8 @@ module RailsBestPractices
       CONTROLLER_FILES = /_controller.rb$/
       MIGRATION_FILES = /db\/migrate\/.*rb/
       MODLE_FILES = /models\/.*rb/
-      VIEW_FILES = /views\/.*erb/
-      PARTIAL_VIEW_FILES = /views\/.*\/_.*erb/
+      VIEW_FILES = /views\/.*(erb|haml)/
+      PARTIAL_VIEW_FILES = /views\/.*\/_.*(erb|haml)/
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb

@@ -20,4 +20,4 @@ module RailsBestPractices
       end
     end
   end
-end
+end

data/lib/rails_best_practices/command.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
 def expand_dirs_to_files *dirs
-  extensions = ['rb', 'erb', 'builder']
+  extensions = ['rb', 'erb', 'haml', 'builder']
 
   dirs.flatten.map { |p|
     if File.directory? p

data/lib/rails_best_practices/core/runner.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'ruby_parser'
 require 'erb'
+require 'haml'
 require 'yaml'
 
 module RailsBestPractices
@@ -29,6 +30,9 @@ module RailsBestPractices
         if filename =~ /.*erb/
           content = ERB.new(content).src
         end
+        if filename =~ /.*haml/
+          content = Haml::Engine.new(content).precompiled
+        end
         node = parse(filename, content)
         node.accept(@checker) if node
       end

data/rails_best_practices.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-10}
+  s.date = %q{2009-11-13}
   s.default_executable = %q{rails_best_practices}
   s.description = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.email = %q{flyerhzm@gmail.com}
@@ -88,27 +88,27 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.test_files = [
-    "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
-     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
-     "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
-     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
-     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
-     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb",
-     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
+    "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
      "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
-     "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
-     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
-     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
+     "spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb",
+     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
+     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
+     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/use_filter_check_spec.rb",
+     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
+     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
+     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
+     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
+     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
+     "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
      "spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb",
-     "spec/rails_best_practices/checks/use_filter_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
-     "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
-     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
-     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
+     "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
+     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/rails_best_practices/checks/law_of_demeter_check_spec.rb

@@ -24,6 +24,18 @@ describe RailsBestPractices::Checks::LawOfDemeterCheck do
     errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
   end
 
+  it "should law of demeter" do
+    content = <<-EOF
+= @invoice.user.name
+= @invoice.user.address
+= @invoice.user.cellphone
+    EOF
+    @runner.check('app/views/invoices/show.html.haml', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/invoices/show.html.haml:1 - law of demeter"
+  end
+
   it "should no law of demeter" do
     content = <<-EOF
     <%= @invoice.user_name %>

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -15,6 +15,16 @@ describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableChe
     errors[0].to_s.should == "app/views/posts/_post.html.erb:1 - replace instance variable with local variable"
   end
 
+  it "should replace instance variable with local varialbe in haml file" do
+    content = <<-EOF
+= @post.title
+    EOF
+    @runner.check('app/views/posts/_post.html.haml', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/_post.html.haml:1 - replace instance variable with local variable"
+  end
+
   it "should not replace instance variable with local varialbe" do
     content = <<-EOF
     <%= post.title %>
@@ -23,4 +33,4 @@ describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableChe
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 +08:00
+date: 2009-11-13 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -133,25 +133,25 @@ signing_key:
 specification_version: 3
 summary: check rails files according to ihower's presentation 'rails best practices'
 test_files: 
-- spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
-- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
 - spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb
-- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
-- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
-- spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb
-- spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
 - spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
-- spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
-- spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
-- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
+- spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb
+- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
+- spec/rails_best_practices/checks/use_observer_check_spec.rb
 - spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
+- spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
+- spec/rails_best_practices/checks/use_filter_check_spec.rb
+- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
+- spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
+- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
+- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
+- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
+- spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
+- spec/rails_best_practices/checks/use_model_callback_check_spec.rb
+- spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
 - spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb
-- spec/rails_best_practices/checks/use_filter_check_spec.rb
 - spec/rails_best_practices/checks/use_model_association_check_spec.rb
-- spec/rails_best_practices/checks/use_model_callback_check_spec.rb
-- spec/rails_best_practices/checks/use_observer_check_spec.rb
-- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
+- spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
+- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
 - spec/spec_helper.rb