object_logging 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Christopher J. Bottaro
+
+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 THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= object_logging
+
+Super simple logging for objects.
+
+== Why?
+
+It's a pain to trudge through large log files.  Sometimes you just want to see log messages for one particular object.
+
+== Usage
+
+  class Something
+    include ObjectLogging
+    def foo
+      logger.debug "entering"
+      logger.info "leaving"
+    end
+  end
+  
+  something = Something.new
+  something.foo
+  puts something.logger.log # => [DEBUG] Something#foo entering
+                            #    [INFO] Something#foo leaving
+
+This logs to memory.  Your log will be gone when the object goes out of scope.
+
+=== Logging to the Rails cache
+
+  class Something
+    include ObjectLogging
+    object_logging :rails_cache, :id => :proc_or_method_name_to_identify_object
+  end
+
+This is useful for when you want to view the log after the object goes out of scope.
+
+The option <tt>:id</tt> needs to a Proc or method name that returns a string that uniquely identifies the object (i.e. will be used as the cache key).
+
+=== Logging to the Rails log or STDOUT
+
+  class Something
+    include ObjectLogging
+    object_logging :rails_log
+  end
+
+  class Something
+    include ObjectLogging
+    object_logging :stdout
+  end
+
+This logs to memory, but also logs to <tt>Rails.logger</tt> or <tt>STDOUT</tt>.
+
+== Sharing loggers
+
+You can pass Logger instances between your objects.  This is useful for when you want an object to temporarily log to another object's log.
+
+  a = Account.new
+  u = User.new
+  
+  a.logger.entries.length # => 0
+  u.logger.entries.length # => 0
+  
+  a.logger.debug "blah"
+  u.logger.debug "bleh"
+  
+  u.logger = a.logger
+  u.logger.debug "weee"
+  
+  a.logger.entries.length # => 2
+  u.logger.entries.length # => 1
+
+
+== Copyright
+
+Copyright (c) 2010 Christopher J. Bottaro. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "object_logging"
+    gem.summary = %Q{Super simple logging for objects.}
+    gem.description = %Q{It's a pain to trudge through large log files.  Sometimes you just want to see log messages for one particular object.}
+    gem.email = "cjbottaro@alumni.cs.utexas.edu"
+    gem.homepage = "http://github.com/cjbottaro/object_logging"
+    gem.authors = ["Christopher J. Bottaro"]
+    # gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "object_logging #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/object_logging.rb

@@ -0,0 +1,53 @@
+require "object_logging/metaclass"
+require "object_logging/logger"
+
+module ObjectLogging
+  
+  def self.included(mod)
+    mod.send(:extend,  ClassMethods)
+    mod.send(:include, InstanceMethods)
+    mod.metaclass.class_eval do
+      alias_method :inherited_without_object_logging, :inherited
+      alias_method :inherited, :inherited_with_object_logging
+    end
+  end
+  
+  module ClassMethods
+    
+    def inherited_with_object_logging(mod)
+      inherited_without_object_logging(mod)
+      object_logging_copy = @object_logging && @object_logging.collect do |e|
+        begin
+          e.dup
+        rescue TypeError
+          e
+        end
+      end
+      mod.instance_variable_set("@object_logging", object_logging_copy)
+    end
+    
+    def object_logging(*args)
+      if args.empty?
+        @object_logging
+      else
+        options = args.last.kind_of?(Hash) ? args.pop : {}
+        @object_logging = [args.first, options]
+      end
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    def logger
+      @logger ||= Logger.new(self)
+      @logger.objectify(self)
+    end
+    
+    def logger=(logger)
+      @logger = logger
+    end
+    
+  end
+  
+end

data/lib/object_logging/log/base.rb

@@ -0,0 +1,23 @@
+module ObjectLogging
+  module Log
+    class Base
+      
+      def initialize(object, options)
+        @storage = []
+      end
+      
+      def log(level, context, message)
+        @storage << [level, context, message]
+      end
+      
+      def entries
+        @storage
+      end
+      
+      def clear
+        @storage = []
+      end
+      
+    end
+  end
+end

data/lib/object_logging/log/rails_cache.rb

@@ -0,0 +1,41 @@
+require "object_logging/log/base"
+
+module ObjectLogging
+  module Log
+    class RailsCache < Base
+      
+      def initialize(object, options)
+        @key = make_key(object, options)
+      end
+      
+      def log(level, context, message)
+        Rails.cache.write(key, entries << [level, context, message])
+      end
+      
+      def entries
+        Rails.cache.read(key) || []
+      end
+      
+      def clear
+        Rails.cache.delete(key)
+      end
+      
+    private
+      
+      def key
+        @key
+      end
+      
+      def make_key(object, options)
+        id = options[:id]
+        if id.kind_of(Proc)
+          key = id.call(object)
+        else
+          key = object.send(id)
+        end
+        "object_logging/#{key}"
+      end
+      
+    end
+  end
+end

data/lib/object_logging/log/rails_log.rb

@@ -0,0 +1,14 @@
+require "object_logging/log/base"
+
+module ObjectLogging
+  module Log
+    class RailsLog < Base
+      
+      def log(level, context, message)
+        super
+        Rails.logger.send(level.downcase, "#{context} #{message}")
+      end
+      
+    end
+  end
+end

data/lib/object_logging/log/stdout.rb

@@ -0,0 +1,14 @@
+require "object_logging/log/base"
+
+module ObjectLogging
+  module Log
+    class Stdout < Base
+      
+      def log(level, context, message)
+        super
+        puts "[#{level.downcase}] #{context} #{message}"
+      end
+      
+    end
+  end
+end

data/lib/object_logging/logger.rb

@@ -0,0 +1,69 @@
+module ObjectLogging
+  class Logger
+    
+    def initialize(object)
+      @log = instantiate_log(object)
+    end
+    
+    def objectify(object)
+      (@object = object) and self
+    end
+    
+    %w[debug info warn error fatal].each do |level|
+      class_eval <<-str
+        def #{level}(message, options = {})
+          make_entry("#{level}", message, options)
+        end
+      str
+    end
+    
+    def log
+      entries.collect do |level, context, message|
+        "[#{level}] #{context} #{message}"
+      end.join("\n")
+    end
+    
+    def entries
+      @log.entries
+    end
+    
+    def clear
+      @log.clear
+    end
+    
+  private
+    
+    def instantiate_log(object)
+      type, options = object.class.object_logging
+      type = "base", options = {} if type.nil?
+      class_name = type.to_s.split("_").collect{ |word| word.capitalize }.join
+      klass = ObjectLogging::Log.const_get(class_name)
+      klass.new(object, options)
+    end
+    
+    def make_entry(level, message, options)
+      method_name = options[:method_name] || get_method_name
+      class_name  = options[:class_name] || get_class_name(method_name)
+      context = "#{class_name}##{method_name}"
+      @log.log(level.upcase, context, message)
+    end
+    
+    def get_method_name
+      m = caller[2].match(/`(.+)'/)
+      if m
+        m[1]
+      else
+        "(unknown)"
+      end
+    end
+    
+    def get_class_name(method_name)
+      if @object.respond_to?(method_name.to_sym)
+        @object.class.name
+      else
+        "(unknown)"
+      end
+    end
+    
+  end
+end

data/lib/object_logging/metaclass.rb

@@ -0,0 +1,7 @@
+class Object
+  def metaclass
+    class << self
+      self
+    end
+  end
+end

data/test/object_logging_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class ObjectLoggingTest < Test::Unit::TestCase
+  
+  def test_basic
+    u = User.new
+    u.foo
+    u.bar
+    expected = [
+      ["DEBUG", "User#foo", "foo"],
+      ["INFO", "User#bar", "bar"]
+    ]
+    assert_equal expected, u.logger.entries
+  end
+  
+  def test_usurping
+    u = User.new
+    a = Account.new
+    
+    u.foo
+    a.foi
+    
+    u_logger = u.logger
+    u.logger = a.logger
+    
+    u.bar
+    a.baz
+    
+    u.logger = u_logger
+    
+    u.foo
+    a.foi
+    
+    expected = [
+      ["DEBUG", "User#foo", "foo"],
+      ["DEBUG", "User#foo", "foo"]
+    ]
+    assert_equal expected, u.logger.entries
+    
+    expected = [
+      ["DEBUG", "Account#foi", "foi"],
+      ["INFO", "User#bar", "bar"],
+      ["INFO", "Account#baz", "baz"],
+      ["DEBUG", "Account#foi", "foi"],
+    ]
+    assert_equal expected, a.logger.entries
+  end
+  
+  def test_inheritance
+    p = Person.new
+    s = Schmuck.new
+    assert_equal p.class.object_logging, s.class.object_logging
+    assert_not_equal p.class.object_logging.object_id, s.class.object_logging.object_id
+    assert_equal([:rails_log, {}], s.class.object_logging)
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'object_logging'
+
+class Test::Unit::TestCase
+end
+
+class User
+  include ObjectLogging
+  
+  def foo
+    logger.debug("foo")
+  end
+  
+  def bar
+    logger.info("bar")
+  end
+end
+
+class Account
+  include ObjectLogging
+  
+  def foi
+    logger.debug("foi")
+  end
+  
+  def baz
+    logger.info("baz")
+  end
+  
+end
+
+class Person
+  include ObjectLogging
+  object_logging :rails_log
+end
+
+class Schmuck < Person
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: object_logging
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christopher J. Bottaro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: It's a pain to trudge through large log files.  Sometimes you just want to see log messages for one particular object.
+email: cjbottaro@alumni.cs.utexas.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/object_logging.rb
+- lib/object_logging/log/base.rb
+- lib/object_logging/log/rails_cache.rb
+- lib/object_logging/log/rails_log.rb
+- lib/object_logging/log/stdout.rb
+- lib/object_logging/logger.rb
+- lib/object_logging/metaclass.rb
+- test/object_logging_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cjbottaro/object_logging
+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: Super simple logging for objects.
+test_files: 
+- test/object_logging_test.rb
+- test/test_helper.rb