inform 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTRmYzY5YmIwZDNiY2EyYWExNjViNGE5ZjcxNDdkNjU3MjJmNTNiYg==
+  data.tar.gz: !binary |-
+    YTRiNGZmZWJiZTA3ZjU4OTM5MWYxODc2MmRjMjM4MDlkNDU1OTZhZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTg3OGU3NzBhMDI0ODM5MDZmMGFjOWU1MmMzZTRlNjdjN2RlYjAzNWJlNjc1
+    MGU5ZjVhMGM3YWQ0NTg2ZWEwZDY4ODA3NTlmNTAwYWNjNjE5MTQ0NzFjMTJj
+    MTQ2NjczMWZiZGM3MzZkMDM5MWYzMGE5MjQ4OGVmMjdmZjRiODM=
+  data.tar.gz: !binary |-
+    MzZmZGE2ZDM4YmJiNTdiM2JjYTk1OTE1NTIwYWRhZGVmNTU1ZWMzZjE0NDRl
+    YmExZWE2ZTQ3NjVlMjFhNDU3ZjdhZDY2OTVkYzc1MzZmNGZkMjczODUwNTU0
+    NmE4YThmYjc1OGEwYjQxMDE1OTA3N2MwNWQ4OTFmYzFlMzc1NTY=

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.ruby-version

data/README.md

@@ -1,25 +1,40 @@
 # Inform
 
 **Inform** prints colourised, interactive logging output to the console.
+It includes support for timings and thread-local prefixes.
 
 For example:
 
-    Inform.level = :info
-    frozbot = Inform.info("Initializing the frozbot") do
-      Frozbot.new
-    end
-    
-    Inform.info("Frozbot is %{name}", :name => frozbot.name)
+``` ruby
+# Controllable log level filtering
+Inform.level = :info
 
-Will print:
+# Accept a block, print timing information once completed if > 0.1s
+frozbot = Inform.info("Initializing the frozbot") do
+  Frozbot.new
+  sleep 1
+end
+
+# Other log levels than info
+Inform.level = :debug
+Inform.debug("Madness")
+Inform.warning("and")
+Inform.error("Nonsense")
 
-    >>> Initializing the frozbot : Done
-    *** Frozbot is myfrozbot
+# Thread-local log prefixing
+Thread.current[:inform] = '1'
+Inform.info("Frozbot is %{name}", :name => frozbot.name)
+```
 
-### Caveat
+Will print:
 
-This code was taken directly from the our **dew** project and is not ready for prime time. Interfaces,
-requirements, etc will change.
+```
+>>> Initializing the frozbot : Done (1.00s)
+    Madness
+WARNING: and
+ERROR: Nonsense
+1 *** Frozbot is myfrozbot
+```
 
 ### TODO
 
@@ -27,12 +42,12 @@ requirements, etc will change.
  * Refactor tests
  * Colourisation isn't tested at all - should it be?
  * RDoc
- 
+
 ## License
 
 (The MIT License)
 
-Copyright (c) 2011 PlayUp
+Copyright (c) 2011 PlayUp, 2012-13 Michael Pearson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -51,4 +66,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/inform/version.rb

@@ -1,3 +1,3 @@
 class Inform
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/inform.rb

@@ -21,6 +21,14 @@ class Inform
 
   class << self
 
+    def thread_prefix= prefix
+      Thread.current[:inform_prefix] = prefix
+    end
+
+    def thread_prefix
+      Thread.current[:inform_prefix]
+    end
+
     def level
       @level.nil? ? DEFAULT_LOG_LEVEL : @level
     end
@@ -35,13 +43,15 @@ class Inform
     end
 
     def info(message, args=nil)
+
       if block_given?
         start = Time.now
-        log(:info, ">>> " + color_args(message, args, GREEN) + " : ", :no_newline => true)
+        smart_newlines = thread_prefix.nil?
+        log(:info, ">>> " + color_args(message, args, GREEN) + " : ", :no_newline => smart_newlines)
         ret = yield
         elapsed = Time.now - start
         message = elapsed > 0.01 ? "Done. (#{sprintf '%.2f', elapsed}s)" : 'Done.'
-        log(:info, color(message, GREEN), :continue_line => true, :prefix => '>>> ')
+        log(:info, color(message, GREEN), :continue_line => smart_newlines, :prefix => '>>> ')
         ret
       else
         log(:info, "*** " + color_args(message, args, GREEN))
@@ -74,6 +84,10 @@ class Inform
           @need_newline = false
         end
         message += "\n" if end_with_newline
+        if Thread.current.key? :inform_prefix
+          message = Thread.current[:inform_prefix].to_s + ' ' + message
+        end
+
         $stdout.print message
         $stdout.flush
       end

data/spec/inform_spec.rb

@@ -10,6 +10,15 @@ def should_print method
       $stdout.should_receive(:print).with(/hello.+hey.+you.+goodbye/)
       Inform.send(method, "hello %{a} %{b} goodbye", :a => 'hey', :b => 'you')
     end
+    it "should prefix with the :inform thread variable if present" do
+      begin
+        Inform.thread_prefix = 'hi'
+        $stdout.should_receive(:print).with(/^hi .+blank/)
+        Inform.send(method, "blank")
+      ensure
+        Inform.thread_prefix = nil
+      end
+    end
   end
 end
 
@@ -57,35 +66,35 @@ describe Inform do
       Inform.level = :info
       Inform.level.should == :info
     end
-    
+
     it "should not allow us to set a log level that isn't recognized" do
       lambda {Inform.level = :warble}.should raise_error /unrecognized/i
     end
   end
-  
+
   context "with log level debug" do
     before { Inform.level = :debug }
 
-    should_print :debug    
-    should_print :info    
+    should_print :debug
+    should_print :info
     should_accept_block :info
     # should_accept_block :debug
 
     should_print :warning
     should_print :error
   end
-  
+
   context "with log level set to :info" do
     before { Inform.level = :info }
     should_not_print :debug
     should_print :info
     should_accept_block :info
     # should_accept_block :debug
-    
+
     should_print :warning
     should_print :error
   end
-  
+
   context "with log level set to :warning" do
     before { Inform.level = :warning }
     should_not_print :debug
@@ -100,11 +109,11 @@ describe Inform do
     should_not_print :info
     should_not_print :warning
     should_print :error
-    
+
     describe :info do
       it "should still execute the code block" do
         Inform.info("") { 'hello' }.should == 'hello'
       end
     end
   end
-end
+end

metadata

@@ -1,78 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: inform
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 0.0.7
 platform: ruby
-authors: 
+authors:
 - Michael Pearson
 - Chris Ottrey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  name: rspec
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: gem-release
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  name: rake
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  name: gem-release
 description: Interactive, colourised logging
-email: 
+email:
 - mipearson@gmail.com
-- ""
+- ''
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -85,37 +73,27 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/mipearson/inform
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Interactive, colourised logging
-test_files: 
+test_files:
 - spec/inform_spec.rb
 - spec/spec_helper.rb