green_log 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c301ce67ee757ddf2093b93fc973ff46ad005f2ea7e8da3e693ca01a6c7444
-  data.tar.gz: 0ec5551c9554ec465acfd815f4a95514f8dbf48529427a0187d51b02657e2671
+  metadata.gz: e5b5433755b4109fd922e8b52ddb5548f197a138828440db5a34d3e36cbfef7a
+  data.tar.gz: 7662ef6e5b9ffa36b325ef0a35d024291063a5862824e98c026e0792a5d50947
 SHA512:
-  metadata.gz: 889da34f831f8d7b95bb79343b6905f88d0ffde04a308773ec6775ed70f2b7ffd8668f7eb9c0c8b6ec5fc4d7a2ffbbc6ff59ccecbbdac34fec6ac598c35bba0b
-  data.tar.gz: f72a8e18d791b8d57a6a413d40c870c7dfb3b34414dc6e00862972acf927ef34d3520676cc973f2fdb7c29f0d92b9d15a69fed230d257b8f19c069b9f8523e7e
+  metadata.gz: ba12d366ae1cad087af69a2f237657f5f25671dce6f9c0ad91394afa63ec0b6f537906f022dabc8e5bf00c973504f4353c9500e4d80481eec530eb58c930f905
+  data.tar.gz: 640bd883b9b8acb70d338e67d7c891f816a9763e73fe19e249c7de52c642fb56067bc31c9769a4a154f35bf64752cee7e5150893c23a5c2520f17ed564192beb

data/README.md

@@ -1,6 +1,7 @@
 # GreenLog
 
