pt_logger 0.0.2 → 0.0.3

data/lib/pt_logger/base.rb

@@ -1,15 +1,35 @@
 module PtLogger
 
   # Command: log +message+ to Pivotal Tracker.
+  #
+  # The +message+ to log can the result of block evaluation:
+  #
+  #   log 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(message)
+  #
+  # An explicit story ID can be provided in both block and args form:
+  #
+  #   log(story_id) do
+  #     "evaluate the message to log here"
+  #   end
+  #
+  #   log(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(message,story_id=nil)
+  def self.log(*args)
     if pt = PtLogger::Logger.new
-      pt.append_story_note(message,story_id)
+      message = block_given? ? yield : args.shift
+      pt.append_story_note(message,args.shift)
     else
       false
     end

data/lib/pt_logger/version.rb

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

data/spec/support/credentials_helper.rb

@@ -22,6 +22,8 @@ NOTE: real PT credentials are not configured so if the integration tests are mis
 they will fail. Set real PT credentials with environment variables:
 
   export TEST_PTLOGGER_API_KEY=your_api_key
+  export TEST_PTLOGGER_PROJECT_ID=your_project_id
+  export TEST_PTLOGGER_STORY_ID=your_story_id
 
       }
       false
@@ -38,12 +40,12 @@ they will fail. Set real PT credentials with environment variables:
 
   # Returns the project ID to use for tests
   def test_project_id
-    '703897'
+    ENV['TEST_PTLOGGER_PROJECT_ID'] || '703897'
   end
 
   # Returns the story ID to use for tests
   def test_story_id
-    '47387051'
+    ENV['TEST_PTLOGGER_STORY_ID'] || '47387051'
   end
 
 end

data/spec/unit/base_spec.rb

@@ -6,17 +6,56 @@ describe PtLogger do
 
   describe "##log" do
     subject { resource_class.log(message) }
-    context "when story_id is defined in the message" 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 successfully logged" do
+
+      context "when message passed as parameter" 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
+
+      context "when message passed as block" do
+        subject { resource_class.log do
+          message
+        end }
+        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 "with explicit story ID" do
+      let(:expected_story_id) { 12345678 }
+      let(:message) { "test message" }
+      let(:expected_message) { "[PtLogger] #{message}" }
+
+      context "when message passed as parameter" do
+        subject { resource_class.log(message,expected_story_id) }
+        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 message passed as block" do
+        subject { resource_class.log(expected_story_id) do
+          message
+        end }
         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 }
@@ -25,6 +64,7 @@ describe PtLogger do
         subject
       end
     end
+
     context "when some kind of logging error occurs" do
       let(:message) { "test message without ID" }
       before do
@@ -32,6 +72,7 @@ describe PtLogger do
       end
       it { should be_false }
     end
+
   end
 
   describe "#log_if" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport