kitlog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbfb04c9827d7c0c8eec169408abfeed397862a1c09e56e86addc8279c22df28
+  data.tar.gz: 7521afef6761be82e66f30649eab7c7b61a9018f5d00a4896b54fb0d8cae0289
+SHA512:
+  metadata.gz: 1988af1b796d22ca32e44f52bbf6320a1bc48c2769e2281877a7f87e8f3b5d5a22f8e120779bfeb1884f1a94947d90224d1f036c732413fdd0364eefe9b5db8b
+  data.tar.gz: db2bc7e901db3af7a32d24cf32b84d643d92d036b60b94246c907d9eeede4dad8e948555a52c1a003ba2d1f8f50f37b96adafed2a1f9ee7e28d78adb4c81f746

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+---
+version: 2
+
+references:
+  bundle_install: &bundle_install
+    run:
+      name: Bundle
+      command: gem install bundler && bundle install --path vendor/bundle --jobs=4 --retry=3
+
+  cache_bundle_for_lockfile: &cache_bundle_for_lockfile
+    save_cache:
+      key: ruby2.6.5-Gemfile-{{ checksum "Gemfile.lock" }}
+      paths:
+        - vendor/bundle
+
+  cache_bundle: &cache_bundle
+    save_cache:
+      key: ruby2.6.5-Gemfile
+      paths:
+        - vendor/bundle
+
+  restore_bundle: &restore_bundle
+    restore_cache:
+      keys:
+        - ruby2.6.5-Gemfile-{{ checksum "Gemfile.lock" }}
+        - ruby2.6.5-Gemfile
+
+jobs:
+  build:
+    docker:
+      - image: "ruby:2.6.5"
+    working_directory: ~/kitlog
+    steps:
+      - checkout
+      - *restore_bundle
+      - *bundle_install
+      - *cache_bundle_for_lockfile
+      - *cache_bundle
+      - run: bundle exec rubocop
+      - run: bundle exec rspec
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - build

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+---
+inherit_gem:
+  gc_ruboconfig: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,5 @@
+# Frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    kitlog (1.0.0)
+      values (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    gc_ruboconfig (2.8.0)
+      rubocop (>= 0.77)
+      rubocop-performance (~> 1.5)
+      rubocop-rspec (>= 1.33.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.37.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+    values (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gc_ruboconfig (= 2.8.0)
+  kitlog!
+  pry (~> 0.10)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,19 @@
+# kitlog [![CircleCI](https://circleci.com/gh/lawrencejones/kitlog.svg?style=svg)](https://circleci.com/gh/lawrencejones/kitlog)
+
+The smallest of logging libraries that imitates the go-kit logger interface.
+Super simple, just:
+
+```ruby
+irb(main):001:0> require "kitlog"
+
+irb(main):002:0> Kitlog.log(event: "hello, from a terminal")
+event="hello, from a terminal" ts="2019-12-16T11:23:07.908104000Z" tid=70217581666320
+
+irb(main):003:0> Kitlog.configure(format: :json)
+irb(main):004:0> Kitlog.log(event: "hello, with json")
+{"event":"hello, with json","ts":"2019-12-16T11:23:27.448655000Z","tid":70217581666320}
+
+irb(main):005:0> logger = Kitlog.with(component: "app");
+irb(main):006:0> logger.log(event: "ping")
+{"component":"app","event":"ping","ts":"2019-12-16T11:23:46.460129000Z","tid":70217581666320}
+```

data/kitlog.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitlog"
+  spec.version       = "1.0.0"
+  spec.summary       = "Logger for Ruby that imitates go-kit logger"
+  spec.authors       = %w[me@lawrencejones.dev]
+  spec.homepage      = "https://github.com/lawrencejones/kitlog"
+  spec.email         = %w[me@lawrencejones.dev]
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.4"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "values", "~> 1.8"
+
+  spec.add_development_dependency "gc_ruboconfig", "= 2.8.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.8"
+end

data/lib/kitlog.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "logger"
+require "values"
+require "json"
+
+module Kitlog
+  class ContextualLogger < Value.new(:logger, :context)
+    def log(**kwargs)
+      logger.info(context.merge(kwargs))
+    end
+
+    def with(additional_context)
+      super(context: context.merge(additional_context))
+    end
+  end
+
+  FORMATTERS = {
+    json: ->(payload) { payload.to_json },
+    logfmt: ->(payload) do
+      payload.reduce("") { |a, (k, v)| a + "#{k}=#{v.to_json} " }
+    end,
+  }.freeze
+
+  # rubocop:disable Metrics/MethodLength
+  def self.configure(destination: STDERR, format: nil)
+    format ||= destination.isatty ? :logfmt : :json
+    formatter = FORMATTERS.fetch(format)
+
+    @logger = Logger.new(destination)
+    @logger.formatter = proc do |_severity, datetime, _progname, payload|
+      formatter.call(
+        payload.merge(
+          ts: datetime.strftime("%Y-%m-%dT%H:%M:%S.%NZ"),
+          tid: Thread.current.object_id,
+        ),
+      ) + "\n"
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  configure
+
+  def self.logger
+    @logger
+  end
+
+  def self.with(**context)
+    ContextualLogger.new(@logger, context)
+  end
+
+  def self.log(**kwargs)
+    @logger.info(kwargs)
+  end
+
+  def log(**kwargs)
+    @logger.info(kwargs)
+  end
+end

data/spec/lib/kitlog_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "kitlog"
+
+RSpec.describe(Kitlog) do
+  subject(:output) { StringIO.new }
+
+  let(:logger) { described_class }
+
+  before { described_class.configure(destination: output) }
+
+  def maybe_parse(output)
+    JSON.parse(output.string)
+  rescue JSON::ParserError
+    nil
+  end
+
+  it "logs in valid JSON format" do
+    expect { logger.log(event: "hey") }.
+      to change { maybe_parse(output) }.
+      to(include("event" => "hey"))
+  end
+
+  describe ".with" do
+    let(:logger) { described_class.with(component: "app") }
+
+    it "persists additional keys into other log messages" do
+      expect { logger.log(event: "hey") }.
+        to change { maybe_parse(output) }.
+        to(include("component" => "app", "event" => "hey"))
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: kitlog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- me@lawrencejones.dev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: gc_ruboconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- me@lawrencejones.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- kitlog.gemspec
+- lib/kitlog.rb
+- spec/lib/kitlog_spec.rb
+homepage: https://github.com/lawrencejones/kitlog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Logger for Ruby that imitates go-kit logger
+test_files:
+- spec/lib/kitlog_spec.rb