flipsasser-bullet 1.1.0

data/lib/bullet/logger.rb

@@ -0,0 +1,9 @@
+module Bullet
+  class BulletLogger < Logger
+    LOG_FILE = ::RAILS_ROOT + '/log/bullet.log'
+
+    def format_message(severity, timestamp, progname, msg)
+      "#{timestamp.to_formatted_s(:db)}[#{severity}] #{msg}\n"
+    end
+  end
+end

data/lib/bulletware.rb

@@ -0,0 +1,25 @@
+class Bulletware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    return @app.call(env) unless Bullet.enable?
+
+    Bullet::Association.start_request
+    status, headers, response = @app.call(env)
+    return [status, headers, response] if response.empty?
+
+    if Bullet::Association.has_bad_assocations?
+      if !headers['Content-Type'].nil? and headers['Content-Type'].include? 'text/html'
+        response_body = response.body << Bullet::Association.bad_associations_alert
+        headers['Content-Length'] = response_body.length.to_s
+      end
+
+      Bullet::Association.log_bad_associations(env['PATH_INFO'])
+    end
+    response_body ||= response.body
+    Bullet::Association.end_request
+    [status, headers, response_body]
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'bullet'

data/spec/bullet_association_spec.rb

@@ -0,0 +1,696 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:')
+
+describe Bullet::Association, 'has_many' do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :categories do |t|
+        t.column :name, :string
+      end
+      
+      create_table :posts do |t|
+        t.column :name, :string
+        t.column :category_id, :integer
+      end
+
+      create_table :comments do |t|
+        t.column :name, :string
+        t.column :post_id, :integer
+      end
+
+      create_table :entries do |t|
+        t.column :name, :string
+        t.column :category_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+  
+  class Category < ActiveRecord::Base
+    has_many :posts
+    has_many :entries
+  end
+
+  class Post < ActiveRecord::Base
+    belongs_to :category
+    has_many :comments
+  end
+  
+  class Entry < ActiveRecord::Base
+    belongs_to :category
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+  end
+  
+  before(:all) do
+    setup_db
+    
+    category1 = Category.create(:name => 'first')
+    category2 = Category.create(:name => 'second')
+    
+    post1 = category1.posts.create(:name => 'first')
+    post2 = category1.posts.create(:name => 'second')
+    post3 = category2.posts.create(:name => 'third')
+    post4 = category2.posts.create(:name => 'fourth')
+    
+    comment1 = post1.comments.create(:name => 'first')
+    comment2 = post1.comments.create(:name => 'second')
+    comment3 = post2.comments.create(:name => 'third')
+    comment4 = post2.comments.create(:name => 'fourth')
+    
+    entry1 = category1.entries.create(:name => 'first')
+    entry2 = category1.entries.create(:name => 'second')
+  end
+  
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+  
+  context "post => comments" do
+    it "should detect preload with post => comments" do
+      Post.find(:all, :include => :comments).each do |post|
+        post.comments.collect(&:name)
+      end
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+  
+    it "should detect no preload post => comments" do
+      Post.find(:all).each do |post|
+        post.comments.collect(&:name)
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+    
+    it "should detect unused preload post => comments" do
+      Post.find(:all, :include => :comments).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+
+    it "should no detect unused preload post => comments" do
+      Post.find(:all).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+  end
+  
+  context "category => posts => comments" do
+    it "should detect preload with category => posts => comments" do
+      Category.find(:all, :include => {:posts => :comments}) do |category|
+        category.posts.each do |post|
+          post.comments.collect(&:name)
+        end
+      end
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+  
+    it "should detect preload category => posts, but no post => comments" do
+      Category.find(:all, :include => :posts).each do |category|
+        category.posts.each do |post|
+          post.comments.collect(&:name)
+        end
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+  
+    it "should detect no preload category => posts => comments" do
+      Category.find(:all).each do |category|
+        category.posts.each do |post|
+          post.comments.collect(&:name)
+        end
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+    
+    it "should detect unused preload with category => posts => comments" do
+      Category.find(:all, :include => {:posts => :comments}).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+    
+    it "should detect unused preload with post => commnets, no category => posts" do
+      Category.find(:all, :include => {:posts => :comments}).each do |category|
+        category.posts.collect(&:name)
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+    
+    it "should no detect preload with category => posts => comments" do
+      Category.find(:all).each do |category|
+        category.posts.each do |post|
+          post.comments.collect(&:name)
+        end
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+  end
+  
+  context "category => posts, category => entries" do
+    it "should detect preload with category => [posts, entries]" do
+      Category.find(:all, :include => [:posts, :entries]).each do |category|
+        category.posts.collect(&:name)
+        category.entries.collect(&:name)
+      end
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+
+    it "should detect preload with category => posts, but no category => entries" do
+      Category.find(:all, :include => :posts).each do |category|
+        category.posts.collect(&:name)
+        category.entries.collect(&:name)
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+
+    it "should detect no preload with category => [posts, entries]" do
+      Category.find(:all).each do |category|
+        category.posts.collect(&:name)
+        category.entries.collect(&:name)
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+    
+    it "should detect unused with category => [posts, entries]" do
+      Category.find(:all, :include => [:posts, :entries]).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+    
+    it "should detect unused preload with category => entries, but no category => posts" do
+      Category.find(:all, :include => [:posts, :entries]).each do |category|
+        category.posts.collect(&:name)
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+    
+    it "should detect no unused preload" do
+      Category.find(:all).each do |category|
+        category.posts.collect(&:name)
+        category.entries.collect(&:name)
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+  end
+
+  context "no preload" do
+    it "should no preload only one post => commnets" do
+      Post.first.comments.collect(&:name)
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+  end
+
+  context "belongs_to" do
+    it "should preload comments => post" do
+      Comment.find(:all).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.should be_has_unpreload_associations
+    end
+    
+    it "should no preload comment => post" do
+      Comment.first.post.name
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+    
+    it "should no preload comments => post" do
+      Comment.find(:all, :include => :post).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+    
+    it "should detect no unused preload comments => post" do
+      Comment.find(:all).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+    
+    it "should detect unused preload comments => post" do
+      Comment.find(:all, :include => :post).collect(&:name)
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should be_has_unused_preload_associations
+    end
+    
+    it "should dectect no unused preload comments => post" do
+      Comment.find(:all).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+    
+    it "should dectect no unused preload comments => post" do
+      Comment.find(:all, :include => :post).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+  end
+end
+
+describe Bullet::Association, 'has_and_belongs_to_many' do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :students do |t|
+        t.column :name, :string
+      end
+      
+      create_table :teachers do |t|
+        t.column :name, :string
+      end
+
+      create_table :students_teachers, :id => false do |t|
+        t.column :student_id, :integer
+        t.column :teacher_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Student < ActiveRecord::Base
+    has_and_belongs_to_many :teachers
+  end
+
+  class Teacher < ActiveRecord::Base
+    has_and_belongs_to_many :students
+  end
+
+  before(:all) do
+    setup_db
+    student1 = Student.create(:name => 'first')
+    student2 = Student.create(:name => 'second')
+    teacher1 = Teacher.create(:name => 'first')
+    teacher2 = Teacher.create(:name => 'second')
+    student1.teachers = [teacher1, teacher2]
+    student2.teachers = [teacher1, teacher2]
+    teacher1.students << student1
+    teacher2.students << student2
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+
+  it "should detect unpreload associatoins" do
+    Student.find(:all).each do |student|
+      student.teachers.collect(&:name)
+    end
+    Bullet::Association.should be_has_unpreload_associations
+  end
+
+  it "should detect no unpreload associatoins" do
+    Student.find(:all, :include => :teachers).each do |student|
+      student.teachers.collect(&:name)
+    end
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+  
+  it "should detect unused preload associatoins" do
+    Student.find(:all, :include => :teachers).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should be_has_unused_preload_associations
+  end
+
+  it "should detect no unused preload associatoins" do
+    Student.find(:all).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_has_unused_preload_associations
+  end
+end
+
+describe Bullet::Association, 'has_many :through' do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :firms do |t|
+        t.column :name, :string
+      end
+      
+      create_table :clients do |t|
+        t.column :name, :string
+      end
+
+      create_table :relations do |t|
+        t.column :firm_id, :integer
+        t.column :client_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Firm < ActiveRecord::Base
+    has_many :relations
+    has_many :clients, :through => :relations
+  end
+
+  class Client < ActiveRecord::Base
+    has_many :relations
+    has_many :firms, :through => :relations
+  end
+
+  class Relation < ActiveRecord::Base
+    belongs_to :firm
+    belongs_to :client
+  end
+
+  before(:all) do
+    setup_db
+    firm1 = Firm.create(:name => 'first')
+    firm2 = Firm.create(:name => 'second')
+    client1 = Client.create(:name => 'first')
+    client2 = Client.create(:name => 'second')
+    firm1.clients = [client1, client2]
+    firm2.clients = [client1, client2]
+    client1.firms << firm1
+    client2.firms << firm2
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+
+  it "should detect unpreload associatoins" do
+    Firm.find(:all).each do |firm|
+      firm.clients.collect(&:name)
+    end
+    Bullet::Association.should be_has_unpreload_associations
+  end
+
+  it "should detect no unpreload associatoins" do
+    Firm.find(:all, :include => :clients).each do |firm|
+      firm.clients.collect(&:name)
+    end
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+
+  it "should detect no unused preload associatoins" do
+    Firm.find(:all).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_has_unused_preload_associations
+  end
+
+  it "should detect unused preload associatoins" do
+    Firm.find(:all, :include => :clients).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should be_has_unused_preload_associations
+  end
+end
+
+describe Bullet::Association, 'has_many :as' do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :votes do |t|
+        t.column :vote, :integer
+        t.references :voteable, :polymorphic => true
+      end
+      
+      create_table :users do |t|
+        t.column :name, :string
+      end
+
+      create_table :news do |t|
+        t.column :name, :string
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Vote < ActiveRecord::Base
+    belongs_to :voteable, :polymorphic => true
+  end
+
+  class User < ActiveRecord::Base
+    has_many :votes, :as => :voteable
+  end
+
+  class News < ActiveRecord::Base
+    has_many :votes, :as => :voteable
+  end
+
+  before(:all) do
+    setup_db
+    user1 = User.create(:name => 'first')
+    user2 = User.create(:name => 'second')
+    user1.votes << Vote.create(:vote => 10)
+    user1.votes << Vote.create(:vote => 20)
+    user2.votes << Vote.create(:vote => 10)
+    user2.votes << Vote.create(:vote => 20)
+
+    news1 = News.create(:name => 'first')
+    news2 = News.create(:name => 'second')
+    news1.votes << Vote.create(:vote => 10)
+    news1.votes << Vote.create(:vote => 20)
+    news2.votes << Vote.create(:vote => 10)
+    news2.votes << Vote.create(:vote => 20)
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+
+  it "should detect unpreload associatoins" do
+    User.find(:all).each do |user|
+      user.votes.collect(&:vote)
+    end
+    Bullet::Association.should be_has_unpreload_associations
+  end
+
+  it "should detect no unpreload associatoins" do
+    User.find(:all, :include => :votes).each do |user|
+      user.votes.collect(&:vote)
+    end
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+
+  it "should detect unpreload associatoins with voteable" do
+    Vote.find(:all).each do |vote|
+      vote.voteable.name
+    end
+    Bullet::Association.should be_has_unpreload_associations
+  end
+
+  it "should detect no unpreload associatoins with voteable" do
+    Vote.find(:all, :include => :voteable).each do |vote|
+      vote.voteable.name
+    end
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+  
+  it "should detect no unused preload associations" do
+    User.find(:all).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_has_unused_preload_associations
+  end
+  
+  it "should detect unused preload associations" do
+    User.find(:all, :include => :votes).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should be_has_unused_preload_associations
+  end
+  
+  it "should detect no unused preload associations with voteable" do
+    Vote.find(:all).collect(&:vote)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_has_unused_preload_associations
+  end
+
+  it "should detect unused preload associatoins with voteable" do
+    Vote.find(:all, :include => :voteable).collect(&:vote)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should be_has_unused_preload_associations
+  end
+end
+
+describe Bullet::Association, "has_one" do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :companies do |t|
+        t.column :name, :string
+      end
+
+      create_table :addresses do |t|
+        t.column :name, :string
+        t.column :company_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Company < ActiveRecord::Base
+    has_one :address
+  end
+
+  class Address < ActiveRecord::Base
+    belongs_to :company
+  end
+
+  before(:all) do
+    setup_db
+
+    company1 = Company.create(:name => 'first')
+    company2 = Company.create(:name => 'second')
+
+    Address.create(:name => 'first', :company => company1)
+    Address.create(:name => 'second', :company => company2)
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+
+  it "should detect unpreload association" do
+    Company.find(:all).each do |company|
+      company.address.name
+    end
+    Bullet::Association.should be_has_unpreload_associations
+  end
+
+  it "should detect no unpreload association" do
+    Company.find(:all, :include => :address).each do |company|
+      company.address.name
+    end
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+  
+  it "should detect no unused preload association" do
+    Company.find(:all).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_has_unused_preload_associations
+  end
+
+  it "should detect unused preload association" do
+    Company.find(:all, :include => :address).collect(&:name)
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should be_has_unused_preload_associations
+  end
+end
+
+describe Bullet::Association, "call one association that in possiable objects" do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :contacts do |t|
+        t.column :name, :string
+      end
+      
+      create_table :emails do |t|
+        t.column :name, :string
+        t.column :contact_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+  
+  class Contact < ActiveRecord::Base
+    has_many :emails
+  end
+  
+  class Email < ActiveRecord::Base
+    belongs_to :contact
+  end
+  
+  before(:all) do
+    setup_db
+    
+    contact1 = Contact.create(:name => 'first')
+    contact2 = Contact.create(:name => 'second')
+    
+    email1 = contact1.emails.create(:name => 'first')
+    email2 = contact1.emails.create(:name => 'second')
+    email3 = contact2.emails.create(:name => 'third')
+    email4 = contact2.emails.create(:name => 'fourth')
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+  
+  it "should detect no unpreload association" do
+    Contact.find(:all)
+    Contact.first.emails.collect(&:name)
+    Bullet::Association.should_not be_has_unpreload_associations
+  end
+end