loggem 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f4ccc993806cfff7d3136dda26cb18c894841ba
+  data.tar.gz: 91e20794192eef5747113598247b5fc3561ff012
+SHA512:
+  metadata.gz: 3fcbffff07692ebbac951698b5566eb87d158878e6ea5d73127755e2b33484efb1bfec6ff4c986abea8b81b61c9e99fc6410751cb18abe477ebbe43f1c837694
+  data.tar.gz: 728493834434c189190ed48d5609160b1672f5dace4db4ecf4327b2c55b78d8f8b09dccd43c8d62eb6b6eef6a833cdf2f5bb81e8cc90f181da56854c752a90db

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loggem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Istvan Demeter
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Loggem
+
+Simple log wrapper with different formatters. Minimal Rails/ActiveRecord/Sequel support, so far
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'loggem'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loggem
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/qw3r/loggem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/loggem/event.rb

@@ -0,0 +1,49 @@
+module Loggem
+  class Event
+
+    def initialize(arguments = {})
+      @data = {}
+      @arguments = arguments
+    end
+
+
+
+    def data
+      parse_arguments @arguments
+    end
+
+
+
+    private
+
+    STACKTRACE_SIZE = 5
+
+
+
+    def parse_arguments(arguments)
+      @data.merge! at: arguments.fetch(:level)
+      @data.merge! parse arguments.fetch(:message)
+      @data.merge! parse arguments.fetch(:payload, {})
+      @data.merge! arguments.fetch(:context, {})
+    end
+
+
+
+    def parse(object)
+      case object
+        when Exception
+          return {message: object.message} if object.backtrace.nil?
+
+          {message: object.message, stacktrace: object.backtrace[0..(STACKTRACE_SIZE - 1)].join("\n")}
+
+        when Hash
+          object
+
+        else
+          {message: object.to_s.strip}
+
+      end
+    end
+
+  end
+end

data/lib/loggem/extensions/active_record.rb

@@ -0,0 +1,25 @@
+require 'active_record'
+
+module Loggem
+  module Extensions
+    module ActiveRecord
+
+      def self.included(klass)
+        klass.send :remove_method, :sql
+      end
+
+
+
+      def sql(event)
+        payload = event.payload
+        return if %w(SCHEMA EXPLAIN).include?(payload[:name])
+
+        debug message: payload[:sql], duration: event.duration.round(4), description: payload[:name], source: 'active_record'
+      end
+
+    end
+
+    ::ActiveRecord::LogSubscriber.send :include, ActiveRecord
+  end
+end
+

data/lib/loggem/extensions/sequel.rb

@@ -0,0 +1,23 @@
+require 'sequel'
+
+module Loggem
+  module Extensions
+    module Sequel
+
+      def self.included(klass)
+        klass.send :remove_method, :log_duration
+      end
+
+
+
+      def log_duration(duration, message)
+        return if message.start_with? 'SET '
+
+        log_each((lwd = log_warn_duration and duration >= lwd) ? :warn : sql_log_level, {message: message, duration: (duration * 1000).round(4), source: 'sequel'})
+      end
+
+    end
+
+    ::Sequel::Database.send :include, Sequel
+  end
+end

data/lib/loggem/formatters/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module Loggem
+  module Formatters
+    class Json
+
+      def call(data)
+        JSON.dump data
+      end
+
+    end
+  end
+end

data/lib/loggem/formatters/key_value.rb

