story_express 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc2569d3ea2a62a5ff6dc2c15f0c69fb70e4f075
-  data.tar.gz: f217930372afed358b77581f69b86ace664d9274
+  metadata.gz: fac73c6f4c81a9dbd812c6623b9061a292cbbe9a
+  data.tar.gz: 7a9b2ad45e0c834af72ec21548a4f157c3579c0b
 SHA512:
-  metadata.gz: 5f984e044bd51c6203ee19318a0e9fec54c173264cef51a58401586c13757802cf1dd66b7f929ef43d2eaedca820272d942cdd136b970c6ef0436a65a00781cd
-  data.tar.gz: 6b07b2539c96286461dfe4166bf7bb13bab7161d43f5a7832dcb4011409cc65c2dda13f9d4fef4d1baaf57d51b624e069e39c69695ff1a352362c8dd438eeae9
+  metadata.gz: 0ed140bf6b989b2bcc32431222dfaa6d7280136e16d43674d8221ebf9fed281d9819f0e89d60553a2a708591eabb5b352438e8cb01ea993cb1e0f531526ce8be
+  data.tar.gz: 29beb91cd71b2b23b586e30bb298b2089775c12f0c3bef840fdf9af3ab32b5ad6f8b0e63b2777f2f4bc11b736fdef9680f5093cda81b20e7accd4c996c505172

data/README.md

@@ -1,6 +1,7 @@
 # StoryExpress
 
-TODO: Write a gem description
+Story Express delivers all the stories you've marked as finished.
+We recommend to use it at the end of your CI build once the stories have been deployed to an environment where your PM can accept.
 
 ## Installation
 
@@ -20,11 +21,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+**Currently only supports tracker projects.**
+
+Story Express delivers stories that are found by grepping git logs for a story id.
+So, to work with story express, include the story id in your commit message(s) for the commit(s) that finish a given story.
+
+You need your tracker project id and a tracker API key.
+Set the ```TRACKER_PROJECT_ID``` and ```TRACKER_TOKEN``` to your project id and API key respectively.
+Then, running ```story_express``` will deliver all your finished stories.
+
+```
+TRACKER_PROJECT_ID=123456789 TRACKER_TOKEN=0123456789abcdef story_express
+```
+
+## TODO
+
+* Support other agile tracking systems (JIRA primarily)
+* Accept inputs as command-line arguments
+* Allow for customization of matching commit messages
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/story_express/fork )
+1. Fork it ( https://github.com/shelbyd/story_express/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/story_express/story_finder.rb

@@ -6,7 +6,7 @@ module StoryExpress
       project = PivotalTracker::Project.find(ENV['TRACKER_PROJECT_ID'])
       stories = project.stories.all(state: 'finished', story_type: ['bug', 'feature'])
       stories.select do |story|
-        GitReader.grep_log("finishes ##{story.id}").length > 0
+        GitReader.grep_log(story.id).length > 0
       end
     end
   end

data/lib/story_express/version.rb

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

data/spec/story_express/story_finder_spec.rb

@@ -9,8 +9,8 @@ describe StoryExpress::StoryFinder do
     it 'returns finished stories that have been marked finished' do
       allow(PivotalTracker::Project).to receive(:find).with(ENV['TRACKER_PROJECT_ID']).and_return(project)
       allow(project.stories).to receive(:all).with(state: 'finished', story_type: ['bug', 'feature']).and_return([finished_marked_story, finished_unmarked_story])
-      allow(StoryExpress::GitReader).to receive(:grep_log).with('finishes #finished_marked_story').and_return('[finishes #finished_marked_story]')
-      allow(StoryExpress::GitReader).to receive(:grep_log).with('finishes #finished_unmarked_story').and_return('')
+      allow(StoryExpress::GitReader).to receive(:grep_log).with('finished_marked_story').and_return('[finishes #finished_marked_story]')
+      allow(StoryExpress::GitReader).to receive(:grep_log).with('finished_unmarked_story').and_return('')
 
       expect(StoryExpress::StoryFinder.deliverables).to eq [finished_marked_story]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: story_express
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shelby Doolittle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pivotal-tracker
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Story Express delivers your stories to your PM.
@@ -123,3 +123,4 @@ test_files:
 - spec/story_express/rider_spec.rb
 - spec/story_express/story_finder_spec.rb
 - spec/story_express_spec.rb
+has_rdoc: