ichnite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac82fab7a519dfb9edef4d98a92f953546e7cc1c
+  data.tar.gz: a4868d184ac77fb4435a423614d6e801fb3c859b
+SHA512:
+  metadata.gz: 07a693714a2a2afaa613ec83fad18bf16b1a3f5f6082d828cbd1692632c972891c8f573b846eb9b46e99f8313e52d7b15dda1f011501815b9920c14d7d62115b
+  data.tar.gz: 396b276ebde495bf1e8ea35af076f97aa19a15f6b7ffa4144679caf4a8f11c8a02fa55455008bfed4223a1df87e7ab19686e8c98571663097859fca34680f496

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yves Senn
+
+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 @@
+# Ichnite
+
+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/ichnite`. 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 'ichnite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ichnite
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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]/ichnite.
+
+
+## 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(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ichnite"
+
+# 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/ichnite.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ichnite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ichnite"
+  spec.version       = Ichnite::VERSION
+  spec.authors       = ["Yves Senn"]
+  spec.email         = ["yves.senn@gmail.com"]
+
+  spec.summary       = %q{A structured logging library.}
+  spec.description   = %q{Bring structured logging to your Ruby applications.}
+  spec.homepage      = "https://github.com/senny/ichnite"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/ichnite.rb

@@ -0,0 +1,57 @@
+require "ichnite/version"
+require "ichnite/formatters"
+require "ichnite/logger"
+
+module Ichnite
+  def self.log(event, opts = {})
+    default_logger.log(event, opts)
+  end
+
+  def self.context(event)
+    c = { event: event.to_s }
+    @augments.each { |a| c.merge!(a.call) } if defined?(@augments)
+    if Thread.current[:ichnite_context]
+      c.merge!(Thread.current[:ichnite_context])
+    end
+    c
+  end
+
+  def self.augment(&blk)
+    @augments ||= []
+    @augments << blk
+  end
+
+  def self.enter(context)
+    Thread.current[:ichnite_context] ||= {}
+    Thread.current[:ichnite_context].merge!(context)
+
+    if block_given?
+      begin
+        yield
+      ensure
+        leave(*context.keys)
+      end
+    end
+  end
+
+  def self.leave(*context_keys)
+    if context_keys.empty?
+      Thread.current[:ichnite_context] = {}
+    else
+      context_keys.each {|k| Thread.current[:ichnite_context].delete k }
+    end
+  end
+
+  def self.default_logger
+    @default_logger ||=
+      if defined?(Rails)
+        Ichnite::Logger.new(Rails.logger)
+      else
+        Ichnite::Logger.new($stdout)
+      end
+  end
+
+  def self.default_logger=(logger)
+    @default_logger = logger
+  end
+end

data/lib/ichnite/formatters.rb

@@ -0,0 +1,32 @@
+# Vendored from lograge.
+# Source: https://github.com/roidrage/lograge/blob/master/lib/lograge/formatters/key_value.rb
+# License: MIT
+module Ichnite
+  module Formatters
+    class KeyValue
+      def call(data)
+        fields = fields_to_display(data)
+
+        event = fields.map { |key| format(key, data[key]) }
+        event.join(' ')
+      end
+
+      def fields_to_display(data)
+        data.keys
+      end
+
+      def format(key, value)
+        if key == :error
+          # Exactly preserve the previous output
+          # Parsing this can be ambigious if the error messages contains
+          # a single quote
+          value = "'#{value}'"
+        elsif value.is_a? Float
+          value = Kernel.format('%.2f', value)
+        end
+
+        "#{key}=#{value}"
+      end
+    end
+  end
+end

data/lib/ichnite/logger.rb

@@ -0,0 +1,23 @@
+module Ichnite
+  class Logger
+    attr_reader :logger
+
+    def initialize(logger)
+      @logger = logger
+      @formatter = Formatters::KeyValue.new
+    end
+
+    def log(event, opts = {})
+      emit(Ichnite.context(event).merge(opts))
+    end
+
+    private
+
+    def emit(data)
+      data.each do |k, v|
+        data[k] = v.iso8601 if v.respond_to?(:iso8601)
+      end
+      @logger.info @formatter.call(data)
+    end
+  end
+end

data/lib/ichnite/version.rb

@@ -0,0 +1,3 @@
+module Ichnite
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ichnite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yves Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Bring structured logging to your Ruby applications.
+email:
+- yves.senn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ichnite.gemspec
+- lib/ichnite.rb
+- lib/ichnite/formatters.rb
+- lib/ichnite/logger.rb
+- lib/ichnite/version.rb
+homepage: https://github.com/senny/ichnite
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A structured logging library.
+test_files: []
+has_rdoc: