bullet 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ebb362baca8a029544d754fed872a09f7033377
-  data.tar.gz: f12124695713d21526305a4c381160048cdc93d6
+  metadata.gz: f5d5793126ed37cd4f560144b157258999c0b318
+  data.tar.gz: 56e7d6b4a5d4a2fda7bcc9707523e4863159aa83
 SHA512:
-  metadata.gz: 7aac621e2ddb3931bb385017401121641027980ebddf0d82d1b43c9a71040a7c2eba3af2c4cb7862d69f9c31c99ac1e124f6a60bd9be6e8388199c187effc98f
-  data.tar.gz: 721e946c60ebc8de7bd6c609abb90a9fd29c5c4df2ac275b8bb607e64cffcd86887fa7fc0c82fdd86303faf77d251519b49314dc9af1032131af039b9fd5f868
+  metadata.gz: 817982d863e94c8fb85379b07006536e83c4ea97e0b92a9f7cc4a1444dcba2f4743202a25a9a6f68b9be2cad20985bd6fb5c0a45a4015a93e782ac4eaaa95da9
+  data.tar.gz: 14311a13bfd4b6bcd88f2f72271b3e39a681ee19c13d42aeba4318a7826e4e927792479b75f6d07357725699dd6d0a0d7b6c2545e3f37ed4d24fb86766d10b20

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1.1
 gemfile:
   - Gemfile.rails-4.1
   - Gemfile.rails-4.0

data/CHANGELOG.md

@@ -3,7 +3,7 @@
 ## 4.8.0 (02/16/2014)
 
 * Support rails 4.1.0.beta1
-* Update specs to be RSepc 3.0 compatible
+* Update specs to be RSpec 3.0 compatible
 * Update latest minor version activerecord and mongoid on travis
 
 ## 4.7.0 (11/03/2013)

data/Gemfile.rails-3.2

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.15'
+gem 'rails', '~> 3.2.17'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'mysql2', platforms: [:ruby]

data/Gemfile.rails-4.0

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.0.1'
+gem 'rails', '~> 4.0.4'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'mysql2', platforms: [:ruby]

data/Gemfile.rails-4.1

@@ -2,9 +2,11 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '4.1.0.beta1'
+gem 'rails', '~> 4.1.0'
 gem 'sqlite3'
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'mysql2'
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
@@ -12,3 +14,8 @@ gem "guard"
 gem "guard-rspec"
 
 gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/README.md

@@ -53,8 +53,10 @@ config.after_initialize do
                   :receiver => 'your_account@jabber.org',
                   :show_online_status => true }
   Bullet.rails_logger = true
+  Bullet.bugsnag = true
   Bullet.airbrake = true
   Bullet.add_footer = true
+  Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
 end
 ```
 
@@ -71,9 +73,10 @@ The code above will enable all seven of the Bullet notification systems:
 * `Bullet.xmpp`: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the bullet account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the bullet account won't announce it's online status anymore.
 * `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
 * `Bullet.add_footer`: adds the details in the bottom left corner of the page
+* `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
 
 Bullet also allows you to disable n_plus_one_query, unused_eager_loading
-and counter_cache detectors respectively
+and counter_cache detectors respectively.
 
 ```ruby
 Bullet.n_plus_one_query_enable = false

data/bullet.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
 
   s.add_dependency "activesupport"
-  s.add_dependency "uniform_notifier", ">= 1.4.0"
+  s.add_dependency "uniform_notifier", "~> 1.6.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/bullet.rb

@@ -25,11 +25,11 @@ module Bullet
   end
 
   class << self
-    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable
+    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes
     attr_reader :notification_collector, :whitelist
     attr_accessor :add_footer
 
-    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :to => UniformNotifier
+    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :bugsnag=, :to => UniformNotifier
 
     def raise=(should_raise)
       UniformNotifier.raise=(should_raise ? Notification::UnoptimizedQueryError : false)
@@ -64,9 +64,13 @@ module Bullet
       self.enable? && !!@counter_cache_enable
     end
 
+    def stacktrace_includes
+      @stacktrace_includes || []
+    end
+
     def add_whitelist(options)
       @whitelist[options[:type]][options[:class_name].classify] ||= []
-      @whitelist[options[:type]][options[:class_name].classify] << options[:association]
+      @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_sym
     end
 
     def get_whitelist_associations(type, class_name)

data/lib/bullet/active_record3x.rb

@@ -93,7 +93,7 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        def has_cached_counter?(reflection = reflection)
+        def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
           Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
           result

data/lib/bullet/active_record4.rb

@@ -93,7 +93,7 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        def has_cached_counter?(reflection = reflection)
+        def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
           Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
           result

data/lib/bullet/active_record41.rb

@@ -86,7 +86,7 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        def has_cached_counter?(reflection = reflection)
+        def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
           Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
           result

data/lib/bullet/detector/n_plus_one_query.rb

@@ -50,7 +50,10 @@ module Bullet
           def caller_in_project
             app_root = rails? ? Rails.root.to_s : Dir.pwd
             vendor_root = app_root + "/vendor"
-            caller.select { |c| c.include?(app_root) && !c.include?(vendor_root) }
+            caller.select do |c|
+              c.include?(app_root) && !c.include?(vendor_root) ||
+              Bullet.stacktrace_includes.any? { |include| c.include?(include) }
+            end
           end
 
           def possible?(bullet_ar_key)

