bunyan 0.1.0 → 0.2.0

data/.gitignore

@@ -1 +1,3 @@
 .bundle
+coverage
+pkg

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Version 0.2.0
+=============
+* Moved all configuration-related stuff to the Config class
+* Added ability to set the collection size in configuration block
+* Bunyan attributes (:connection, :collection, :db) now map directly to mongo counterparts

data/README.md

@@ -13,7 +13,7 @@ Configure
 =========
 The only configuration options required are the database and collection name.
 
-For rails apps, puts the config block in an initializer.
+For rails apps, put the following config block in an initializer.
 
     # config/initializers/bunyan.rb
     Bunyan::Logger.configure do |config|
@@ -58,3 +58,4 @@ TODO
 ====
 * Ability to limit bunyan to only run in certain environments
 * Add middleware client for easy drop-in to rails/rack apps
+* <del>Ability to configure size of capped collection</del>

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bunyan.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bunyan}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Sharp"]
-  s.date = %q{2010-03-17}
+  s.date = %q{2010-03-20}
   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 = [
@@ -17,13 +17,17 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "CHANGELOG.md",
      "Gemfile",
      "README.md",
      "Rakefile",
      "VERSION",
      "bunyan.gemspec",
+     "examples/rails.rb",
      "lib/bunyan.rb",
+     "lib/bunyan/config.rb",
      "spec/bunyan_spec.rb",
+     "spec/config_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -34,7 +38,10 @@ Gem::Specification.new do |s|
   s.summary = %q{A MongoDB-based logging solution.}
   s.test_files = [
     "spec/bunyan_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/config_spec.rb",
+     "spec/integration/non_rails_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/rails.rb"
   ]
 
   if s.respond_to? :specification_version then

data/examples/rails.rb

@@ -0,0 +1,11 @@
+
+# put in config/initializers/bunyan.rb
+Bunyan::Logger.configure do |config|
+  # required options
+  config.database   "bunyan_logger"
+  config.collection "#{RAILS_ENV}_log"
+
+  # optional
+  config.size       75.megabytes
+end
+

data/lib/bunyan.rb

@@ -1,59 +1,49 @@
 require 'rubygems'
-
-#gem 'mongo_ext'
-
 require 'mongo'
 require 'singleton'
 
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require 'bunyan/config'
+
 module Bunyan
   class Logger
     include Singleton
 
     class InvalidConfigurationError < RuntimeError; end
 
-    attr_reader :db, :connection, :config
+    attr_reader :db, :connection, :collection, :config
 
     # Bunyan::Logger.configure do |config|
     #   # required options
     #   config.database   'bunyan_logger'
     #   config.collection 'development_log'
+    #
+    #   # optional options
+    #   config.disabled true
+    #   config.size 52428800 # 50.megabytes in Rails
     # end
     def configure(&block)
-      @config = {}
+      @config = Logger::Config.new
 
-      yield self
+      yield @config
 
       ensure_required_options_exist
       initialize_connection unless disabled?
+      @configured = true
     end
 
-    # First time called sets the database name. 
-    # Otherwise, returns the database name.
-    def database(db_name = nil)
-      @config[: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)
-      @config[:collection] ||= coll
+    def configured?
+      @configured
     end
-    alias_method :collection=, :collection
-
-    def disabled(dis = nil)
-      @config[:disabled] ||= dis
-    end
-    alias_method :disabled=, :disabled
 
     def disabled?
-      !!disabled
+      !!config.disabled
     end
 
     def method_missing(method, *args, &block)
       begin
-        db.send(method, *args)
+        collection.send(method, *args) if database_is_usable?
       rescue
         super(method, *args, &block)
       end
@@ -66,25 +56,31 @@ module Bunyan
 
     private
       def initialize_connection
-        @connection  = Mongo::Connection.new.db(database)
-        @db          = retrieve_or_initialize_collection(collection)
+        @db         = Mongo::Connection.new.db(config.database)
+        @connection = @db.connection
+        @collection = retrieve_or_initialize_collection(config.collection)
+      end
+
+      def database_is_usable?
+         configured? && !disabled?
       end
 
       def ensure_required_options_exist
-        raise InvalidConfigurationError, 'Error! Please provide a database name.'   unless database
-        raise InvalidConfigurationError, 'Error! Please provide a collection name.' unless collection
+        raise InvalidConfigurationError, 'Error! Please provide a database name.'   unless config.database
+        raise InvalidConfigurationError, 'Error! Please provide a collection name.' unless config.collection
       end
 
       def retrieve_or_initialize_collection(collection_name)
         if collection_exists?(collection_name)
-          connection.collection(collection_name)
+          db.collection(collection_name)
         else
-          connection.create_collection(collection_name, :capped => true)
+          db.create_collection(collection_name, :capped => true, :size => config.size)
         end
       end
 
       def collection_exists?(collection_name)
-        connection.collection_names.include? collection_name
+        db.collection_names.include? collection_name
       end
+
   end
 end

data/lib/bunyan/config.rb

@@ -0,0 +1,46 @@
+
+module Bunyan
+  class Logger
+
+    class Config
+      # used to hold all user-defined configuration options
+      attr_accessor :collection, :database, :disabled
+
+      def initialize
+        @size     = 52428800
+        @disabled = false
+      end
+
+      def [](meth)
+        send(meth)
+      end
+
+      # 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
+
+      # default size is 50 megabytes
+      def size(new_size = nil)
+        new_size.nil? ? @size : @size = new_size
+      end
+      alias_method :size=, :size
+    end
+
+  end
+end

data/spec/bunyan_spec.rb

@@ -1,27 +1,40 @@
 require 'spec_helper'
 
 describe Bunyan::Logger do
-
   before do
-    @conn = mock_mongo_connection
     @logger = Bunyan::Logger.instance
-    @logger.stub!(:connection).and_return(@conn)
+    @mock_database = nil
+    Mongo::Connection.unstub!(:new)
   end
 
   it 'should have a connection' do
-    @logger.should respond_to :connection
+    configure_test_db
+    @logger.connection.should be_instance_of Mongo::Connection
   end
 
-  it 'should have a collection' do
-    @logger.should respond_to :collection
+  it 'should have a reference to the mongo db object' do
+    @logger.db.should be_instance_of Mongo::DB
   end
 
   it 'should have a config hash' do
-    @logger.config.should be_a Hash
+    @logger.config.should respond_to :[]
+  end
+
+
+  it 'should use the mongo c extension' do
+    defined?(CBson::VERSION).should_not be_nil
+  end
+end
+
+describe 'when initializing the collection' do
+  before do
+    @conn = mock_mongo_connection
+    @logger = Bunyan::Logger.instance
+    @logger.stub!(:connection).and_return(@conn)
   end
 
   it 'should create a new capped collection if the collection does not already exist' do
-    @conn.should_receive(:create_collection).with('collection_1', :capped => true)
+    @conn.should_receive(:create_collection).with('collection_1', :capped => true, :size => 52428800)
     @conn.stub!(:collection_names).and_return([])
     Bunyan::Logger.configure do |config|
       config.database   'database_1'
@@ -37,7 +50,6 @@ describe Bunyan::Logger do
       config.collection 'collection_1'
     end
   end
-
 end
 
 describe 'the required config options' do
@@ -58,46 +70,6 @@ describe 'the required config options' do
   end
 end
 
-describe 'bunyan logger configuration' do
-  describe 'setting config values' do
-    before do
-      Bunyan::Logger.configure do |c|
-        c.database   'database2'
-        c.collection 'collection2'
-      end
-    end
-
-    it 'should allow setting of the database' do
-      Bunyan::Logger.database.should == 'database2'
-    end
-
-    it 'shoudl allow setting of the collection name' do
-      Bunyan::Logger.collection.should == 'collection2'
-    end
-  end
-
-  describe 'the optional config options' do
-    it 'should allow the user to mark bunyan as disabled' do
-      Bunyan::Logger.configure do |c|
-        c.database   'test_db'
-        c.collection 'test_collection'
-        c.disabled   true
-      end
-      Bunyan::Logger.should be_disabled
-    end
-  end
-
-  describe "when the disabled flag is set" do
-    it 'should not create a new logger instance' do
-      Bunyan::Logger.should_not_receive(:initialize_connection)
-      Bunyan::Logger.configure do |c|
-        c.database   'test_db'
-        c.collection 'test_collection'
-        c.disabled   true
-      end
-    end
-  end
-end
 
 describe Bunyan::Logger, "#disabled?" do
   it "should return false if nothing is set" do
@@ -109,19 +81,10 @@ describe Bunyan::Logger, "#disabled?" do
   end
 end
 
-describe 'the database getter' do
-  it 'should allow setting of the database' do
-    Bunyan::Logger.configure do |config|
-      config.database   'my_database'
-      config.collection 'my_collection'
-    end
-    Bunyan::Logger.instance.database.should == 'my_database'
-  end
-end
-
 describe 'mongodb instance methods passed to a logger instance' do
   it 'should be passed through to the collection' do
-    Bunyan::Logger.db.should_receive(:count)
+    configure_test_db
+    Bunyan::Logger.collection.should_receive(:count)
     Bunyan::Logger.count
   end
 end
@@ -135,3 +98,31 @@ describe 'alternate configuration syntax' do
     Bunyan::Logger.config[:database].should == 'some_database'
   end
 end
+
+describe 'when bunyan is disabled' do
+  it "should not send messages to the mongo collection" do
+    @conn = mock_mongo_connection
+    Bunyan::Logger.configure do |config|
+      config.database   'bunyan_test'
+      config.collection 'bunyan_test_log'
+      config.disabled   true
+    end
+    %w(insert count find).each do |command|
+      Bunyan::Logger.collection.should_not_receive(command)
+      Bunyan::Logger.send command
+    end
+  end
+end
+
+describe 'when bunyan is not configured' do
+  it 'should not try to send messages to mongo' do
+    Bunyan::Logger.instance.stub!(:configured?).and_return(false)
+    Bunyan::Logger.should_not be_configured
+    Bunyan::Logger.should_not be_disabled
+    %w(insert count find).each do |command|
+      Bunyan::Logger.collection.should_not_receive(command)
+      Bunyan::Logger.send command
+    end
+  end
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Bunyan::Logger::Config do
+  before do
+    @config = Bunyan::Logger::Config.new
+  end
+
+  it 'should have a collection' do
+    @config.should respond_to :collection
+  end
+end
+
+describe Bunyan::Logger::Config, 'collection size' do
+  it 'should default to 50 megabytes' do
+    # configure_test_db
+    config = Bunyan::Logger::Config.new
+    config.size.should == 52428800
+  end
+
+  it 'should all the user to set the collection size' do
+    Bunyan::Logger.configure do |c|
+      c.database   'bunyan_test_log'
+      c.collection 'configured_size'
+      c.size       100_000_000
+    end
+
+    Bunyan::Logger.config[:size].should == 100_000_000
+  end
+end
+
+describe Bunyan::Logger::Config, 'when setting the collection size' do
+  it 'should never set the size to nil' do
+    @config = Bunyan::Logger::Config.new
+    @config.size nil
+    @config.size.should == 52428800
+  end
+
+  it 'should override the default value' do
+    @config = Bunyan::Logger::Config.new
+    @config.size 1010
+    @config.size.should == 1010
+  end
+end
+
+describe Bunyan::Logger::Config, 'when getting the collection size' do
+  it 'should return the collection size'
+end
+
+describe Bunyan::Logger::Config, 'alternate method invocation syntax' do
+  it 'should act like a hash' do
+    config = Bunyan::Logger::Config.new
+    config.size 10
+    config.should_receive(:size).and_return(10)
+    config[:size].should == 10
+  end
+end
+
+describe 'bunyan logger configuration' do
+  describe 'setting config values' do
+    before do
+      Bunyan::Logger.configure do |c|
+        c.database   'database2'
+        c.collection 'collection2'
+      end
+    end
+
+    it 'should allow setting of the database' do
+      Bunyan::Logger.config.database.should == 'database2'
+    end
+
+    it 'shoudl allow setting of the collection name' do
+      Bunyan::Logger.config.collection.should == 'collection2'
+    end
+  end
+
+  describe 'the optional config options' do
+    it 'should allow the user to mark bunyan as disabled' do
+      Bunyan::Logger.configure do |c|
+        c.database   'test_db'
+        c.collection 'test_collection'
+        c.disabled   true
+      end
+      Bunyan::Logger.should be_disabled
+    end
+  end
+
+  describe "when the disabled flag is set" do
+    it 'should not create a new logger instance' do
+      Bunyan::Logger.should_not_receive(:initialize_connection)
+      Bunyan::Logger.configure do |c|
+        c.database   'test_db'
+        c.collection 'test_collection'
+        c.disabled   true
+      end
+    end
+  end
+end
+

data/spec/integration/non_rails_spec.rb

@@ -0,0 +1,14 @@
+# $LOAD_PATH.unshift(File.expand_path(File.dirname('../../lib/bunyan'))
+# 
+# require 'bunyan'
+# 
+# Bunyan::Logger.configure do |c|
+#   c.database   'bunyan_integration_db'
+#   c.collection 'test_log'
+# 
+#   c.size 104857600 # 100.megabytes
+# end
+# 
+# describe 
+# 
+# Bunyan::Logger.insert({  })

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
+require 'rubygems'
+require 'bundler'
 Bundler.setup
 Bundler.require :default, :test
 
 require File.expand_path(File.dirname(__FILE__) + '/../lib/bunyan')
-$LOAD_PATH.unshift File.expand_path(__FILE__)
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 
 Spec::Runner.configure do |config|
 
@@ -16,18 +18,25 @@ Spec::Runner.configure do |config|
 
   def mock_mongo_connection
     @mock_collection = mock("Mongo Collection")
+    @mock_connection = mock("Mongo Connection")
     @mock_database   = mock("Mongo Database", 
        :collection        => @mock_collection, 
        :create_collection => @mock_collection,
-       :collection_names  => ['name 1'])
-    @mock_connection = mock("Mongo Connection", :db => @mock_database)
+       :collection_names  => ['name 1'],
+       :connection        => @mock_connection)
+    @mock_connection.stub!(:db).and_return(@mock_database)
     Mongo::Connection.stub!(:new).and_return(@mock_connection)
     @mock_database
   end
 
   def cleanup_bunyan_config
-    Bunyan::Logger.instance_variable_set(:@database, nil)
-    Bunyan::Logger.instance_variable_set(:@collection, nil)
-    Bunyan::Logger.instance_variable_set(:@db, nil)
+    Bunyan::Logger.instance_variable_set(:@config, Bunyan::Logger::Config.new)
+  end
+
+  def configure_test_db
+    Bunyan::Logger.configure do |config|
+      config.database   'bunyan_test'
+      config.collection 'bunyan_test_log'
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alex Sharp
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 -07:00
+date: 2010-03-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,13 +53,17 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - VERSION
 - bunyan.gemspec
+- examples/rails.rb
 - lib/bunyan.rb
+- lib/bunyan/config.rb
 - spec/bunyan_spec.rb
+- spec/config_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -94,4 +98,7 @@ specification_version: 3
 summary: A MongoDB-based logging solution.
 test_files: 
 - spec/bunyan_spec.rb
+- spec/config_spec.rb
+- spec/integration/non_rails_spec.rb
 - spec/spec_helper.rb
+- examples/rails.rb