bunyan 0.4.2 → 0.5.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+Version 0.5.0
+=============
+* Added ActiveRecord-style "silent" connection reconnect
+* Added #abort_on_failed_reconnect configuration option
+* Upped dependent version of mongo gem to ~> 1.2.4
+
 Version 0.4.0
 =============
 * New configuration syntax (see readme)

data/Gemfile

@@ -1,8 +1,8 @@
 source 'http://rubygems.org'
 
-gem 'bson_ext', '>=1.0.9'
+gem 'bson_ext', '>=1.2.4'
 gemspec
 
 group :test do
-  gem 'rspec', '>= 1.3.0'
+  gem 'rspec', '~> 1.3.0'
 end

data/Rakefile

@@ -7,13 +7,24 @@ begin
     gemspec.email = "ajsharp@gmail.com"
     gemspec.homepage = "http://github.com/ajsharp/bunyan"
     gemspec.authors = ["Alex Sharp"]
-    gemspec.add_dependency 'mongo',     '~> 1.0.9'
+    gemspec.add_dependency 'mongo',     '~> 1.2.4'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end
 
-task :default do
-  system("spec spec")
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new
+
+  Spec::Rake::SpecTask.new(:specs_with_coverage) do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
+  end
+rescue LoadError
 end
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/bunyan.gemspec

