bogo 0.2.10 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4147a55ee937c7f32176f7401c9450fae36c3a34
-  data.tar.gz: fb706011f35266dfd5ad9c84d55d046a0a655db2
+SHA256:
+  metadata.gz: 3c54ebb5a6708a864ecac0a28f00ac6195ec7ea8cbf4b45af0938e819dcbb352
+  data.tar.gz: d433b7b015699094dfb387e301627259bb1bd5fedce8b737a3975f23a1893903
 SHA512:
-  metadata.gz: 31a9b4dad739a3bb2650e9bec4b66c3e064ae09b13ad5b5ee9c3cf147da04acdc7a7c17a327e0b014ea148e4a5ca1b863b9e6bc3f0b00607abd6e697a28fcab0
-  data.tar.gz: 6a90ab84ac9a68e8f0c78d23d0951564a0277ddd69282ae32604c5299cdb2f0bc2d67bbb6f51242f7ba8ffc67cb936ee400a3d5b5979196371bd88cb21a2304e
+  metadata.gz: 976fc3309852ef467a1407a74e70c32b4ebb42d168e28feb32f0a1171239ca26e5dfb8c004ac60daf93cd9aeff4f68ce616728be33cfbe2d485850a5e4888a77
+  data.tar.gz: 7bd54f01ae3b64183caf8582e93c2d34e28ddb2e3fbaeeb4eb49b04ef45c2cd3eb0807974749a34fa7dbbbb28d1eecacf71988e9675e51740eecc97ca7282d88

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.2.15
+* [Logger] Fix frozen string modification (#6)
+* [Stack] Add stack
+
+# v0.2.14
+* [Logger] Add logging helpers
+
+# v0.2.12
+* [Lazy] Add #to_h helper
+
 # v0.2.10
 * [Lazy] Dup and freeze non-dirty values
 

data/CONTRIBUTING.md

@@ -1,22 +1,18 @@
 # Contributing
 
-## Branches
+## Fixes
 
-### `master` branch
+Have a fix to some bug you want to submit? Well you're
+awesome. Please just include a description of the bug
+(or link to originating issue) and test coverage on the
+modifications.
 
-The master branch is the current stable released version.
+## New Features
 
-### `develop` branch
-
-The develop branch is the current edge of development.
-
-## Pull requests
-
-* https://github.com/spox/bogo/pulls
-
-Please base all pull requests of the `develop` branch. Merges to
-`master` only occur through the `develop` branch. Pull requests
-based on `master` will likely be cherry picked.
+Have a new feature you want to add? Well you're awesome
+too! It may be a good idea to submit an issue first to
+describe the desired feature and get any feedback. Please
+be sure to include tests.
 
 ## Issues
 

data/LICENSE

@@ -1,4 +1,4 @@
-   Copyright 2014 Chris Roberts
+   Copyright 2022 Chris Roberts
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under 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,19 @@
-$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_development_dependency "pry"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rake"
+  s.files = Dir["lib/**/*"] + %w(bogo.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
 end

data/lib/bogo/animal_strings.rb

@@ -1,5 +1,3 @@
-require 'bogo'
-
 module Bogo
   # Animal stylings on strings
   module AnimalStrings
@@ -24,7 +22,5 @@ module Bogo
     def snake(string)
       string.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').gsub('-', '_').downcase
     end
-
   end
-
 end

data/lib/bogo/constants.rb

@@ -1,10 +1,6 @@
-require 'bogo'
-
 module Bogo
-
   # Constant helper
   module Constants
-
     # Convert string to constant
     #
     # @param string [String] full constant name
@@ -40,7 +36,5 @@ module Bogo
         constantize(klass.join('::'))
       end
     end
-
   end
-
 end

data/lib/bogo/ephemeral_file.rb

@@ -1,15 +1,12 @@
-require 'bogo'
 require 'tempfile'
 
 module Bogo
   # Tempfile that will destroy itself when closed
   class EphemeralFile < Tempfile
-
     # Override to remove file after close
     def close
       super
       delete
     end
-
   end
 end

data/lib/bogo/http_proxy.rb

@@ -7,7 +7,6 @@ require 'http/request'
 # library to allow easy sharing. It is the responsibility of the user
 # to ensure the http gem is available!
 class HTTP::Request
-
   # Override to implicitly apply proxy as required
   #
   # NOTE: If dealing with https request, force port so CONNECT request
@@ -54,5 +53,4 @@ class HTTP::Request
     end
     "CONNECT #{@uri.host}:#{dest_port} HTTP/#{version}"
   end
-
 end

data/lib/bogo/lazy.rb

@@ -1,21 +1,35 @@
-require 'bogo'
 require 'multi_json'
+require 'monitor'
 require 'digest/sha2'
 
 module Bogo
   # Adds functionality to facilitate laziness
   module Lazy
-
     # Instance methods for laziness
     module InstanceMethods
 
+      def self.included(klass)
+        klass.include(MonitorMixin)
+        klass.instance_variable_set(:@calling_on_missing, false)
+        klass.class_eval do
+          alias_method :unlazy_initialize, :initialize
+          def initialize(*args, **opts, &block)
+            @data = nil
+            @dirty = Smash.new
+            unlazy_initialize(*args, **opts, &block)
+          end
+        end
+      end
+
       # @return [Smash] argument hash
       def data
-        unless(@data)
-          @data = Smash.new
-          self.class.attributes.each do |key, value|
-            if(value.has_key?('default'))
-              @data[key] = value['default']
+        synchronize do
+          unless(@data)
+            @data = Smash.new
+            self.class.attributes.each do |key, value|
+              if(value.has_key?('default'))
+                @data[key] = value['default']
+              end
             end
           end
         end
@@ -24,15 +38,17 @@ module Bogo
 
       # @return [Smash] updated data
       def dirty
-        unless(@dirty)
-          @dirty = Smash.new
+        synchronize do
+          unless(@dirty)
+            @dirty = Smash.new
+          end
         end
         @dirty
       end
 
       # @return [Smash] current data state
       def attributes
-        data.merge(dirty)
+        synchronize { data.merge(dirty) }
       end
 
       # Create new instance
@@ -40,20 +56,22 @@ module Bogo
       # @param args [Hash]
       # @return [self]
       def load_data(args={})
-        args = args.to_smash
-        @data = Smash.new
-        self.class.attributes.each do |name, options|
-          val = args[name]
-          if(options[:required] && !args.has_key?(name) && !options.has_key?(:default))
-            raise ArgumentError.new("Missing required option: `#{name}`")
-          end
-          if(val.nil? && !args.has_key?(name) && options[:default])
-            if(options[:default])
-              val = options[:default].respond_to?(:call) ? options[:default].call : options[:default]
+        synchronize do
+          args = args.to_smash
+          @data = Smash.new
+          self.class.attributes.each do |name, options|
+            val = args[name]
+            if(options[:required] && !args.has_key?(name) && !options.has_key?(:default))
+              raise ArgumentError.new("Missing required option: `#{name}`")
+            end
+            if(val.nil? && !args.has_key?(name) && options[:default])
+              if(options[:default])
+                val = options[:default].respond_to?(:call) ? options[:default].call : options[:default]
+              end
+            end
+            if(args.has_key?(name) || val)
+              self.send("#{name}=", val)
             end
-          end
-          if(args.has_key?(name) || val)
-            self.send("#{name}=", val)
           end
         end
         self
@@ -65,9 +83,11 @@ module Bogo
       #
       # @return [self]
       def valid_state
-        data.merge!(dirty)
-        dirty.clear
-        @_checksum = Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
+        synchronize do
+          data.merge!(dirty)
+          dirty.clear
+          @_checksum = Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
+        end
         self
       end
 
@@ -76,14 +96,16 @@ module Bogo
       # @param attr [String, Symbol] name of attribute
       # @return [TrueClass, FalseClass] model or attribute is dirty
       def dirty?(attr=nil)
-        if(attr)
-          dirty.has_key?(attr)
-        else
-          if(@_checksum)
-            !dirty.empty? ||
-              @_checksum != Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
+        synchronize do
+          if(attr)
+            dirty.has_key?(attr)
           else
-            true
+            if(@_checksum)
+              !dirty.empty? ||
+                @_checksum != Digest::SHA256.hexdigest(MultiJson.dump(data.inspect).to_s)
+            else
+              true
+            end
           end
         end
       end
@@ -98,11 +120,22 @@ module Bogo
         "<#{self.class.name}:#{object_id} [#{data.inspect}]>"
       end
 
+      # @return [Hash]
+      def to_h
+        synchronize do
+          Hash[
+            attributes.map{|k,v|
+              [k, v.is_a?(Array) ?
+                v.map{|x| x.respond_to?(:to_h) ? x.to_h : x} :
+                v.respond_to?(:to_h) ? v.to_h : v]
+            }
+          ]
+        end
+      end
     end
 
     # Class methods for laziness
     module ClassMethods
-
       # Disable dirty state
       def always_clean!
         self.class_eval do
@@ -254,11 +287,9 @@ module Bogo
         @attributes = attrs.to_smash
         true
       end
-
     end
 
     class << self
-
       # Injects laziness into class
       #
       # @param klass [Class]
@@ -268,16 +299,12 @@ module Bogo
           extend ClassMethods
 
           class << self
-
             def inherited(klass)
               klass.set_attributes(self.attributes.to_smash)
             end
-
           end
         end
       end
-
     end
-
   end
 end

data/lib/bogo/logger.rb

@@ -0,0 +1,78 @@
+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
+      @lock = Mutex.new
+    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.dup
+      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)
+        @lock.synchronize { @logger.send(:#{l_m}, *ma, &mb) }
+      end
+      EOC
+    end
+  end
+end

data/lib/bogo/memoization.rb

@@ -1,16 +1,12 @@
-require 'bogo'
-
 module Bogo
   # Memoization helpers
   module Memoization
-
     # Lock for providing exclusive access
     EXCLUSIVE_LOCK = Mutex.new
     # Holder for global memoization items
     GLOBAL_MEMOS = Smash.new
 
     class << self
-
       # Clean up isolated memoizations
       #
       # @param object_id [Object]
@@ -38,7 +34,6 @@ module Bogo
           GLOBAL_MEMOS.clear
         end
       end
-
     end
 
     # Memoize data
@@ -123,6 +118,5 @@ module Bogo
       end
       true
     end
-
   end
 end

data/lib/bogo/priority_queue.rb

@@ -1,10 +1,7 @@
-require 'bogo'
-
 module Bogo
   # Specialized priority based queue
   # @note does not allow duplicate objects to be queued
   class PriorityQueue
-
     # Create a new priority queue
     #
     # @return [self]
@@ -24,10 +21,12 @@ module Bogo
     def push(item, cost=nil, &block)
       lock.synchronize do
         if(queue[item])
-          raise ArgumentError.new "Item already exists in queue. Items must be unique! (#{item})"
+          raise ArgumentError,
+            "Item already exists in queue. Items must be unique! (#{item})"
         end
         unless(cost || block_given?)
-          raise ArgumentError.new 'Cost must be provided as parameter or block!'
+          raise ArgumentError,
+            'Cost must be provided as parameter or block!'
         end
         @block_costs += 1 if cost.nil?
         queue[item] = cost || block
@@ -45,10 +44,12 @@ module Bogo
         items.each do |item_pair|
           item, cost = item_pair
           if(queue[item])
-            raise ArgumentError.new "Item already exists in queue. Items must be unique! (#{item})"
+            raise ArgumentError,
+              "Item already exists in queue. Items must be unique! (#{item})"
           end
           unless(cost.is_a?(Numeric) || cost.is_a?(Proc))
-            raise ArgumentError.new "Cost must be provided as parameter or proc! (item: #{item})"
+            raise ArgumentError,
+              "Cost must be provided as parameter or proc! (item: #{item})"
           end
           @block_costs += 1 if cost.is_a?(Proc)
           queue[item] = cost
@@ -106,7 +107,5 @@ module Bogo
     protected
 
     attr_reader :queue, :lock
-
   end
-
 end

data/lib/bogo/retry.rb

@@ -1,10 +1,6 @@
-require 'bogo'
-
 module Bogo
-
   # Perform action and retry until successful or abort
   class Retry
-
     # Create a type of retry
     #
     # @param type [String, Symbol] name of retry type
@@ -38,7 +34,8 @@ module Bogo
     # @return [self]
     def initialize(args={}, &block)
       unless(block)
-        raise ArgumentError.new 'Expecting block but no block was provided!'
+        raise ArgumentError,
+          'Expecting block but no block was provided!'
       end
       args = args.to_smash
       @ui = args[:ui]
@@ -58,7 +55,8 @@ module Bogo
     # @return [Object] result of action
     def run!
       if(dead)
-        raise RuntimeError.new "Action has already reached maximum allowed attempts (#{max_attempts})!"
+        raise RuntimeError,
+          "Action has already reached maximum allowed attempts (#{max_attempts})!"
       else
         begin
           log_attempt!
@@ -110,7 +108,6 @@ module Bogo
 
     # Flat retry implementation
     class Flat < Retry
-
       # @return [Numeric]
       attr_reader :wait_interval
 
@@ -133,12 +130,10 @@ module Bogo
       def wait_on_failure(*_)
         wait_interval
       end
-
     end
 
     # Linear retry implementation
     class Linear < Retry
-
       # @return [Numeric]
       attr_reader :wait_interval
 
@@ -161,12 +156,10 @@ module Bogo
       def wait_on_failure(*_)
         wait_interval * attempts
       end
-
     end
 
     # Exponential retry implementation
     class Exponential < Retry
-
       # @return [Numeric]
       attr_reader :wait_interval
       # @return [Numeric]
@@ -196,9 +189,6 @@ module Bogo
       def wait_on_failure(*_)
         retries == 0 ? wait_interval : (wait_interval + retries) ** wait_exponent
       end
-
     end
-
   end
-
 end