pivotxt 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem "treetop"
+gem "rspec", ">= 2.0.0.beta.17"
+gem "ruby-debug"
+gem "pivotal-tracker"
+gem "fakeweb"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    happymapper (0.3.2)
+      libxml-ruby (~> 1.1.3)
+    libxml-ruby (1.1.4)
+    linecache (0.43)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    pivotal-tracker (0.2.2)
+      builder
+      happymapper (>= 0.3.2)
+      nokogiri (~> 1.4.3.1)
+      rest-client (~> 1.6.0)
+    polyglot (0.3.1)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  pivotal-tracker
+  rspec (>= 2.0.0.beta.17)
+  ruby-debug
+  treetop

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2010 Gabe Hollombe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,50 @@
+# Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.
+
+Sure, there's [slurper](http://github.com/hashrocket/slurper) but I didn't like slurper's file format; it's too YAML-y.  
+Hint: if you need a vim plugin to help you write your stories file, it's probably overly-complicated.
+
+So, I drafted a simple file format that I'd like to use and I wrote a grammar in Treetop to parse that format.  Pivotxt is the result.  Hopefully you'll find it as useful as I do. 
+
+## Configuration & Usage
+1.  Stick your appropriate values into pivotxt_config.yml
+2.  Use bin/pivotxt like this: pivotxt stories.pivotxt
+3.  You're done.
+
+
+## Sample stories.pivotxt file format
+<pre>
+LabelOne LabelTwo
+  - Features start with -'s as you can see (an inline description for this feature would go here)
+
+  - Features can have multi-line descriptions too, like this one
+      This is the first description line for the above feature.
+      Here is another line.
+      And yet another line here.
+
+  - All stories nested under a line of labels will have those labels applied to them.
+      In this case, we'll end up with 3 features and 2 chores, 
+      all with the 'LabelOne' and 'LabelTwo' labels assigned to them
+      because these are all nested under the 'LabelOne LabelTwo' line above.
+
+  [] Chores look like check boxes (and they can have inline descriptions too)
+
+  [] Chores can also have multi-line descriptions
+      Here's a multiline description for the above chore.
+      This is a second line of description.
+
+
+AnotherLabel
+  - Obviously, you can have as many labeled groups of stories as you want.
+      This feature belongs to a new label group called 'AnotherLabel' 
+      and it will be the only story created for the 'AnotherLabel' label.
+</pre>
+
+
+## Acknowledgements
+* Special thanks to Clifford Heath ([@cliffordheath](http://twitter.com/cliffordheath)) for helping me grok Treetop and get started with my grammar.
+* Thanks to [Hashrocket's slurper](http://github.com/hashrocket/slurper) for the inspriation.
+
+
+## Copyright
+
+MIT Licensed.  Copyright (c) 2010 Gabe Hollombe. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pivotxt"
+    gem.summary = %Q{Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.}
+    gem.description = %Q{Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.}
+    gem.email = "gabe@avantbard.com"
+    gem.homepage = "http://github.com/gabehollombe/pivotxt"
+    gem.authors = ["Gabe Hollombe"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pivotxt #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/pivotxt

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(File.dirname(__FILE__)), '..', 'lib'))
+require 'rubygems'
+require 'pivotxt'
+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.pivotxt" : ARGV[0]
+
+pivotxt = Pivotxt.new(story_file, '../pivotxt_config.yml')
+pivotxt.upload_stories!

data/lib/pivotxt.rb

@@ -0,0 +1,40 @@
+require 'treetop'
+require 'pivotal-tracker'
+require 'yaml'
+
+class Pivotxt
+  attr_reader :project
+
+  def initialize(stories_file, config_file)
+    @stories_file = stories_file
+    @config = YAML.load_file(config_file)
+
+    PivotalTracker::Client.token = @config['token']
+    @project = PivotalTracker::Project.find(@config['project_id'])
+  end
+
+  def load_stories
+    grammar = File.join(File.dirname(__FILE__), 'pivtxt.treetop')
+    Treetop.load grammar
+    
+    parser = PivtxtParser.new
+    parser.consume_all_input = false
+    tree = parser.parse(File.read(@stories_file).to_s)
+
+    return tree.value
+  end
+
+  def upload_stories!
+    labeled_groups = load_stories()
+    labeled_groups.each do |labeled_group|
+      labels = labeled_group[:labels]
+      stories = labeled_group[:stories]
+      stories.each do |story|
+        title = story[:title].value
+        description = story[:description].value
+        @project.stories.create(:name => title, :description => description, :labels => labels, :story_type => story[:type].to_s)
+      end
+    end
+
+  end
+end

data/lib/pivtxt.treetop

@@ -0,0 +1,135 @@
+grammar Pivtxt
+
+  rule label_groups
+    labeled_stories*
+    {
+      def value
+        elements.collect{|e| e.value}
+      end
+    }
+  end
+
+  rule labeled_stories
+    blank_line*
+    labels:(one_line "\n")
+    stories
+    {
+      def value
+        { :labels => labels.text_value.split(' '),
+          :stories => stories.stories_array
+        }
+      end
+    }
+  end
+
+  rule stories
+    story*
+    {
+      def stories_array
+        elements.collect {|e| e.value}
+      end
+    }
+  end
+
+  rule story
+    blank_line*
+    item:(feature / chore)
+    {
+      def value
+        item.value
+      end
+    }
+  end
+
+  rule feature
+    indent '- ' 
+    story_body
+    {
+      def value
+        {:type => :feature, :title => story_body.title, :description => story_body.description}
+      end
+    }
+  end
+
+  rule chore
+    indent '[] '
+    story_body
+    {
+      def value
+        {:type => :chore, :title => story_body.title, :description => story_body.description}
+      end
+    }
+  end
+
+  rule story_body
+    title
+    description:( 
+      "\n" multiline_description { def value; multiline_description.value; end }
+      / 
+      inline_description "\n" { def value; inline_description.value; end }
+    )
+  end
+
+  rule title
+    plain_text { 
+      def value
+        text_value 
+      end 
+    }
+  end
+
+  rule inline_description
+    (
+      '(' inline_description ')'
+      /
+      plain_text
+    ) 
+    {
+      def value
+        text_value
+      end
+    }
+  end
+
+  rule multiline_description
+    (indent indent one_line "\n")*
+    {
+      def value
+        text_value
+      end
+    }
+  end
+
+
+
+
+  #==========================================
+  # Utility rules
+  #==========================================
+
+  rule plain_text
+    (!non_plain .)*
+  end
+
+  # Characters not allowed in a one-line text fragment
+  rule non_plain
+    ([()] / "\n")
+  end
+
+
+  # Any text to end of line:
+  rule one_line
+    (!"\n" .)*
+  end
+
+
+  rule blank_line
+    [ \t]* "\n"
+  end
+
+
+  rule indent
+    '  '
+  end
+
+end

data/pivotxt.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pivotxt}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe Hollombe"]
+  s.date = %q{2010-10-01}
+  s.default_executable = %q{pivotxt}
+  s.description = %q{Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.}
+  s.email = %q{gabe@avantbard.com}
+  s.executables = ["pivotxt"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "bin/pivotxt",
+     "lib/pivotxt.rb",
+     "lib/pivtxt.treetop",
+     "pivotxt.gemspec",
+     "pivotxt_config.yml",
+     "spec/fixtures/pivotxt_stories.txt",
+     "spec/pivotxt_spec.rb",
+     "spec/pivotxt_treetop_grammar_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gabehollombe/pivotxt}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.}
+  s.test_files = [
+    "spec/pivotxt_spec.rb",
+     "spec/pivotxt_treetop_grammar_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/pivotxt_config.yml

@@ -0,0 +1,4 @@
+project_id: 12345 # found in the project settings or address bar in Tracker
+token: 123abc123abc123abc123abc # found on your profile page in Tracker
+requested_by: Default User # must be a user on the project
+

data/spec/fixtures/pivotxt_stories.txt

@@ -0,0 +1,19 @@
+LabelOne LabelTwo
+  - feature one (description one)
+
+  - feature two (description two)
+    
+  - feature three with multiline desc following
+      desc line 1
+      desc line 2
+      desc line 3
+
+  [] chore one (chore desc one)
+
+  [] chore two with multiline desc
+    chore desc line 1
+    chore desc line 2
+
+
+LabelThree
+  - feature four (desc for feature four)

data/spec/pivotxt_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Pivotxt do
+  before do
+    stories_file = File.join(File.dirname(__FILE__), 'fixtures', 'pivotxt_stories.txt')
+    config_file = File.join(File.dirname(__FILE__), '..', 'pivotxt_config.yml')
+
+    PivotalTracker::Project.stub!(:find).and_return(PivotalTracker::Project.new)
+    @pivotxt = Pivotxt.new(stories_file, config_file)
+  end
+
+  it 'sets the pivotal project as configured' do
+    @pivotxt.project.should be_a_kind_of(PivotalTracker::Project)
+  end
+
+  describe '#load_stories(file)' do
+    before do
+      @label_groups = @pivotxt.load_stories
+    end
+    
+    it 'returns label_groups' do
+      @label_groups.length.should == 2
+    end
+  end
+
+  describe "#upload_stories!" do
+    it 'creates a story of the appropriate type with the appropriate labels' do
+      @pivotxt.project.stories.stub!(:create).and_return(PivotalTracker::Story.new)
+      @pivotxt.project.stories.should_receive(:create).exactly(6).times
+      @pivotxt.upload_stories!
+    end
+  end
+end

data/spec/pivotxt_treetop_grammar_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'the pivotxt treetop grammar' do
+  before do
+    grammar = File.join(File.dirname(__FILE__), '..', 'lib', 'pivtxt.treetop')
+    Treetop.load grammar
+    
+    @parser = PivtxtParser.new
+    @parser.consume_all_input = false
+  end
+  
+  it 'parses an example stories file' do
+    stories_file = File.join(File.dirname(__FILE__), 'fixtures', 'pivotxt_stories.txt')
+    tree = @parser.parse(File.read(stories_file).to_s)
+    print "FAILURE REASON: " + @parser.failure_reason.to_s if ! tree
+
+
+    label_groups = tree.value
+
+    labels = label_groups.first[:labels]
+    labels.should include('LabelOne', 'LabelTwo')
+    
+    stories = label_groups.first[:stories]
+    stories.length.should == 5
+
+
+    stories[0][:title].value.should == "feature one "
+    stories[0][:description].value.should == "(description one)"
+    stories[0][:type].should == :feature
+
+    multi_line_desc = stories[2][:description].value
+    multi_line_desc.should include('desc line 1', 'desc line 2', 'desc line 3')
+
+    stories[3][:type].should == :chore
+    stories[3][:title].value.should == "chore one "
+    stories[3][:description].value.should == "(chore desc one)"
+
+
+    #next label group
+    stories = label_groups[1][:stories]
+    stories.length.should == 1
+    label_groups[1][:labels].should include('LabelThree')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruby-debug'
+require 'treetop'
+require 'pivotal-tracker'
+require 'pivotxt'
+
+require 'fakeweb'
+FakeWeb.allow_net_connect = false

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: pivotxt
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabe Hollombe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 +10:00
+default_executable: pivotxt
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.
+email: gabe@avantbard.com
+executables: 
+- pivotxt
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- bin/pivotxt
+- lib/pivotxt.rb
+- lib/pivtxt.treetop
+- pivotxt.gemspec
+- pivotxt_config.yml
+- spec/fixtures/pivotxt_stories.txt
+- spec/pivotxt_spec.rb
+- spec/pivotxt_treetop_grammar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gabehollombe/pivotxt
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Pivotxt lets you easily create stories in Pivotal Tracker from a simple text file.
+test_files: 
+- spec/pivotxt_spec.rb
+- spec/pivotxt_treetop_grammar_spec.rb
+- spec/spec_helper.rb