mm-logged-time 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'bson_ext'
+gemspec

data/LICENSE

@@ -0,0 +1 @@
+I, Brian Hempel, release this software to the public domain.  (2011)

data/README.rdoc

@@ -0,0 +1,54 @@
+= MM Logged Time
+
+Logging of query time and load time for MongoMapper, like so:
+
+	(0.5ms) all query mm-test-1-8-7.parakeets {:name=>"Bro"}
+	(0.1ms) all load  mm-test-1-8-7.parakeets {:name=>"Bro"}
+
+Load time is logged separately because sometimes MongoMapper, not MongoDB, is the bottleneck:
+
+	(48.6ms) all query mes-geo.places {:ancestor_ids=>2347581, ... }
+	(623.7ms) all load  mes-geo.places {:ancestor_ids=>2347581, ... }
+
+== Installation
+
+Add mm-logged-time to your Gemfile:
+
+	gem 'mm-logged-time'
+
+You may wish to only include it in your development group:
+
+	group :development do
+	  gem 'mm-logged-time'
+	end
+
+Once you have MongoMapper set up with a logger, you can turn on logged time. For example, in mongo_config.rb:
+	
+	MongoMapper.connection = Mongo::Connection.new('localhost', 27017, :logger => Rails.logger)
+	MongoMapper.logged_time_level = Logger::DEBUG
+
+To turn it off either set the logger to a less verbose level, or:
+
+	MongoMapper.logged_time_level = nil
+
+That's it.  Happy logging!
+
+== Warning
+
+The only want to separate out MongoMappers's load and query was to totally clobber some functions in MM's source.  Future updates to MongoMapper could cause this gem to break your app.
+
+Of course, gem updates to an app are always fickle in my experience.  Please don't be deterred from using mm-logged-time.  Gem updates == breakage.  Just be aware that mm-logged-time could be the culprit if you update MongoMapper.
+
+== Development/Tests
+
+	gem install bundler
+	bundle
+	bundle exec rake
+
+== Pull Requests
+
+Pull requests, bug reports, and feedback are welcome!
+
+== License
+
+Public domain.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.libs      << 'lib' << 'test'
+  test.pattern   = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/lib/mm_logged_time/decorator_extensions.rb

@@ -0,0 +1,43 @@
+module MmLoggedTime
+  module DecoratorExtensions
+    # if someone can figure out a cleaner way to do this, please let me know
+    # can't just 'include' because then super also tries to load the doc
+    # undef also handly breaks everything
+    # overriden code here: https://github.com/jnunemaker/mongomapper/blob/master/lib/mongo_mapper/plugins/querying/decorator.rb
+    INSTANCE_METHODS = <<-BIG_EVAL
+      def all(opts={})
+        result = nil
+        log_time("all query") { result = super }
+        log_time("all load ") { result.map { |doc| model.load(doc) } }
+      end
+
+      def first(opts={})
+        result = nil
+        log_time("first query") { result = super }
+        log_time("first load ") { model.load(result) }
+      end
+
+      def last(opts={})
+        result = nil
+        log_time("last query") { result = super }
+        log_time("last load ") { model.load(result) }
+      end
+    
+      private
+        def log_time(msg)
+          logger = model.logger
+          result = nil
+          if logger && MongoMapper.logged_time_level && logger.level <= MongoMapper.logged_time_level
+            time = Benchmark.realtime do
+              result = yield
+            end
+            time_ms = (time*10000).round / 10.0
+            logger.add MongoMapper.logged_time_level, "(\#{time_ms}ms) \#{msg} \#{collection.db.name}.\#{collection.name} \#{to_hash.inspect}"
+            result
+          else
+            yield
+          end
+        end
+    BIG_EVAL
+  end
+end

data/lib/mm_logged_time/mongo_mapper_extensions.rb

@@ -0,0 +1,16 @@
+module MmLoggedTime
+  module MongoMapperExtensions
+    module ClassMethods
+      def logged_time_level=(level)
+        unless MmLoggedTime::VALID_LEVELS.include?(level)
+          raise "Invalid log level.  Valid options are: #{MmLoggedTime::VALID_LEVELS.inspect}"
+        end
+        @logged_time_level = level
+      end
+      
+      def logged_time_level
+        @logged_time_level
+      end
+    end
+  end
+end

data/lib/mm_logged_time/version.rb

@@ -0,0 +1,3 @@
+module MmLoggedTime
+  VERSION = "0.5.0"
+end

data/lib/mm_logged_time.rb

@@ -0,0 +1,19 @@
+require 'logger'
+require 'mongo_mapper'
+
+module MmLoggedTime
+  VALID_LEVELS = [
+    nil,
+    Logger::FATAL,
+    Logger::ERROR,
+    Logger::WARN,
+    Logger::INFO,
+    Logger::DEBUG
+  ]
+end
+
+require 'mm_logged_time/mongo_mapper_extensions.rb'
+require 'mm_logged_time/decorator_extensions.rb'
+
+MongoMapper.extend(MmLoggedTime::MongoMapperExtensions::ClassMethods)
+MongoMapper::Plugins::Querying::Decorator.module_eval(MmLoggedTime::DecoratorExtensions::INSTANCE_METHODS)

