bunyan 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+Version 0.4.0
+=============
+* New configuration syntax (see readme)
+* Ability to pass in custom connection object
+
 Version 0.3.0
 =============
 * Can now specify and connect a remote host and alternate port

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+ Copyright (c) 2010 Alex Sharp
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THEse, and/or sell
+ copies of the Software, and to permit p

data/README.md

@@ -1,9 +1,15 @@
 Bunyan
 ======
+![](http://img2.timeinc.net/ew/dynamic/imgs/080612/Paul-Bunyan-Blue-Ox_l.jpg)
+
 Bunyan is a thin ruby wrapper around a MongoDB [capped collection](http://www.mongodb.org/display/DOCS/Capped+Collections), 
 created with high-performance, flexible logging in mind.
 
-![](http://img2.timeinc.net/ew/dynamic/imgs/080612/Paul-Bunyan-Blue-Ox_l.jpg)
+Bunyan is not intended to be used as a drop-in replacement for the default
+rails logger. If you need to do this, please see peburrows' [mongo\_db\_logger](http://github.com/peburrows/mongo_db_logger).
+
+However, there is planned support for a flexible middleware component to drop in
+to your rails app. 
 
 Install
 =======
@@ -16,15 +22,20 @@ The only configuration options required are the database and collection name.
 For rails apps, put the following config block in an initializer.
 
     # config/initializers/bunyan.rb
-    Bunyan::Logger.configure do |config|
+    Bunyan::Logger.configure do
       # required options
-      config.database   'bunyan_logger'
-      config.collection 'development_log'
+      database   'bunyan_logger'
+      collection 'development_log'
 
       # optional
-      config.host     'some.remote.host' # defaults to localhost
-      config.port     '12345'            # defaults to 27017
-      config.disabled true
+      host     'some.remote.host' # defaults to localhost
+      port     '12345'            # defaults to 27017
+      disabled true
+
+      # other connection option
+      # Specify a valid ruby driver connection object (single / pair)
+      # if you do so, host / port are ignored 
+      connection = $connection
     end
 
 Usage
@@ -58,9 +69,9 @@ More
 
 TODO
 ====
-* Ability to specify auth creds for making mongo connection
+* Ability to specify auth creds for making a mongo connection
 * <del>Fail silently if no mongo server running</del>
 * Ability to limit bunyan to only run in certain environments
 * Add middleware client for easy drop-in to rails/rack apps
-<del>* Add ability to connect to a remote mongo server</del>
+* <del>Add ability to connect to a remote mongo server</del>
 * <del>Ability to configure size of capped collection</del>

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bunyan.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bunyan}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Sharp"]
-  s.date = %q{2010-04-12}
+  s.date = %q{2010-08-14}
   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 = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     ".gitignore",
      "CHANGELOG.md",
      "Gemfile",
+     "MIT-LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
@@ -26,8 +27,10 @@ Gem::Specification.new do |s|
      "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"
   ]
@@ -39,6 +42,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/bunyan_spec.rb",
      "spec/config_spec.rb",
+     "spec/integration_spec.rb",
      "spec/spec_helper.rb",
      "examples/rails.rb"
   ]

data/lib/bunyan/config.rb

@@ -1,10 +1,11 @@
+require 'bunyan/configurable_methods'
 
 module Bunyan
   class Logger
 
     class Config
-      # used to hold all user-defined configuration options
-      attr_accessor :collection, :database, :disabled
+      extend Bunyan::ConfigurableMethods
+      configurable_methods :port, :host, :database, :collection, :disabled, :connection
 
       def initialize
         @size     = 52428800
@@ -15,36 +16,6 @@ module Bunyan
         send(meth)
       end
 
-      def port(port_num = nil)
-        @port ||= port_num
-      end
-      alias_method :port=, :port
-
-      def host(host_address = nil)
-        @host ||= host_address
-      end
-      alias_method :host=, :host
-
-      # First time called sets the database name. 
-      # Otherwise, returns the database name.
-      def database(db_name = nil)
-        @database ||= db_name
-      end
-      alias_method :database=, :database
-
-      # First time called sets the collection name. 
-      # Otherwise, returns the collection name.
-      # For the actual collection object returned by Mongo, see #db.
-      def collection(coll = nil)
-        @collection ||= coll
-      end
-      alias_method :collection=, :collection
-
-      def disabled(dis = nil)
-        @disabled ||= dis
-      end
-      alias_method :disabled=, :disabled
-
       def disabled?
         !!@disabled
       end

data/lib/bunyan/configurable_methods.rb

@@ -0,0 +1,17 @@
+module Bunyan
+  module ConfigurableMethods
+    private
+      def configurable_method(method_name)
+        class_eval %Q{
+          def #{method_name}(local_#{method_name} = nil)
+            @#{method_name} ||= local_#{method_name}
+          end
+          alias_method :#{method_name}=, :#{method_name}
+        }
+      end
+
+      def configurable_methods(*methods)
+        methods.each { |method| configurable_method(method) }
+      end
+  end
+end

data/lib/bunyan.rb

@@ -14,19 +14,20 @@ module Bunyan
 
     attr_reader :db, :connection, :collection, :config
 
-    # Bunyan::Logger.configure do |config|
+    # Bunyan::Logger.configure do
     #   # required options
-    #   config.database   'bunyan_logger'
-    #   config.collection 'development_log'
+    #   database   'bunyan_logger'
+    #   collection 'development_log'
     #
     #   # optional options
