rails_best_practices 0.1.0

data/spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveModelLogicIntoModelCheck.new)
+  end
+  
+  it "should move model logic into model" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+      
+      def publish
+        @post = Post.find(params[:id])
+        @post.update_attributes(:is_published, true)
+        @post.approved_by = current_user
+        if @post.created_at > Time.now - 7.days
+          @post.popular = 100
+        else
+          @post.popular = 0
+        end
+      end
+      
+      redirect_to post_url(@post)
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - move model logic into model"
+  end
+
+  it "should not move model logic into model with simple model calling" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def publish
+        @post = Post.find(params[:id])
+        @post.update_attributes(:is_published, true)
+        @post.approved_by = current_user
+      end
+
+      redirect_to post_url(@post)
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/nested_model_forms_check_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::NestedModelFormsCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NestedModelFormsCheck.new)
+  end
+  
+  it "should nested model form check" do
+    pending
+  end
+end

data/spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::OveruseRouteCustomizationsCheck.new)
+  end
+  
+  it "should overuse route customizations" do
+    content = <<-EOF
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :posts, :member => { :comments => :get,
+                                         :create_comment => :post,
+                                         :udpate_comment => :post,
+                                         :delete_comment => :post }
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+  end
+end

data/spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new)
+  end
+  
+  it "should replace complex creation with factory method" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+      
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.vip = (@invoice.amount > 1000)
+        
+        if Time.now.day > 15
+          @invoice.deliver_time = Time.now + 2.month
+        else
+          @invoice.deliver_time = Time.now + 1.month
+        end
+        
+        @invoice.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/invoices_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controller/invoices_controller.rb:3 - replace complex creation with factory method"
+  end
+
+  it "should not replace complex creation with factory method with simple creation" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/invoices_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not replace complex creation with factory method when attrasgn_count is 5" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.vip = (@invoice.amount > 1000)
+
+        if Time.now.day > 15
+          @invoice.deliver_time = Time.now + 2.month
+        else
+          @invoice.deliver_time = Time.now + 1.month
+        end
+
+        @invoice.save
+      end
+    end
+    EOF
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new('attribute_assignment_count' => 5))
+    @runner.check('app/controller/invoices_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/use_model_association_check_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseModelAssociationCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseModelAssociationCheck.new)
+  end
+  
+  it "should use model association for instance variable" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+      
+      def create
+        @post = Post.new(params[:post])
+        @post.user_id = current_user.id
+        @post.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association"
+  end
+
+  it "should not use model association without association assign" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        @post = Post.new(params[:post])
+        @post.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should use model association for local variable" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        post = Post.new(params[:post])
+        post.user_id = current_user.id
+        post.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association"
+  end
+
+  it "should not use model association" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        post = current_user.posts.buid(params[:post])
+        post.save
+      end
+    end
+    EOF
+    @runner.check('app/controller/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/use_model_callback_check_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseModelCallbackCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseModelCallbackCheck.new)
+  end
+  
+  it "should use model callback check" do
+    pending
+  end
+end

data/spec/rails_best_practices/checks/use_scope_access_check_spec.rb

@@ -0,0 +1,171 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseScopeAccessCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseScopeAccessCheck.new)
+  end
+  
+  context "if" do
+    it "shoud use scope access" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+      
+        def edit
+          @post = Post.find(params[:id])
+        
+          if @post.user != current_user
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+    end
+
+    it "shoud use scope access by comparing with id" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          if @post.user_id != current_user.id
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+    end
+
+    it "shoud use scope access with current_user ==" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          if current_user != @post.user
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+    end
+
+    it "shoud use scope access by current_user.id ==" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          if current_user.id != @post.user_id
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+    end
+  end
+
+  context "unless" do
+    it "shoud use scope access" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          unless @post.user == current_user
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+    end
+
+    it "shoud use scope access by comparing with id" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          unless @post.user_id == current_user.id
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+    end
+
+    it "shoud use scope access with current_user ==" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          unless current_user == @post.user
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+    end
+
+    it "shoud use scope access by current_user.id ==" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+
+        def edit
+          @post = Post.find(params[:id])
+
+          unless current_user.id == @post.user_id
+            flash[:warning] = 'Access Denied'
+            redirect_to posts_url
+          end
+        end
+      end
+      EOF
+      @runner.check('app/controller/posts_controller.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,8 @@
+--colour
+--format
+specdoc
+--reverse
+--timeout
+20
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec/autorun'
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'rails_best_practices'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: rails_best_practices
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-05 00:00:00 +08:00
+default_executable: rails_best_practices
+dependencies: []
+
+description: ""
+email: flyerhzm@gmail.com
+executables: 
+- rails_best_practices
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- 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/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.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/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
+has_rdoc: true
+homepage: http://github.com/flyerhzm/rails_best_practices
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ""
+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