data/mm-logged-time.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mm_logged_time/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mm-logged-time"
+  s.version     = MmLoggedTime::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Hempel"]
+  s.email       = ["wezzex@parrett.net"]
+  s.homepage    = "http://github.com/brianhempel/mm-logged-time"
+  s.summary     = "Logging of query time and load time for MongoMapper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'mongo_mapper', '>=0.8.6'
+  s.add_dependency 'i18n' # active_support complains without this
+  
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'jnunemaker-matchy', '~> 0.4.0'
+  s.add_development_dependency 'shoulda'
+end

data/test/functional/test_logged_time.rb

@@ -0,0 +1,120 @@
+require 'test_helper'
+require 'stringio'
+
+class Parakeet
+  include MongoMapper::Document
+  key :name
+end
+
+PARAKEET_NAMES = %w{
+  Bro
+  Sis
+  Larry
+  Silvester
+  Monterray
+}
+
+def make_some_parakeets
+  PARAKEET_NAMES.each do |name|
+    Parakeet.create!(:name => name)
+  end
+end
+
+class TestLoggedTime < Test::Unit::TestCase
+  context "" do
+    setup do
+      @str_io = StringIO.new
+      @logger = Logger.new(@str_io)
+      MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017, :logger => @logger)
+      make_some_parakeets
+    end
+  
+    teardown do
+      Parakeet.collection.drop
+    end
+  
+    context "timed logging turned on" do
+      setup do
+        MongoMapper.logged_time_level = Logger::DEBUG
+      end
+    
+      should "log calls to #all" do
+        Parakeet.all
+        @str_io.string.should =~ /all query/
+        @str_io.string.should =~ /all load/
+      end
+      
+      should "not break all" do
+        Parakeet.all.size.should == 5
+      end
+
+      should "log time and database and collection and query" do
+        Parakeet.where(:name => "Bro").all
+        @str_io.string.should =~ /\(\d+.\dms\) all query #{MongoMapper.database.name}\.parakeets \{:name=>"Bro"\}/
+        @str_io.string.should =~ /\(\d+.\dms\) all load  #{MongoMapper.database.name}\.parakeets \{:name=>"Bro"\}/
+      end
+
+      should "log calls to #first" do
+        Parakeet.first
+        @str_io.string.should =~ /first query/
+        @str_io.string.should =~ /first load/
+      end
+      
+      should "not break first" do
+        Parakeet.first.class.should == Parakeet
+      end
+      
+      should "log calls to #last" do
+        Parakeet.last
+        @str_io.string.should =~ /last query/
+        @str_io.string.should =~ /last load/
+      end
+      
+      should "not break last" do
+        Parakeet.last.class.should == Parakeet
+      end
+    end
+    
+    context "different logger levels" do
+      should "not log if logger is set to be less verbose" do
+        MongoMapper.logged_time_level = Logger::DEBUG
+        @logger.level = Logger::ERROR
+        Parakeet.where(:name => "Bro").all
+        @str_io.string.should_not =~ /all query|all load/
+      end
+      
+      should "log if logger is set to the same verbosity" do
+        MongoMapper.logged_time_level = Logger::INFO
+        @logger.level = Logger::INFO
+        Parakeet.where(:name => "Bro").all        
+        @str_io.string.should =~ /all query.+all load/m
+      end
+      
+      should "log if logger is set to a higher verbosity" do
+        MongoMapper.logged_time_level = Logger::WARN
+        @logger.level = Logger::INFO
+        Parakeet.where(:name => "Bro").all        
+        @str_io.string.should =~ /all query.+all load/m
+      end
+    end
+  
+    context "timed logging not turned on" do
+      # # not sure how to test this...
+      # should "default to off" do
+      #   Parakeet.all
+      #   @str_io.string.should_not =~ /all query|all load/
+      # end
+
+      should "allow explicit turning off" do
+        MongoMapper.logged_time_level = Logger::DEBUG
+        Parakeet.where(:name => "Bro").all
+        @str_io.string.should =~ /all query.+all load/m
+        
+        @str_io.string = ""
+        MongoMapper.logged_time_level = nil
+        Parakeet.where(:name => "Bro").all
+        @str_io.string.should_not =~ /all query|all load/
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'matchy'
+require 'shoulda'
+require 'mongo_mapper'
+require 'mm_logged_time'
+
+MongoMapper.database = "mm-test-#{RUBY_VERSION.gsub('.', '-')}"

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: mm-logged-time
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Brian Hempel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 8
+        - 6
+        version: 0.8.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: 
+email: 
+- wezzex@parrett.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/mm_logged_time.rb
+- lib/mm_logged_time/decorator_extensions.rb
+- lib/mm_logged_time/mongo_mapper_extensions.rb
+- lib/mm_logged_time/version.rb
+- mm-logged-time.gemspec
+- test/functional/test_logged_time.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/brianhempel/mm-logged-time
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Logging of query time and load time for MongoMapper
+test_files: 
+- test/functional/test_logged_time.rb
+- test/test_helper.rb