pivotoolz 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee482afee960eb56b08d82ff6e1a99b5b7f07573
-  data.tar.gz: 850fc5aa2badb4170ec98dc289d9e5a0b31449c4
+  metadata.gz: 7f72efc65285d87ffae7064cec06b0ad482114a7
+  data.tar.gz: b2a485f35a316a47f320123c67685bef40182c0f
 SHA512:
-  metadata.gz: 812d018033aa466021c77d5136ad6f6abe1c6a63b5c96cce323d56382503f24c7e9397328c548b20b990ce67ff7ffc1f78ccfad55677562f0e96d3c2f800152a
-  data.tar.gz: 30a77effaa6690f146a036c7b9396e8091f917136c8c4f62fa07eb0eeea682722f382cd31a92d87458673d92b577d66454e851cf3f47e7b422178ee5d8245130
+  metadata.gz: 49d1f4aa7e15914ca3bb705dd767e80064acd91fd3f76610ea82b5636638f6ab89fc9094835c212360e27788618758e84db2784a2466c856292fd89f528412c5
+  data.tar.gz: 14907bd1939a6b5bccc87e0ead36a39e781362e07edf8939091dc1d5df9f1e7d3cd1a2e29f389a2b1573c10482b92b232d11c0596ce301c92547a285709d2667

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.mov

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in pivotoolz.gemspec
 gemspec

data/README.md

@@ -27,6 +27,23 @@ Or install it yourself as:
 
     $ gem install pivotoolz
 
+To take full advantage of the tools, ensure you have the following
+environment variables set:
+```bash
+PIVOTAL_TRACKER_API_TOKEN  # Get this from your pivotal tracker account profile page
+SLACK_WEBHOOK_URL          # Get this by creating a new Incoming Webhook integration in Slack
+```
+
+Set the environment variables by either adding them to your `.bashrc` file
+or exporting them prior to usage:
+Set the environment variables by exporting them with the following commands:
+`export PIVOTAL_TRACKER_API_TOKEN=YOUR_TOKEN`
+`export SLACK_WEBHOOK_URL=YOUR_WEBHOOK_URL`
+
+Alternatively, you can simply add those export statements to your `.bashrc` file
+so that you won't have to keep typing it every time you want to use
+`post-slack-message` or `deliver-deployed-stories` and their ilk.
+
 ## Usage
 
 Pivotoolz is a collection of tiny programs that can be used individually
@@ -39,7 +56,7 @@ Deliver all stories that have been deployed to the given
 environment since the previous and last deployment.
 
 Example:
-`bundle exec deliver-deployed-stories ENVIRONMENT`
+`deliver-deployed-stories ENVIRONMENT`
 
 Where `ENVIRONMENT` is the environment you consider to be where stories
 can be accepted/rejected.
@@ -50,7 +67,12 @@ test out stories. As long as we label our deployed git SHAs with tags
 (using `tag-it`), we can automatically deliver any finished stories
 that went out in the last deployment by simply running the command:
 
-`bundle exec deliver-deployed-stories acceptance`
+`deliver-deployed-stories acceptance`
+
+Add the command to your deployment process to have your stories automatically delivered
+on a successful deployment.
+
+![usage](assets/deliver-deployed-stories-demo.gif)
 
 ### `deliver-story`
 
@@ -60,27 +82,65 @@ required are `id` and `current_state`
 Typically used with output from `get-story-info-from-id` piped in.
 
 Example:
-`bundle exec get-story-info-from-id STORY_ID | bundle exec deliver-story`
+`get-story-info-from-id STORY_ID | deliver-story`
   OR
-`bundle exec deliver-story '{"id": 123, "current_state": "finished"}'`
+`deliver-story '{"id": 123, "current_state": "finished"}'`
 
 If `current_state` is not `finished`, the story will not be delivered.
 
-### `stories-deployed`
+### `story-ids-deployed`
+
+Returns a newline delimited list of all story ids deployed
+to the given environment.
 
