pt_logger 0.0.1 → 0.0.2

data/README.md

@@ -63,6 +63,9 @@ NB: there currently isn't a generator to make a config file for you
     story_id = "1234"
     PtLogger.log(message_text,story_id)
 
+The <tt>log</tt> method will return true of logging was successful, else returns false.
+It supresses any StandardErrors that may occur during logging.
+
 ## How to log a message with implicit story ID
 
 If the PT story ID is not passed as an explicit parameter to the <tt>log</tt> method,
@@ -71,3 +74,27 @@ The story ID may either be prefixed with "#" or "PT:", for example:
 
     PtLogger.log("logging a message to PT:123456 (i.e. this will be added to Pivotal Tracker story number 123456)")
     PtLogger.log("alternatively #78910 (i.e. this will be added to Pivotal Tracker story number 78910)")
+
+## How to conditionally log a message
+
+The <tt>log_if</tt> method can be used to log only if the <tt>condition</tt> is true.
+
+The message to log can be constructed in a block, which is handy because this will only be called
+if the condition is true:
+
+    condition = log_only_if_this == true
+    PtLogger.log_if( condition ) do
+      "evaluate the message to log here with implicit PT:123456 story id"
+    end
+
+The message to log can also be provided as a parameter:
+
+    PtLogger.log_if( condition, "the message to log with implicit PT:123456 story id" )
+
+Explicit story IDs can also be provided separately from the message:
+
+    story_id = 123456
+    PtLogger.log_if( condition, "the message to log", story_id )
+    PtLogger.log_if( condition, story_id ) do
+      "the message to log"
+    end

data/lib/pt_logger/base.rb

@@ -1,9 +1,52 @@
 module PtLogger
 
+  # Command: log +message+ to Pivotal Tracker.
+  # If +story_id+ is provided, logs to that story, else logs to a story ID
+  # referenced in the message itself (as #999 or PT:999).
+  #
+  # Returns true if log was successful, else false.
+  # Supresses any StandardErrors that may occur during logging.
+  #
   def self.log(message,story_id=nil)
     if pt = PtLogger::Logger.new
       pt.append_story_note(message,story_id)
+    else
+      false
     end
+  rescue
+    false
+  end
+
+  # Command: log +message+ to Pivotal Tracker if +condition+ is true.
+  #
+  # The +message+ to log can the result of block evaluation:
+  #
+  #   log_if(condition) do
+  #     "evaluate the message to log here with implicit PT:999999 story id"
+  #   end
+  #
+  # Or the +message+ to log can be passed as an arguent:
+  #
+  #   log_if(condition,message)
+  #
+  # An explicit story ID can be provided in both block and args form:
+  #
+  #   log_if(condition,story_id) do
+  #     "evaluate the message to log here"
+  #   end
+  #
+  #   log_if(condition,message,story_id)
+  #
+  # If +story_id+ is provided, logs to that story, else logs to a story ID
+  # referenced in the message itself (as #999 or PT:999).
+  #
+  # Returns true if log was successful, else false.
+  # Supresses any StandardErrors that may occur during logging.
+  #
+  def self.log_if(condition,*args)
+    return false unless condition
+    message = block_given? ? yield : args.shift
+    log(message,*args)
   end
 
 end

data/lib/pt_logger/logger.rb

@@ -33,8 +33,9 @@ class PtLogger::Logger
     if (story_id ||= :infer) == :infer
       story_id = extract_story_id_from(message)
     end
-    return unless story_id
+    return false unless story_id
     send_story_note!("[#{prepend_text}] #{message}",story_id)
+    true
   end
 
   def extract_story_id_from(message)

data/lib/pt_logger/version.rb

@@ -1,3 +1,3 @@
 module PtLogger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/pt_logger.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Paul Gallagher"]
   gem.email         = ["gallagher.paul@gmail.com"]
   gem.description   = %q{Simple way to log messages to Pivotal tracker stories}
-  gem.summary       = %q{Provides a simple interface for logging infomation on a Pivotal Tracker story. Optionally integrates with Rails logger.}
-  gem.homepage      = ""
+  gem.summary       = %q{Provides a simple interface for logging infomation on a Pivotal Tracker story}
+  gem.homepage      = "https://github.com/evendis/pt_logger"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/integration/base_spec.rb

