loggability 0.14.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4c536cf9f22b05e0acc0b3cb3e1f4202d19ab2c2
-  data.tar.gz: 5262aca5aedb923da7883b756a1d0b6c664f13ab
+SHA256:
+  metadata.gz: 5c0f3a12e9663d82cb709b0bf7f5aea24f9a49dba2435f5c63e289b7c731aa3e
+  data.tar.gz: cf7da9a50c5890505b96d2c1609f487a6ddb8c73c7deed602eb7508174613de2
 SHA512:
-  metadata.gz: a53a0d4ea43fd572540705175b95e8bd1f797ebbc9059df328b17fdaf72fe76c8e2077bd47f729c02e430234872eeb234c6ec7d2c65466693af375d50dee05e0
-  data.tar.gz: 920507dfb7ef2dff0105baae0d0da205e59e5e705bf5da5cb3149e17eabd80fffde576c9bf63a79cdb633a989d0d73f0bbebd82f637284b35c88690240058dd7
+  metadata.gz: e18c0c2891d2b0094dafa8b50b9b7d7ed8ba655e3f2f88105a279a655319041e39231417d0041eed2b29bed8b7fa956097f4d5f330a3a62122efd4de5d8d5435
+  data.tar.gz: b9a3fc6f3181e3e63d00d85709598601c3e266e19f471fb0456f7169c2acc2ea350235e480ce8adbbb16b713e234acfe6f9f76d951c4231e3847a48f6149419f

data/History.rdoc

@@ -1,3 +1,58 @@
+= Release History for loggability
+
+---
+== v0.18.0 [2020-12-24] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add memory management to the http log device
+- Add a dead-simple log server example
+- Update for Ruby 3, add my updated gem cert
+
+Thanks again to Mahmood Khan <mkhan1484@gmail.com> for the patch.
+
+
+== v0.17.0 [2020-02-27] Michael Granger <ged@faeriemud.org>
+
+Bugfixes:
+
+- Fix the construction of the client in the http log device
+
+Improvements:
+
+- Add support for log devices to the aggregate #output_to
+
+
+
+== v0.16.0 [2020-02-24] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Expose a "log device" API and add the ability to write to multiple devices
+- Add a device for logging to an HTTP service
+
+Thanks to Mahmood Khan <mkhan1484@gmail.com> for the patch.
+
+
+== v0.15.1 [2020-01-09] Michael Granger <ged@faeriemud.org>
+
+Bugfixes:
+
+- Change the spec to require Ruby 2.5 or greater. This was because
+  of the use methods that are only public in newer versions.
+
+
+== v0.15.0 [2020-01-08] Michael Granger <ged@faeriemud.org>
+
+(Yanked)
+
+Enhancements:
+
+- Make literal strings frozen by default
+- Add a structured log formatter.
+- Add fixes for Ruby 2.6 and 2.7
+
+
 == v0.14.0 [2017-01-30] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/Manifest.txt

@@ -1,26 +1,37 @@
 .simplecov
-ChangeLog
 History.rdoc
-Manifest.txt
-README.rdoc
-Rakefile
 lib/loggability.rb
 lib/loggability/constants.rb
 lib/loggability/formatter.rb
 lib/loggability/formatter/color.rb
 lib/loggability/formatter/default.rb
 lib/loggability/formatter/html.rb
+lib/loggability/formatter/structured.rb
 lib/loggability/logclient.rb
 lib/loggability/logger.rb
 lib/loggability/loghost.rb
+lib/loggability/log_device.rb
+lib/loggability/log_device/appending.rb
+lib/loggability/log_device/datadog.rb
+lib/loggability/log_device/file.rb
+lib/loggability/log_device/http.rb
 lib/loggability/override.rb
 lib/loggability/spechelpers.rb
+Manifest.txt
+Rakefile
+README.md
 spec/helpers.rb
 spec/loggability/formatter/color_spec.rb
+spec/loggability/formatter/default_spec.rb
 spec/loggability/formatter/html_spec.rb
+spec/loggability/formatter/structured_spec.rb
 spec/loggability/formatter_spec.rb
 spec/loggability/logger_spec.rb
 spec/loggability/loghost_spec.rb
