rails_best_practices 0.2.3 → 0.2.4

data/README.textile

@@ -44,6 +44,7 @@ NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
 UseObserverCheck: { }
+IsolateSeedDataCheck: { }
 </code></pre>
 
 *************************************************
@@ -77,7 +78,7 @@ h2. Progress
 ## [-Use Observer-]
 
 * Lesson 4. Migration
-## Isolating Seed Data
+## [-Isolating Seed Data-]
 ## Always add DB index
 
 * Lesson 5. Controller

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/lib/rails_best_practices/checks/check.rb

@@ -3,7 +3,7 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :if, :unless, :class]
+      NODE_TYPES = [:call, :defn, :if, :unless, :class, :lasgn]
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/isolate_seed_data_check.rb

@@ -0,0 +1,46 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a migration file to make sure not to insert data in migration, move them to seed file.
+    #
+    # Implementation: check if there are :create, :create!, and :new with :save or :save! exist, the migration file needs isolate seed data.
+    class IsolateSeedDataCheck < Check
+
+      def interesting_nodes
+        [:call, :lasgn]
+      end
+
+      def interesting_files
+        /db\/migrate\/.*rb/
+      end
+
+      def initialize
+        super
+        @new_variables = []
+      end
+
+      def evaluate_start(node)
+        if [:create, :create!].include? node.message
+          add_error("isolate seed data")
+        elsif :lasgn == node.node_type
+          remember_new_variable(node)
+        elsif [:save, :save!].include? node.message
+          add_error("isolate seed data") if new_record?(node)
+        end
+      end
+
+      private
+
+      def remember_new_variable(node)
+        unless node.grep_nodes({:node_type => :call, :message => :new}).empty?
+          @new_variables << node.subject.to_s
+        end
+      end
+
+      def new_record?(node)
+        @new_variables.include? node.subject.to_ruby
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks.rb

@@ -13,3 +13,4 @@ require 'rails_best_practices/checks/not_use_default_route_check'
 require 'rails_best_practices/checks/keep_finders_on_their_own_model_check'
 require 'rails_best_practices/checks/law_of_demeter_check'
 require 'rails_best_practices/checks/use_observer_check'
+require 'rails_best_practices/checks/isolate_seed_data_check'

data/rails_best_practices.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "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/isolate_seed_data_check.rb",
      "lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb",
      "lib/rails_best_practices/checks/law_of_demeter_check.rb",
      "lib/rails_best_practices/checks/many_to_many_collection_check.rb",
@@ -53,6 +54,7 @@ Gem::Specification.new do |s|
      "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/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",
@@ -81,6 +83,7 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
      "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/isolate_seed_data_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",

data/rails_best_practices.yml

@@ -13,3 +13,4 @@ NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
 UseObserverCheck: { }
+IsolateSeedDataCheck: { }

data/spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb

@@ -22,6 +22,24 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
     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.check('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

data/spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::IsolateSeedDataCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::IsolateSeedDataCheck.new)
+  end
+
+  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.check('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"
+  end
+
+  it "should isolate seed data with new and save" 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.check('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 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.check('db/migrate/20090818130258_create_roles.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.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Richard Huang
@@ -52,6 +52,7 @@ files:
 - 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/isolate_seed_data_check.rb
 - lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
 - lib/rails_best_practices/checks/law_of_demeter_check.rb
 - lib/rails_best_practices/checks/many_to_many_collection_check.rb
@@ -76,6 +77,7 @@ files:
 - 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/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
@@ -126,6 +128,7 @@ test_files:
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
 - spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
 - spec/rails_best_practices/checks/use_model_callback_check_spec.rb
+- spec/rails_best_practices/checks/isolate_seed_data_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