-Returns a list of all stories deployed to a given environment.
+Example:
+```
+story-ids-deployed production
 
-Output is of the form:
+# Output:
+123
+456
 
-STORY_TITLE:
-LINK_TO_STORY
+```
 
-STORY_TITLE:
-LINK_TO_STORY
+
+
+### `merge`
+
+Tired of running multiple commands to merge your branch when all you
+really want to do is 'just merge' your branch? Now you can!
+Just run `merge TARGET_BRANCH` where target branch is the branch
+you want to merge into. The `merge` program takes care of rebasing the
+latest local and upstream changes from target branch into your branch,
+pushing your rebased branch, and then merging with the `--no-ff` flag.
+Life is short, the time saved adds up real fast!
+
+Example:
+When in a branch you want to merge, just run
+`merge master` to merge it into the `master` branch. You will end up
+with a clean git history and all commits in your branch will be bundled
+nicely under a top-level merge commit.
+
+![usage](assets/merge-demo.gif)
+
+### `tag-it`
+
+Tag the current git HEAD with a given tag (usually environment you're about to deploy to).
+
+Example:
+`tag-it production` - Will tag the current git HEAD with `production/TIMESTAMP`
+
+![usage](assets/tag-it-demo.gif)
+
+### `stories-deployed`
+
+If you use `tag-it` to label your git SHAs for deployment, this will return a list
+of all stories deployed between the previous and last deployments using the tags to
+scan a commit range.
 
 Example:
 ```
-bundle exec stories-deployed production
+stories-deployed production  # You may need to prepend bundle exec depending on your setup
 # Output:
 
 Update README:
@@ -91,6 +151,8 @@ https://www.pivotaltracker.com/story/show/456
 
 ```
 
+![usage](assets/stories-deployed-demo.gif)
+
 Use with `post-slack-message` to post a message in a slack deployment channel
 with the list of stories that just got deployed.
 
@@ -102,28 +164,43 @@ Once you have done so, copy your Webhook URL into
 an environment variable `SLACK_WEBHOOK_URL`.
 If the `SLACK_WEBHOOK_URL` has been defined correctly, you will
 be able to post a message in slack to any channel as follows:
-`bundle exec post-slack-message CHANNEL "MESSAGE_TEXT"`
+```bash
+post-slack-message CHANNEL "MESSAGE_TEXT"
+```
 Where CHANNEL is of the form "#channel" or "@user".
 
 You can also pipe a message to the `post-slack-message` program. For
 example:
-`{ echo Stories deployed to production:; bundle exec stories-deployed production; } | bundle exec post-slack-message '#production-deploys'`
+```bash
+{ echo Stories deployed to production:; stories-deployed production; } | post-slack-message '#production-deploys'
+```
 
-### `story-ids-deployed`
+`post-slack-message` can be helpful if you just want to have fun trolling your co-workers too.
 
-Returns a newline delimited list of all story ids deployed
-to the given environment.
+![usage](assets/post-slack-message-demo.gif)
+
+### `pv-git-branch`
+
+Wouldn't it be nice to have all your Git branch names consistent with your dev team? Well now
+you can with `pv-git-branch`. Just pass `pv-git-branch` a Pivotal Story ID, and it will return
+branch name for you based on author name, the pivital story category, the pivotal story
+name and the pivotal story id. Be sure to set your `PIVOTAL_TRACKER_API_TOKEN` env variable is
+exported in your `.bashrc` file. If you want to explicitly set your initials as the author name,
+set your git config user initials like this: `git config --add user.initials af`. Otherwise it
+will take your `git config user.name` or `whoami` information.
 
 Example:
+```bash
+pv-git-branch 111222333
 ```
-bundle exec story-ids-deployed production
-
-# Output:
-123
-456
+This would return something like: `af/features/building-someting-greate-111222333`
 
+So it can be used with git like this:
+```bashr
+git checkout -b $(pv-git-branch 111222333)
 ```
 
+![usage](assets/pv-git-branch-demo.gif)
 
 ## Development
 

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/exe/pv-git-branch

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/pivotoolz/git_branch'
+
+if ARGV.length != 1
+  puts "#{GitBranch.usage_message}"
+  exit
+end
+puts GitBranch.new.generate(ARGV.first)

data/lib/pivotoolz/git_branch.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+class GitBranch
+  def generate(story_id)
+    if !story_id
+      puts "#{GitBranch.usage_message}"
+      exit
+    end
+
+    story = get_pivotal_story(story_id)
+
+    author      = set_author
+    category    = set_category(story['story_type'])
+    description = set_description(story['name'])
+    pivotal_id  = story['id']
+
+    "#{author}/#{category}/#{description}-#{pivotal_id}"
+  end
+
+  private
+
+  def get_pivotal_story(pivotal_id)
+    unless ENV['PIVOTAL_TRACKER_API_TOKEN']
+      puts "!: You need to set the 'PIVOTAL_TRACKER_API_TOKEN' environment variable"
+      exit
+    end
+
+    story = JSON.parse(`get-story-info-from-id #{pivotal_id.tr('#', '')}`)
+  end
+
+  def set_author
+    author_name = get_author_initials || get_author_name || get_whoami || 'unknown'
+    author_name.downcase!
+    author_name.tr!('.@!#$%^\&*()', '')
+    author_name.tr(' ', '+')
+  end
+
+  def get_author_initials
+    initials = `git config user.initials`.strip
+    initials unless initials.empty?
+  end
+
+  def get_author_name
+    name = `git config user.name`.strip
+    name unless name.empty?
+  end
+
+  def get_whoami
+    you = `whoami`.strip
+    you unless you.empty?
+  end
+
+  def set_category(category)
+    category + 's'
+  end
+
+  def set_description(description)
+    description.tr!(':_,/.&!@#$%^*()[]\'`<>"', '') # remove unwanted punctuation
+    description.tr!('-', ' ') # replace dashes with space
+    description.downcase! # convert to lowercase
+    description.gsub!(/ +/,'-') # collapse spacing and replace spaces with dashes
+    description[0 .. 45].gsub(/-$/, '')
+  end
+
+  def self.usage_message
+    "Usage : bin/git-branch-it [pivotal_story_id]"
+  end
+end

data/lib/pivotoolz/version.rb

@@ -1,3 +1,3 @@
 module Pivotoolz
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/pivotoolz.rb

@@ -1,5 +1,4 @@
 require "pivotoolz/version"
 
 module Pivotoolz
-  # Your code goes here...
 end

data/pivotoolz.gemspec

@@ -14,8 +14,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sufyanadam/pivotoolz"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotoolz
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Sufyan Adam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -77,6 +77,7 @@ executables:
 - get-story-info-from-id
 - merge
 - post-slack-message
+- pv-git-branch
 - stories-deployed
 - story-ids-deployed
 - tag-it
@@ -92,6 +93,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/deliver-deployed-stories-demo.gif
+- assets/merge-demo.gif
+- assets/post-slack-message-demo.gif
+- assets/pv-git-branch-demo.gif
+- assets/stories-deployed-demo.gif
+- assets/tag-it-demo.gif
 - bin/console
 - bin/setup
 - exe/deliver-deployed-stories
@@ -99,10 +106,12 @@ files:
 - exe/get-story-info-from-id
 - exe/merge
 - exe/post-slack-message
+- exe/pv-git-branch
 - exe/stories-deployed
 - exe/story-ids-deployed
 - exe/tag-it
 - lib/pivotoolz.rb
+- lib/pivotoolz/git_branch.rb
 - lib/pivotoolz/version.rb
 - pivotoolz.gemspec
 homepage: https://github.com/sufyanadam/pivotoolz