bunyan 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/Gemfile

@@ -0,0 +1,9 @@
+gem 'mongo',      '>= 0.19'
+gem 'mongo_ext',  '>= 0.19'
+
+group :test do
+  gem 'rspec', '>= 1.3.0'
+  gem 'ZenTest'
+  gem 'autotest-growl'
+  gem 'autotest-fsevent'
+end

data/README.md

@@ -0,0 +1,60 @@
+Bunyan
+======
+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)
+
+Install
+=======
+    gem install bunyan
+
+Configure
+=========
+The only configuration options required are the database and collection name.
+
+For rails apps, puts the config block in an initializer.
+
+    # config/initializers/bunyan.rb
+    Bunyan::Logger.configure do |config|
+      # required options
+      config.database   'bunyan_logger'
+      config.collection 'development_log'
+
+      # optional
+      config.disabled true
+    end
+
+Usage
+=====
+You can access the bunyan logger anywhere is your app via Bunyan::Logger.
+The Logger class is implemented as a singleton, and you can call any instance
+method on the Logger class. This is implemented with some method_missing magic,
+which is explained in a bit more detail below.
+
+Internals
+=========
+Bunyan makes heavy usage of method\_missing both at the class and instance level.
+At the class level, this is purely for convenience to pass missing class methods
+to the singleton instance, which precludes us from needing to use Logger.instance
+directly. At the instance level, method\_missing is used to provide a very thin
+layer around MongoDB, via the Mongo driver.
+
+The net effect of this is that there is no reason to muck around with 
+calling methods directly on Bunyan::Logger.instance, because all methods that 
+don't already exist at the class level will be sent to Bunyan::Logger.instance.
+
+    Bunyan::Logger.count == Bunyan::Logger.instance.count # => true
+
+Also, you can call any instance methods Bunyan::Logger that you would otherwise 
+call on a Mongo collection object.
+
+More
+====
+* [MongoDB Capped Collections](http://www.mongodb.org/display/DOCS/Capped+Collections)
+* [Mongo Ruby Driver](http://github.com/mongodb/mongo-ruby-driver)
+
+TODO
+====
+* Ability to limit bunyan to only run in certain environments
+* Add middleware client for easy drop-in to rails/rack apps

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "bunyan"
+    gemspec.summary = "A MongoDB-based logging solution."
+    gemspec.description = "Bunyan is a thin ruby wrapper around a MongoDB capped collection, created with high-performance, flexible logging in mind."
+    gemspec.email = "ajsharp@gmail.com"
+    gemspec.homepage = "http://github.com/ajsharp/bunyan"
+    gemspec.authors = ["Alex Sharp"]
+    gemspec.add_dependency 'mongo',     '>= 0.19'
+    gemspec.add_dependency 'mongo_ext', '>= 0.19'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bunyan.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bunyan}
+  s.version = "0.1.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.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",
+     "Gemfile",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bunyan.gemspec",
+     "lib/bunyan.rb",
+     "spec/bunyan_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.6}
+  s.summary = %q{A MongoDB-based logging solution.}
+  s.test_files = [
+    "spec/bunyan_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo>, [">= 0.19"])
+      s.add_runtime_dependency(%q<mongo_ext>, [">= 0.19"])
+    else
+      s.add_dependency(%q<mongo>, [">= 0.19"])
+      s.add_dependency(%q<mongo_ext>, [">= 0.19"])
+    end
+  else
+    s.add_dependency(%q<mongo>, [">= 0.19"])
+    s.add_dependency(%q<mongo_ext>, [">= 0.19"])
+  end
+end
+

data/lib/bunyan.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+
+#gem 'mongo_ext'
+
+require 'mongo'
+require 'singleton'
+
+module Bunyan
+  class Logger
+    include Singleton
+
+    class InvalidConfigurationError < RuntimeError; end
+
+    attr_reader :db, :connection, :config
+
+    # Bunyan::Logger.configure do |config|
+    #   # required options
+    #   config.database   'bunyan_logger'
+    #   config.collection 'development_log'
+    # end
+    def configure(&block)
+      @config = {}
+
+      yield self
+
+      ensure_required_options_exist
+      initialize_connection unless disabled?
+    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
+    end
+    alias_method :collection=, :collection
+
+    def disabled(dis = nil)
+      @config[:disabled] ||= dis
+    end
+    alias_method :disabled=, :disabled
+
+    def disabled?
+      !!disabled
+    end
+
+    def method_missing(method, *args, &block)
+      begin
+        db.send(method, *args)
+      rescue
+        super(method, *args, &block)
+      end
+    end
+
+    # Pass all missing class methods to the singleton instance
+    def self.method_missing(method, *args, &block)
+      Logger.instance.send(method, *args, &block)
+    end
+
+    private
+      def initialize_connection
+        @connection  = Mongo::Connection.new.db(database)
+        @db          = retrieve_or_initialize_collection(collection)
+      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
+      end
+
+      def retrieve_or_initialize_collection(collection_name)
+        if collection_exists?(collection_name)
+          connection.collection(collection_name)
+        else
+          connection.create_collection(collection_name, :capped => true)
+        end
+      end
+
+      def collection_exists?(collection_name)
+        connection.collection_names.include? collection_name
+      end
+  end
+end

data/spec/bunyan_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe Bunyan::Logger do
+
+  before do
+    @conn = mock_mongo_connection
+    @logger = Bunyan::Logger.instance
+    @logger.stub!(:connection).and_return(@conn)
+  end
+
+  it 'should have a connection' do
+    @logger.should respond_to :connection
+  end
+
+  it 'should have a collection' do
+    @logger.should respond_to :collection
+  end
+
+  it 'should have a config hash' do
+    @logger.config.should be_a Hash
+  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.stub!(:collection_names).and_return([])
+    Bunyan::Logger.configure do |config|
+      config.database   'database_1'
+      config.collection 'collection_1'
+    end
+  end
+
+  it 'should not create a new collection if one already exists by that name' do
+    @conn.should_not_receive(:create_collection)
+    @conn.collection_names.should_receive(:include?).with('collection_1').and_return(true)
+    Bunyan::Logger.configure do |config|
+      config.database   'database_1'
+      config.collection 'collection_1'
+    end
+  end
+
+end
+
+describe 'the required config options' do
+  it 'should raise an error if a db name is not provided' do
+    lambda {
+      Bunyan::Logger.configure do |c|
+        c.collection 'collection_without_database'
+      end
+    }.should raise_exception(Bunyan::Logger::InvalidConfigurationError, 'Error! Please provide a database name.')
+  end
+
+  it 'should raise an error if a db collection is not provided' do
+    lambda {
+      Bunyan::Logger.configure do |c|
+        c.database 'db_without_collection'
+      end
+    }.should raise_exception(Bunyan::Logger::InvalidConfigurationError, 'Error! Please provide a collection name.')
+  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
+    Bunyan::Logger.configure do |config|
+      config.database   'my_database'
+      config.collection 'my_collection'
+    end
+    Bunyan::Logger.disabled?.should == false
+  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)
+    Bunyan::Logger.count
+  end
+end
+
+describe 'alternate configuration syntax' do
+  it 'should allow a user to set config options with traditional setters' do
+    Bunyan::Logger.configure do |config|
+      config.database = 'some_database'
+      config.collection = 'some_collection'
+    end
+    Bunyan::Logger.config[:database].should == 'some_database'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+s
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+Bundler.setup
+Bundler.require :default, :test
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/bunyan')
+$LOAD_PATH.unshift File.expand_path(__FILE__)
+
+Spec::Runner.configure do |config|
+
+  config.after :each do
+    cleanup_bunyan_config
+  end
+
+  config.before :each do
+    mock_mongo_connection
+  end
+
+  def mock_mongo_connection
+    @mock_collection = mock("Mongo Collection")
+    @mock_database   = mock("Mongo Database", 
+       :collection        => @mock_collection, 
+       :create_collection => @mock_collection,
+       :collection_names  => ['name 1'])
+    @mock_connection = mock("Mongo Connection", :db => @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)
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: bunyan
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 19
+        version: "0.19"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 19
+        version: "0.19"
+  type: :runtime
+  version_requirements: *id002
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- bunyan.gemspec
+- lib/bunyan.rb
+- spec/bunyan_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ajsharp/bunyan
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A MongoDB-based logging solution.
+test_files: 
+- spec/bunyan_spec.rb
+- spec/spec_helper.rb