green_log 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c301ce67ee757ddf2093b93fc973ff46ad005f2ea7e8da3e693ca01a6c7444
-  data.tar.gz: 0ec5551c9554ec465acfd815f4a95514f8dbf48529427a0187d51b02657e2671
+  metadata.gz: 505b570d0cf686dae462b48c5480e527d039e8e8bdf334e400a33a88da50cd77
+  data.tar.gz: 75104ff8e40ae40a08913433591247f39788053da332b7f9485b386af1f1787a
 SHA512:
-  metadata.gz: 889da34f831f8d7b95bb79343b6905f88d0ffde04a308773ec6775ed70f2b7ffd8668f7eb9c0c8b6ec5fc4d7a2ffbbc6ff59ccecbbdac34fec6ac598c35bba0b
-  data.tar.gz: f72a8e18d791b8d57a6a413d40c870c7dfb3b34414dc6e00862972acf927ef34d3520676cc973f2fdb7c29f0d92b9d15a69fed230d257b8f19c069b9f8523e7e
+  metadata.gz: df89efb0360c12c546715c5e99caeae2f305ddbee4e9200eba8ea6badec30163a2932d9ffdf12b596f8aa0cb28e54bf3940e163730833c768626c42db8fc0094
+  data.tar.gz: 2e661586a2ffcb6aa851a0d87e1b38e96966d394e5a69b5dbc1a56969b49baa8ce7cf38e9433c5b2411ec70f3c4fb15bf0d45640ed1c9d3432277cd4318086c0

data/README.md

@@ -140,6 +140,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,6 +193,18 @@ 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.

data/green_log.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: green_log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: values
@@ -72,14 +72,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
@@ -134,6 +134,7 @@ 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