prepor-ologger 0.1.2

data/.gitignore

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

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ologger"
+    gemspec.summary = "Object separated logs"
+    gemspec.description = ""
+    gemspec.email = "ceo@prepor.ru"
+    gemspec.homepage = "http://github.com/prepor/olog"
+    gemspec.authors = ["Andrew Rudenko"]
+    gemspec.add_dependency('prepor-artester')
+    gemspec.add_dependency('activesupport')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/Readme.rdoc

@@ -0,0 +1,26 @@
+= Usage
+
+  # Initializer
+  require 'ologger'
+  Object.send :include OLogger
+  
+  # Controller  
+  around_filter OLogger
+  
+  # Daemon  
+  OLogger.enable do
+    loop do
+      bla bla
+    end
+  end
+  
+  # Configs  
+  OLogger.path = Pathname('log/ologs')
+  
+  # In objects
+  def start!(character)
+    ologger "Starting project", character
+  end
+	
+
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/bin/ologger

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + "/../lib/ologger"
+
+ARGV.each do |path|
+  OLogger.gc_dir(Pathname.new(path))
+end

data/lib/ologger/buffer.rb

@@ -0,0 +1,36 @@
+module OLogger
+  class Buffer
+    attr_accessor :messages
+  
+    def initialize
+      self.messages = []
+    end
+  
+    def flush
+      self.messages = []
+    end
+  
+    def add(options = {})
+      messages << options
+    end
+  
+    def grouped_messages
+      messages.group_by { |b| "#{b[:logger_module]}.#{b[:logger_id]}"}
+    end
+  
+    def write
+      grouped_messages.each do |k, game_module_messages|
+        logger_module = game_module_messages.first[:logger_module] || 'unknown'
+        logger_id = game_module_messages.first[:logger_id] || 'unknown'
+        OLogger.create_module(logger_module)        
+        (OLogger.path + logger_module + (logger_id.to_s + '.log')).open('a+') do |file|
+          game_module_messages.each do |message|
+            file.puts "#{Time.now.strftime('%d.%m.%Y %H:%M:%S')}: #{message[:message]}"
+            message[:objs].each { |obj| PP.pp(obj, file) } if message[:objs]
+          end
+        end        
+      end 
+    end
+  
+  end
+end

data/lib/ologger/middleware.rb

@@ -0,0 +1,23 @@
+module OLogger
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      OLogger.buffer.flush
+      @status, @headers, @response = @app.call(env)
+      OLogger.buffer.write
+      [@status, @headers, self]
+    end
+  
+    def each(&block)
+      @response.each(&block)
+    end
+
+  end
+end

data/lib/ologger/object_methods.rb

@@ -0,0 +1,34 @@
+module OLogger
+  module ObjectMethods
+    def ologger_module
+      self.class.name.tableize
+    end
+
+    def ologger_id
+      if defined?(ActiveRecord::Base) && self.is_a?(ActiveRecord::Base)
+        self.id
+      else
+        self.object_id
+      end 
+    end
+    # g#group_fight.123#
+    def ologger(message, *objs)
+      parsed_objs = objs.map { |o| ologger_object_format(o) }
+      OLogger.buffer.add :message => message, :objs => parsed_objs, :logger_module => ologger_module, :logger_id => ologger_id
+    end   
+    def ologger_object_format(obj)
+      if defined?(ActiveRecord::Base) && obj.is_a?(ActiveRecord::Base)
+        if obj == self
+          obj.attributes
+        elsif obj.ologger_id
+          OLogger.buffer.add :message => 'Self:', :objs => [obj.attributes], :logger_module => obj.ologger_module, :logger_id => obj.ologger_id        
+          "g##{obj.ologger_module}.#{obj.ologger_id}#"
+        else
+          obj
+        end
+      else
+        obj
+      end
+    end  
+  end  
+end

data/lib/ologger/parser.rb

