logfoo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99b9133634291a10985c788fc7b72295c4c2c5f7
+  data.tar.gz: 441f75d9524ec2c761e210cd9aa813aa32207cb0
+SHA512:
+  metadata.gz: 70f9168d32bba533630acf666915a9f60cb7c8dedfbb22a6c4a3157d40702d96460ae069dc8b74af3ecca389c9e9ee7d1b2cafced86add7a5b4648bdf535b3b2
+  data.tar.gz: 43752457c5b71c7e021d9f7a7395e833665e33c7b8ca7ed06f6bac9d2952bb74dcab1b17b610ab2a4141dc40d6861aa8be28a62cde2792e37f81c34b10150323

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dima.exe@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dmitry Galinsky
+
+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,41 @@
+# Logfoo
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logfoo`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logfoo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logfoo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/logfoo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+  t.libs << "test"
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logfoo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logfoo/app.rb

@@ -0,0 +1,96 @@
+require 'thread'
+require 'singleton'
+
+module Logfoo
+  class App
+
+    include Singleton
+
+    def initialize
+      @queue = Queue.new
+      @lock  = Mutex.new
+    end
+
+    def start
+      @lock.synchronize do
+        unless @thread
+          @thread = main_loop
+        end
+      end
+    end
+
+    def started?
+      !!@thread
+    end
+
+    def stop
+      @lock.synchronize do
+        return unless @thread
+        append(:shutdown)
+        @thread.join
+        @thread = nil
+      end
+    end
+
+    def append(entry)
+      @queue.push(entry) if @thread
+    end
+
+    private
+
+      def new_entry(msg)
+        Entry.new(
+          :info,
+          Time.now,
+          self.class,
+          msg
+        )
+      end
+
+      def main_loop ; Thread.new do
+        begin
+          loop do
+            entry = @queue.pop
+            if entry == :shutdown
+              break
+            end
+            if entry == :boom
+              raise RuntimeError.new("ignore me")
+            end
+            App.append(entry)
+          end
+        rescue Exception => ex
+          App.handle_exception(ex, self.class)
+          retry
+        end
+      end ; end
+  end
+
+  class App
+    class << self
+      @@appenders          = [IoAppender.new]
+      @@exception_handlers = [StderrExceptionHanlder.new]
+
+      def appenders(*fn)
+        @@appenders = fn.flatten
+      end
+
+      def exception_handlers(*fn)
+        @@exception_handlers = fn.flatten
+      end
+
+      def append(entry)
+        @@appenders.each{|fn| fn.call(entry) }
+      end
+
+      def handle_exception(ex, scope = nil, context = {})
+        @@exception_handlers.each{|fn| fn.call(ex, scope, context) }
+      end
+
+      def reset!
+        @@appenders          = [IoAppender.new]
+        @@exception_handlers = [StderrExceptionHanlder.new]
+      end
+    end
+  end
+end

data/lib/logfoo/appenders/io_appender.rb

@@ -0,0 +1,13 @@
+module Logfoo
+  class IoAppender
+    def initialize(io = nil, formatter = nil)
+      @io        = io || STDOUT
+      is_tty     = @io.respond_to?(:tty?) && @io.tty?
+      @formatter = formatter || (is_tty ? SimpleFormatter.new : LogfmtFormatter.new)
+    end
+
+    def call(entry)
+      @formatter.call(entry).each{|line| @io.puts line }
+    end
+  end
+end

data/lib/logfoo/context.rb

@@ -0,0 +1,63 @@
+module Logfoo
+  class Context
+
+    attr_reader :level
+
+    def initialize(app, scope, context = nil)
+      @app     = app
+      @scope   = scope
+      @level   = Logfoo::DEBUG
+      @context = context || {}
+    end
+
+    def level=(level)
+      @level = level.to_i
+    end
+
+    def []=(k,v)
+      if v == nil
+        @context.delete(k)
+      else
+        @context[k] = v
+      end
+    end
+
+    def measure(message, payload = {})
+      tm = Time.now.to_f
+      re = nil
+      re = yield if block_given?
+      tm = Time.now.to_f - tm
+      payload[:duration] = tm
+      self.info message, payload
+      re
+    end
+
+    Logfoo::LEVELS.each_with_index do |lv, idx|
+      level_id = lv.downcase.to_sym
+      define_method level_id do |message = nil, payload = nil, &block|
+        return if idx < level
+        message = block ? block.call : message
+        payload = @context.merge(payload || {})
+        entry =
+          if message.is_a?(Exception)
+            ExceptionEntry.new(
+              level_id,
+              Time.now,
+              @scope,
+              message,
+              payload
+            )
+          else
+            Entry.new(
+              level_id,
+              Time.now,
+              @scope,
+              message,
+              payload
+            )
+          end
+        @app.append(entry)
+      end
+    end
+  end
+end

data/lib/logfoo/entry.rb

@@ -0,0 +1,24 @@
+module Logfoo
+  Entry = Struct.new(:level, :time, :scope, :message, :payload) do
+    def to_h
+      {
+        level:   level   || :info,
+        time:    time    || Time.now,
+        message: message,
+        scope:   scope,
+      }.merge!(payload || {})
+    end
+  end
+
+  ExceptionEntry = Struct.new(:level, :time, :scope, :exception, :payload) do
+    def to_h
+      {
+        level:     level || :error,
+        time:      time  || Time.now,
+        message:   exception.message,
+        scope:     scope,
+        exception: exception.class.to_s,
+      }.merge!(payload || {})
+    end
+  end
+end

data/lib/logfoo/exception_handlers/stderr_exception_handler.rb

@@ -0,0 +1,14 @@
+module Logfoo
+
+  class StderrExceptionHanlder
+    def initialize(appender = nil)
+      @appender = appender || IoAppender.new(STDERR)
+    end
+
+    def call(ex, scope, context)
+      entry = ExceptionEntry.new(nil, nil, scope, ex, context)
+      @appender.call(entry)
+    end
+  end
+
+end

data/lib/logfoo/formatters/logfmt_formatter.rb

@@ -0,0 +1,71 @@
+module Logfoo
+  class LogfmtFormatter
+
+    UNESCAPED_STRING = /\A[\w\.\-\+\%\,\:\;\/]*\z/i
+
+    IGNORED_FIELDS = [:time]
+
+    def call(entry)
+      case entry
+      when ExceptionEntry
+        format_exception(entry)
+      when Entry
+        format_entry(entry)
+      else
+        [entry_or_ex.to_s]
+      end
+    end
+
+    private
+
+      def format_entry(entry)
+        [format_hash(entry.to_h)]
+      end
+
+      def format_exception(entry)
+        values = []
+        values << format_hash(entry.to_h)
+        if entry.exception && entry.exception.backtrace.is_a?(Array)
+          values <<
+            "#{entry.exception.class}: #{entry.exception.message}\n" +
+            entry.exception.backtrace.map{|l| "\t#{l}" }.join("\n")
+        end
+        values
+      end
+
+      def format_hash(attrs)
+        attrs.inject([]) do |ac, (k,v)|
+          if !IGNORED_FIELDS.include?(k) && !(v == nil || v == "")
+            new_value = sanitize(v)
+            ac << "#{k}=#{new_value}"
+          end
+          ac
+        end.join(" ")
+      end
+
+      def sanitize(v)
+        case v
+        when ::Array
+          may_quote v.join(",")
+        when ::Integer, ::Symbol
+          v.to_s
+        when ::Float
+          "%0.4f" % v
+        when ::TrueClass, ::FalseClass
+          v ? "t" : "f"
+        when Time
+          quote v.utc.to_s
+        else
+          may_quote(v.to_s)
+        end
+      end
+
+      def quote(s)
+        s.inspect
+      end
+
+      def may_quote(s)
+        s =~ UNESCAPED_STRING ? s : quote(s)
+      end
+  end
+end

data/lib/logfoo/formatters/simple_formatter.rb

@@ -0,0 +1,21 @@
+module Logfoo
+  class SimpleFormatter < LogfmtFormatter
+
+    private
+
+      def format_hash(attrs)
+        level   = attrs.delete(:level)
+        message = attrs.delete(:message)
+        scope   = attrs.delete(:scope)
+
+        IGNORED_FIELDS.each do |f|
+          attrs.delete(f)
+        end
+
+        payload = super(attrs)
+        payload = payload.empty? ? "" : " [#{payload}]"
+        message = message.to_s.empty? ? "" : " #{message}"
+        "[%5s]: #{scope} -#{message}#{payload}" % level.upcase
+      end
+  end
+end

data/lib/logfoo/version.rb

@@ -0,0 +1,3 @@
+module Logfoo
+  VERSION = '0.0.1'
+end

data/lib/logfoo.rb

@@ -0,0 +1,43 @@
+module Logfoo
+  TRACE = 0
+  DEBUG = 1
+  INFO  = 2
+  WARN  = 3
+  ERROR = 4
+  FATAL = 5
+
+  LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'].freeze
+
+  def self.get_logger(scope, context = nil)
+    App.instance.start unless App.instance.started?
+    Context.new(App.instance, scope.to_s, context)
+  end
+
+  def self.stop
+    App.instance.stop
+  end
+
+  def logfmt_formatter
+    LogfmtFormatter.new
+  end
+
+  def simple_formatter
+    SimpleFormatter.new
+  end
+
+  def io_appender(*args)
+    IoAppender.new(*args)
+  end
+end
+
+%w{
+  entry
+  formatters/logfmt_formatter
+  formatters/simple_formatter
+  appenders/io_appender
+  exception_handlers/stderr_exception_handler
+  app
+  context
+}.each do |f|
+  require File.expand_path("../logfoo/#{f}", __FILE__)
+end

data/logfoo.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logfoo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logfoo"
+  spec.version       = Logfoo::VERSION
+  spec.authors       = ["Dmitry Galinsky"]
+  spec.email         = ["dima.exe@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/dmexe/logfoo"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: logfoo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Galinsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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: Write a longer description or delete this line.
+email:
+- dima.exe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logfoo.rb
+- lib/logfoo/app.rb
+- lib/logfoo/appenders/io_appender.rb
+- lib/logfoo/context.rb
+- lib/logfoo/entry.rb
+- lib/logfoo/exception_handlers/stderr_exception_handler.rb
+- lib/logfoo/formatters/logfmt_formatter.rb
+- lib/logfoo/formatters/simple_formatter.rb
+- lib/logfoo/version.rb
+- logfoo.gemspec
+homepage: https://github.com/dmexe/logfoo
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files: []