bogo 0.2.12 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e468cddb60b30f3171155a342bf27f2dcb3987c07d482969a61da5e38f304b9b
-  data.tar.gz: ce539b480d5d9e49872e6cefb871e0885ca37fe319e33c509690a7adf99effde
+  metadata.gz: 730a00461fb1d2b71a79a959bec8085111781a1ac542443566f875f9c9560e45
+  data.tar.gz: 7225927bd86221c434caf7f9808f87c17c7b71a1e7839ec172157521876bf551
 SHA512:
-  metadata.gz: 656136e804d93739ad3c63a250f87e31ffd76fbf2a3812a299ab6a75753ca9fc3710152cd35014876aa8182a22468992dec8ab8989aa65543cc01e8fec4fd22e
-  data.tar.gz: '061880c66c34a33fd1f85308bcef8a59d38c58242d62f46c51a2ff4dea20a14a8459fa0d3173905176b7ac47e7f472afcbca7017b0d34f00d4c4f32d59a307d9'
+  metadata.gz: c3351892aae400d4035470522093bd231f6611d8e955338ac29af84d7ff594b498b863ee63fce80272b42cb3aa3bb4e13e32f3c95f67fe6c66c73ea8ac8cdfed
+  data.tar.gz: a9cac6cfbb9df030f965ca3e6d180343ba8445a1bbffd7ea029b02a45dc05f4846d81211e5ba3c8cbc2a99b83c4683715e3e62179c1e879c9a866502692ca49d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.2.14
+* [Logger] Add logging helpers
+
 # v0.2.12
 * [Lazy] Add #to_h helper
 

data/LICENSE

@@ -1,4 +1,4 @@
-   Copyright 2014 Chris Roberts
+   Copyright 2018 Chris Roberts
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -376,5 +376,42 @@ between retries at an exponential rate before retry:
 * `:wait_interval` - Numeric (default: 5)
 * `:wait_exponent` - Numeric (default: 2)
 
+## `Bogo::Logger`
+
+This is a wrapped stdlib Logger instance to provide thread-safe
+access for logging. It includes a `Bogo::Logger#named` method for
+creating sub-loggers.
+
+```ruby
+require 'bogo'
+
+base = Bogo::Logger.new
+base.progname = 'base'
+base.info 'test'
+
+sub = base.named(:sub)
+sub.info 'test'
+```
+
+### `Bogo::Logger::Helpers`
+
+Adds a `#logger` method when included which provides access to the
+global logger. Name can be customized using `.logger_name`.
+
+```ruby
+require 'bogo'
+
+class Fubar
+  class Thing
+    include Bogo::Logger::Helpers
+    logger_name(:thing)
+
+    def test
+      logger.info "test"
+    end
+  end
+end
+```
+
 # Info
-* Repository: https://github.com/spox/bogo
+* Repository: https://github.com/spox/bogo

data/bogo.gemspec

@@ -1,19 +1,20 @@
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
-require 'bogo/version'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + "/lib/"
+require "bogo/version"
 Gem::Specification.new do |s|
-  s.name = 'bogo'
+  s.name = "bogo"
   s.version = Bogo::VERSION.version
