git-commit-story 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm 1.9.3-p374@git-commit-story

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    git-commit-story (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-commit-story!
+  rspec
+  watchr

data/README.md

@@ -0,0 +1,5 @@
+This is a thin wrapper around git-commit that adds a story id to commit messages.
+
+    Usage: git commit-story --message 'message' --story 'story'
+        -m, --message MESSAGE            The commit message
+        -s, --story STORY                The story ID (This can be the Pivotal id, AgileZen id, or any label)

data/bin/git-commit-story

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "git-commit-story"
+
+class GitCommitStoryRunner
+  def initialize(args)
+    parse_args(args)
+  end
+
+  def parse_args(args)
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: git commit-story --message 'message' --story 'story'"
+      opts.on("-m", "--message MESSAGE", "The commit message") do |message|
+        puts "message: #{message}"
+        @message = message
+      end
+      opts.on("-s", "--story STORY", "The story ID (This can be the Pivotal id, AgileZen id, or any label)") do |story_id|
+        @story = story_id
+      end
+    end
+
+    parser.parse!
+  end
+
+  def run
+    gcs = GitCommitStory.new(:commit_message => @message, :story_id => @story)
+    gcs.commit
+  end
+end
+
+GitCommitStoryRunner.new(ARGV).run

data/bin/git-cs

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "git-commit-story"
+
+class GitCommitStoryRunner
+  def initialize(args)
+    parse_args(args)
+  end
+
+  def parse_args(args)
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: git commit-story --message 'message' --story 'story'"
+      opts.on("-m", "--message MESSAGE", "The commit message") do |message|
+        puts "message: #{message}"
+        @message = message
+      end
+      opts.on("-s", "--story STORY", "The story ID (This can be the Pivotal id, AgileZen id, or any label)") do |story_id|
+        @story = story_id
+      end
+    end
+
+    parser.parse!
+  end
+
+  def run
+    gcs = GitCommitStory.new(:commit_message => @message, :story_id => @story)
+    gcs.commit
+  end
+end
+
+GitCommitStoryRunner.new(ARGV).run

data/git-commit-story.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = "git-commit-story"
+  s.executables << "git-commit-story"
+  s.version     = "0.1.0"
+  s.date        = "2013-04-30"
+  s.summary     = "StreamSend git commit wrapper"
+  s.description = "Thin wrapper around git commit that adds a story id to commit messages"
+  s.authors     = ["Jeff Roush"]
+  s.email       = "jroush@ezpublishing.com"
+  s.files       = ["lib/git-commit-story.rb"]
+  s.homepage    = "https://github.com/Jeff-R/git-commit-story"
+  s.files       = `git ls-files`.split($/)
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "watchr"
+end

data/lib/git-commit-story.rb

@@ -0,0 +1,73 @@
+require "ostruct"
+require "yaml"
+
+class GitCommitStory
+  attr_reader :options
+
+  def initialize(options)
+    @config_file_name    = ".git-commit-story.yml"
+    config_file_options = options_from_config_file
+    config_file_options.merge!(options)
+    @options = config_file_options
+  end
+
+  def options_from_config_file
+    if File.exist?(@config_file_name)
+      config_file_options = YAML.load_file(@config_file_name)
+    else
+      {}
+    end
+  end
+
+  def save_config_file
+    File.open(@config_file_name, "w") { |f| f.puts @options.to_yaml }
+  end
+
+  def story_id
+    if @options[:story_id]
+      @options[:story_id]
+    else
+      prompt = "Enter a story"
+      prompt += " [#{@options[:previous_story_id]}]" if @options[:previous_story_id]
+      puts prompt
+      response = $stdin.gets.strip
+      if response == ""
+        if @options[:previous_story_id]
+          @options[:story_id] = @options[:previous_story_id]
+        else
+          puts "No story id was supplied"
+          abort
+        end
+      else
+        @options[:story_id] = response
+      end
+    end
+  end
+
+  def final_commit_message
+    message = ""
+    if options[:commit_message]
+      message = options[:commit_message]
+    else
+      message = get_message_from_prompt
+    end
+    "#{message}\n\nstory: #{story_id}"
+  end
+
+  def get_message_from_prompt
+    puts "Enter a commit message"
+    message = $stdin.gets
+    if message.length == 0
+      puts "No message supplied"
+      abort
+    end
+    message.strip
+  end
+
+  def commit
+    message = "git commit -m '#{final_commit_message}'"
+    result = system(message)
+    options[:previous_story_id] = story_id
+    save_config_file
+  end
+end

data/spec/lib/git-commit-story_spec.rb

@@ -0,0 +1,130 @@
+require "git-commit-story"
+require "yaml"
+
+describe GitCommitStory do
+  let(:config_file_name) { ".git-commit-story.yml" }
+
+  before do
+    YAML.stub(:load_file).with(config_file_name).and_return({})
+    File.stub(:open).with(anything, "w")
+    File.stub(:exist?).and_return(true)
+    $stdin.stub(:gets)
+    $stdout.stub(:puts)
+    $stderr.stub(:puts)
+  end
+
+  describe "with a story id" do
+    it "doesn't prompt for a story" do
+      $stdout.should_not_receive(:puts)
+      $stdin.should_not_receive(:gets)
+      GitCommitStory.new(story_id: "anything").story_id
+    end
+  end
+
+  describe "without a story id" do
+    it "prompts for a story" do
+      $stdout.should_receive(:puts).with("Enter a story")
+      $stdin.should_receive(:gets).and_return("story")
+      gcs = GitCommitStory.new({})
+      gcs.story_id
+    end
+
+    it "saves the new story id to options" do
+      new_story_id = "my new story"
+      $stdin.stub(:gets).and_return("#{new_story_id}\n")
+      gcs = GitCommitStory.new({})
+      gcs.story_id
+      gcs.options[:story_id].should == new_story_id
+    end
+
+    it "includes a saved story id in the prompt" do
+      gcs = GitCommitStory.new({message: "new message"})
+      gcs.options[:previous_story_id] = "previous story"
+      $stdout.should_receive(:puts).with("Enter a story [previous story]")
+      $stdin.should_receive(:gets).and_return("")
+      gcs.story_id
+    end
+
+    it "uses the previous story id if the user presses enter" do
+      gcs = GitCommitStory.new({message: "new message"})
+      new_story_id = "previous story"
+      gcs.options[:previous_story_id] = new_story_id
+      $stdin.stub(:gets).and_return("")
+      gcs.story_id
+      gcs.options[:story_id].should == new_story_id
+    end
+  end
+
+  it "reads .git-commit-story.yml if one exists" do
+    YAML.should_receive(:load_file).with(config_file_name).and_return({foo: "bar"})
+    gcs = GitCommitStory.new({})
+    gcs.options[:foo].should == "bar"
+  end
+
+  it "overrides config file options with passed options" do
+    YAML.should_receive(:load_file).with(config_file_name).and_return({foo: "bar", what: "ever"})
+    gcs = GitCommitStory.new({foo: "baz"})
+    gcs.options[:foo].should == "baz"
+    gcs.options[:what].should == "ever"
+  end
+
+  it "saves its configuration to a .git-commit-story.yml" do
+    mock_file = mock("file")
+    options = { foo: "bar" }
+    mock_file.should_receive(:puts).with(options.to_yaml.to_s)
+    File.should_receive(:open).with(config_file_name, "w").and_yield(mock_file)
+    GitCommitStory.new(options).save_config_file
+  end
+
+  describe "with a commit message" do
+    it "adds the story id to the commit message" do
+      commit_message = "the commit message"
+      gcs = GitCommitStory.new(commit_message: commit_message, story_id: "whatever")
+      message = "#{commit_message}\n\nstory: whatever"
+      gcs.final_commit_message.should == message
+    end
+  end
+
+  describe "without a commit message" do
+    it "prompts for a commit message" do
+      $stdout.should_receive(:puts).with("Enter a commit message")
+      $stdin.should_receive(:gets).and_return("new commit message\n")
+      gcs = GitCommitStory.new(story_id: "whatever")
+      gcs.final_commit_message.should == "new commit message\n\nstory: whatever"
+    end
+  end
+
+  it "saves a commit" do
+    gcs = GitCommitStory.new(:commit_message => "commit message", story_id: "whatever")
+    shell_command_string = "git commit -m '#{gcs.final_commit_message}'"
+    gcs.should_receive(:system).with(shell_command_string)
+    gcs.commit
+  end
+
+  it "saves the previous story_id after a commit" do
+    gcs = GitCommitStory.new(:commit_message => "commit message", story_id: "whatever")
+    gcs.stub(:system)
+    gcs.should_receive(:save_config_file)
+    gcs.commit
+    gcs.options[:previous_story_id].should == "whatever"
+  end
+
+  it "aborts a commit if the user enters an empty message" do
+    gcs = GitCommitStory.new(story_id: "whatever")
+    $stdin.stub(:gets).and_return("")
+    $stdout.should_receive(:puts).with("No message supplied")
+    expect {
+      gcs.get_message_from_prompt
+    }.to raise_error SystemExit
+  end
+
+  it "aborts a commit if the user enters an empty story id" do
+    gcs = GitCommitStory.new(message: "whatever")
+    $stdin.stub(:gets).and_return("")
+    $stdout.should_receive(:puts).with("No story id was supplied")
+    expect {
+      gcs.story_id
+    }.to raise_error SystemExit
+  end
+
+end

data/spec_watchr.rb

@@ -0,0 +1,2 @@
+watch("spec/(.*)\.rb") { |md| system("rspec spec/") }
+watch("lib/(.*)\.rb")  { |md| system("rspec spec/") }

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: git-commit-story
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Roush
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Thin wrapper around git commit that adds a story id to commit messages
+email: jroush@ezpublishing.com
+executables:
+- git-commit-story
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/git-commit-story
+- bin/git-cs
+- git-commit-story.gemspec
+- lib/git-commit-story.rb
+- spec/lib/git-commit-story_spec.rb
+- spec_watchr.rb
+homepage: https://github.com/Jeff-R/git-commit-story
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: StreamSend git commit wrapper
+test_files: []