@@ -1,66 +1,68 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{bunyan}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Sharp"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2011-03-31}
   s.description = %q{Bunyan is a thin ruby wrapper around a MongoDB capped collection, created with high-performance, flexible logging in mind.}
   s.email = %q{ajsharp@gmail.com}
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG.md",
-     "Gemfile",
-     "Gemfile.lock",
-     "MIT-LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "bunyan.gemspec",
-     "examples/middleware.rb",
-     "examples/rails.rb",
-     "lib/bunyan.rb",
-     "lib/bunyan/config.rb",
-     "lib/bunyan/configurable_methods.rb",
-     "spec/bunyan_spec.rb",
-     "spec/config_spec.rb",
-     "spec/integration_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "CHANGELOG.md",
+    "Gemfile",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bunyan.gemspec",
+    "examples/middleware.rb",
+    "examples/rails.rb",
+    "lib/bunyan.rb",
+    "lib/bunyan/config.rb",
+    "lib/bunyan/configurable_methods.rb",
+    "spec/bunyan_spec.rb",
+    "spec/config_spec.rb",
+    "spec/integration_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/ajsharp/bunyan}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{A MongoDB-based logging solution.}
   s.test_files = [
+    "examples/middleware.rb",
+    "examples/rails.rb",
     "spec/bunyan_spec.rb",
-     "spec/config_spec.rb",
-     "spec/integration_spec.rb",
-     "spec/spec_helper.rb",
-     "examples/middleware.rb",
-     "examples/rails.rb"
+    "spec/config_spec.rb",
+    "spec/integration_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongo>, ["~> 1.0.9"])
+      s.add_runtime_dependency(%q<bson_ext>, [">= 1.2.4"])
+      s.add_runtime_dependency(%q<bunyan>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo>, ["~> 1.2.4"])
     else
-      s.add_dependency(%q<mongo>, ["~> 1.0.9"])
+      s.add_dependency(%q<bson_ext>, [">= 1.2.4"])
+      s.add_dependency(%q<bunyan>, [">= 0"])
+      s.add_dependency(%q<mongo>, ["~> 1.2.4"])
     end
   else
-    s.add_dependency(%q<mongo>, ["~> 1.0.9"])
+    s.add_dependency(%q<bson_ext>, [">= 1.2.4"])
+    s.add_dependency(%q<bunyan>, [">= 0"])
+    s.add_dependency(%q<mongo>, ["~> 1.2.4"])
   end
 end
 

data/lib/bunyan.rb

@@ -14,17 +14,19 @@ module Bunyan
 
     attr_reader :db, :connection, :collection, :config
 
-    # Bunyan::Logger.configure do
-    #   # required options
-    #   database   'bunyan_logger'
-    #   collection 'development_log'
+    # @example Configuring bunyan
+    #   Bunyan::Logger.configure do
+    #     # required options
+    #     database   'bunyan_logger'
+    #     collection 'development_log'
     #
-    #   # optional options
-    #   disabled true
-    #   size 52428800 # 50.megabytes in Rails
-    # end
+    #     # optional options
+    #     disabled true
+    #     size 52428800 # 50.megabytes in Rails
+    #   end
     def configure(&block)
       @config = Logger::Config.new
+      @config.abort_on_failed_reconnect = false
 
       # provide legacy support for old configuration syntax
       (block.arity > 0) ? yield(@config) : @config.instance_eval(&block)
@@ -46,8 +48,26 @@ module Bunyan
     def method_missing(method, *args, &block)
       begin
         collection.send(method, *args) if database_is_usable?
-      rescue
-        super(method, *args, &block)
+      rescue Mongo::ConnectionFailure
+        # At this point, the problem may be that the server was restarted
+        # and we have stale connection object. The mongo ruby driver will
+        # handle automatically handling a reconnect, and will issue a fresh
+        # connection object if it can obtain one. In which case, let's try
+        # the query again.
+        begin
+          collection.send(method, *args, &block) if database_is_usable?
+        rescue Mongo::ConnectionFailure => e
+          # Ok, we're having real connection issues. The mongod server is likely
+          # down. We still may want to fail silently, because bunyan is mostly a support
+          # library, and we wouldn't want exceptions to bubble up just b/c the
+          # mongod server is down. If it were the core datastore, then we probably
+          # would want it to bubble up.
+          #
+          # If you for some reason you do want error to bubble up, set the
+          # `abort_on_failed_reconnect` config option to true.
+
+          raise e if config.abort_on_failed_reconnect?
+        end
       end
     end
 

data/lib/bunyan/config.rb

@@ -5,7 +5,7 @@ module Bunyan
 
     class Config
       extend Bunyan::ConfigurableMethods
-      configurable_methods :port, :host, :database, :collection, :disabled, :connection
+      configurable_methods :port, :host, :database, :collection, :disabled, :connection, :abort_on_failed_reconnect
 
       def initialize
         @size     = 52428800
@@ -20,6 +20,10 @@ module Bunyan
         !!@disabled
       end
 
+      def abort_on_failed_reconnect?
+        !!@abort_on_failed_reconnect
+      end
+
       # default size is 50 megabytes
       def size(new_size = nil)
         new_size.nil? ? @size : @size = new_size

data/spec/bunyan_spec.rb

@@ -28,25 +28,111 @@ describe Bunyan::Logger do
 end
 
 describe 'when a mongod instance is not running' do
-  before do
-    Mongo::Connection.stub!(:new).and_raise(Mongo::ConnectionFailure)
-  end
+  context "when initializing the bunyan setup" do
+    before do
+      Mongo::Connection.stub!(:new).and_raise(Mongo::ConnectionFailure)
+    end
 
-  it 'should not blow up' do
-    lambda {
+    it 'should not blow up' do
+      lambda {
+        Bunyan::Logger.configure do |c|
+          c.database   'doesnt_matter'
+          c.collection 'b/c mongod isnt running'
+        end
+      }.should_not raise_exception(Mongo::ConnectionFailure)
+    end
+
+    it 'should mark bunyan as disabled' do
       Bunyan::Logger.configure do |c|
         c.database   'doesnt_matter'
         c.collection 'b/c mongod isnt running'
       end
-    }.should_not raise_exception(Mongo::ConnectionFailure)
+      Bunyan::Logger.should be_disabled
+    end
   end
 
-  it 'should mark bunyan as disabled' do
-    Bunyan::Logger.configure do |c|
-      c.database   'doesnt_matter'
-      c.collection 'b/c mongod isnt running'
+  context "when sending queries to Bunyan when a connection error occurs" do
+    class Mongo::Connection
+      attr_accessor :conn_fail
+
+      def new_send_message_on_socket(*args)
+        if conn_fail && conn_fail > 0
+          self.conn_fail -= 1
+          raise Mongo::ConnectionFailure
+        else
+          old_send_message_on_socket(*args)
+        end
+      end
+    end
+
+    before do
+      Mongo::Connection.send(:alias_method, :old_send_message_on_socket, :send_message_on_socket)
+      Mongo::Connection.send(:alias_method, :send_message_on_socket, :new_send_message_on_socket)
+    end
+
+    after do
+      Mongo::Connection.send(:alias_method, :send_message_on_socket, :old_send_message_on_socket)
+    end
+
+    before do
+      unstub_mongo
+      configure_test_db
+    end
+
+    it "should not raise an exception" do
+      Bunyan::Logger.connection.conn_fail = 1
+
+      lambda {
+        Bunyan::Logger.count
+      }.should_not raise_error(Mongo::ConnectionFailure)
+    end
+
+    context "by default" do
+      it "should not raise an exception if a connection error occurs on multiple requests" do
+        Bunyan::Logger.connection.conn_fail = 2
+
+        lambda {
+          Bunyan::Logger.count
+        }.should_not raise_error(Mongo::ConnectionFailure)
+      end
+    end
+
+    context "when abort_on_failed_reconnect is true" do
+      before do
+        configure_test_db do |c|
+          c.abort_on_failed_reconnect true
+        end
+      end
+
+      it "should raise an exception when more than one failed request occurs" do
+        Bunyan::Logger.connection.conn_fail = 2
+
+        lambda {
+          Bunyan::Logger.count
+        }.should raise_error(Mongo::ConnectionFailure)
+      end
+
+      it "should not raise an error when only one failed request occurs" do
+        Bunyan::Logger.connection.conn_fail = 1
+
+        lambda {
+          Bunyan::Logger.count
+        }.should_not raise_error(Mongo::ConnectionFailure)
+      end
+    end
+
+    it "should raise errors at the mongo level" do
+      # This is really a test to make sure our crazy stubbing magic
+      # above is working properly. It has nothing to do with actual
+      # library behavior.
+      Bunyan::Logger.connection.conn_fail = 1
+      db = Bunyan::Logger.db
+      coll = db.collection('no_op_collection')
+
+      lambda {
+        coll.count
+      }.should raise_error(Mongo::ConnectionFailure)
     end
-    Bunyan::Logger.should be_disabled
   end
 end
 

data/spec/config_spec.rb

@@ -210,4 +210,49 @@ describe 'the old configuration syntax' do
     
     Bunyan::Logger.config.database.should == 'old_config_db'
   end
-end
+end
+
+describe Bunyan::Logger::Config, '#abort_on_failed_reconnect' do
+  subject { Bunyan::Logger.config.abort_on_failed_reconnect }
+
+  it 'defaults to false' do
+    configure_test_db
+    subject.should be_false
+  end
+
+  it 'can be set to true in the config block' do
+    configure_test_db do |c|
+      c.abort_on_failed_reconnect true
+    end
+
+    subject.should be_true
+  end
+
+  it 'can be set to false in the config block' do
+    configure_test_db do |c|
+      c.abort_on_failed_reconnect false
+    end
+
+    subject.should be_false
+  end
+
+  describe "#abort_on_failed_reconnect?" do
+    subject { Bunyan::Logger.config.abort_on_failed_reconnect? }
+
+    it "should returns true when set to true" do
+      configure_test_db { |c| c.abort_on_failed_reconnect true }
+
+      subject.should be_true
+    end
+
+    it "should return false when set to false" do
+      configure_test_db { |c| c.abort_on_failed_reconnect false }
+      subject.should be_false
+    end
+
+    it "should return false by default" do
+      subject.should be_false
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -28,6 +28,10 @@ Spec::Runner.configure do |config|
     @mock_database
   end
 
+  def unstub_mongo
+    Mongo::Connection.unstub!(:new)
+  end
+
   def other_fake_mongo
     #I want to check Mongo::Connection.stub.new is not called
     dm = DuckedMongo
@@ -35,10 +39,11 @@ Spec::Runner.configure do |config|
     dm
   end
 
-  def configure_test_db
-    Bunyan::Logger.configure do |config|
-      config.database   'bunyan_test'
-      config.collection 'bunyan_test_log'
+  def configure_test_db(&block)
+    Bunyan::Logger.configure do |c|
+      c.database   'bunyan_test'
+      c.collection 'bunyan_test_log'
+      yield(c) if block_given?
     end
   end
 end

metadata

@@ -2,12 +2,12 @@
 name: bunyan
 version: !ruby/object:Gem::Version 
   hash: 11
-  prerelease: false
+  prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Alex Sharp
@@ -15,25 +15,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 -07:00
+date: 2011-03-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mongo
   prerelease: false
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 23
         segments: 
         - 1
+        - 2
+        - 4
+        version: 1.2.4
+  name: bson_ext
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 0
-        - 9
-        version: 1.0.9
+        version: "0"
+  name: bunyan
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  name: mongo
+  version_requirements: *id003
 description: Bunyan is a thin ruby wrapper around a MongoDB capped collection, created with high-performance, flexible logging in mind.
 email: ajsharp@gmail.com
 executables: []
@@ -43,10 +73,8 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
-- .gitignore
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -67,8 +95,8 @@ homepage: http://github.com/ajsharp/bunyan
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -92,14 +120,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A MongoDB-based logging solution.
 test_files: 
+- examples/middleware.rb
+- examples/rails.rb
 - spec/bunyan_spec.rb
 - spec/config_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
-- examples/middleware.rb
-- examples/rails.rb

data/.gitignore

@@ -1,4 +0,0 @@
-.bundle
-coverage
-pkg
-.rvmrc

data/Gemfile.lock

@@ -1,23 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bunyan (0.4.1)
-      mongo (~> 1.0.9)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    bson (1.1)
-    bson_ext (1.1)
-    mongo (1.0.9)
-      bson (>= 1.0.5)
-    rspec (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bson_ext (>= 1.0.9)
-  bunyan!
-  mongo (~> 1.0.9)
-  rspec (>= 1.3.0)