+spec/loggability/log_device/appending_spec.rb
+spec/loggability/log_device/datadog_spec.rb
+spec/loggability/log_device/file_spec.rb
+spec/loggability/log_device/http_spec.rb
 spec/loggability/override_spec.rb
 spec/loggability/spechelpers_spec.rb
 spec/loggability_spec.rb

data/{README.rdoc → README.md}

@@ -1,12 +1,19 @@
-= loggability
+# loggability
 
-home   :: http://deveiate.org/projects/loggability
-code   :: http://bitbucket.org/ged/loggability
-docs   :: http://deveiate.org/code/loggability
-github :: http://github.com/ged/loggability
+home
+: https://hg.sr.ht/~ged/Loggability
 
+code
+: https://hg.sr.ht/~ged/Loggability/browse
 
-== Description
+docs
+: https://deveiate.org/code/loggability
+
+github
+: https://github.com/ged/loggability
+
+
+## Description
 
 A composable logging system built on the standard Logger library.
 
@@ -21,23 +28,23 @@ An example:
     require 'inversion'
     require 'treequel'
     require 'loggability'
-    
+
     # Set up our own library
     module MyProject
         extend Loggability
         log_as :my_project
-    
+
         class Server
             extend Loggability
             log_to :my_project
-    
+
             def initialize
                 self.log.debug "Listening."
             end
         end
-    
+
     end
-    
+
     # Now tell everything that's using Loggability to log to an HTML
     # log file at INFO level
     Loggability.write_to( '/usr/local/www/htdocs/log.html' )
@@ -45,30 +52,30 @@ An example:
     Loggability.level = :info
 
 
-== Prerequisites
+## Prerequisites
 
-* Ruby 1.9.3 or better, Rubinius 2.0 or better
+* Ruby 2.4+
 
 It will probably work under any other interpreter in which Logger works, but
 it's only tested in the above.
 
 
-== Installation
+## Installation
 
     $ gem install loggability
 
 
-== Usage
+## Usage
 
-Loggability is split up into two parts: {log hosts}[rdoc-ref:Loggability::LogHost]
-and {log clients}[rdoc-ref:Loggability::LogClient]. A <b>log
+Loggability is split up into two parts: [log hosts](rdoc-ref:Loggability::LogHost)
+and [log clients](rdoc-ref:Loggability::LogClient). A <b>log
 host</b> is an object that contains a Logger instance that will be used to
 log stuff. A <b>log client</b> is an object that will write logging messages to a
 particular <b>log host</b>'s Logger.
 
 Both parts require that you extend the object with Loggability.
 
-=== Setting Up A 'Log Host'
+### Setting Up A 'Log Host'
 
 To install a Logger into an object, you use the +log_as+ declaration with a
 Symbol that will be used as the key for the object's Logger:
@@ -116,10 +123,10 @@ or use a few new convenience methods for changing the logging level:
     log_messages = []
     MyProject.logger.output_to( log_messages )
 
