mongodb_logger 0.4.2 → 0.5.0

data/lib/mongodb_logger/server/views/shared/layout/_mustache.erb

@@ -0,0 +1,6 @@
+<script type="text/javascript">
+  window.MustacheTemplates = {};
+  <% Dir["#{File.expand_path(File.join(@main_dir, "server", "templates"))}/**/*.mustache"].each do |template| %>
+    window.MustacheTemplates[<%= template.split(File::SEPARATOR).last(2).join("/").gsub(".mustache", "").inspect %>] = Mustache.compile(<%= File.open(template, 'rb').read.inspect %>)
+  <% end %>
+</script>

data/lib/mongodb_logger/server/views/show_log.erb

@@ -2,8 +2,8 @@
 
 <div class="unit-right">
   <div class="pam">
-    <a href="<%=h url_path("overview") %>" data-pjax='#mainPjax' class="button small grey">Back</a>
-  </div> <!-- pam -->            
+    <a href="<%=h url_path("overview") %>" data-pjax='true' class="button small grey">Back</a>
+  </div> <!-- pam -->
 </div> <!-- unit-right -->
 <h1 class="pam">Log #<%=h @log['_id'] %></h1>
 <ul class="list">

data/lib/mongodb_logger/server_config.rb

@@ -2,7 +2,7 @@ require 'mongodb_logger/logger'
 
 module MongodbLogger
   class ServerConfig
-    
+
     class ServerLogger < MongodbLogger::Logger
       private
       def resolve_config
@@ -12,14 +12,14 @@ module MongodbLogger
         config
       end
     end
-   
+
     class << self
       def set_config(config_path)
         ENV['MONGODBLOGGERCONFIG'] = config_path
-        @logger = ServerLogger.new(:path => "server.log")
+        @logger = ServerLogger.new(path: "server.log")
         @logger.mongo_adapter
       end
-   
+
       def mongo_adapter
         @logger.mongo_adapter if @logger
       end

data/lib/mongodb_logger/utils/migrate.rb

@@ -0,0 +1,50 @@
+require 'mongodb_logger/logger'
+require 'mongodb_logger/utils/progressbar'
+
+module MongodbLogger
+  module Utils
+    class Migrate
+
+      def initialize
+        raise "this task work only in Rails app" unless defined?(Rails)
+        Progressbar.new.show("Importing data to new capped collection") do
+          mongodb_logger = Rails.logger
+          collection_name = mongodb_logger.db_configuration['collection'].dup
+          @mongo_adapter = mongodb_logger.mongo_adapter
+          @migrate_logger = create_migration_collection(mongodb_logger.db_configuration)
+
+          iterator = 0
+          all_count = @mongo_adapter.collection.find.count
+          @mongo_adapter.collection.find.each do |row|
+            @migrate_logger.mongo_adapter.collection.insert(row)
+            iterator += 1
+            progress ((iterator.to_f / all_count.to_f) * 100).round
+          end if all_count > 0
+          progress 100
+          @migrate_logger.mongo_adapter.rename_collection(collection_name, true)
+        end
+      end
+
+      def create_migration_collection(configuration)
+        configuration.merge!({ 'collection' => "#{configuration['collection']}_copy_#{rand(100)}" })
+        migrate_logger = MongoMigrateLogger.new(configuration)
+        migrate_logger.mongo_adapter.reset_collection
+        migrate_logger
+      end
+
+      class MongoMigrateLogger < MongodbLogger::Logger
+        def initialize(config = {})
+          @static_config = config
+          super(path: "/dev/null")
+        end
+
+        private
+        def resolve_config
+          @static_config
+        end
+      end
+
+
+    end
+  end
+end

data/lib/mongodb_logger/utils/progressbar.rb