@@ -0,0 +1,9 @@
+module OLogger
+  module Parser    
+    def self.parse(str)
+      str.gsub(/g#([\d\w.]+)\.([\d\w.]+)#/i, "<a href=\"#{OLogger::LOG_URL}\\1/\\2\">\\1/\\2</a>")
+    end
+  end
+  
+end
+  

data/lib/ologger/raise_patch.rb

@@ -0,0 +1,18 @@
+class StandardError
+  attr_accessor :obj
+end
+module Kernel
+  def ologger_raise(*argv)
+    if Thread.current[:ologger_raiser]
+      ex = StandardError.new(*argv)
+      ex.obj = self
+      ologger_old_raise ex
+    else
+      ologger_old_raise(*argv)
+    end
+  end
+
+  alias_method :ologger_old_raise, :raise
+  alias_method :raise, :ologger_raise
+
+end

data/lib/ologger/tags

@@ -0,0 +1,2 @@
+add	buffer.rb	/^    def add(options = {})$/
+open	buffer.rb	/^        (OLogger.path + logger_module + (logger_id/

data/lib/ologger.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'pp'
+require 'pathname'
+require 'activesupport'
+
+
+
+require 'ologger/raise_patch'
+module OLogger
+  LOG_URL = '/game_logs/'  
+  
+  require 'ologger/parser'
+  require 'ologger/buffer'
+  require 'ologger/object_methods'
+  require 'ologger/middleware'
+  
+  class << self
+    attr_accessor :path, :on_raise
+    def path
+      @path ||= defined?(RAILS_ROOT) ? Pathname.new(File.join(RAILS_ROOT, 'log/o_logs')) : nil
+    end
+    def gc
+      gc_dir
+    end
+    
+    def gc_dir(dir_path = OLogger.path)
+      if dir_path.directory?
+        dir_path.each_entry do |path|
+          if not_self_and_parent path
+            gc_dir(dir_path + path)
+          end
+        end
+      else
+        if needed_to_remove?(dir_path)
+          dir_path.delete
+        end
+      end
+    end
+    
+    def not_self_and_parent(path)
+      path.to_s != '.' && path.to_s != '..'
+    end
+    
+    def needed_to_remove?(path)
+      path.mtime < 1.day.ago || path.size > 300.kilobytes
+    end
+    
+    def get_log(log_id)
+      name = parse_log_id(log_id)
+      path = OLogger.path + name[:module] + name[:file]
+      if File.exist?(path)
+        OLogger::Parser.parse(File.read(path))
+      else
+        nil
+      end
+    end
+    
+    def list_of_modules
+      OLogger.path.entries.select { |v| not_self_and_parent v }
+    end
+    
+    def get_logs(log_module)
+      path = OLogger.path + log_module
+      path.entries.select { |v| not_self_and_parent v }.map{ |v| v.to_s.gsub /\.log$/, '' }
+    end
+    
+    def parse_log_id(log_id)
+      p = log_id.match(/(.+)\.(.+)/i)
+      {:module => p[1], :file => p[2] + '.log'}
+    end
+    
+    def create_module(log_module)
+      path = OLogger.path + log_module
+      unless path.exist?
+        path.mkpath
+      end      
+    end
+    
+    def logger(logger_module, logger)
+      Logger.new('logfile.log')
+    end
+    
+    def buffer
+      @buffer ||= Buffer.new
+    end
+    
+    def enable(&block)      
+      buffer.flush
+      Thread.current[:ologger_raiser] = true
+      begin
+        yield           
+      rescue StandardError => e
+        e.obj.ologger "Exception:", :objs => [e, e.backtrace]
+        on_raise.call(e) if on_raise && on_raise.is_a?(Proc)
+      ensure
+        Thread.current[:ologger_raiser] = false
+        buffer.write
+      end      
+    end
+    
+    def filter(controller, &block)
+      enable(&block)
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.send :include, ObjectMethods
+    receiver.extend ObjectMethods
+  end
+  
+
+end

data/ologger.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ologger}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko"]
+  s.date = %q{2009-09-14}
+  s.default_executable = %q{ologger}
+  s.description = %q{}
+  s.email = %q{ceo@prepor.ru}
+  s.executables = ["ologger"]
+  s.files = [
+    ".gitignore",
+     "Rakefile",
+     "Readme.rdoc",
+     "VERSION",
+     "bin/ologger",
+     "lib/ologger.rb",
+     "lib/ologger/buffer.rb",
+     "lib/ologger/middleware.rb",
+     "lib/ologger/object_methods.rb",
+     "lib/ologger/parser.rb",
+     "lib/ologger/raise_patch.rb",
+     "lib/ologger/tags",
+     "memory",
+     "ologger.gemspec",
+     "test/test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/prepor/olog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Object separated logs}
+  s.test_files = [
+    "test/test.rb",
+     "test/test_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<prepor-artester>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<prepor-artester>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<prepor-artester>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/test/test.rb

@@ -0,0 +1,97 @@
+require 'test/test_helper'
+
+describe OLogger do
+  describe "Object with game logger" do
+    before(:each) do
+      OLogger.buffer.flush
+      Object.send :include, OLogger
+      @obj = Object.new
+      
+    end
+    it "should add message to buffer" do
+      mock(OLogger.buffer).add(hash_including(:message => 'hi!'))
+      @obj.ologger 'hi!'
+    end
+    
+    it "should add objects to buffer" do
+      mock(OLogger.buffer).add(hash_including(:message => 'hi!', :objs => [{ :foo => :bar}, { :bar => :foo}]))
+      @obj.ologger 'hi!', { :foo => :bar}, { :bar => :foo}
+    end
+  end
+  
+  describe "ActiveRecord object with game logger" do    
+    before(:each) do
+      Artester[:game_logger].reload
+      OLogger.buffer.flush
+      Object.send :include, OLogger
+      @obj = Object.new
+      @ar_obj = Foo.create :name => 'tester', :bar => 'hi!'
+    end
+    
+    it "should insert link to ar object" do
+      mock(OLogger.buffer).add(hash_including(:message => 'Self:', :objs => [{"name"=>"tester", "id"=>1, "bar"=>"hi!"}]))
+      mock(OLogger.buffer).add(hash_including(:message => 'hi!', :objs => ["g#foos.#{@ar_obj.id}#"]))
+      stub(OLogger.buffer).add
+      @obj.ologger 'hi!', @ar_obj
+    end
+    
+    it "should insert itsel description to ar object log" do
+      mock(OLogger.buffer).add(hash_including(:message => 'Self:', :objs => [{"name"=>"tester", "id"=>1, "bar"=>"hi!"}]))      
+      stub(OLogger.buffer).add
+      
+      @obj.ologger 'hi!', @ar_obj
+    end
+    
+    it "should raise exceptions" do
+      mock(OLogger.buffer).add(hash_including(:message => "Exception:"))
+      OLogger.enable do
+        Foo.find(10)
+      end
+    end
+
+    describe "writing" do
+      
+      before(:all) do
+        OLogger.path = Pathname.new('test/ologs')
+        OLogger.path.rmtree if OLogger.path.exist?
+      end
+      
+      after(:each) do
+        OLogger.path.rmtree if OLogger.path.exist?
+      end
+
+      it 'should call raise callback' do
+        raiser = lambda { |e| 0 }
+        mock(raiser).call(is_a(StandardError))
+        OLogger.on_raise = raiser
+        OLogger.enable do
+          Foo.find(10)
+        end
+      end 
+      it "should write logs to file" do
+        path = OLogger.path + 'foos' + "#{@ar_obj.id}.log"
+        path.exist?.should be_false
+        OLogger.enable do
+          @ar_obj.ologger 'hi!'
+        end
+        path.exist?.should be_true
+      end
+      
+      describe "garbage collecting" do
+        before(:each) do          
+          OLogger.enable do
+            @ar_obj.ologger 'hi!'
+          end
+        end
+        it "should remove all big and old logs" do
+          stub(OLogger).needed_to_remove? { true }
+          (OLogger.path + 'foos' + "#{@ar_obj.id}.log").exist?.should be_true
+          OLogger.gc
+          (OLogger.path + 'foos' + "#{@ar_obj.id}.log").exist?.should be_false
+        end
+      end
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'test/unit'
+require 'spec'
+require 'rr'
+require 'artester'
+
+$LOAD_PATH.unshift('lib')
+
+require 'lib/ologger'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+Artester.init
+  
+Artester.def :game_logger do
+  model :foo do
+    definition do |t|
+      t.string :name
+      t.string :bar
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: prepor-ologger
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Andrew Rudenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-14 00:00:00 -07:00
+default_executable: ologger
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prepor-artester
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: ceo@prepor.ru
+executables: 
+- ologger
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- Readme.rdoc
+- VERSION
+- bin/ologger
+- lib/ologger.rb
+- lib/ologger/buffer.rb
+- lib/ologger/middleware.rb
+- lib/ologger/object_methods.rb
+- lib/ologger/parser.rb
+- lib/ologger/raise_patch.rb
+- lib/ologger/tags
+- memory
+- ologger.gemspec
+- test/test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/prepor/olog
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Object separated logs
+test_files: 
+- test/test.rb
+- test/test_helper.rb