-![](https://github.com/greensync/green_log/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/green_log.svg)](http://badge.fury.io/rb/green_log)
+[![Build Status](https://github.com/mdub/green_log/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/mdub/green_log/actions/workflows/ci.yml)
 
 GreenLog is a logging library for Ruby applications.  It:
 
@@ -140,6 +141,14 @@ Logs go to STDOUT by default; specify `dest` to override, e.g.
 logger = GreenLog::Logger.build(dest: STDERR)
 ```
 
+### Null logger
+
+`GreenLog::Logger.null` returns a "null object" Logger, which routes log entries to `/dev/null`.
+
+```ruby
+logger = GreenLog::Logger.null
+```
+
 ### Filtering by log severity
 
 By default all log entries will result in output. You can add a severity-threshold to avoid emitting debug-level log messages, e.g.
@@ -185,9 +194,21 @@ legacy_logger.warn("Old skool")
 # outputs: W -- Old skool
 ```
 
+### Rack request-logging
+
+GreenLog bundles a Rack middleware - an alternative to [`Rack::CommonLogger`](https://www.rubydoc.info/gems/rack/Rack/CommonLogger) - that generates structured HTTP access logs:
+
+```ruby
+require "green_log"
+require "green_log/rack/request_logging"
+
+logger = GreenLog::Logger.build(format: "json")
+use GreenLog::Rack::RequestLogging, logger
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/greensync/green_log.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdub/green_log.
 
 ## License
 

data/green_log.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.name          = "green_log"
   spec.version       = GreenLog::VERSION
   spec.authors       = ["Mike Williams"]
-  spec.email         = ["mike.williams@greensync.com.au"]
+  spec.email         = ["mdub@dogbiscuit.org"]
 
   spec.summary       = "Structured logging for cloud-native systems."
-  spec.homepage      = "https://github.com/greensync/green_log"
+  spec.homepage      = "https://github.com/mdub/green_log"
   spec.license       = "MIT"
 
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
@@ -24,11 +24,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "values", "~> 1.8"
+  spec.required_ruby_version = ">= 2.7.0"
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry", "~> 0.12.2"
   spec.add_development_dependency "rack"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.77"
 

data/lib/green_log/core_refinements.rb

@@ -28,6 +28,14 @@ module GreenLog
 
     end
 
+    refine ::Array do
+
+      def to_loggable_value
+        map(&:to_loggable_value).freeze
+      end
+
+    end
+
     refine ::Numeric do
 
       def to_loggable_value

data/lib/green_log/entry.rb

@@ -2,15 +2,28 @@
 
 require "green_log/core_refinements"
 require "green_log/severity"
-require "values"
 
 module GreenLog
 
   # Represents a structured log entry.
-  class Entry < Value.new(:severity, :message, :context, :data, :exception)
+  class Entry
 
     using CoreRefinements
 
+    def initialize(severity:, message:, context:, data:, exception:)
+      @severity = severity
+      @message = message
+      @context = context
+      @data = data
+      @exception = exception
+    end
+
+    attr_reader :severity
+    attr_reader :message
+    attr_reader :context
+    attr_reader :data
+    attr_reader :exception
+
     class << self
 
       def with(**args)
@@ -21,7 +34,7 @@ module GreenLog
         args[:context] = args.fetch(:context, {}).to_loggable_value
         args[:data] = args.fetch(:data, {}).to_loggable_value
         args[:exception] ||= nil
-        super(**args)
+        new(**args)
       end
 
       def build(severity, *args, &block)
@@ -31,7 +44,13 @@ module GreenLog
     end
 
     def in_context(extra_context)
-      with(context: extra_context.integrate(context).to_loggable_value)
+      Entry.new(
+        severity: severity,
+        message: message,
+        context: extra_context.integrate(context).to_loggable_value,
+        data: data,
+        exception: exception,
+      )
     end
 
     # A builder for entries.

data/lib/green_log/logger.rb

@@ -5,6 +5,7 @@ require "green_log/entry"
 require "green_log/severity"
 require "green_log/severity_filter"
 require "green_log/severity_threshold_support"
+require "green_log/null_writer"
 require "green_log/simple_writer"
 
 module GreenLog
@@ -84,6 +85,11 @@ module GreenLog
         GreenLog.const_get("#{format.capitalize}Writer")
       end
 
+      # Return a null-object Logger.
+      def null
+        new(NullWriter.new)
+      end
+
     end
 
   end

data/lib/green_log/null_writer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "green_log/entry"
+require "green_log/severity"
+require "json"
+
+module GreenLog
+
+  # A road to nowhere.
+  class NullWriter
+
+    def initialize; end
+
+    def <<(_entry); end
+
+    def severity_threshold
+      Severity::FATAL
+    end
+
+  end
+
+end

data/lib/green_log/rack/request_logging.rb

@@ -64,11 +64,15 @@ module GreenLog
       end
 
       def request_body(request)
-        original_position = request.body.pos
-        request.body.rewind
-        request.body.read
-      ensure
-        request.body.seek(original_position)
+        return "" if request.body.size.zero?
+
+        begin
+          original_position = request.body.pos
+          request.body.rewind
+          request.body.read
+        ensure
+          request.body.seek(original_position)
+        end
       end
 
       def response_details(response)

data/lib/green_log/version.rb

@@ -2,6 +2,6 @@
 
 module GreenLog
 
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: green_log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Williams
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2023-03-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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.77'
-description: 
+description:
 email:
-- mike.williams@greensync.com.au
+- mdub@dogbiscuit.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,17 +120,18 @@ files:
 - lib/green_log/entry.rb
 - lib/green_log/json_writer.rb
 - lib/green_log/logger.rb
+- lib/green_log/null_writer.rb
 - lib/green_log/rack/request_logging.rb
 - lib/green_log/severity.rb
 - lib/green_log/severity_filter.rb
 - lib/green_log/severity_threshold_support.rb
 - lib/green_log/simple_writer.rb
 - lib/green_log/version.rb
-homepage: https://github.com/greensync/green_log
+homepage: https://github.com/mdub/green_log
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,15 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Structured logging for cloud-native systems.
 test_files: []