slurper 0.2.3 → 0.4.0

data/README.rdoc

@@ -12,7 +12,7 @@ Works great with slurper.vim! (http://github.com/alowe/vim-slurper)
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Send me a pull request.
 
 == Setup
 
@@ -20,7 +20,7 @@ Works great with slurper.vim! (http://github.com/alowe/vim-slurper)
 
 == Config
 
-Create a story_defaults.yml file in your working directory for project stories.
+Slurper requires a slurper_config.yml file in your working directory. This file contains your Tracker API and story requestor information.
 
 === Example
 
@@ -32,31 +32,72 @@ The project_id tells tracker which project to add your stories to. It can be fou
 
 The token can be found on your personal profile page in Pivotal Tracker.
 
-The name, labels and description fields provide slurper with default values for story titles and descriptoins if you don't provide them in your stories.slurper file.
-
 The requested_by field should be the name of your project stakeholder exactly as it appears in tracker.
 
 == Usage
 
-Create a stories.slurper file and compose your stories in the slurper story format. In your working directory use the slurp command to import your stories from the stories.slurper file into Pivotal Tracker. If you have multiple story files for a project, stories.slurper and stories2.slurperfor example you can explicitly provide which file to slurp.
+Create a stories.slurper file and compose your stories in the slurper story format. In your working directory use the slurp command to import your stories from the stories.slurper file into Pivotal Tracker. Slurper looks for a stories.slurper file in your current directory by default, however, you can provide an alternate story source file if necessary.
 
-  $slurp stories2.slurper
+Default
 
-=== Example
+  $slurp ~/stories.slurper
+  
+Also valid
+
+  $slurp ~/special_stories.slurper
+  
+Or even
+
+  $slurp ~/mystories.txt
 
+=== Example stories.slurper
+
+  ==
+  story_type:
+    chore
+  name:
+    Set Up Staging Environment
+  description:
+    Set up and configure staging environment for approval of stories
+
+  labels:
+    
   ==
-  name
-    User Create Something
-  description
-    In order to accomplish some business value
-    As a User
-    I want to create something
-
-  labels
-    things
+  story_type:
+    feature
+  name:
+    Campaign Manager Does Something
+  description:
+    In order to get some value
+    As a campaign manager
+    I want to do something
+
+    - can do something
+
+  labels:
+    campaign managers
   ==
+  story_type:
+    release
+  name:
+    Big Release
+  description:
+    This release marks a lot of awesome functionality
+
+  labels:
+    
+  ==
+  story_type:
+    bug
+  name:
+    I did something and nothing happened
+  description:
+    When I do something, another thing is supposed to happen but I see an error screen instead.
+
+  labels:
+    
 
-Note: stories must have == before and after each story.
+Note: the story source file is whitespace-sensitive. Be sure the value for each key phrase is indented with two spaces beneath each key phrase. Also, start each story with a double-equals on its own line.
 
 
 Credit - Wes Gibbs (http://wgibbs.github.com) thought of and wrote slurper as a ruby script. It was later packaged and released as a gem by his fellow Rocketeers after using it and finding it extremely handy.

data/bin/slurp

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
 
-# Slurps stories from the given file (stories.txt by default) and creates
+# Slurps stories from the given file (stories.slurper by default) and creates
 # Pivotal Tracker stories from them. Useful during story carding sessions
 # when you want to capture a number of stories quickly without clicking
 # your way through the Tracker UI.
 
-# Note that if you include labels in stories.txt, they don't appear
+# Default story values and API token information should be provided in a
+# ~/.slurper.yml file.
+
+# Note that if you include labels in stories.slurper, they don't appear
 # immediately in Tracker. You'll have to refresh Tracker after a few seconds
 # to see them.
 
@@ -23,17 +26,4 @@ end.parse!
 
 story_file = ARGV.empty? ? "stories.slurper" : ARGV[0]
 
-story_lines = Array.new
-stories = Array.new
-IO.foreach(story_file) do |line|
-  if line[0,2] != "=="
-    story_lines << line
-  else
-    stories << Story.new.parse(story_lines)
-    story_lines.clear
-  end
-end
-
-stories.reverse! unless options[:reverse]
-
-stories.each { |story| story.save }
+Slurper.slurp(story_file, options[:reverse])

data/lib/slurper.rb

@@ -1 +1,58 @@
 require 'story'
+
+class Slurper
+  attr_accessor :story_file, :stories
+
+  def self.slurp(story_file, reverse = true)
+    slurper = new(story_file)
+    slurper.yamlize_story_file
+    slurper.stories.reverse! if reverse
+    slurper.create_stories
+  end
+
+  def initialize(story_file)
+    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
+  end
+
+  def create_stories
+    puts "Preparing to slurp #{stories.size} stories into Tracker..."
+    stories.each_with_index do |story, index|
+      begin
+        story.save
+        puts "#{index+1}. #{story.name}"
+      rescue ActiveResource::ServerError, ActiveResource::ResourceNotFound => e
+        msg = "Slurp failed on story "
+        if story.attributes["name"]
+          msg << story.attributes["name"]
+        else
+          msg << "##{options[:reverse] ? index + 1 : stories.size - index }"
+        end
+        puts msg + ".  Error: #{e}"
+      end
+    end
+  end
+
+  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
+  end
+
+end

data/lib/story.rb

@@ -2,8 +2,8 @@ require 'active_resource'
 
 class Story < ActiveResource::Base
 
-  @@defaults = YAML.load_file('story_defaults.yml')
-  self.site = "http://www.pivotaltracker.com/services/v2/projects/#{@@defaults['project_id']}"
+  @@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
 
@@ -13,58 +13,4 @@ class Story < ActiveResource::Base
     load(@@defaults.merge(attributes))
   end
 
-  def parse(story_lines)
-    @story_lines = story_lines
-    parse_name
-    parse_description
-    parse_labels
-    self
-  end
-
-  private
-
-  def parse_name
-    @story_lines.each_with_index do |line, i|
-      if start_of_value?(line, 'name')
-        if starts_with_whitespace?(@story_lines[i+1])
-          @attributes["name"] = @story_lines[i+1].strip
-        else
-          @attributes.delete("name")
-        end
-      end
-    end
-  end
-
-  def parse_description
-    @story_lines.each_with_index do |line, i|
-      if start_of_value?(line, 'description')
-        desc = Array.new
-        while((next_line = @story_lines[i+=1]) && starts_with_whitespace?(next_line)) do
-          desc << next_line
-        end
-        desc.empty? ? @attributes.delete("description") : @attributes["description"] = desc.join.gsub(/^ +/, "").gsub(/^\t+/, "")
-      end
-    end
-  end
-
-  def parse_labels
-    @story_lines.each_with_index do |line, i|
-      if start_of_value?(line, 'labels')
-        if starts_with_whitespace?(@story_lines[i+1])
-          @attributes["labels"] = @story_lines[i+1].strip
-        else
-          @attributes.delete("labels")
-        end
-      end
-    end
-  end
-
-  def starts_with_whitespace?(line)
-    line && line[0,1] =~ /\s/
-  end
-
-  def start_of_value?(line, attribute)
-    line[0,attribute.size] == attribute
-  end
-
 end

data/spec/{story_spec.rb → slurper_spec.rb}

@@ -1,18 +1,14 @@
 require 'rubygems'
 require 'spec'
-require 'story'
+require 'slurper'
 
-describe Story do
-
-  it ".parse should return a reference to the story" do
-    story = Story.new
-    story.parse("").should == story
-  end
+describe Slurper do
 
   context "deals with leading/trailing whitespace" do
     before do
-      story_lines = IO.readlines(File.dirname(__FILE__) + "/whitespacey_story.txt")
-      @story = Story.new.parse(story_lines)
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "whitespacey_story.slurper"))
+      slurper.yamlize_story_file
+      @story = slurper.stories.first
     end
 
     it "strips whitespace from the name" do
@@ -26,8 +22,9 @@ describe Story do
 
   context "given values for all attributes" do
     before do
-      story_lines = IO.readlines(File.dirname(__FILE__) + "/full_story.txt")
-      @story = Story.new.parse(story_lines)
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "full_story.slurper"))
+      slurper.yamlize_story_file
+      @story = slurper.stories.first
     end
 
     it "parses the name correctly" do
