lager 1.1.3.1 → 1.1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64b64cc70e40a568fafd57dd3734138c27f60110
-  data.tar.gz: a3a04e2ccd0fbd5e3353b4d6bb8319c1fe3bec09
+SHA256:
+  metadata.gz: ddc68c3afe5aa76a06167a875a6023bd06c2b4c9092f9ca2190cfad926ba7142
+  data.tar.gz: 7df85fefabc6f5bd0618d5c0b9a5c0005321ab7011e30648155463eaf8fafabd
 SHA512:
-  metadata.gz: 0867774d99d08023b09b4c823d41939197f9b74b12e3ee585e0d809aae12dc143172bb8a6b68d9d0590ec905a993e3a73b847e3fa7dee9983bf3017f30fa12fe
-  data.tar.gz: 0346d4b317fe7914666fb35fa4676b97600bd82509c92fedab6b48e1191d7def7401cf01153a41144022efa6c641b1dfeb86f6bdd95362a004b5254137f2791f
+  metadata.gz: 8ed30f93d47d148cf4c980ab6508cd49dcb37e5bc319612dd516af3d3efdee283e72e7b01ff310d16d572daee9e88c254711aac199fb1cb2d30b7e2a7cb306c1
+  data.tar.gz: 77d2c837acfd89396f8e4ddf7492fbd0b14d4e3b0f22cdf2db4c61205465b3e474d29edb1055deb33d20464e5398ffa2865a3ffa9f88f137480a809b67cc13fd

data/README.md

