yog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a368faf2b40b6f7874d643db6cdf6d92f888f11d11e6d9592564f99e9f347c8
+  data.tar.gz: 9326d66736f140ab0ca623efb54596e3dd90dba49e7256107a10679b83f8436c
+SHA512:
+  metadata.gz: 7a76c80aeabb756397ec4aa6a5311dee0d781590a4fbcff68177f7b580bf02d5c8b9118cb288e65005208a2b801beb121319b4b0f077b8152a1386a85fa7757b
+  data.tar.gz: fcb89cc14d962bed269ac576503861a99e82c61c0da22ea34415199210310139bc05e01438f1a9c44229b47db2eecf115245ac76aa0da6630d4179e7060a96fa

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-version
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: bin/test
+
+rvm:
+- 2.5

data/Gemfile

@@ -0,0 +1,4 @@
+ruby "2.5"
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    yog (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    ffi (1.9.21)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard (~> 2.14)
+  guard-minitest (~> 2.4)
+  minitest (~> 5.11)
+  pry (~> 0.11)
+  yog!
+
+RUBY VERSION
+   ruby 2.5.0p0
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,4 @@
+guard :minitest do
+  watch(%r{_test\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2018 John Barnette
+
+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,7 @@
+# Yog [<img align="right" alt="Build status" src="https://travis-ci.org/jbarnette/yog.svg">](https://travis-ci.org/jbarnette/yog)
+
+A lightweight Ruby library for emitting [logfmt](https://brandur.org/logfmt) style `key=value` log lines.
+
+## Contributing
+
+Yog is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). Bug reports and pull requests are welcome. Everyone interacting in the Yog project’s codebase, issues, and PRs is expected to follow the [code of conduct](docs/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,8 @@
+#!/bin/sh
+# Run a REPL.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+exec ruby -r bundler/setup -r pry -r yog -e Pry.start -- "$@"

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/sh
+# Install development dependencies.
+
+set -e
+
+cd "$(dirname "$0")/.."
+bundle install

data/bin/test

@@ -0,0 +1,9 @@
+#!/bin/sh
+# CI entrypoint, run the tests.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+exec ruby -r bundler/setup -r minitest/autorun \
+  -e "Dir['test/**/*_test.rb'].each { |f| load f }"

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jbarnette@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/lib/yog.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "yog/logfmt"
+
+# Writes structured log lines.
+class Yog
+
+  # Get ready to do some yogging.
+  def initialize(generator: Logfmt, output: $stdout, context: {})
+    @context = context
+    @generator = generator
+    @output = output
+
+    freeze
+  end
+
+  # Log a message. Logs any given block's duration as `elapsed=float` ms.
+  def write(msg, **fields)
+    if msg.is_a?(Hash)
+      fields, msg = msg, nil
+    end
+
+    result = if block_given?
+      start = Time.now
+
+      yield.tap do
+        fields[:duration] = (Time.now - start) * 1000
+      end
+    end
+
+    unless @output.nil?
+      prefix = { now: Time.now.utc, msg: msg }
+      combined = Yog.merge(prefix, fields, @context)
+      @output.puts(@generator.generate(combined))
+    end
+
+    result
+  end
+
+  # Log an error.
+  def error(ex, **fields)
+    write(ex.message, at: "error", type: ex.class, **fields)
+  end
+
+  # Update the context.
+  def push(**fields)
+    self.tap { @context.merge!(fields) }
+  end
+
+  # Create a new log with more context.
+  def with(**fields)
+    self.class.new \
+      context: Yog.merge(@context, fields),
+      generator: @generator,
+      output: @output
+  end
+
+  ### Helpers for the default log
+
+  # The log for Yog(), Yog.push(), and Yog.with().
+  def self.current
+    logs.first
+  end
+
+  # A stack of receivers with the current log first.
+  def self.logs
+    Thread.current[:logs] ||= [new]
+  end
+
+  # Add fields to all Yog() calls in the given block.
+  def self.context(**fields)
+    yield logs.unshift(with(fields))
+  ensure
+    logs.shift
+  end
+
+  # Update the context of the current log.
+  def self.push(**fields)
+    current.push(fields)
+  end
+
+  # Create a new log by extending the context of the current log.
+  def self.with(**fields)
+    current.with(fields)
+  end
+
+  # Write a line to the current log.
+  def self.write(msg, **fields, &block)
+    current.write(msg, fields, &block)
+  end
+
+  # Log an error to the current log.
+  def self.error(ex, **fields)
+    current.error(ex, fields)
+  end
+
+  # Internal: Combine a list of contexts.
+  def self.merge(*contexts)
+    contexts.inject { |a, b| a.merge(b) }
+  end
+end
+
+# Write a line to the current log.
+def Yog(msg, **fields, &block)
+  case msg
+  when Exception
+    Yog.error(msg, fields)
+  else
+    Yog.write(msg, fields, &block)
+  end
+end

data/lib/yog/logfmt.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "time"
+
+class Yog
+
+  # https://brandur.org/logfmt
+  module Logfmt
+    def self.generate(**fields)
+      fields.map { |k, v| "#{k}=#{render(v)}" }.join(" ")
+    end
+
+    private
+
+    def self.render(v)
+      case v
+      when DateTime, Time
+        v.iso8601(2)
+      when Float
+        sprintf("%.2f", v)
+      when NilClass
+        "nil"
+      when String
+        (/[ '",{}\[\]:=]/ =~ v) ? v.inspect : v
+      else
+        render(v.to_s)
+      end
+    end
+  end
+end

data/yog.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name = "yog"
+  spec.version = "0.1.0"
+  spec.authors = ["John Barnette"]
+  spec.email = ["john@jbarnette.com"]
+
+  spec.summary = "A lightweight Ruby library for emitting logfmt style log lines."
+  spec.homepage = "https://github.com/jbarnette/yog"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| /^test/ =~ f }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: yog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- john@jbarnette.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/guard
+- bin/setup
+- bin/test
+- docs/CODE_OF_CONDUCT.md
+- lib/yog.rb
+- lib/yog/logfmt.rb
+- yog.gemspec
+homepage: https://github.com/jbarnette/yog
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby library for emitting logfmt style log lines.
+test_files: []