@@ -35,18 +32,23 @@ describe Story do
     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"
+      @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
+
+    it "parses the story type correctly" do
+      @story.story_type.should == "feature"
+    end
   end
 
   context "given only a name" do
     before do
-      story_lines = IO.readlines(File.dirname(__FILE__) + "/name_only.txt")
-      @story = Story.new.parse(story_lines)
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "name_only.slurper"))
+      slurper.yamlize_story_file
+      @story = slurper.stories.first
     end
 
     it "should parse the name correctly" do
@@ -57,27 +59,29 @@ describe Story do
 
   context "given empty attributes" do
     before do
-      story_lines = IO.readlines(File.dirname(__FILE__) + "/empty_attributes.txt")
-      @story = Story.new.parse(story_lines)
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "empty_attributes.slurper"))
+      slurper.yamlize_story_file
+      @story = slurper.stories.first
     end
 
     it "should not set any name" do
-      @story.attributes.keys.should_not include("name")
+      @story.name.should be_nil
     end
 
     it "should not set any description" do
-      @story.attributes.keys.should_not include("description")
+      @story.description.should be_nil
     end
 
     it "should not set any labels" do
-      @story.attributes.keys.should_not include("labels")
+      @story.labels.should be_nil
     end
   end
 
   context "given attributes with spaces" do
     before do
-      story_lines = IO.readlines(File.dirname(__FILE__) + "/quoted_attributes.txt")
-      @story = Story.new.parse(story_lines)
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slurper
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors: 
 - Wes Gibbs
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 -05:00
+date: 2010-02-05 00:00:00 -05:00
 default_executable: slurp
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,4 +67,4 @@ signing_key:
 specification_version: 3
 summary: takes a formatted story file and puts it on Pivotal Tracker
 test_files: 
-- spec/story_spec.rb
+- spec/slurper_spec.rb