slurper 0.4.1 → 0.4.2

data/lib/slurper.rb

@@ -5,7 +5,8 @@ class Slurper
 
   def self.slurp(story_file, reverse)
     slurper = new(story_file)
-    slurper.yamlize_story_file
+    slurper.load_stories
+    slurper.prepare_stories
     slurper.stories.reverse! unless reverse
     slurper.create_stories
   end
@@ -14,14 +15,12 @@ class Slurper
     self.story_file = story_file
   end
 
-  def yamlize_story_file
-    self.stories = YAML.load(
-      IO.read(story_file).
-        gsub(/^/, "    ").
-        gsub(/    ==.*/, "- !ruby/object:Story\n  attributes:").
-        gsub(/    description:$/, "    description: |")
-    )
-    scrub_descriptions
+  def load_stories
+    self.stories = YAML.load(yamlize_story_file)
+  end
+
+  def prepare_stories
+    stories.each { |story| story.prepare }
   end
 
   def create_stories
@@ -44,15 +43,11 @@ class Slurper
 
   protected
 
-  def scrub_descriptions
-    stories.each do |story|
-      if story.respond_to? :description
-        story.description = story.description.gsub("  ", "").gsub(" \n", "\n")
-      end
-      if story.respond_to?(:description) && story.description == ""
-        story.attributes["description"] = nil
-      end
-    end
+  def yamlize_story_file
+    IO.read(story_file).
+      gsub(/^/, "    ").
+      gsub(/    ==.*/, "- !ruby/object:Story\n  attributes:").
+      gsub(/    description:$/, "    description: |")
   end
 
 end

data/lib/story.rb

@@ -2,15 +2,33 @@ require 'active_resource'
 
 class Story < ActiveResource::Base
 
-  @@defaults = YAML.load_file('slurper_config.yml')
-  self.site = "http://www.pivotaltracker.com/services/v3/projects/#{@@defaults['project_id']}"
-  headers['X-TrackerToken'] = @@defaults.delete("token")
-  attr_accessor :story_lines
-
-  def initialize(attributes = {})
-    @attributes     = {}
-    @prefix_options = {}
-    load(@@defaults.merge(attributes))
+  def self.config
+    @@config ||= YAML.load_file('slurper_config.yml')
+  end
+
+  self.site = "http://www.pivotaltracker.com/services/v3/projects/#{config['project_id']}"
+  headers['X-TrackerToken'] = config.delete("token")
+
+  def prepare
+    scrub_description
+    default_requested_by
+  end
+
+  protected
+
+  def scrub_description
+    if respond_to?(:description)
+      self.description = description.gsub("  ", "").gsub(" \n", "\n")
+    end
+    if respond_to?(:description) && description == ""
+      self.attributes["description"] = nil
+    end
+  end
+
+  def default_requested_by
+    if (!respond_to?(:requested_by) || requested_by == "") && Story.config["requested_by"]
+      self.attributes["requested_by"] = Story.config["requested_by"]
+    end
   end
 
 end

data/spec/slurper_spec.rb

@@ -7,23 +7,19 @@ describe Slurper do
   context "deals with leading/trailing whitespace" do
     before do
       slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "whitespacey_story.slurper"))
-      slurper.yamlize_story_file
+      slurper.load_stories
       @story = slurper.stories.first
     end
 
     it "strips whitespace from the name" do
       @story.name.should == "Profit"
     end
-
-    it "strips whitespace from the description" do
-      @story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n"
-    end
   end
 
   context "given values for all attributes" do
     before do
       slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "full_story.slurper"))
-      slurper.yamlize_story_file
+      slurper.load_stories
       @story = slurper.stories.first
     end
 
@@ -31,10 +27,6 @@ describe Slurper do
       @story.name.should == "Profit"
     end
 
-    it "parses the description correctly" do
-      @story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n\nAcceptance:\n- do the thing\n- don't forget the other thing\n"
-    end
-
     it "parses the label correctly" do
       @story.labels.should == "money,power,fame"
     end
@@ -47,7 +39,7 @@ describe Slurper do
   context "given only a name" do
     before do
       slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "name_only.slurper"))
-      slurper.yamlize_story_file
+      slurper.load_stories
       @story = slurper.stories.first
     end
 
@@ -60,7 +52,7 @@ describe Slurper do
   context "given empty attributes" do
     before do
       slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "empty_attributes.slurper"))
-      slurper.yamlize_story_file
+      slurper.load_stories
       @story = slurper.stories.first
     end
 
@@ -68,25 +60,9 @@ describe Slurper do
       @story.name.should be_nil
     end
 
-    it "should not set any description" do
-      @story.description.should be_nil
-    end
-
     it "should not set any labels" do
       @story.labels.should be_nil
     end
   end
 
-  context "given attributes with spaces" do
-    before do
-      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "quoted_attributes.slurper"))
-      slurper.yamlize_story_file
-      @story = slurper.stories.first
-    end
-
-    it "should set the description correctly" do
-      @story.description.should == "I have a \"quote\"\n"
-    end
-  end
-
 end

data/spec/story_spec.rb

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'spec'
+require 'slurper'
+
+describe Story do
+
+  context "#prepare" do
+    it "scrubs the description" do
+      story = Story.new
+      story.stub!(:default_requested_by)
+      story.should_receive(:scrub_description)
+      story.prepare
+    end
+
+    it "scrubs the defaults the requested_by attribute" do
+      story = Story.new
+      story.stub!(:scrub_description)
+      story.should_receive(:default_requested_by)
+      story.prepare
+    end
+  end
+
+  context "requested_by attribute" do
+    it "uses the default if not given one" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Client"
+    end
+
+    it "uses the default if given a blank requested_by" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new(:requested_by => "")
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Client"
+    end
+
+    it "uses the name given in the story file if there is one" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new(:requested_by => "Mr. Stakeholder")
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Stakeholder"
+    end
+  end
+
+  context "scrubs the descriptions correctly" do
+    it "when the description is blank" do
+      story = Story.new(:description => "")
+      story.send(:scrub_description)
+      story.description.should be_nil
+    end
+
+    it "when there is no description given" do
+      story = Story.new
+      lambda {
+        story.send(:scrub_description)
+      }.should_not raise_error
+    end
+
+    it "when it contains quotes" do
+      desc = <<-STRING
+        I have a "quote"
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "I have a \"quote\"\n"
+    end
+
+    it "when it is full of whitespace" do
+      desc = <<-STRING
+        In order to do something   
+        As a role     
+        I want to click a thingy  
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n"
+    end
+
+    it "when it contains acceptance criteria" do
+      desc = <<-STRING
+        In order to do something
+        As a role
+        I want to click a thingy
+
+        Acceptance:
+        - do the thing
+        - don't forget the other thing
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n\nAcceptance:\n- do the thing\n- don't forget the other thing\n"
+    end
+  end
+
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: slurper
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Wes Gibbs
@@ -12,19 +17,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 -05:00
+date: 2010-02-22 00:00:00 -05:00
 default_executable: slurp
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 description: "\n      Slurps stories from the given file (stories.slurper by default) and creates\n      Pivotal Tracker stories from them. Useful during story carding sessions\n      when you want to capture a number of stories quickly without clicking\n      your way through the Tracker UI.\n    "
 email: info@hashrocket.com
 executables: 
@@ -51,20 +60,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: takes a formatted story file and puts it on Pivotal Tracker
 test_files: 
 - spec/slurper_spec.rb
+- spec/story_spec.rb