rails_best_practices 0.6.1 → 0.6.5

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/rails_best_practices/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rails_best_practices"
+  s.version     = RailsBestPractices::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Richard Huang"]
+  s.email       = ["flyerhzm@gmail.com"]
+  s.homepage    = "http://rails-bestpractices.com"
+  s.summary     = "a code metric tool for rails codes."
+  s.description = "a code metric tool for rails codes, written in Ruby."
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_dependency("ruby_parser", "~> 2.0.4")
+  s.add_dependency("ruby-progressbar", "~> 0.0.9")
+  s.add_dependency("colored", "~> 1.2")
+  s.add_dependency("erubis", "~> 2.6.6")
+  s.add_dependency("haml", "~> 3.0.18")
+  s.add_dependency("i18n")
+  s.add_dependency("activesupport")
+
+  s.add_development_dependency("rspec", "~> 2.0.1")
+  s.add_development_dependency("watchr", "~> 0.6")
+  s.add_development_dependency("bundler", ">= 1.0.0")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/rubies_test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+rvm ruby-1.8.7@rails_best_practices ruby -S bundle install      || exit $?
+rvm ruby-1.9.2@rails_best_practices ruby -S bundle install      || exit $?
+rvm ree@rails_best_practices ruby -S bundle install             || exit $?
+rvm 1.8.7@rails_best_practices
+rake spec:progress
+rvm 1.9.2@rails_best_practices
+rake spec:progress
+rvm ree@rails_best_practices
+rake spec:progress