-    #   config.disabled true
-    #   config.size 52428800 # 50.megabytes in Rails
+    #   disabled true
+    #   size 52428800 # 50.megabytes in Rails
     # end
     def configure(&block)
       @config = Logger::Config.new
 
-      yield @config
+      # provide legacy support for old configuration syntax
+      (block.arity > 0) ? yield(@config) : @config.instance_eval(&block)
 
       ensure_required_options_exist
       initialize_connection unless disabled?
@@ -34,7 +35,7 @@ module Bunyan
     end
 
     def configured?
-      @configured
+      !!@configured
     end
 
     def disabled?
@@ -58,8 +59,13 @@ module Bunyan
     private
       def initialize_connection
         begin
-          @db         = Mongo::Connection.new(config.host, config.port).db(config.database)
-          @connection = @db.connection
+          if (config.connection)
+            @connection = config.connection
+            @db = @connection.db
+          else
+            @db = Mongo::Connection.new(config.host, config.port).db(config.database)
+            @connection = @db.connection
+          end
           @collection = retrieve_or_initialize_collection(config.collection)
         rescue Mongo::ConnectionFailure => ex
           # @TODO: I don't like how I'm overloading @config.disabled

data/spec/config_spec.rb

@@ -43,7 +43,15 @@ describe Bunyan::Logger::Config, 'when setting the collection size' do
 end
 
 describe Bunyan::Logger::Config, 'when getting the collection size' do
-  it 'should return the collection size'
+  it 'should return the collection size' do
+    Bunyan::Logger.configure do |c|
+      c.database   'test_db'
+      c.collection 'test_collection'
+      c.size       2929
+    end
+
+    Bunyan::Logger.config.size.should == 2929
+  end
 end
 
 describe Bunyan::Logger::Config, 'alternate method invocation syntax' do
@@ -158,3 +166,48 @@ describe 'when we configure a port' do
   end
 end
 
+describe 'when we set a connection' do
+
+  def configure_with_connection
+    Bunyan::Logger.configure do |c|
+      c.connection = other_fake_mongo
+      c.port       '20910'
+      c.database   'test_db'
+      c.collection 'test_collection'
+    end
+  end
+
+  it 'should not set a connection based on other params' do
+    Mongo::Connection.should_not_receive(:new)
+    configure_with_connection
+  end
+
+  it 'should set the db field' do
+    Mongo::Connection.should_not_receive(:new)
+    configure_with_connection
+    Bunyan::Logger.db.should eql(@mock_database)
+  end
+  
+end
+
+describe 'the new configuration syntax' do
+  it 'should allow argument-less block configuration syntax' do
+    Bunyan::Logger.configure do
+      database   'new_config_db'
+      collection 'new_config_collection'
+    end
+    
+    Bunyan::Logger.config.database.should == 'new_config_db'
+  end
+end
+
+describe 'the old configuration syntax' do
+  it 'should allow the configuration object to be passed in to the configure block' do
+    Bunyan::Logger.configure do |c|
+      c.database   'old_config_db'
+      c.collection 'old_config_collection'
+    end
+    
+    Bunyan::Logger.config.database.should == 'old_config_db'
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'making a mongodb connection with the new configuration syntax' do
+  def configure_db_with_new_syntax
+    Bunyan::Logger.configure do
+      database   'bunyan_integration_db'
+      collection 'test_integration'
+    end
+  end
+  
+  before do
+    Mongo::Connection.unstub!(:new)
+    configure_db_with_new_syntax
+    @params = {:request_uri => '/', :response_code => 200}
+  end
+    
+  it 'should allow inserting documents' do
+    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectID
+  end
+  
+  it 'should allow querying documents' do
+    Bunyan::Logger.insert(@params)
+    Bunyan::Logger.find(@params).count.should == 1
+  end
+end
+
+describe 'making a mongodb connection with the old configuration syntax' do
+  def configure_db_with_old_syntax
+    Bunyan::Logger.configure do |c|
+      c.database   'bunyan_integration_db'
+      c.collection 'test_integration'
+    end
+  end
+  
+  before do
+    Mongo::Connection.unstub!(:new)
+    configure_db_with_old_syntax
+    @params = {:request_uri => '/', :response_code => 200}
+  end
+    
+  it 'should allow inserting documents' do
+    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectID
+  end
+  
+  it 'should allow querying documents' do
+    Bunyan::Logger.insert(@params)
+    Bunyan::Logger.find(@params).count.should == 1
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ Bundler.require :default, :test
 require File.expand_path(File.dirname(__FILE__) + '/../lib/bunyan')
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 
+class DuckedMongo
+end
+
 Spec::Runner.configure do |config|
 
   config.before :each do
@@ -25,6 +28,13 @@ Spec::Runner.configure do |config|
     @mock_database
   end
 
+  def other_fake_mongo
+    #I want to check Mongo::Connection.stub.new is not called
+    dm = DuckedMongo
+    dm.stub!(:db).and_return(@mock_database)
+    dm
+  end
+
   def configure_test_db
     Bunyan::Logger.configure do |config|
       config.database   'bunyan_test'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Alex Sharp
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-12 00:00:00 -07:00
+date: 2010-08-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - VERSION
@@ -64,8 +65,10 @@ files:
 - 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
 has_rdoc: true
@@ -101,5 +104,6 @@ summary: A MongoDB-based logging solution.
 test_files: 
 - spec/bunyan_spec.rb
 - spec/config_spec.rb
+- spec/integration_spec.rb
 - spec/spec_helper.rb
 - examples/rails.rb