slurper 0.1.0

data/README.rdoc

@@ -0,0 +1,58 @@
+= slurper
+
+Slurper allows you to quickly compose your stories in a text file and import them into Pivotal Tracker.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  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.
+
+== Setup
+
+gem install hashrocket-slurper
+
+== Config
+
+Create a story_defaults.yml file in your working directory for project stories.
+
+=== Example
+
+  project_id: 1234
+  token: 123abc123abc123abc
+  name: Untitled
+  description: "In order to \nAs a \nI want \n\nAcceptance:\n* "
+  requested_by: Jane Stakeholder
+  labels: slurper
+
+The project_id tells tracker which project to add your stories to. It can be found on the project settings or the url for the project.
+
+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.txt file.
+
+The requested_by field should be the name of your project stakeholder exactly as it appears in tracker.
+
+== Usage
+
+Create a stories.txt file and compose your stories in the slurper story format.
+
+=== Example
+
+  ==
+  name
+    User Create Something
+  description
+    In order to accomplish some business value
+    As a User
+    I want to create something
+
+  labels
+    things
+  ==
+
+Note: stories must have == before and after each story.

data/bin/slurp

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+# Slurps stories from the given file (stories.txt 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
+# immediately in Tracker. You'll have to refresh Tracker after a few seconds
+# to see them.
+
+$:.unshift(File.join(File.dirname(File.dirname(__FILE__)),'lib'))
+require 'rubygems'
+require 'slurper'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.on("-r", "--reverse", "Reverse story creation order") do |v|
+    options[:reverse] = v
+  end
+end.parse!
+
+story_file = ARGV.empty? ? "stories.txt" : 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 }

data/lib/slurper.rb

@@ -0,0 +1 @@
+require 'story'

data/lib/story.rb

@@ -0,0 +1,70 @@
+require 'activeresource'
+
+class Story < ActiveResource::Base
+
+  @@defaults = YAML.load_file('story_defaults.yml')
+  self.site = "http://www.pivotaltracker.com/services/v2/projects/#{@@defaults['project_id']}"
+  headers['X-TrackerToken'] = @@defaults.delete("token")
+  attr_accessor :story_lines
+
+  def initialize(attributes = {})
+    @attributes     = {}
+    @prefix_options = {}
+    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

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'spec'
+require 'story'
+
+describe Story do
+
+  it ".parse should return a reference to the story" do
+    story = Story.new
+    story.parse("").should == story
+  end
+
+  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)
+    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
+      story_lines = IO.readlines(File.dirname(__FILE__) + "/full_story.txt")
+      @story = Story.new.parse(story_lines)
+    end
+
+    it "parses the name correctly" 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
+  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)
+    end
+
+    it "should parse the name correctly" do
+      @story.name.should == "Profit"
+    end
+
+    it "should use the default value for the description" do
+      @story.description.should == "In order to \nAs a \nI want \n\nAcceptance:\n* "
+    end
+
+    it "should use the default value for the labels" do
+      @story.labels.should == "slurper"
+    end
+  end
+
+  context "given empty attributes" do
+    before do
+      story_lines = IO.readlines(File.dirname(__FILE__) + "/empty_attributes.txt")
+      @story = Story.new.parse(story_lines)
+    end
+
+    it "should not set any name" do
+      @story.attributes.keys.should_not include("name")
+    end
+
+    it "should not set any description" do
+      @story.attributes.keys.should_not include("description")
+    end
+
+    it "should not set any labels" do
+      @story.attributes.keys.should_not include("labels")
+    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)
+    end
+
+    it "should set the description correctly" do
+      @story.description.should == "I have a \"quote\"\n"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: slurper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wes Gibbs
+- Adam Lowe
+- Stephen Caudill
+- Tim Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-16 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 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: "\n      Slurps stories from the given file (stories.txt 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: 
+- slurp
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- bin/slurp
+- lib/slurper.rb
+- lib/story.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/hashrocket/slurper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: takes a formatted story file and puts it on Pivotal Tracker
+test_files: 
+- spec/story_spec.rb