-...{and more}[rdoc-ref:Loggability::Logger].
+...[and more](rdoc-ref:Loggability::Logger).
 
 
-=== Setting Up A 'Log Client'
+### Setting Up A 'Log Client'
 
 To add an object that will log to your log host, after you <tt>extend Loggability</tt>,
 use the +log_to+ declaration to hook up the object (and instances of the object if
@@ -153,7 +160,7 @@ You can also use the <b>log host</b> itself as the argument to +log_to+:
     end
 
 
-=== Aggregate Logging
+### Aggregate Logging
 
 If you have several <b>log hosts</b>, and you want to affect them all simultaneously,
 you can do that using the aggregate functions of Loggability. They're the same as the
@@ -161,15 +168,15 @@ methods on Loggability::Logger:
 
     # Set all logs to log at INFO level
     Loggability.level = :info
-    
+
     # Write HTML logs
     Loggability.format_with( :html )
-    
+
     # Log everything to the same logfile
     Loggability.output_to( "/tmp/my_project_log.html" )
 
 
-=== Temporarily Overriding Logging  Behavior
+### Temporarily Overriding Logging  Behavior
 
 Sometimes you want to log one particular chunk of code at a different
 level, or to a different destination, and then restore everything back
@@ -187,7 +194,7 @@ Loggability has a few ways of doing that:
     Loggability.outputting_to( logs ) do
         ...
     end
-    
+
     # Log using the HTML formatter
     Loggability.formatted_with( :html ) do
         ...
@@ -210,7 +217,7 @@ You can also make the override only apply to the loggers for a subset of log hos
       ACME.start_up
     end
 
-=== Configurability
+### Configurability
 
 Loggability has support for the Configurability[https://rubygems.org/gems/configurability]
 library, which does the same thing for configuration that Loggability does for
@@ -230,39 +237,41 @@ The format of the value of each logger is:
 
 where:
 
-[+SEVERITY+]
-  The log level; one of: +debug+, +info+, +warn+, +error+, or +fatal+
-[+TARGET+]
-  The destination for log messages. This can be the path to a log file, or
-  one of <tt>'STDOUT'</tt> or <tt>'STDERR'</tt>, which get mapped to the
-  equivalent filehandle. Optional.
-[+FORMAT+]
-  The name of one of the formatters. Loggability comes with +default+ (plaintext),
-  +color+ (ANSI colored text), and +html+ formatters. Optional.
++SEVERITY+
+:  The log level; one of: +debug+, +info+, +warn+, +error+, or +fatal+
 
-If the special key <tt>__default__</tt> is included, its config will be used to set
-global defaults before the individual configs are applied.
++TARGET+
+:  The destination for log messages. This can be the path to a log file, or
+   one of <tt>'STDOUT'</tt> or <tt>'STDERR'</tt>, which get mapped to the
+   equivalent filehandle. Optional.
 
-If either of the optional values is unspecified, it is left unchanged from what it
-was before configuration.
++FORMAT+
+:  The name of one of the formatters. Loggability comes with +default+
+   (plaintext), +color+ (ANSI colored text), and +html+ formatters. Optional.
 
+If the special key <tt>__default__</tt> is included, its config will be used to
+set global defaults before the individual configs are applied.
 
-=== RSpec Helpers
+If either of the optional values is unspecified, it is left unchanged from what
+it was before configuration.
 
-Loggability includes a couple of helper functions for RSpec that allow you to control
-log levels for particular specs.
 
-To use it, require <tt>loggability/spechelpers</tt> in your specs (we put it in the 
-spec helpers file) and then include the helpers from your RSpec config:
+### RSpec Helpers
 
-  require 'loggability/spechelpers'
-  RSpec.configure do |c|
-    # ...
-    c.include( Loggability::SpecHelpers )
-  end
+Loggability includes a couple of helper functions for RSpec that allow you to
+control log levels for particular specs.
+
+To use it, require <tt>loggability/spechelpers</tt> in your specs (we put it in
+the spec helpers file) and then include the helpers from your RSpec config:
 
-This will install a before and after `:all` hook to set the logging levels before each
-example group and then reset it before moving on to the next group.
+    require 'loggability/spechelpers'
+    RSpec.configure do |c|
+      # ...
+      c.include( Loggability::SpecHelpers )
+    end
+
+This will install a before and after `:all` hook to set the logging levels
+before each example group and then reset it before moving on to the next group.
 
 You can also access the bodies of those hooks manually:
 
@@ -270,31 +279,31 @@ You can also access the bodies of those hooks manually:
   reset_logging()
 
 The helpers also allow you to set logging levels for a whole example group, for
-particular contexts, or even for individual examples using RSpec's metadata hash
-syntax:
+particular contexts, or even for individual examples using RSpec's metadata
+hash syntax:
 
   # Set logging to 'error' level for each example in this group
   describe MyClass, logging: :error do
-  
+
     # ...but for examples in this context, set it to 'fatal'
     context 'created with a target', log: :fatal do
-    
+
       # ...except for this one, which logs at 'debug' level
       it "does something to it", logging: :debug do
-      
+
       end
-    
+
       it "does some other stuff, too"
-    
+
     end
-  
+
   end
 
-The {setup_logging}[rdoc-ref:Loggability::SpecHelpers.setup_logging] helper
+The [setup_logging](rdoc-ref:Loggability::SpecHelpers.setup_logging) helper
 also provides support for displaying the logs inline with spec formatters for
 which outputting the logs to STDERR isn't optimal. The only one that's
-currently uses it is the 
-{'webkit' formatter}[https://rubygems.org/gems/rspec-formatter-webkit], but
+currently uses it is the
+['webkit' formatter](https://rubygems.org/gems/rspec-formatter-webkit), but
 it should be easy to adapt to other HTML displays as well.
 
 It looks for either an +HTML_LOGGING+ environment variable, or for the
@@ -307,23 +316,21 @@ This can be used to append logs to each example when the formatter
 builds the output.
 
 
-== Contributing
+## Contributing
 
 You can check out the current development source with
-Mercurial[http://bitbucket.org/ged/loggability], or if you prefer Git, via
-{its Github mirror}[https://github.com/ged/loggability].
+Mercurial[http://hg.sr.ht/~ged/Loggability], or if you prefer Git, via
+[its Github mirror](https://github.com/ged/loggability).
 
-After checking out the source, run:
 
-    $ rake newb
+## Author
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the API documentation.
+- Michael Granger <ged@faeriemud.org>
 
 
-== License
+## License
 
-Copyright (c) 2012-2017, Michael Granger
+Copyright (c) 2012-2020, Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -1,81 +1,9 @@
-#!/usr/bin/env rake
+#!/usr/bin/env ruby -S rake
 
-require 'rake/clean'
+require 'rake/deveiate'
 
-begin
-	require 'hoe'
-rescue LoadError
-	abort "This Rakefile requires 'hoe' (gem install hoe)"
+Rake::DevEiate.setup( 'loggability' ) do |project|
+	project.required_ruby_version = ['~> 2.5', '~> 3.0']
+	project.publish_to = 'deveiate:/usr/local/www/public/code'
 end
 
-GEMSPEC = 'loggability.gemspec'
-
-Hoe.plugin :mercurial
-Hoe.plugin :signing
-Hoe.plugin :deveiate
-
-Hoe.plugins.delete :rubyforge
-
-hoespec = Hoe.spec 'loggability' do
-	self.readme_file = 'README.rdoc'
-	self.history_file = 'History.rdoc'
-	self.extra_rdoc_files = FileList[ '*.rdoc' ]
-
-	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
-
-	self.dependency 'hoe-deveiate',    '~> 0.4', :developer
-	self.dependency 'hoe-bundler',     '~> 1.2', :developer
-	self.dependency 'simplecov',       '~> 0.7', :developer
-	self.dependency 'configurability', '~> 3.1', :developer
-
-	self.license "Ruby"
-	self.require_ruby_version( '>=1.9.3' )
-	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
-	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
-
-	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
-end
-
-ENV['VERSION'] ||= hoespec.spec.version.to_s
-
-# Ensure the specs pass before checking in
-task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
-
-
-desc "Build a coverage report"
-task :coverage do
-	ENV["COVERAGE"] = 'yes'
-	Rake::Task[:spec].invoke
-end
-CLOBBER.include( 'coverage' )
-
-
-# Use the fivefish formatter for docs generated from development checkout
-if File.directory?( '.hg' )
-	require 'rdoc/task'
-
-	Rake::Task[ 'docs' ].clear
-	RDoc::Task.new( 'docs' ) do |rdoc|
-	    rdoc.main = "README.rdoc"
-	    rdoc.rdoc_files.include( "*.rdoc", "ChangeLog", "lib/**/*.rb" )
-	    rdoc.generator = :fivefish
-		rdoc.title = 'Loggability'
-	    rdoc.rdoc_dir = 'doc'
-	end
-end
-
-task :gemspec => GEMSPEC
-file GEMSPEC => [ __FILE__, 'lib/loggability.rb' ]
-task GEMSPEC do |task|
-	hoespec = $hoespec.spec
-	hoespec.files.delete( '.gemtest' )
-	hoespec.signing_key = nil
-	hoespec.version = "#{hoespec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
-	hoespec.cert_chain = [ 'certs/ged.pem' ]
-	File.open( task.name, 'w' ) do |fh|
-		fh.write( hoespec.to_ruby )
-	end
-end
-
-CLOBBER.include( GEMSPEC.to_s )
-