rails_best_practices 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+.*.swp
+pkg/**

data/README.textile

@@ -1,3 +1,30 @@
+h1. rails_best_practices
+
+rails_best_practices is a gem to check quality of rails app files according to ihower's presentation "Rails Best Practices".
+rails_best_practices is a static file parser tool based on ruby_parser.
+
+*************************************************
+
+h2. Install
+
+<pre><code>
+sudo gem install rails_best_practices --source http://gemcutter.org
+</code></pre>
+
+*************************************************
+
+h2. Usage
+
+at the root of rails
+
+<pre><code>
+rails_best_practices .
+</code></pre>
+
+*************************************************
+
+h2. Progress
+
 * Lesson 1. Move code from Controller to Model
 ## [-Move finder to named_scope-]
 ## [-Use model association-]
@@ -11,7 +38,7 @@
 ## Nested Model Forms (one-to-many)
 
 * Lesson 2. RESTful Conventions
-## Overuse route customizations
+## [-Overuse route customizations-]
 ## Needless deep nesting
 ## Not use default route
 
@@ -38,4 +65,8 @@
 ## Move code into helper
 ## Replace instance variable with local variable
 ## Use Form Builder
-## Organize Helper files
+## Organize Helper files
+
+*************************************************
+
+Copyright © 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/Rakefile

@@ -22,10 +22,12 @@ end
 
 Jeweler::Tasks.new do |gemspec|
   gemspec.name = "rails_best_practices"
-  gemspec.summary = ""
-  gemspec.description = ""
+  gemspec.summary = "check rails files according to ihower's presentation 'rails best practices'"
+  gemspec.description = "check rails files according to ihower's presentation 'rails best practices'"
   gemspec.email = "flyerhzm@gmail.com"
   gemspec.homepage = "http://github.com/flyerhzm/rails_best_practices"
   gemspec.authors = ["Richard Huang"]
+  gemspec.add_dependency 'ruby_parser'
+  gemspec.add_dependency 'ruby2ruby'
 end
 Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rails_best_practices/checks.rb

@@ -6,4 +6,5 @@ require 'rails_best_practices/checks/use_model_callback_check'
 require 'rails_best_practices/checks/replace_complex_creation_with_factory_method_check'
 require 'rails_best_practices/checks/move_model_logic_into_model_check'
 require 'rails_best_practices/checks/many_to_many_collection_check'
-require 'rails_best_practices/checks/nested_model_forms_check'
+require 'rails_best_practices/checks/nested_model_forms_check'
+require 'rails_best_practices/checks/overuse_route_customizations_check'

data/lib/rails_best_practices/checks/overuse_route_customizations_check.rb

@@ -0,0 +1,34 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    class OveruseRouteCustomizationsCheck < Check
+      
+      def interesting_nodes
+        [:call]
+      end
+      
+      def interesting_files
+        /config\/routes.rb/
+      end
+
+      def initialize(options = {})
+        super()
+        @customize_count = options['customize_count'] || 3
+      end
+      
+      def evaluate_start(node)
+        if s(:lvar, :map) == node.subject and :resources == node.message
+          add_error "overuse route customizations" if member_and_collection_count(node) > @customize_count
+        end
+      end
+
+      private
+
+      def member_and_collection_count(node)
+        customize_hash = eval(Ruby2Ruby.new.process(node.grep_nodes(:node_type => :hash).first))
+        (customize_hash[:member].size || 0) + (customize_hash[:collection].size || 0)
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'ruby_parser'
+require 'ruby2ruby'
 require 'yaml'
 
 module RailsBestPractices
@@ -56,4 +57,4 @@ module RailsBestPractices
       end
     end
   end
-end
+end

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -32,12 +32,13 @@ class Sexp
   
   def grep_nodes(options)
     return self if options.empty?
+    node_type = options[:node_type]
     subject = options[:subject]
     message = options[:message]
     arguments = options[:arguments]
     nodes = []
     self.recursive_children do |child|
-      if (!subject or subject == child.subject) and (!message or message == child.message) and (!arguments or arguments == child.arguments)
+      if (!node_type or node_type == child.node_type) and (!subject or subject == child.subject) and (!message or message == child.message) and (!arguments or arguments == child.arguments)
         nodes << child
       end
     end

data/rails_best_practices.gemspec

@@ -0,0 +1,98 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails_best_practices}
+  s.version = "0.1.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-05}
+  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}
+  s.executables = ["rails_best_practices"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/rails_best_practices",
+     "lib/rails_best_practices.rb",
+     "lib/rails_best_practices/checks.rb",
+     "lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb",
+     "lib/rails_best_practices/checks/check.rb",
+     "lib/rails_best_practices/checks/many_to_many_collection_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/nested_model_forms_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/use_model_association_check.rb",
+     "lib/rails_best_practices/checks/use_model_callback_check.rb",
+     "lib/rails_best_practices/checks/use_scope_access_check.rb",
+     "lib/rails_best_practices/command.rb",
+     "lib/rails_best_practices/core.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",
+     "rails_best_practices.gemspec",
+     "rails_best_practices.yml",
+     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
+     "spec/rails_best_practices/checks/many_to_many_collection_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/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_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_scope_access_check_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/flyerhzm/rails_best_practices}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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/use_scope_access_check_spec.rb",
+     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
+     "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
+     "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
+     "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
+     "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 0"])
+      s.add_runtime_dependency(%q<ruby2ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<ruby_parser>, [">= 0"])
+      s.add_dependency(%q<ruby2ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby_parser>, [">= 0"])
+    s.add_dependency(%q<ruby2ruby>, [">= 0"])
+  end
+end
+

data/rails_best_practices.yml

@@ -4,4 +4,7 @@ UseScopeAccessCheck: { }
 AddModelVirtualAttributeCheck: { }
 # UseModelCallbackCheck: { }
 ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
-MoveModelLogicIntoModelCheck: { called_count: 4 }
+MoveModelLogicIntoModelCheck: { called_count: 4 }
+# ManyToManyCollectionCheck: { }
+# NestedModelFormsCheck: { }
+OveruseRouteCustomizations: { customize_count: 3 }

data/spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb

@@ -10,12 +10,39 @@ describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
     ActionController::Routing::Routes.draw do |map|
       map.resources :posts, :member => { :comments => :get,
                                          :create_comment => :post,
-                                         :udpate_comment => :post,
+                                         :update_comment => :post,
                                          :delete_comment => :post }
     end
     EOF
     @runner.check('config/routes.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
+    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations"
   end
-end
+  
+  it "should overuse route customizations with collection" do
+    content = <<-EOF
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :posts, :member => { :create_comment => :post,
+                                         :update_comment => :post,
+                                         :delete_comment => :post },
+                            :collection => { :comments => :get }
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations"
+  end
+
+  it "should not overuse route customizations when customize route is only one" do
+    content = <<-EOF
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :posts, :member => { :vote => :post }
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -11,9 +11,28 @@ cert_chain: []
 
 date: 2009-11-05 00:00:00 +08:00
 default_executable: rails_best_practices
-dependencies: []
-
-description: ""
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: check rails files according to ihower's presentation 'rails best practices'
 email: flyerhzm@gmail.com
 executables: 
 - rails_best_practices
@@ -23,6 +42,7 @@ extra_rdoc_files:
 - LICENSE
 - README.textile
 files: 
+- .gitignore
 - LICENSE
 - README.textile
 - Rakefile
@@ -36,6 +56,7 @@ files:
 - 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/nested_model_forms_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/use_model_association_check.rb
 - lib/rails_best_practices/checks/use_model_callback_check.rb
@@ -47,12 +68,14 @@ files:
 - lib/rails_best_practices/core/error.rb
 - lib/rails_best_practices/core/runner.rb
 - lib/rails_best_practices/core/visitable_sexp.rb
+- rails_best_practices.gemspec
 - rails_best_practices.yml
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
 - spec/rails_best_practices/checks/many_to_many_collection_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/nested_model_forms_check_spec.rb
+- spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_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
@@ -86,7 +109,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: ""
+summary: check rails files according to ihower's presentation 'rails best practices'
 test_files: 
 - spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb