loggability 0.8.1 → 0.9.0.pre.73

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd32c093968b3ea5843c6697f92de513c0b0cf86
-  data.tar.gz: 77d614d2a678792322dc0662d49fb18d2a31f158
+  metadata.gz: ca197a7e5f2104cf971a2f8f416b3a4d6fa581db
+  data.tar.gz: 6be12107ba29eb58a9e6ae9570faa7535d5e40f4
 SHA512:
-  metadata.gz: d66083a3f8fa879ebfec74866d630706b47bf1a1db88a8bb073274c6d447350e85d45dfcf61ca229623dfeb89dab1a76fc2e7f0472b1d6f5e36b3829865e67bf
-  data.tar.gz: 774215025c07daf8c795908f9305f9f6ee4eb51bcb4c29ba117e50c22186f689e4a8a83f393715d8f1bd09df49132e5d9e6c9c55152835ff7769c7c1f0d711e7
+  metadata.gz: 41a0aeb5f7633c34e28f294c03750dc4d7f4be00178f9c7383f98aa877295c1825c4b12dc1c71a91d8dc1149371100284293fd4b9652eb23b841e78f543db58a
+  data.tar.gz: d413ef02c1479adc8dfb8579135b720a956c93990bf084d1e6c1ac3f2e4608513f807cc3de41f6f30ddc01bf4549998dbd9c6f3e7e17a157961b7eb518db0fed

data/Manifest.txt

@@ -20,4 +20,5 @@ spec/loggability/formatter/html_spec.rb
 spec/loggability/formatter_spec.rb
 spec/loggability/logger_spec.rb
 spec/loggability/override_spec.rb
+spec/loggability/spechelpers_spec.rb
 spec/loggability_spec.rb

data/README.rdoc

@@ -45,43 +45,6 @@ An example:
     Loggability.level = :info
 
 
-=== Configurability
-
-Loggability has support for the Configurability[https://rubygems.org/gems/configurability]
-library, which does the same thing for configuration that Loggability does for
-logging.
-
-You can configure all registered loggers from the 'logging' section of the config:
-
-    logging:
-	  __default__: warn STDERR
-	  mongrel2: info STDOUT (html)
-	  strelka: debug (html)
-	  inversion: error /var/log/templating.log (default)
-
-The format of the value of each logger is:
-
-    SEVERITY [TARGET] [(FORMAT)]
-
-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.
-
-If the special key <tt>__default__</tt> is included, its config will be used to set
-global defaults before the individual configs are applied.
-
-If either of the optional values is unspecified, it is left unchanged from what it
-was before configuration.
-
-
 == Prerequisites
 
 * Ruby 1.9.3 or better, Rubinius 2.0 or better
@@ -216,24 +179,121 @@ Loggability has a few ways of doing that:
 
     # Log only fatal errors...
     Loggability.with_level( :fatal ) do
-		    ...
-		end
+        ...
+    end
 
     # Log everything to an array for the block
     logs = []
-		Loggability.outputting_to( logs ) do
-		    ...
-		end
+    Loggability.outputting_to( logs ) do
+        ...
+    end
     
-		# Log using the HTML formatter
-		Loggability.formatted_with( :html ) do
-		    ...
-		end
+    # Log using the HTML formatter
+    Loggability.formatted_with( :html ) do
+        ...
+    end
 
     # Or chain them together:
     Loggability.with_level( :debug ).outputting_to( $stderr ).formatted_with( :color ) do
-		    Client.connect!
-		end
+        Client.connect!
+    end
+
+
+=== Configurability
+
+Loggability has support for the Configurability[https://rubygems.org/gems/configurability]
+library, which does the same thing for configuration that Loggability does for
+logging.
+
+You can configure all registered loggers from the 'logging' section of the config:
+
+    logging:
+      __default__: warn STDERR
+      mongrel2: info STDOUT (html)
+      strelka: debug (html)
+      inversion: error /var/log/templating.log (default)
+
+The format of the value of each logger is:
+
+    SEVERITY [TARGET] [(FORMAT)]
+
+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.
+
+If the special key <tt>__default__</tt> is included, its config will be used to set
+global defaults before the individual configs are applied.
+
+If either of the optional values is unspecified, it is left unchanged from what it
+was before configuration.
+
+
+=== RSpec Helpers
+
+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:
+
+  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:
+
+  setup_logging( level=:fatal )
+  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:
+
+  # 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
+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
+it should be easy to adapt to other HTML displays as well.
+
+It looks for either an +HTML_LOGGING+ environment variable, or for the
++TM_FILENAME+ variable to be set to a filename that ends with '_spec.rb'
+(for Textmate's rspec runner). In either of those conditions, it will set
+up logging output to go to a thread-local Array called 'logger-output',
+log using the 'html' formatter, and set the log level to 'debug'.
+
+This can be used to append logs to each example when the formatter
+builds the output.
 
 
 == Contributing

data/Rakefile

@@ -47,3 +47,16 @@ task :coverage do
 	Rake::Task[:spec].invoke
 end
 
+# 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.rdoc_dir = 'doc'
+	end
+end
+

data/lib/loggability/spechelpers.rb

@@ -6,19 +6,50 @@ require 'loggability' unless defined?( Loggability )
 
 # Some helper functions for testing. Usage:
 #
+#    # in spec_helpers.rb
 #    RSpec.configure do |c|
-#        c.include( Loggability::SpecHelpers )
+#      c.include( Loggability::SpecHelpers )
 #    end
 #
-#    describe MyClass do
-#        before( :all ) { setup_logging }
-#        after( :all ) { reset_logging }
+#    # in my_class_spec.rb; set logging level to :error
+#    describe MyClass, log: :error do
 #
-#        # ...
+#      # Except for this example, which logs at :debug
+#      it "does something", log: :debug do
+#        # anything the spec does here will be logged at :debug
+#      end
+#
+#      it "does something else" do
+#        # but this will use the :error level from the 'describe'
+#      end
 #
 #    end
+#
 module Loggability::SpecHelpers
 
+	### Inclusion callback -- install some hooks that set up logging
+	### for RSpec specs.
+	def self::included( context )
+		context.around( :each ) do |example|
+			if level = (example.metadata[:log] || example.metadata[:logging])
+				Loggability.with_level( level, &example )
+			else
+				example.run
+			end
+		end
+
+		context.before( :all ) do
+			setup_logging()
+		end
+
+		context.after( :all ) do
+			reset_logging()
+		end
+
+		super
+	end
+
+
 	### Reset the logging subsystem to its default state.
 	def reset_logging
 		Loggability.formatter = nil

data/lib/loggability.rb

@@ -9,7 +9,7 @@ require 'date'
 module Loggability
 
 	# Package version constant
-	VERSION = '0.8.1'
+	VERSION = '0.9.0.pre.73'
 
 	# VCS revision
 	REVISION = %q$Revision: db603bf7b399 $

data/spec/helpers.rb

@@ -112,5 +112,6 @@ RSpec.configure do |c|
 	c.include( SpecHelpers )
 	c.include( Loggability::SpecHelpers )
 	c.filter_run_excluding( :configurability ) unless defined?( Configurability )
+
 end
 

data/spec/loggability/spechelpers_spec.rb

@@ -0,0 +1,16 @@
+# -*- rspec -*-
+
+require_relative '../helpers'
+
+require 'tempfile'
+require 'rspec'
+
+require 'loggability/spechelpers'
+
+
+describe Loggability::SpecHelpers do
+
+	# Not sure how to test this stuff
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0.pre.73
 platform: ruby
 authors:
 - Michael Granger
@@ -30,7 +30,7 @@ cert_chain:
   6mKCwjpegytE0oifXfF8k75A9105cBnNiMZOe1tXiqYc/exCgWvbggurzDOcRkZu
   /YSusaiDXHKU2O3Akc3htA==
   -----END CERTIFICATE-----
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
@@ -187,6 +187,7 @@ files:
 - spec/loggability/formatter_spec.rb
 - spec/loggability/logger_spec.rb
 - spec/loggability/override_spec.rb
+- spec/loggability/spechelpers_spec.rb
 - spec/loggability_spec.rb
 - .gemtest
 homepage: http://deveiate.org/projects/loggability
@@ -206,12 +207,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: loggability
-rubygems_version: 2.0.6
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: A composable logging system built on the standard Logger library