@@ -0,0 +1,79 @@
+# https://github.com/bitboxer/simple_progressbar
+module MongodbLogger
+  module Utils
+    class Progressbar
+      def initialize
+        @last_length = 0
+        @title = ""
+        @progress = 0
+      end
+
+      def show(title, &block)
+        @title = title
+        print @title + " "
+        start_progress
+        # thanks to http://www.dcmanges.com/blog/ruby-dsls-instance-eval-with-delegation
+        @self_before_instance_eval = eval "self", block.binding
+        instance_eval(&block)
+        finish_progress
+      end
+
+      def interrupt
+        # TODO: Make some of the strings constants so we don't have to use a magic number here.
+        progressbar_length = 16 + @last_length + @title.length
+        move_cursor = "\e[#{progressbar_length}D"
+        print move_cursor + (" " * progressbar_length) + move_cursor
+        STDOUT.flush
+        yield
+        puts
+        print @title + " "
+        render_progress(@progress)
+      end
+
+      def progress(percent)
+        print "\e[#{15 + @last_length}D"
+        render_progress(percent)
+      end
+
+      def method_missing(method, *args, &block)
+        @self_before_instance_eval.send method, *args, &block
+      end
+
+      private
+
+      def render_progress(percent)
+        @progress = percent
+        print "["
+
+        print "*" * [(percent/10).to_i, 10].min
+        print " " * [10 - (percent/10).to_i, 0].max
+
+        if percent.class != Float
+          printable_percent = "%3s" % percent
+        else
+          non_decimal_digits = (Math.log(percent) / Math.log(10)).truncate + 1
+          printable_percent = (non_decimal_digits < 3 ? " " * (3 - non_decimal_digits) : "") + percent.to_s
+        end
+
+        print "]\e[32m #{printable_percent}\e[0m %"
+
+        new_length = printable_percent.length
+        if @last_length > new_length
+          print " " * (@last_length - new_length)
+          print "\e[#{@last_length - new_length}D"
+        end
+        @last_length = new_length
+
+        STDOUT.flush
+      end
+
+      def start_progress
+        render_progress(0)
+      end
+
+      def finish_progress
+        puts
+      end
+    end
+  end
+end

data/lib/mongodb_logger/version.rb

@@ -1,3 +1,3 @@
 module MongodbLogger
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/mongodb_logger.gemspec

@@ -1,35 +1,42 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/mongodb_logger/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongodb_logger/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Alexey Vasiliev"]
   gem.email         = ["leopard.not.a@gmail.com"]
-  gem.description   = %q{MongoDB logger for Rails 3}
-  gem.summary       = %q{MongoDB logger for Rails 3}
+  gem.description   = %q{MongoDB logger for Rails}
+  gem.summary       = %q{MongoDB logger for Rails}
   gem.homepage      = "http://mongodb-logger.catware.org"
 
   gem.extra_rdoc_files  = [ "LICENSE", "README.md" ]
   gem.rdoc_options      = ["--charset=UTF-8"]
 
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-rails"
   gem.add_development_dependency "shoulda"
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "cucumber"
+  gem.add_development_dependency "cucumber-rails"
   gem.add_development_dependency "capybara"
   gem.add_development_dependency "coffee-script"
   gem.add_development_dependency "uglifier"
   gem.add_development_dependency "jasmine"
+  gem.add_development_dependency "appraisal"
+  gem.add_development_dependency "aruba"
   # adapters
   gem.add_development_dependency "mongo"
   gem.add_development_dependency "moped"
-  
+
   gem.add_dependency "rake",            ">= 0.9.0"
-  gem.add_dependency "json",            "~> 1.7.0"
+  gem.add_dependency "multi_json",      ">= 1.6.0"
   gem.add_dependency "activesupport",   ">= 3.1.0"
   gem.add_dependency "actionpack",      ">= 3.1.0"
   gem.add_dependency "sprockets",       ">= 2.0.0"
-  gem.add_dependency "sinatra",         "~> 1.3.0"
-  gem.add_dependency "erubis",          "~> 2.7.0"
+  gem.add_dependency "sinatra",         ">= 1.3.0"
+  gem.add_dependency "erubis",          ">= 2.7.0"
+  gem.add_dependency "mustache",        ">= 0.99.0"
   gem.add_dependency "vegas",           "~> 0.1.0"
 
   gem.rubyforge_project = "mongodb_logger"

data/spec/factories/config/database_with_capsize.yml

@@ -0,0 +1,9 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+  mongodb_logger:
+    database: system_log
+    application_name: mongo_foo
+    capsize: <%= 50.megabytes %>

data/spec/javascripts/support/jasmine.yml

@@ -11,11 +11,7 @@
 #   - dist/**/*.js
 #
 src_files:
-    - app/assets/javascripts/vendors/jquery-1.8.3.min.js
-    - app/assets/javascripts/vendors/jquery-ui-1.9.2.min.js
-    - app/assets/javascripts/vendors/jquery.pjax.min.js
-    - app/assets/javascripts/vendors/highlight.pack.js
-    - app/assets/javascripts/logs.js
+    - app/assets/javascripts/mongodb_logger.js
 
 # stylesheets
 #

data/spec/mongodb_logger_spec.rb

@@ -0,0 +1,257 @@
+require 'spec_helper'
+
+describe MongodbLogger::Logger do
+  extend MongodbLogger::SpecMacros
+
+  EXCEPTION_MSG = "Foo"
+
+  before :all do
+    create_logs_dir
+  end
+
+  context "in instantiation" do
+    before do
+      described_class.any_instance.stub(:internal_initialize).and_return(nil)
+      described_class.any_instance.stub(:disable_file_logging?).and_return(false)
+      @mongodb_logger = described_class.new
+    end
+
+    [MongodbLogger::SpecHelper::LOGGER_CONFIG,
+      MongodbLogger::SpecHelper::DEFAULT_CONFIG,
+      MongodbLogger::SpecHelper::MONGOID_CONFIG].each do |config|
+      context "during configuration when using #{config}" do
+        before do
+          setup_for_config(config)
+        end
+        after do
+          cleanup_for_config(config)
+        end
+
+        should_use_database_name_in_config
+      end
+    end
+
+    context "during configuration when using #{MongodbLogger::SpecHelper::DEFAULT_CONFIG_WITH_URL}" do
+      before do
+        setup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG_WITH_URL, MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+      end
+      after do
+        cleanup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+      end
+
+      it "authenticated by url" do
+        @mongodb_logger.send(:connect)
+        @mongodb_logger.mongo_adapter.authenticated?.should be_true
+        @mongodb_logger.db_configuration['database'].should == "system_log"
+      end
+    end
+
+    context "upon connecting with authentication settings" do
+      before do
+        setup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG_WITH_AUTH, MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+        create_mongo_user
+      end
+      after do
+        remove_mongo_user
+        cleanup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+      end
+
+      should_use_database_name_in_config
+
+      it "authenticate with the credentials in the configuration" do
+        @mongodb_logger.send(:connect)
+        @mongodb_logger.mongo_adapter.authenticated?.should be_true
+      end
+    end
+
+    context "after configuration" do
+      before do
+        setup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+        @mongodb_logger.send(:connect)
+        @mongo_adapter = @mongodb_logger.mongo_adapter
+      end
+
+      it "set the default host, port, and capsize if not configured" do
+        @mongo_adapter.configuration['host'].should == 'localhost'
+        @mongo_adapter.configuration['port'].should == 27017
+        @mongo_adapter.configuration['capsize'].should == MongodbLogger::Logger::DEFAULT_COLLECTION_SIZE
+      end
+
+      it "set the mongo collection name depending on the Rails environment" do
+         @mongo_adapter.collection_name.should == "#{Rails.env}_log"
+      end
+
+      it "set the application name when specified in the config file" do
+        @mongo_adapter.configuration['application_name'].should == "mongo_foo"
+      end
+
+      it "set safe insert when specified in the config file" do
+        @mongo_adapter.configuration['write_options'].should be_present
+      end
+
+      it "use the database name in the config file" do
+        @mongo_adapter.configuration['database'].should == "system_log"
+      end
+
+      it "not authenticate" do
+        @mongo_adapter.authenticated?.should be_false
+      end
+
+      it "create a capped collection in the database with the configured size" do
+        @mongodb_logger.send(:check_for_collection)
+        @mongo_adapter.connection.collection_names.include?(@mongo_adapter.configuration['collection']).should be_true
+        # new capped collections are X MB + 5888 bytes, but don't be too strict in case that changes
+        @mongo_adapter.collection_stats[:storageSize].should < MongodbLogger::Logger::DEFAULT_COLLECTION_SIZE + 1.megabyte
+      end
+
+    end
+
+  end
+
+  context "after instantiation" do
+    before do
+      common_mongodb_logger_setup
+    end
+
+    context "upon insertion of a log record when active record is not used" do
+      before do
+        log_to_mongo("Test")
+      end
+
+      should_contain_one_log_record
+
+      it "allow recreation of the capped collection to remove all records" do
+        @mongo_adapter.reset_collection
+        @mongo_adapter.collection.find.count.should == 0
+      end
+    end
+
+    context "upon insertion of a colorized log record when ActiveRecord is used" do
+      before do
+        @log_message = "TESTING"
+        log_to_mongo("\e[31m #{@log_message} \e[0m")
+      end
+
+      it "detect logging is colorized" do
+        @mongodb_logger.send(:logging_colorized?).should be_true
+      end
+
+      should_contain_one_log_record
+
+      it "strip out colorization from log messages" do
+        @mongo_adapter.collection.find({"messages.debug" => @log_message}).count.should == 1
+      end
+    end
+
+    it "add application metadata to the log record" do
+      options = { "application" => self.class.name }
+      log_metadata_to_mongo(options)
+      @mongo_adapter.collection.find({"application" => self.class.name}).count.should == 1
+    end
+
+    it "not raise an exception when bson-unserializable data is logged in the :messages key" do
+      log_to_mongo(Tempfile.new("foo"))
+      @mongo_adapter.collection.find.count.should == 1
+    end
+
+    it "not raise an exception when bson-unserializable data is logged in the :params key" do
+      log_params_to_mongo({:foo => Tempfile.new("bar")})
+      @mongo_adapter.collection.find.count.should == 1
+    end
+
+    context "when an exception is raised" do
+      it "log the exception" do
+        expect { log_exception_to_mongo(EXCEPTION_MSG) }.to raise_error RuntimeError, EXCEPTION_MSG
+        @mongo_adapter.collection.find({"messages.error" => /^#{EXCEPTION_MSG}/}).count.should == 1
+        @mongo_adapter.collection.find({"is_exception" => true}).count.should == 1
+      end
+    end
+  end
+
+  context "after configure" do
+    before do
+      MongodbLogger::Base.configure do |config|
+        config.on_log_exception do |mongo_record|
+          # do something with error
+        end
+      end
+      common_mongodb_logger_setup
+    end
+
+    it "not call callback function on log" do
+      MongodbLogger::Base.should_receive(:on_log_exception).exactly(0)
+      log_to_mongo("Test")
+    end
+
+    context "when an exception is raised" do
+      it "should call callback function" do
+        MongodbLogger::Base.should_receive(:on_log_exception).exactly(1)
+        expect { log_exception_to_mongo(EXCEPTION_MSG) }.to raise_error RuntimeError, EXCEPTION_MSG
+      end
+    end
+  end
+
+  context "logging at INFO level" do
+    before do
+      common_mongodb_logger_setup(level: MongodbLogger::Logger::INFO)
+      log_to_mongo("INFO")
+    end
+
+    should_contain_one_log_record
+
+    it "not log DEBUG messages" do
+      @mongo_adapter.collection.find({"messages.debug" => { "$exists" => true }}).count.should == 0
+    end
+  end
+
+  context "without file logging" do
+    before do
+      setup_for_config(MongodbLogger::SpecHelper::DEFAULT_CONFIG_WITH_NO_FILE_LOGGING, MongodbLogger::SpecHelper::DEFAULT_CONFIG)
+      @log_file = Pathname.new('log.out')
+      FileUtils.touch(@log_file)
+    end
+
+    after do
+      File.delete(@log_file)
+    end
+
+    context "in instantiation" do
+      it "not call super in the initialize method" do
+        described_class.should_receive(:open).exactly(0)
+        MongodbLogger::Logger.new
+      end
+
+      it "set log" do
+        MongodbLogger::Logger.new.instance_variable_get(:@log).should be_a_kind_of(Logger)
+      end
+    end
+
+    context "after instantiation" do
+      context "upon insertion of a log record" do
+        before do
+          @mongodb_logger = MongodbLogger::Logger.new(path: @log_file)
+          log_to_mongo("Test")
+        end
+
+        it "not log the record to a file" do
+          File.open(@log_file.to_s, "rb").read.should be_blank
+        end
+      end
+    end
+  end
+
+  context "with custom collection" do
+    before do
+      config = MongodbLogger::SpecHelper::DEFAULT_CONFIG_WITH_COLLECTION
+      common_mongodb_logger_setup({}, config)
+      file_path = File.join(MongodbLogger::SpecHelper::SAMPLE_CONFIG_DIR, config)
+      @file_config = YAML.load(ERB.new(File.new(file_path).read).result)[Rails.env]['mongodb_logger']
+    end
+
+    it "changed collection name" do
+      @mongo_adapter.collection.name.should == @file_config['collection']
+      @mongo_adapter.collection_stats[:collection].should == @file_config['collection']
+    end
+  end
+
+end