@@ -11,7 +11,7 @@ describe PtLogger do
     let(:message) { "a test message for the PT:#{test_story_id} story" }
     subject { resource_class.log(message) }
     it "logs successfully" do
-      should be_a(PivotalTracker::Note)
+      should be_true
     end
   end
 

data/spec/unit/base_spec.rb

@@ -7,21 +7,125 @@ describe PtLogger do
   describe "##log" do
     subject { resource_class.log(message) }
     context "when story_id is defined in the message" do
-      let(:message) { "test message for story #12345678" }
-      let(:expected_message) { "[PtLogger] test message for story #12345678" }
       let(:expected_story_id) { 12345678 }
-      it "should not call send_story_note!" do
-        logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
-        subject
+      let(:message) { "test message for story ##{expected_story_id}" }
+      let(:expected_message) { "[PtLogger] #{message}" }
+      context "when successfully logged" do
+        before do
+          logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+        end
+        it { should be_true }
       end
     end
     context "when story_id is not defined" do
       let(:message) { "test message without ID" }
+      it { should be_false }
       it "should not call send_story_note!" do
         logger_class.any_instance.should_receive(:send_story_note!).never
         subject
       end
     end
+    context "when some kind of logging error occurs" do
+      let(:message) { "test message without ID" }
+      before do
+        logger_class.any_instance.should_receive(:append_story_note).and_raise(StandardError)
+      end
+      it { should be_false }
+    end
+  end
+
+  describe "#log_if" do
+
+    context "with implicit story ID" do
+      let(:expected_story_id) { 12345678 }
+      let(:message) { "test message for story ##{expected_story_id}" }
+      let(:expected_message) { "[PtLogger] #{message}" }
+
+      context "when message passed as block" do
+        subject { resource_class.log_if(condition) do
+          message
+        end }
+        context "when successfully logged" do
+          let(:condition) { true }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+          end
+          it { should be_true }
+        end
+        context "when log prevented by condition" do
+          let(:condition) { false }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).never
+          end
+          it { should be_false }
+        end
+      end
+
+      context "when message passed as parameter" do
+        subject { resource_class.log_if(condition,message) }
+        context "when successfully logged" do
+          let(:condition) { true }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+          end
+          it { should be_true }
+        end
+        context "when log prevented by condition" do
+          let(:condition) { false }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).never
+          end
+          it { should be_false }
+        end
+      end
+
+    end
+
+    context "with explicit story ID" do
+      let(:expected_story_id) { 12345678 }
+      let(:message) { "test message" }
+      let(:expected_message) { "[PtLogger] #{message}" }
+
+      context "when message passed as block" do
+        subject { resource_class.log_if(condition,expected_story_id) do
+          message
+        end }
+        context "when successfully logged" do
+          let(:condition) { true }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+          end
+          it { should be_true }
+        end
+        context "when log prevented by condition" do
+          let(:condition) { false }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).never
+          end
+          it { should be_false }
+        end
+      end
+
+      context "when message passed as parameter" do
+        subject { resource_class.log_if(condition,message,expected_story_id) }
+        context "when successfully logged" do
+          let(:condition) { true }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+          end
+          it { should be_true }
+        end
+        context "when log prevented by condition" do
+          let(:condition) { false }
+          before do
+            logger_class.any_instance.should_receive(:send_story_note!).never
+          end
+          it { should be_false }
+        end
+      end
+
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,7 +201,7 @@ files:
 - spec/unit/base_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/logger_spec.rb
-homepage: ''
+homepage: https://github.com/evendis/pt_logger
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -224,8 +224,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Provides a simple interface for logging infomation on a Pivotal Tracker story.
-  Optionally integrates with Rails logger.
+summary: Provides a simple interface for logging infomation on a Pivotal Tracker story
 test_files:
 - spec/fixtures/cassettes/PtLogger/with_embedded_story_id/logs_successfully.yml
 - spec/integration/base_spec.rb