-  s.summary = 'Helper libraries'
-  s.author = 'Chris Roberts'
-  s.email = 'code@chrisroberts.org'
-  s.homepage = 'https://github.com/spox/bogo'
-  s.description = 'Helper libraries'
-  s.require_path = 'lib'
-  s.license = 'Apache 2.0'
-  s.add_runtime_dependency 'hashie'
-  s.add_runtime_dependency 'multi_json'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'rake', '~> 10'
-  s.files = Dir['lib/**/*'] + %w(bogo.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+  s.summary = "Helper libraries"
+  s.author = "Chris Roberts"
+  s.email = "code@chrisroberts.org"
+  s.homepage = "https://github.com/spox/bogo"
+  s.description = "Helper libraries"
+  s.require_path = "lib"
+  s.license = "Apache 2.0"
+  s.add_runtime_dependency "hashie"
+  s.add_runtime_dependency "multi_json"
+  s.add_runtime_dependency "concurrent-ruby", "~> 1.1.3"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rake", "~> 10"
+  s.files = Dir["lib/**/*"] + %w(bogo.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
 end

data/lib/bogo.rb

@@ -1,16 +1,17 @@
-require 'bogo/version'
+require "bogo/version"
 
 module Bogo
-  autoload :AnimalStrings, 'bogo/animal_strings'
-  autoload :Constants, 'bogo/constants'
-  autoload :EphemeralFile, 'bogo/ephemeral_file'
-  autoload :Lazy, 'bogo/lazy'
-  autoload :Memoization, 'bogo/memoization'
-  autoload :PriorityQueue, 'bogo/priority_queue'
-  autoload :Retry, 'bogo/retry'
-  autoload :Smash, 'bogo/smash'
-  autoload :Utility, 'bogo/utility'
+  autoload :AnimalStrings, "bogo/animal_strings"
+  autoload :Constants, "bogo/constants"
+  autoload :EphemeralFile, "bogo/ephemeral_file"
+  autoload :Lazy, "bogo/lazy"
+  autoload :Logger, "bogo/logger"
+  autoload :Memoization, "bogo/memoization"
+  autoload :PriorityQueue, "bogo/priority_queue"
+  autoload :Retry, "bogo/retry"
+  autoload :Smash, "bogo/smash"
+  autoload :Utility, "bogo/utility"
 end
 
 # Always load smash
-require 'bogo/smash'
+require "bogo/smash"

data/lib/bogo/logger.rb

@@ -0,0 +1,85 @@
+require "concurrent"
+require "logger"
+
+module Bogo
+  class Logger
+    module Helpers
+      module InstanceMethods
+        def logger
+          self.class.logger
+        end
+      end
+
+      module ClassMethods
+        def logger_name(name)
+          @_logger = logger.named(name.to_s)
+        end
+
+        def logger
+          if !@_logger
+            base = Utility.snake(self.name.
+              split("::").first.downcase)
+            @_logger = Bogo::Logger.logger.named(base)
+          end
+          @_logger
+        end
+      end
+
+      def self.included(klass)
+        klass.include(InstanceMethods)
+        klass.extend(ClassMethods)
+      end
+    end
+
+    # @return [Logger] default logger
+    def self.logger
+      if !@_logger
+        @_logger = new
+      end
+      @_logger
+    end
+
+    # Create a new ::Logger instance wrapped
+    # to allow threaded interactions
+    def initialize(*logger_args)
+      if logger_args.empty?
+        logger_args = [$stderr]
+      end
+      @base_args = logger_args
+      logger = ::Logger.new(*@base_args)
+      logger.level = :fatal
+      @wrapped_logger = Concurrent::MVar.new(logger)
+    end
+
+    # Create a new logger with the sub-name provided
+    #
+    # @param name [String] sub-name for logger
+    # @return [Logger]
+    def named(name)
+      new_name = self.progname.to_s
+      new_name << "." unless new_name.empty?
+      new_name << name
+      new_logger = Logger.new(*@base_args)
+      [:level, :formatter, :datetime_format].each do |m|
+        new_logger.send("#{m}=", self.send(m))
+      end
+      new_logger.progname = new_name
+      new_logger
+    end
+
+    ::Logger.instance_methods.each do |l_m|
+      next if l_m.to_s.start_with?("_") || l_m.to_s == "object_id"
+      class_eval <<-EOC
+      def #{l_m}(*ma, &mb)
+      wrapped_logger.borrow { |l| l.send(:#{l_m}, *ma, &mb) }
+      end
+      EOC
+    end
+
+    protected
+
+    def wrapped_logger
+      @wrapped_logger
+    end
+  end
+end

data/lib/bogo/version.rb

@@ -1,4 +1,4 @@
 module Bogo
   # Current library version
-  VERSION = Gem::Version.new('0.2.12')
+  VERSION = Gem::Version.new("0.2.14")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.14
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +111,7 @@ files:
 - lib/bogo/ephemeral_file.rb
 - lib/bogo/http_proxy.rb
 - lib/bogo/lazy.rb
+- lib/bogo/logger.rb
 - lib/bogo/memoization.rb
 - lib/bogo/priority_queue.rb
 - lib/bogo/retry.rb