sonnet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d7c9190a2c3b30088666a05896be4b39951cc028d9231cf9b11de55531c03bb
+  data.tar.gz: cf736f790ca819802faece8bd735c6a7e0d7aac4feaefce821e3c528c367f08e
+SHA512:
+  metadata.gz: effec6afdf604f2dc9ed8dac4e18a67d45f44df8760e415600a555f7052fa7ef606674818e4a858ce5d51bd23ad7a9591348f45029836b570758726a672101f5
+  data.tar.gz: a667b7bdf7a12bfc8b1447cc32a688e8d62aedbda9494be3288e43ab0a130fc133a8e60ea891746369a3eef6acdfa9f498ecdbd9e4dae0f164c82d4c8b7c4c49

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    sonnet (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    minitest (5.11.3)
+    rake (12.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  minitest
+  rake
+  sonnet!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Cory Kaufman-Schofield
+
+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,39 @@
+# Sonnet
+
+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/sonnet`. 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 'sonnet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sonnet
+
+## 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/allspiritseve/sonnet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "sonnet"
+
+# 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(__FILE__)

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/sonnet/formatter.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sonnet
+  class Formatter
+    TIMESTAMP_FORMAT = "%FT%T.%LZ"
+
+    def self.call(severity, time, progname, data)
+      new(severity, time, progname, data).to_json
+    end
+
+    def initialize(severity, time, progname, data)
+      @severity = severity
+      @time = time
+      @progname = progname
+      @data = data
+    end
+
+    def program
+      @progname || File.basename($0)
+    end
+
+    def timestamp
+      (@time || Time.now).utc.strftime(TIMESTAMP_FORMAT)
+    end
+
+    def data
+      case @data
+      when Exception
+        serialize_exception(@data)
+      when Hash
+        @data
+      else
+        serialize_string(@data)
+      end
+    end
+
+    def level
+      @severity&.downcase
+    end
+
+    # def hostname
+    #   @hostname || Socket.gethostname.force_encoding('UTF-8')
+    # end
+
+    def serialize_exception(exception)
+      {
+        kind: exception.class.name,
+        message: exception.to_s,
+        stack: exception.backtrace&.slice(0, 3)
+      }
+    end
+
+    def serialize_string(string)
+      { message: string.to_s }
+    end
+
+    def pid
+      $$
+    end
+
+    def as_json
+      {
+        program: program,
+        # hostname: hostname,
+        level: level,
+        timestamp: timestamp,
+        pid: pid
+      }.merge(data).compact
+    end
+
+    def to_json
+      as_json.to_json + "\n"
+    end
+  end
+end

data/lib/sonnet/logger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sonnet
+  module Logger
+    def self.extended(logger)
+      logger.formatter = Formatter
+      logger.level = log_level
+    end
+
+    def self.log_level
+      ::Logger.const_get((ENV["LOG_LEVEL"] || "INFO").upcase)
+    end
+  end
+end

data/lib/sonnet/monkeypatch.rb

@@ -0,0 +1,39 @@
+if ActiveSupport::VERSION::MAJOR < 6
+  # Monkeypatch in Rails 6 ActiveSupport::TaggedLogging initializer.
+  # Solves problem in which the TaggedLogging initializer modifies an existing logger
+  # by injecting its own functionality in.
+  module ActiveSupport
+    module TaggedLogging
+      def self.new(logger)
+        logger = logger.dup
+
+        if logger.formatter
+          logger.formatter = logger.formatter.dup
+        else
+          # Ensure we set a default formatter so we aren't extending nil!
+          logger.formatter = ActiveSupport::Logger::SimpleFormatter.new
+        end
+
+        logger.formatter.extend Formatter
+        logger.extend(self)
+      end
+    end
+  end
+
+  # Log actual exception instead of a string
+  module ActionDispatch
+    class DebugExceptions
+      private
+
+      def log_error(_request, wrapper)
+        ActiveSupport::Deprecation.silence do
+          ActionController::Base.logger.fatal(wrapper.exception)
+        end
+      end
+    end
+  end
+else
+  ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActiveSupport::TaggedLogging!')
+  ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActionDispatch::DebugExceptions!')
+end
+

data/lib/sonnet/rails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sonnet
+ class Rails < ::Rails::Engine
+    config.before_configuration do
+      require "sonnet/monkeypatch"
+    end
+  end
+end

data/lib/sonnet/sidekiq/job_logger.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "sidekiq/job_logger"
+
+module Album
+  module Sidekiq
+    class JobLogger < ::Sidekiq::JobLogger
+      def call(item, queue)
+        ::Sidekiq::Logging.with_context(source: item['class']) do
+          begin
+            start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+            logger.debug(:start)
+            yield
+            logger.debug(:done, duration: elapsed(start))
+          rescue
+            logger.debug(:failure, duration: elapsed(start))
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sonnet/version.rb

@@ -0,0 +1,3 @@
+module Sonnet
+  VERSION = "0.1.0"
+end

data/lib/sonnet.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "sonnet/formatter"
+require "sonnet/logger"
+require "sonnet/version"
+
+require "json"
+
+module Sonnet
+end
+
+require "sonnet/rails" if defined?(::Rails::Engine)

data/sonnet.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "sonnet/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sonnet"
+  spec.version = Sonnet::VERSION
+  spec.authors = ["Cory Kaufman-Schofield"]
+  spec.email = ["cory@corykaufman.com"]
+
+  spec.summary = "Structured logs for Ruby applications"
+  spec.description = "Structured logs for Ruby applications"
+  spec.homepage = "https://github.com/allspiritseve/sonnet"
+  spec.license = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/test/sonnet_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+require "logger"
+
+class SonnetTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Sonnet::VERSION
+  end
+
+  def test_json_logging
+    io = StringIO.new
+    logger = Logger.new(io)
+    logger.extend(Sonnet::Logger)
+    logger.info("What's the story, morning glory?")
+    line = JSON.parse(io.string)
+    assert_equal line.fetch("message"), "What's the story, morning glory?"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "minitest/autorun"
+
+require "sonnet"
+require "byebug"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: sonnet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cory Kaufman-Schofield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: byebug
+  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
+  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: 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'
+description: Structured logs for Ruby applications
+email:
+- cory@corykaufman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sonnet.rb
+- lib/sonnet/formatter.rb
+- lib/sonnet/logger.rb
+- lib/sonnet/monkeypatch.rb
+- lib/sonnet/rails.rb
+- lib/sonnet/sidekiq/job_logger.rb
+- lib/sonnet/version.rb
+- sonnet.gemspec
+- test/sonnet_test.rb
+- test/test_helper.rb
+homepage: https://github.com/allspiritseve/sonnet
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Structured logs for Ruby applications
+test_files: []