@@ -0,0 +1,32 @@
+module Loggem
+  module Formatters
+    class KeyValue
+
+      def call(data)
+        data.each.map { |k, v| format k, v }.join ' '
+      end
+
+
+
+      private
+
+      def format(key, value)
+        %Q|#{key}="#{format_value value}"|
+      end
+
+
+
+      def format_value(value)
+        case value
+          when String
+            value.gsub('"') { %q|\"| }
+          when Symbol
+            value
+          else
+            value.inspect
+        end
+      end
+
+    end
+  end
+end

data/lib/loggem/formatters/raw.rb

@@ -0,0 +1,11 @@
+module Loggem
+  module Formatters
+    class Raw
+
+      def call(data)
+        data
+      end
+
+    end
+  end
+end

data/lib/loggem/logger.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module Loggem
+  class Logger
+
+    attr_reader :context
+
+
+
+    def initialize(logger = ::Logger.new(STDOUT))
+      @logger = logger
+      @context = {}
+      @formatter = ::Loggem::Formatters::Json.new
+    end
+
+
+
+    def formatter=(formatter)
+      raise ArgumentError.new("Formatter must respond to 'call'") unless formatter.respond_to?(:call)
+
+      @formatter = formatter
+    end
+
+
+
+    [:debug, :info, :warn, :error, :fatal].each do |level|
+      define_method level do |message, payload = {}|
+        log level, message, payload
+      end
+    end
+
+
+
+    def method_missing(method, *arguments)
+      logger.public_send method, *arguments
+    end
+
+
+
+    private
+
+    attr_reader :logger, :formatter
+
+
+
+    def log(level, message, payload)
+      logger.public_send level, formatter.call(build_event(level, message, payload))
+    end
+
+
+
+    def build_event(level, message, payload)
+      ::Loggem::Event.new(level: level,
+                          message: message,
+                          payload: payload,
+                          context: context).data
+    end
+
+  end
+end

data/lib/loggem/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+#require 'action_view/log_subscriber'
+#require 'action_controller/log_subscriber'
+
+module Lograge
+  class Railtie < Rails::Railtie
+    config.loggem = ActiveSupport::OrderedOptions.new
+    config.loggem.enabled = false
+
+    initializer :loggem do |app|
+      ::Loggem.setup_rails app if config.loggem.enabled
+    end
+  end
+end

data/lib/loggem/version.rb

@@ -0,0 +1,3 @@
+module Loggem
+  VERSION = "0.0.3"
+end

data/lib/loggem.rb

@@ -0,0 +1,30 @@
+require 'loggem/version'
+require 'loggem/logger'
+require 'loggem/event'
+
+require 'loggem/formatters/raw'
+require 'loggem/formatters/json'
+require 'loggem/formatters/key_value'
+
+
+module Loggem
+
+  def self.setup_rails(app)
+    config = app.config.loggem
+
+    logger = Loggem::Logger.new config.logger
+    logger.formatter = config.formatter || ::Loggem::Formatters::Json.new
+    logger.context.merge!(config.context || {})
+    (config.extensions || []).each { |ext| load_extension ext }
+
+    ::Rails.logger = app.config.logger = logger
+  end
+
+
+  def self.load_extension(extension)
+    require "loggem/extensions/#{extension}"
+  end
+
+end
+
+require 'loggem/railtie' if defined?(Rails)

data/loggem.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loggem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "loggem"
+  spec.version       = Loggem::VERSION
+  spec.authors       = ["Istvan Demeter"]
+  spec.email         = ["istvan.demeter@emarsys.com"]
+  spec.summary       = %q{Simple log wrapper with different formatters. Rails/ActiveRecord/Sequel support, so far}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/qw3r/loggem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/loggem/event_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Loggem::Event do
+  subject { Loggem::Event }
+
+  describe 'parsing strings' do
+    it 'should return the parsed message' do
+      event = subject.new level: :info, message: 'string'
+
+      expect(event.data).to eq(at: :info, message: 'string')
+    end
+
+    it 'should strip the leading and trailing spaces' do
+      event = subject.new level: :info, message: '  string  '
+
+      expect(event.data).to eq(at: :info, message: 'string')
+    end
+  end
+
+
+  describe 'parsing exceptions' do
+    let(:exception) { StandardError.new 'error message' }
+
+    it 'should handle exceptions with no stacktrace' do
+      event = subject.new level: :info, message: exception
+
+      expect(event.data).to eq(at: :info, message: 'error message')
+    end
+
+    it 'should log the stacktrace of exceptions (up to 5 lines)' do
+      exception.set_backtrace Array.new(8) { |i| "line#{i}" }
+
+      event = subject.new level: :info, message: exception
+
+      expect(event.data).to eq(at: :info, message: 'error message', stacktrace: "line0\nline1\nline2\nline3\nline4")
+    end
+
+  end
+
+
+  describe 'logging arbitrary objects' do
+    it 'should not fail' do
+      event = subject.new level: :info, message: Object.new
+
+
+      expect { event.data }.to_not raise_error
+    end
+  end
+
+
+  describe 'logging Hash' do
+    it 'should pass it as-is' do
+      event = subject.new level: :info, message: {foo: 'bar'}
+
+      expect(event.data).to eq(at: :info, foo: 'bar')
+    end
+  end
+
+
+  describe 'logging extra information' do
+    it 'should add any extra information given in a Hash without changes' do
+      event = subject.new level: :info, message: 'sh!t happen', payload: {customer: 123}
+
+      expect(event.data).to eq(at: :info, message: 'sh!t happen', customer: 123)
+    end
+  end
+
+
+  describe 'logging context information' do
+    it "should log the context in every log message" do
+      event = subject.new level: :info, message: 'sh!t happen', context: {request_id: 123}
+
+      expect(event.data).to eq(at: :info, message: 'sh!t happen', request_id: 123)
+    end
+  end
+end

data/spec/loggem/formatters/json_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Loggem::Formatters::Json do
+
+  describe "#call" do
+    it "returns the JSON encoded data" do
+      allow(JSON).to receive(:dump).with('raw-data').and_return 'json-data'
+
+      expect(subject.call 'raw-data').to eq 'json-data'
+    end
+  end
+end

data/spec/loggem/formatters/key_value_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Loggem::Formatters::KeyValue do
+
+  describe "#call" do
+    {
+      {message: 'event worth to mention'} => %q{message="event worth to mention"},
+      {message: "single ' quote"} => %q{message="single ' quote"},
+      {message: "double \" quote"} => %q{message="double \" quote"},
+      {tags: %w[a b c]} => %q{tags="["a", "b", "c"]"},
+      {symbol: :symbol} => %q{symbol="symbol"},
+    }.each do |input, output|
+      it "returns the data as key-value pairs" do
+        expect(subject.call input).to eq output
+      end
+    end
+  end
+end

data/spec/loggem/formatters/raw_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Loggem::Formatters::Raw do
+
+  describe "#call" do
+    it "returns the raw data" do
+      expect(subject.call 'raw-data').to eq 'raw-data'
+    end
+  end
+end

data/spec/loggem/logger_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Loggem::Logger do
+  let(:logger) { double 'Logger' }
+
+  subject { Loggem::Logger.new logger }
+
+  describe "use formatters" do
+    let(:default_formatter) { double 'Default Formatter' }
+
+    before(:each) do
+      allow(Loggem::Formatters::Json).to receive(:new).and_return(default_formatter)
+      allow(logger).to receive(:info)
+    end
+
+
+    it "should use the default formatter if none provided" do
+      expect(default_formatter).to receive(:call).with(at: :info, message: 'log message')
+
+      subject.info 'log message'
+    end
+
+
+    it "should use custom formatter if none provided" do
+      formatter = double 'Formatter'
+
+      expect(formatter).to receive(:call).with(at: :info, message: 'log message')
+
+      subject.formatter = formatter
+      subject.info 'log message'
+    end
+
+
+    it "should raise error if formatter doesn't respond to call" do
+      expect {
+        subject.formatter = nil
+      }.to raise_error ArgumentError, "Formatter must respond to 'call'"
+    end
+
+
+  end
+
+
+  describe 'delegate unknown messages to logger' do
+    it "delegates message 'level=' to the logger" do
+      expect(logger).to receive(:level=).with 'desired log level'
+
+      subject.level = 'desired log level'
+    end
+  end
+
+
+  describe 'logging messages' do
+    let(:event) { double 'Event', data: 'event hash' }
+    let(:formatter) { double 'Formatter' }
+
+    before(:each) do
+      allow(formatter).to receive(:call).with('event hash').and_return 'formatted message'
+    end
+
+
+    [:debug, :info, :warn, :error, :fatal].each do |level|
+      it "should log a #{level} message" do
+        allow(::Loggem::Event).to receive(:new).
+                                    with(level: level, message: 'raw message', payload: {}, context: {}).
+                                    and_return(event)
+        expect(logger).to receive(level).with('formatted message')
+
+        subject.formatter = formatter
+        subject.send level, 'raw message'
+      end
+    end
+
+
+    it 'should log a message with payload' do
+      allow(::Loggem::Event).to receive(:new).
+                                  with(level: :info, message: 'raw message', payload: 'payload', context: {}).
+                                  and_return(event)
+      expect(logger).to receive(:info).with('formatted message')
+
+      subject.formatter = formatter
+      subject.info 'raw message', 'payload'
+    end
+
+
+    it 'should log multiple messages with the same context' do
+      allow(::Loggem::Event).to receive(:new).
+                                  with(level: :info, message: 'raw message', payload: {}, context: {request_id: 123}).
+                                  and_return(event)
+
+      expect(logger).to receive(:info).with('formatted message').twice
+
+      subject.formatter = formatter
+      subject.context[:request_id] = 123
+
+      subject.info 'raw message'
+      subject.info 'raw message'
+    end
+
+  end
+
+end

data/spec/loggem_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+
+describe Loggem do
+
+  describe ".rails_setup" do
+    let(:config) { double 'Config', loggem: double(enabled: true,
+                                                   logger: 'custom logger',
+                                                   formatter: 'custom formatter',
+                                                   context: nil,
+                                                   extensions: nil) }
+    let(:rails) { double 'Rails Application', config: config }
+    let(:loggem) { double 'Loggem instance', context: {} }
+
+    before do
+      module Rails
+      end
+    end
+
+    it "should setup rails integration" do
+      allow(::Loggem::Logger).to receive(:new).with('custom logger').and_return(loggem)
+
+      expect(loggem).to receive(:formatter=).with('custom formatter')
+      expect(config).to receive(:logger=).with(loggem)
+      expect(Rails).to receive(:logger=).with(loggem)
+
+      subject.setup_rails(rails)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+require 'loggem'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: loggem
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Istvan Demeter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- istvan.demeter@emarsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/loggem.rb
+- lib/loggem/event.rb
+- lib/loggem/extensions/active_record.rb
+- lib/loggem/extensions/sequel.rb
+- lib/loggem/formatters/json.rb
+- lib/loggem/formatters/key_value.rb
+- lib/loggem/formatters/raw.rb
+- lib/loggem/logger.rb
+- lib/loggem/railtie.rb
+- lib/loggem/version.rb
+- loggem.gemspec
+- spec/loggem/event_spec.rb
+- spec/loggem/formatters/json_spec.rb
+- spec/loggem/formatters/key_value_spec.rb
+- spec/loggem/formatters/raw_spec.rb
+- spec/loggem/logger_spec.rb
+- spec/loggem_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/qw3r/loggem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple log wrapper with different formatters. Rails/ActiveRecord/Sequel support,
+  so far
+test_files:
+- spec/loggem/event_spec.rb
+- spec/loggem/formatters/json_spec.rb
+- spec/loggem/formatters/key_value_spec.rb
+- spec/loggem/formatters/raw_spec.rb
+- spec/loggem/logger_spec.rb
+- spec/loggem_spec.rb
+- spec/spec_helper.rb