data/lib/bullet/notification/base.rb

@@ -40,17 +40,26 @@ module Bullet
       end
 
       def notify_inline
-        self.notifier.inline_notify(self.full_notice)
+        self.notifier.inline_notify(notification_data)
       end
 
       def notify_out_of_channel
-        self.notifier.out_of_channel_notify(self.full_notice)
+        self.notifier.out_of_channel_notify(notification_data)
       end
 
       def short_notice
         [whoami, url, title, body].compact.join("\n")
       end
 
+      def notification_data
+        {
+          :user => whoami,
+          :url => url,
+          :title => title,
+          :body => body_with_caller,
+        }
+      end
+
       def eql?(other)
         klazz_associations_str == other.klazz_associations_str
       end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -21,7 +21,7 @@ module Bullet
 
       protected
         def call_stack_messages
-          @callers.unshift('N+1 Query method call stack').join( "\n  " )
+          (['N+1 Query method call stack'] + @callers).join( "\n  " )
         end
     end
   end

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "4.8.0"
+  VERSION = "4.9.0"
 end

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -93,6 +93,34 @@ module Bullet
         end
       end
 
+      context ".caller_in_project" do
+        it "should include only paths that are in the project" do
+          in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
+          not_in_project = '/def/def.rb'
+
+          expect(NPlusOneQuery).to receive(:caller).and_return([in_project, not_in_project])
+          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_ar_key, :association).and_return(true)
+          expect(NPlusOneQuery).to receive(:create_notification).with([in_project], "Post", :association)
+          NPlusOneQuery.call_association(@post, :association)
+        end
+
+        context "stacktrace_includes" do
+          before { Bullet.stacktrace_includes = [ 'def' ] }
+          after { Bullet.stacktrace_includes = nil }
+
+          it "should include paths that are in the stacktrace_include list" do
+            in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
+            included_gem = '/def/def.rb'
+            excluded_gem = '/ghi/ghi.rb'
+
+            expect(NPlusOneQuery).to receive(:caller).and_return([in_project, included_gem, excluded_gem])
+            expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_ar_key, :association).and_return(true)
+            expect(NPlusOneQuery).to receive(:create_notification).with([in_project, included_gem], "Post", :association)
+            NPlusOneQuery.call_association(@post, :association)
+          end
+        end
+      end
+
       context ".add_possible_objects" do
         it "should add possible objects" do
           NPlusOneQuery.add_possible_objects([@post, @post2])

data/spec/bullet/notification/base_spec.rb

@@ -49,12 +49,22 @@ module Bullet
         end
       end
 
+      context "#notification_data" do
+        it "should return notification data" do
+          allow(subject).to receive(:whoami).and_return("whoami")
+          allow(subject).to receive(:url).and_return("url")
+          allow(subject).to receive(:title).and_return("title")
+          allow(subject).to receive(:body_with_caller).and_return("body_with_caller")
+          expect(subject.notification_data).to eq(:user => "whoami", :url => "url", :title => "title", :body => "body_with_caller")
+        end
+      end
+
       context "#notify_inline" do
         it "should send full_notice to notifier" do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:full_notice).and_return("full_notice")
-          expect(notifier).to receive(:inline_notify).with("full_notice")
+          allow(subject).to receive(:notification_data).and_return(:foo => :bar)
+          expect(notifier).to receive(:inline_notify).with(:foo => :bar)
           subject.notify_inline
         end
       end
@@ -63,8 +73,8 @@ module Bullet
         it "should send full_out_of_channel to notifier" do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:full_notice).and_return("full_notice")
-          expect(notifier).to receive(:out_of_channel_notify).with("full_notice")
+          allow(subject).to receive(:notification_data).and_return(:foo => :bar)
+          expect(notifier).to receive(:out_of_channel_notify).with(:foo => :bar)
           subject.notify_out_of_channel
         end
       end

data/spec/bullet/notification/n_plus_one_query_spec.rb

@@ -6,6 +6,7 @@ module Bullet
       subject { NPlusOneQuery.new([["caller1", "caller2"]], Post, [:comments, :votes], "path") }
 
       it { expect(subject.body_with_caller).to eq("  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2") }
+      it { expect([ subject.body_with_caller, subject.body_with_caller]).to eq([ "  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2", "  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2" ]) }
       it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]") }
       it { expect(subject.title).to eq("N+1 Query in path") }
     end

data/spec/spec_helper.rb

@@ -13,6 +13,10 @@ module Rails
     def root
       File.expand_path(__FILE__).split('/')[0..-3].join('/')
     end
+
+    def env
+      "test"
+    end
   end
 end
 
@@ -51,10 +55,6 @@ if active_record?
       Support::SqliteSeed.setup_db
       Support::SqliteSeed.seed_db
     end
-
-    config.after(:suite) do
-      Support::SqliteSeed.teardown_db
-    end
   end
 
   if ENV["LOG"]

data/spec/support/sqlite_seed.rb

@@ -224,12 +224,6 @@ module Support
       end
     end
 
-    def teardown_db
-      ActiveRecord::Base.connection.tables.each do |table|
-        ActiveRecord::Base.connection.drop_table(table)
-      end
-    end
-
     extend self
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: uniform_notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
 description: help to kill N+1 queries and unused eager loading.
 email:
 - flyerhzm@gmail.com
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.