simple_structured_logger 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 315fe583360fe762860bf5b41c12ddd9b253759e
-  data.tar.gz: 27a68f4612e092dc60d297529f3ee421e4c21667
+SHA256:
+  metadata.gz: bd3c01ed526e586a28acf3c9dcc9c3d8220bea4547c264568cf32c4293c9a77c
+  data.tar.gz: dc3beaa6509ca46fb2be4405e6211b75b373f87221dca5f7ba66e25ed723c4a2
 SHA512:
-  metadata.gz: 91459af84ce0e26f4a3883effa6fe307de46c8591bf77815667fa7e8b98d267425e84683923b10a38649108ac30efc5321edb861b6b34a067c97dadf16caf3b8
-  data.tar.gz: 8508a7487d73be951791e1e6859f3b10d0859dade862fd434301eaa37034a4d4ec9837e33f29205ef3c873588fe0532b6951cd0ae7a2b402a9ad927082646a88
+  metadata.gz: 9a1a5ba635be779a15ea83a4d17d8e71af96f0dc5cc0324bc2ac83af8e76fb959047d236b9e1191990481dfeaaf390469c0b737bfbc532f3bc24fe4979cdf636
+  data.tar.gz: 94830ac9e6452c82183564f9a67e58560d9eacd617a7aea1d69c1d291ffc4187da7726c386895361f78da3e1faa4f020c12c452ac4b01e639c1cbf06bf13a1c2

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1      
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+ 

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.3

data/Gemfile

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

data/README.md

@@ -1,3 +1,6 @@
+[![Ruby](https://github.com/iloveitaly/simple_structured_logger/actions/workflows/ruby.yml/badge.svg)](https://github.com/iloveitaly/simple_structured_logger/actions/workflows/ruby.yml)
+[![gem](https://img.shields.io/gem/v/simple_structured_logger.svg)](https://rubygems.org/gems/simple_structured_logger)
+
 # SimpleStructuredLogger
 
 Dead-simple structured logging in ruby with a dead-simple codebase. That's it.
@@ -32,6 +35,7 @@ gem 'simple_structured_logger'
 * https://github.com/asenchi/scrolls
 * https://github.com/stripe/chalk-log
 * https://github.com/nishidayuya/structured_logger
+* https://github.com/rocketjob/semantic_logger
 
 ## Why is structured logging important?
 
@@ -45,7 +49,26 @@ PaperTrail and easily grab an audit trail for a specific context, i.e. `the_job=
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# config/initializers/logger.rb
+if Rails.env.development? || Rails.env.test?
+  SimpleStructuredLogger::Writer.instance.logger = Rails.logger
+end
+
+# models/order.rb
+class Order
+  include SimpleStructuredLogger
+
+  def initialize
+    log.reset_context!
+    log.default_tags[:global] = 'key'
+  end
+
+  def do_something
+    log.info 'simple structured logging', key: value, shopify_id: 123
+  end
+end
+```
 
 ## Testing
 

data/lib/simple_structured_logger.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'singleton'
 
 module SimpleStructuredLogger
   def log
@@ -6,7 +7,6 @@ module SimpleStructuredLogger
   end
 
   def self.included(klass)
-
     # TODO there's got to be a cleaner way to add a class method from `include`
     klass.class_eval do
       def self.log
@@ -39,10 +39,10 @@ module SimpleStructuredLogger
   class Writer
     include Singleton
 
-    attr_reader :default_tags
+    attr_accessor :default_tags, :logger
 
     def initialize
-      @l = ::Logger.new(STDOUT)
+      @logger = ::Logger.new(STDOUT)
       @default_tags = {}
     end
 
@@ -53,31 +53,43 @@ module SimpleStructuredLogger
     def set_context(context)
       reset_context!
 
+      if self.respond_to?(:expand_context)
+        context = self.expand_context(context)
+      end
+
       @default_tags.merge!(context)
     end
 
     def error(msg, opts={})
-      @l.error("#{msg}: #{stringify_tags(opts)}")
+      @logger.error("#{msg}: #{stringify_tags(opts)}")
     end
 
     def info(msg, opts={})
-      @l.info("#{msg}: #{stringify_tags(opts)}")
+      @logger.info("#{msg}: #{stringify_tags(opts)}")
     end
 
     def debug(msg, opts={})
-      @l.debug("#{msg}: #{stringify_tags(opts)}")
+      @logger.debug("#{msg}: #{stringify_tags(opts)}")
     end
 
     def warn(msg, opts={})
-      @l.warn("#{msg}: #{stringify_tags(opts)}")
+      # TODO consider returning the generated log string with structured keys
+
+      @logger.warn("#{msg}: #{stringify_tags(opts)}")
     end
 
     private
 
+      def generate_log(msg, opts)
+        #code
+      end
+
       def stringify_tags(additional_tags)
         additional_tags = additional_tags.dup
 
-        # TODO expand
+        if self.respond_to?(:expand_log)
+          additional_tags = self.expand_log(additional_tags)
+        end
 
         @default_tags.merge(additional_tags).map { |k,v| "#{k}=#{v}" }.join(' ')
       end

data/simple_structured_logger.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "simple_structured_logger"
-  spec.version       = '0.1.0'
+  spec.version       = '0.1.5'
   spec.authors       = ["Michael Bianco"]
-  spec.email         = ["mike@cliffsidemedia.com"]
+  spec.email         = ["mike@mikebian.co"]
 
-  spec.summary       = "Dead-simple structured logging in ruby with a dead-simple codebase."
+  spec.summary       = "Dead-simple structured logging in ruby with a simple codebase."
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/iloveitaly/simple_structured_logger"
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.2.15"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_structured_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Michael Bianco
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.2.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.2.15
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +52,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description:
 email:
-- mike@cliffsidemedia.com
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".tool-versions"
 - Gemfile
 - README.md
 - Rakefile
@@ -70,7 +73,7 @@ files:
 homepage: https://github.com/iloveitaly/simple_structured_logger
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: Dead-simple structured logging in ruby with a dead-simple codebase.
+summary: Dead-simple structured logging in ruby with a simple codebase.
 test_files: []