data/spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::AddModelVirtualAttributeCheck.new)
+  end
+
+  it "should add model virtual attribute" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:full_name].split(' ', 2).first
+        @user.last_name = params[:full_name].split(' ', 2).last
+        @user.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for @user)"
+  end
+
+  it "should add model virtual attribute with local assignment" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        user = User.new(params[:user])
+        user.first_name = params[:full_name].split(' ', 2).first
+        user.last_name = params[:full_name].split(' ', 2).last
+        user.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for user)"
+  end
+
+  it "should not add model virtual attribute with differen param" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:first_name]
+        @user.last_name = params[:last_name]
+        @user.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not add model virtual attribute with read" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def show
+        if params[:id]
+          @user = User.find(params[:id])
+        else
+          @user = current_user
+        end
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should add model virtual attribute with two dimension params" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:user][:full_name].split(' ', 2).first
+        @user.last_name = params[:user][:full_name].split(' ', 2).last
+        @user.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for @user)"
+  end
+
+  it "should no add model virtual attribute with two dimension params" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:user][:first_name]
+        @user.last_name = params[:user][:last_name]
+        @user.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/always_add_db_index_check_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::AlwaysAddDbIndexCheck.new)
+  end
+
+  it "should always add db index" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "comments", :force => true do |t|
+        t.string "content"
+        t.integer "post_id"
+        t.integer "user_id"
+      end
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/schema.rb:2 - always add db index (comments => [post_id])"
+    errors[1].to_s.should == "db/schema.rb:2 - always add db index (comments => [user_id])"
+  end
+
+  it "should always add db index with polymorphic foreign key" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "versions", :force => true do |t|
+        t.integer  "versioned_id"
+        t.string   "versioned_type"
+        t.string   "tag"
+      end
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
+  end
+
+  it "should always add db index with polymorphic foreign key and _type is defined before _id" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "versions", :force => true do |t|
+        t.string   "versioned_type"
+        t.integer  "versioned_id"
+        t.string   "tag"
+      end
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors.size.should == 1
+    errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
+  end
+
+  it "should always add db index with single index, but without polymorphic foreign key" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "taggings", :force => true do |t|
+        t.integer  "tag_id"
+        t.integer  "taggable_id"
+        t.string   "taggable_type"
+      end
+
+      add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [taggable_id, taggable_type])"
+  end
+
+  it "should always add db index with polymorphic foreign key, but without single index" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "taggings", :force => true do |t|
+        t.integer  "tag_id"
+        t.integer  "taggable_id"
+        t.string   "taggable_type"
+      end
+
+      add_index "taggings", ["taggable_id", "taggable_type"], :name => "index_taggings_on_taggable_id_and_taggable_type"
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [tag_id])"
+  end
+
+  it "should not always add db index with column has no id" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "comments", :force => true do |t|
+        t.string "content"
+        t.integer "position"
+      end
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not always add db index with add_index" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "comments", :force => true do |t|
+        t.string "content"
+        t.integer "post_id"
+        t.integer "user_id"
+      end
+
+      add_index "comments", ["post_id"], :name => "index_comments_on_post_id"
+      add_index "comments", ["user_id"], :name => "index_comments_on_user_id"
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not always add db index with only _type column" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "versions", :force => true do |t|
+        t.string   "versioned_type"
+      end
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not always add db index with multi-column index" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "versions", :force => true do |t|
+        t.integer  "versioned_id"
+        t.string   "versioned_type"
+        t.string   "tag"
+      end
+
+      add_index "versions", ["versioned_id", "versioned_type"], :name => "index_versions_on_versioned_id_and_versioned_type"
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not always add db index if there is an index contains more columns" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "taggings", :force => true do |t|
+        t.integer  "taggable_id"
+        t.string   "taggable_type"
+        t.string   "context"
+      end
+
+      add_index "taggings", ["taggable_id", "taggable_type", "context"], :name => "index_taggings_on_taggable_id_and_taggable_type_and_context"
+    end
+    EOF
+    @runner.review('db/schema.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/check_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::Check do
+  before :each do
+    @check = RailsBestPractices::Checks::Check.new
+  end
+
+  it "should get empty interesting prepare nodes" do
+    @check.interesting_prepare_nodes.should == []
+  end
+
+  it "should get empty interesting review nodes" do
+    @check.interesting_review_nodes.should == []
+  end
+
+  it "should match all files of interesting prepare files" do
+    @check.interesting_prepare_files.should == /.*/
+  end
+
+  it "should match all files of interesting review files" do
+    @check.interesting_review_files.should == /.*/
+  end
+
+  context "review_node_start" do
+    it "should call review_start_if" do
+      node = stub(:node_type => :if)
+      @check.should_receive(:send).with("review_start_if", node)
+      @check.review_node_start(node)
+    end
+
+    it "should call review_start_call" do
+      node = stub(:node_type => :call)
+      @check.should_receive(:send).with("review_start_call", node)
+      @check.review_node_start(node)
+    end
+  end
+
+  context "review_node_end" do
+    it "should call review_end_if" do
+      node = stub(:node_type => :if)
+      @check.should_receive(:send).with("review_end_if", node)
+      @check.review_node_end(node)
+    end
+
+    it "should call review_end_call" do
+      node = stub(:node_type => :call)
+      @check.should_receive(:send).with("review_end_call", node)
+      @check.review_node_end(node)
+    end
+  end
+
+  context "equal?" do
+    it "should be true when compare symbol string with symbol" do
+      @check.equal?(":test", :test).should be_true
+    end
+  end
+end

data/spec/rails_best_practices/checks/dry_bundler_in_capistrano_check_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::DryBundlerInCapistranoCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::DryBundlerInCapistranoCheck.new)
+  end
+
+  it "should dry bundler in capistrno" do
+    content = <<-EOF
+    namespace :bundler do
+      task :create_symlink, :roles => :app do
+        shared_dir = File.join(shared_path, 'bundle')
+        release_dir = File.join(current_release, '.bundle')
+        run("mkdir -p \#{shared_dir} && ln -s \#{shared_dir} \#{release_dir}")
+      end
+
+      task :bundle_new_release, :roles => :app do
+        bundler.create_symlink
+        run "cd \#{release_path} && bundle install --without development test"
+      end
+    end
+
+    after 'deploy:update_code', 'bundler:bundle_new_release'
+    EOF
+    @runner.review('config/deploy.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "config/deploy.rb:1 - dry bundler in capistrano"
+  end
+
+  it "should not dry bundler in capistrano" do
+    content = <<-EOF
+      require 'bundler/capistrano'
+    EOF
+    @runner.review('config/deploy.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::IsolateSeedDataCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::IsolateSeedDataCheck.new)
+  end
+
+  context "create" do
+    it "should isolate seed data" do
+      content = <<-EOF
+      class CreateRoles < ActiveRecord::Migration
+        def self.up
+          create_table "roles", :force => true do |t|
+            t.string :name
+          end
+
+          ["admin", "author", "editor", "account"].each do |name|
+            Role.create!(:name => name)
+          end
+        end
+
+        def self.down
+          drop_table "roles"
+        end
+      end
+      EOF
+      @runner.review('db/migrate/20090818130258_create_roles.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:8 - isolate seed data"
+      errors.size.should == 1
+    end
+  end
+
+  context "new and save" do
+    it "should isolate seed data for local variable" do
+      content = <<-EOF
+      class CreateRoles < ActiveRecord::Migration
+        def self.up
+          create_table "roles", :force => true do |t|
+            t.string :name
+          end
+
+          ["admin", "author", "editor", "account"].each do |name|
+            role = Role.new(:name => name)
+            role.save!
+          end
+        end
+
+        def self.down
+          drop_table "roles"
+        end
+      end
+      EOF
+      @runner.review('db/migrate/20090818130258_create_roles.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
+    end
+
+    it "should isolate seed data for instance variable" do
+      content = <<-EOF
+      class CreateRoles < ActiveRecord::Migration
+        def self.up
+          create_table "roles", :force => true do |t|
+            t.string :name
+          end
+
+          ["admin", "author", "editor", "account"].each do |name|
+            @role = Role.new(:name => name)
+            @role.save!
+          end
+        end
+
+        def self.down
+          drop_table "roles"
+        end
+      end
+      EOF
+      @runner.review('db/migrate/20090818130258_create_roles.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
+    end
+  end
+
+  it "should not isolate seed data without data insert" do
+    content = <<-EOF
+    class CreateRoles < ActiveRecord::Migration
+      def self.up
+        create_table "roles", :force => true do |t|
+          t.string :name
+        end
+      end
+
+      def self.down
+        drop_table "roles"
+      end
+    end
+    EOF
+    @runner.review('db/migrate/20090818130258_create_roles.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end