@@ -1,6 +1,17 @@
+[![CI Status](https://github.com/rickhull/lager/actions/workflows/ci.yaml/badge.svg)](https://github.com/rickhull/lager/actions/workflows/ci.yaml)
+[![Gem Version](https://badge.fury.io/rb/lager.svg)](http://badge.fury.io/rb/lager)
+[![Code Climate](https://codeclimate.com/github/rickhull/lager/badges/gpa.svg)](https://codeclimate.com/github/rickhull/lager/badges)
+
 Lager
 =====
-Lager is a logging mixin.  It is designed to add class methods for logging, via `extend Lager`.  It provides a unified logging instance that you can use in both class and instance methods.  It is implemented with the familiar [Logger class](http://ruby-doc.org/stdlib-2.0/libdoc/logger/rdoc/Logger.html) from ruby's [stdlib](http://ruby-doc.org/stdlib/).  Only one Logger instance is used for the class.  Use #log_to to set the log destination and log level from inside or outside the class.
+
+Lager is a logging mixin.  It is designed to add class methods for logging,
+via `extend Lager`.  It provides a unified logging instance that you can use
+in both class and instance methods.  It is implemented with the familiar
+[Logger class](http://ruby-doc.org/stdlib-2.0/libdoc/logger/rdoc/Logger.html)
+from ruby's [stdlib](http://ruby-doc.org/stdlib/).  Only one Logger instance
+is used for the class.  Use `log_to` to set the log destination and log level
+from inside or outside the class.
 
 Usage
 -----
@@ -13,7 +24,8 @@ class Foo
   # ...
 ```
 
-Now, within Foo, you can use the class instance variable @lager for logging.
+Now, within Foo, you can use the class instance variable `@lager` for
+logging.
 
 ```ruby
   # ...
@@ -25,7 +37,8 @@ Now, within Foo, you can use the class instance variable @lager for logging.
   # ...
 ```
 
-What about instance methods, you ask?  Well, you will need to assign @lager yourself, within #initialize.
+What about instance methods, you ask?  Well, you will need to assign `@lager`
+yourself, within `#initialize`.
 
 ```ruby
   # ...
@@ -57,7 +70,8 @@ f.do_something_complicated
 [2013-07-05 15:14:52] DEBUG: whew! we made it!
 ```
 
-This is because we set the default logging to :debug level, above.  Let's calm things down a bit, shall we?
+This is because we set the default logging to `:debug` level, above.
+Let's calm things down a bit, shall we?
 
 ```ruby
 Foo.log_level = :warn
@@ -70,14 +84,18 @@ We can tell Foo to log to a file:
 Foo.log_to '/tmp/foo.log'
 ```
 
-Note that this will replace the class's Logger instance.  The old log level will be maintained unless you specify a new one.
+Note that this will replace the class's Logger instance.  The old log level
+will be maintained unless you specify a new one.
 
 Best practices
 --------------
-* Set default logging inside the class definition by calling log_to just after extend Lager
-* Set the instance layer's @lager within #initialize
-* Only call message methods (debug, info, warn, error, fatal) on @lager in your class and instance methods.
-* Beyond the class default, let the log destination and log level be managed from the outside, by the users of your class.
+* Set default logging inside the class definition by calling `log_to`
+  just after `extend Lager`
+* Set the instance layer's `@lager` within `#initialize`
+* Only call message methods (debug, info, warn, error, fatal) on `@lager`
+  in your class and instance methods.
+* Beyond the class default, let the log destination and log level be
+  managed from the outside, by the users of your class.
 
 For Logger, generally: use block invocation of message methods.
 
@@ -87,17 +105,21 @@ For Logger, generally: use block invocation of message methods.
 @lager.debug "hi"
 ```
 
-By using the first form, the block will not be evaluated unless you are logging at DEBUG level.  If using the second form, the message is evaluated no matter the current log level.  This can be significant when logging heavily processed  messages.
+By using the first form, the block will not be evaluated unless you are
+logging at `DEBUG` level.  If using the second form, the message is evaluated
+no matter the current log level.  This can be significant when logging heavily
+processed  messages.
 
 Artifacts
 ---------
-* By mixing in Lager via extend, you introduce these class methods:
+* By mixing in via `extend Lager`, you introduce these class methods:
   * lager
   * log_to
   * log_level
   * log_level=
-* By calling log_to, you introduce the *class instance variable* @lager
-* By assigning @lager within initialize, you introduce the *instance variable* @lager
+* By calling `log_to`, you introduce the *class instance variable* `@lager`
+* By assigning `@lager` within `initialize`, you introduce the
+  *instance variable* `@lager`
 
 Now you have a unified interface for logging at both class and instance layers.
 
@@ -107,7 +129,8 @@ Now you have a unified interface for logging at both class and instance layers.
 
 Use an existing Logger instance
 -------------------------------
-If your project already has an existing Logger, then you can set your class to use that Logger:
+If your project already has an existing Logger, then you can set your class
+to use that Logger:
 
 ```ruby
 class Foo
@@ -117,7 +140,8 @@ class Foo
 end
 ```
 
-Of course, $LOG will have to have already been defined at requiretime.  You can set it the same way at runtime:
+Of course, `$LOG` will have to have already been defined at requiretime.
+You can set it the same way at runtime:
 
 ```ruby
 class Foo
@@ -134,6 +158,7 @@ Foo.log_to Project.log
 
 Inheritance
 -----------
+
 ```ruby
 class Foo
   extend Lager

data/Rakefile

@@ -1,12 +1,21 @@
-require 'buildar'
 require 'rake/testtask'
 
-Buildar.new do |b|
-  b.gemspec_file = 'lager.gemspec'
-  b.version_file = 'VERSION'
-  b.use_git           = true
-end
-
+desc "Run tests"
 Rake::TestTask.new :test do |t|
   t.pattern = 'test/*.rb'
+  t.warning = true
+end
+
+task default: %w[test]
+
+begin
+  require 'buildar'
+
+  Buildar.new do |b|
+    b.gemspec_file = 'lager.gemspec'
+    b.version_file = 'VERSION'
+    b.use_git           = true
+  end
+rescue LoadError
+  warn "buildar unavailble"
 end

data/VERSION

@@ -1 +1 @@
-1.1.3.1
+1.1.4.1

data/lager.gemspec

@@ -1,28 +1,17 @@
 Gem::Specification.new do |s|
   s.name        = 'lager'
   s.summary     = "Sane class-level logging"
+  s.description = "Should you use it? Yes."
   s.author      = "Rick Hull"
   s.homepage    = "http://github.com/rickhull/lager"
-  s.license     = 'LGPL'
-  s.has_rdoc    = true
-  s.description = "Should you use it? Yes."
+  s.license     = 'LGPL-3.0'
 
-  s.add_development_dependency "minitest", ["~> 1"]
-  s.add_development_dependency  "buildar", ["~> 1"]
+  s.required_ruby_version = '> 2'
 
-  # dynamic setup
-  this_dir = File.expand_path('..', __FILE__)
-  version_file = File.join(this_dir, 'VERSION')
+  s.version  = File.read(File.join(__dir__, 'VERSION')).chomp
 
   # dynamic assignments
-  s.version  = File.read(version_file).chomp
-  s.files = %w[lager.gemspec
-               VERSION
-               README.md
-               Rakefile
-               lib/lager.rb
-               test/lager.rb
-               examples/foo.rb
-               examples/usage.rb
-            ]
+  s.files  = %w[lager.gemspec VERSION README.md Rakefile]
+  s.files += Dir['lib/**/*.rb']
+  s.files += Dir['test/**/*.rb']
 end

data/test/lager.rb

@@ -1,9 +1,6 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-
 require 'tempfile'
-
-require_relative '../lib/lager'
+require 'lager'
+require 'minitest/autorun'
 
 # useful Foo class
 # calls log_to at require time
@@ -12,28 +9,28 @@ require_relative '../examples/foo'
 
 describe Lager do
   describe ".version" do
-    it "must return a string of numbers and dots" do
-      Lager.version.must_match %r{\A[0-9\.]+\z}
+    it "returns a string of numbers and dots" do
+      expect(Lager.version).must_match %r{\A[0-9\.]+\z}
     end
   end
 
   describe "#log_to" do
     it "must have created a Logger" do
       # note, the useful Foo class has already called log_to
-      Foo.lager.must_be_instance_of(Logger)
+      expect(Foo.lager).must_be_instance_of(Logger)
     end
 
     it "must return its argument" do
-      Foo.log_to($stdout).must_equal $stdout
+      expect(Foo.log_to($stdout)).must_equal $stdout
     end
 
     it "must use an existing Logger when provided" do
       l = Logger.new($stderr)
       Foo.log_to l
-      Foo.lager.must_equal l
+      expect(Foo.lager).must_equal l
       Foo.log_level = :info
       Foo.bar # does debug logging, should be silent
-      Foo.lager.must_equal l
+      expect(Foo.lager).must_equal l
     end
 
     it "must handle a Tempfile when provided" do
@@ -42,7 +39,7 @@ describe Lager do
       Foo.log_level = :debug
       Foo.bar # does debug logging
       t.rewind
-      t.read.wont_be_empty
+      expect(t.read).wont_be_empty
       t.close
       t.unlink
     end
@@ -53,7 +50,7 @@ describe Lager do
       Foo.log_level = :debug
       Foo.bar # does debug logging
       Foo.log_to $stderr
-      File.exists?(fname).must_equal true
+      expect(File.exist?(fname)).must_equal true
       File.unlink fname
     end
   end
@@ -65,23 +62,25 @@ describe Lager do
 
     it "must accept :debug as :debug" do
       Foo.log_level = :debug
-      Foo.log_level.must_equal :debug
+      expect(Foo.log_level).must_equal :debug
     end
 
     it "must accept Logger::INFO as :info" do
       Foo.log_level = Logger::INFO
-      Foo.log_level.must_equal :info
+      expect(Foo.log_level).must_equal :info
     end
 
     it "must accept 'warn' as :warn" do
       Foo.log_level = 'warn'
-      Foo.log_level.must_equal :warn
+      expect(Foo.log_level).must_equal :warn
     end
 
     def must_ignore level
       lev = Foo.log_level
-      Foo.log_level = level
-      Foo.log_level.must_equal lev
+      capture_subprocess_io do # suppress warnings
+        Foo.log_level = level
+      end
+      expect(Foo.log_level).must_equal lev
     end
 
     it "must ignore a bad symbol" do

metadata

@@ -1,45 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: lager
 version: !ruby/object:Gem::Version
-  version: 1.1.3.1
+  version: 1.1.4.1
 platform: ruby
 authors:
 - Rick Hull
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: buildar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies: []
 description: Should you use it? Yes.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -47,33 +19,30 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- examples/foo.rb
-- examples/usage.rb
 - lager.gemspec
 - lib/lager.rb
 - test/lager.rb
 homepage: http://github.com/rickhull/lager
 licenses:
-- LGPL
+- LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.4.4
+signing_key:
 specification_version: 4
 summary: Sane class-level logging
 test_files: []

data/examples/foo.rb

@@ -1,36 +0,0 @@
-require_relative '../lib/lager'
-
-class Foo
-  extend Lager
-
-  # set logging from within, useful for default behavior
-  #
-  log_to $stdout, :warn
-
-  def self.bar
-    @lager.debug { "inside Foo.bar" }
-  end
-
-  def initialize
-    # assign @lager at the instance layer if you want to use it
-    # @lager, here, is technically a different variable than used above
-    # though we are setting them to the same thing
-    #
-    @lager = self.class.lager
-    @lager.debug { "inside Foo#initialize" }
-  end
-end
-
-if __FILE__ == $0
-  Foo.bar
-  Foo.new
-
-  # set logging from outside
-  #
-  puts "Turning on debug logging"
-  Foo.log_to $stderr
-  Foo.log_level :debug
-
-  Foo.bar
-  Foo.new
-end

data/examples/usage.rb

@@ -1,40 +0,0 @@
-require_relative '../lib/lager'
-
-class Foo
-  extend Lager
-  log_to $stdout, :debug  # sets up @lager at the class layer
-
-  def self.bar(baz)
-    unless baz.is_a?(String)
-      @lager.debug { "baz #{baz} is a #{baz.class}, not a string" }
-    end
-  end
-
-  def initialize
-    # set the instance layer's @lager to the class layer's @lager
-    @lager = self.class.lager
-    # now both layers are using the same instance
-  end
-
-  def do_something_complicated
-    @lager.debug { "about to do something complicated" }
-    # ...
-    @lager.debug { "whew! we made it!" }
-  end
-end
-
-if __FILE__ == $0
-  puts "About to spew debug messages"
-  Foo.bar(15)
-  f = Foo.new
-  f.do_something_complicated
-
-  puts "Now updating Foo's log level"
-  Foo.log_level :warn
-  Foo.new.do_something_complicated
-
-  puts "Now the same calls as before"
-  Foo.bar(15)
-  f = Foo.new
-  f.do_something_complicated
-end