git_breeze 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f411ec6aefe6c704aa75132ab0e2ef37aaeaa2d8
+  data.tar.gz: ad02bcd7f002478120db86af40f0a0cd28db8524
+SHA512:
+  metadata.gz: 250c6fa6a18c9eae0c171b13446dc53d25ce36ffbcceedd5ec022d64db6b49e50123114262176be632dd59b7f1b45a9a0834aa21ccac9ff521995de46b75b9a0
+  data.tar.gz: 15d761b82e63553d6c33c16ad22a975db67fb2b7f55c1a907f17e20dceac318976d7c7198bfe05493b9779e4b9045c5a5fe2cf5a256377eec444e8edfec94fb2

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+.bundle
+.ruby-version
+Gemfile.lock
+coverage
+bin/autospec
+bin/rspec
+bin/rake
+doc/
+lib/bundler/man
+/git-breeze
+pkg
+rdoc
+tmp
+tags

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+-I spec/support
+-r pry

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+addons:
+  code_climate:
+    repo_token: d08131691091072810c086f65d42c36ba7ea3241629c643caa363cbc966bbb23

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 0.1.0 / 2015-09-09
+changed references from tracker to brreeze and altered the code to remove unnecessary stuff
+
+### 0.0.1 / 2015-09-09
+[full changelog](https://github.com/stevenharman/git_tracker/compare/v0.0.1...v1.0.0)
+
+Forked from git_tracker

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git_breeze.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', :group => :test, :require => nil

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 MobileIgniter
+
+MIT License
+
+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.md

@@ -0,0 +1,139 @@
+# GitBreeze
+
+*GitBreeze*, or *git-breeze*, is a Git hook that will scan your current
+branch name looking for something it recognizes as a [Breeze][b]
+story number. If it finds one, it will automagically add it, in the [special
+format][pt-format], to your commit message.
+
+## Installation
+
+### 1) Install the `git-breeze` binary
+
+You need to get the `git-breeze` binary onto your system.
+
+- via [Homebrew][homebrew] :beers: (preferred)
+
+  ```bash
+  $ brew install git-breeze
+  ```
+
+- via [RubyGems][rubygems] :pensive: (if you must)
+
+  ```bash
+  $ gem install git_breeze
+  ```
+
+### 2) Initialize the hook
+
+Then you need to initialize the *git hook* into each local Git repository where
+you want to use it.
+
+```bash
+# from inside a local Git repository
+# for example: /path/to/repo/
+$ git breeze init
+```
+
+This will put the `prepare-commit-msg` hook in the `/path/to/repo/.git/hooks`
+directory and make it executable.
+
+**NOTE:** The hook needs to be initialized just once for each repository in
+which you will use it.
+
+## Usage
+
+With the hook initialized in a repository, create branches being sure to include
+the Breeze story number in the branch name.
+
+```bash
+$ git checkout -b a_useful_and_helpful_name_8675309
+```
+
+When you commit, Git will fire the hook which will find the story number in the
+branch name and prepare your commit message so that it includes the story number
+in the [special Breeze syntax][b-format].
+
+```bash
+# on branch named `best_feature_ever-8675309`
+$ git commit
+```
+
+Will result in a commit message something like: *(notice the two empty lines at
+the top)*
+
+```diff
+
+
+#8675309
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch best_feature_ever-8675309
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+# new file:   feature.rb
+#
+
+```
+
+You should then add a [useful and responsible commit message][tpope]. :heart:
+
+### Passing commit messages via command line
+
+If you pass a commit message on the command line the hook will still add the
+story number, preceded by an empty line, to the end of your message.
+
+```bash
+# on branch named `best_feature_ever-8675309`
+$ git commit -m'Look at this rad code, yo!'
+```
+
+Results in this commit message:
+
+```
+Look at this rad code, yo!
+
+#8675309
+```
+
+However, if you include the story number in the Breeze format within
+your commit message, the hook will do nothing.
+
+```bash
+# on branch named `best_feature_ever-8675309`
+$ git commit -m'#8675309 Look at this rad code, yo!'
+```
+
+Results in this commit message:
+
+
+```
+#8675309 Look at this rad code, yo!
+```
+
+### Valid branch names
+
+*GitBreeze* allows you to include the story number any where in the branch
+name, optionally prefixing it with a hash (`#`). Examples:
+
+  - `best_feature_ever_#8675309`
+  - `best-feature-ever-8675309`
+  - `8675309_best_feature_ever`
+  - `#8675309-best-feature-ever`
+  - `your_name/8675309_best_feature_ever`
+  - `your_name/#8675309_best_feature_ever`
+
+## Contributing :octocat:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my_new_feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my_new_feature`)
+5. Create new Pull Request
+
+
+[b]: https://www.breeze.pm/
+[b-format]: http://www.breeze.pm/help/projects/bitbucket-integration
+[tpope]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[homebrew]: http://mxcl.github.com/homebrew
+[rubygems]: http://rubygems.org/gems/git_breeze

data/Rakefile

@@ -0,0 +1,66 @@
+#!/usr/bin/env rake
+require File.expand_path('../lib/git_breeze/version', __FILE__)
+
+# Skip these tasks when being installed by Homebrew
+unless ENV['HOMEBREW_BREW_FILE']
+
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+
+  # Rubygems tasks
+  namespace :gem do
+    require 'bundler/gem_tasks'
+  end
+
+  desc "Create tag v#{GitBreeze::VERSION}, build, and push to GitHub, Rubygems, and Homebrew"
+  task :release => ['gem:release', 'standalone:homebrew']
+
+end
+
+# standalone and Homebrew
+file 'git-breezer' => FileList.new('lib/git_breeze.rb', 'lib/git_breeze/*.rb') do |task|
+  $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+  require 'git_breeze/standalone'
+  GitBreeze::Standalone.save(task.name)
+end
+
+namespace :standalone do
+
+  desc 'Build standalone script'
+  task :build => 'git-breezer'
+
+  desc 'Build and install standalone script'
+  task :install => 'standalone:build' do
+    prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+
+    FileUtils.mkdir_p "#{prefix}/bin"
+    FileUtils.cp 'git-breezer', "#{prefix}/bin", :preserve => true
+  end
+
+  task :homebrew do
+    brew_dir = Bundler.with_clean_env { `brew --prefix` }.chomp
+    Dir.chdir brew_dir do
+      sh 'git checkout -q master'
+      sh 'git pull -q origin master'
+
+      formula_file = 'Library/Formula/git-breezer.rb'
+      sha = `curl -#L https://github.com/stevenharman/git_breeze/archive/v#{GitBreeze::VERSION}.tar.gz | shasum`.split(/\s+/).first
+      abort unless $?.success? and sha.length == 40
+
+      formula = File.read formula_file
+      formula.sub! /\bv\d+(\.\d+)*/, "v#{GitBreeze::VERSION}"
+      formula.sub! /\b[0-9a-f]{40}\b/, sha
+      File.open(formula_file, 'w') {|f| f << formula }
+
+      branch = "git_breeze-v#{GitBreeze::VERSION}"
+      sh "git checkout -q -B #{branch}"
+      sh "git commit -m 'git-breezer #{GitBreeze::VERSION}' -- #{formula_file}"
+      sh "git push -u stevenharman #{branch}"
+      sh "hub pull-request -m 'git-breezer #{GitBreeze::VERSION}'"
+
+      sh 'git checkout -q master'
+    end
+  end
+end
+

data/bin/git-breeze

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'git_breeze'
+GitBreeze::Runner.execute(*ARGV)

data/git_breeze.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/git_breeze/version', __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name          = 'git_breeze'
+    gem.version       = GitBreeze::VERSION
+  gem.authors       = ['Timothy Nott']
+    gem.email         = ['tim@mobileigniter.com']
+  gem.homepage      = 'https://bitbucket.org/mobileigniter/git_breeze'
+    gem.summary       = %q{Teaching Git about Breeze.}
+  gem.description   = <<-EOF
+Some simple tricks that make working with Breeze.pm easier
+  EOF
+
+  gem.add_development_dependency 'rspec', '~> 3.2.0'
+  gem.add_development_dependency 'activesupport', '~> 3.2'
+  # Use i18n < 0.7 until we drop Ruby 1.8.7 and 1.9.2 support
+  gem.add_development_dependency 'i18n', '~> 0.6.11'
+  gem.add_development_dependency 'pry', '~> 0.10.1'
+  # Use Rake < 10.2 (requires Ruby 1.9+) until we drop Ruby 1.8.7 support
+  gem.add_development_dependency 'rake', '~> 10.1.1'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+gem.executables   = %w(git-breeze)
+  gem.require_paths = ['lib']
+end

data/lib/git_breeze/branch.rb

@@ -0,0 +1,24 @@
+require 'English'
+require 'git_breeze/repository'
+
+module GitBreeze
+  module Branch
+    def self.story_number
+      current[/#?(\d{6,10})/, 1]
+    end
+
+    def self.current
+      branch_path = `git symbolic-ref HEAD`
+
+      Repository.ensure_exists unless exit_successful?
+
+      branch_path[%r{refs/heads/(.+)}, 1] || ''
+    end
+
+    private
+
+    def self.exit_successful?
+      $CHILD_STATUS.exitstatus == 0
+    end
+  end
+end

data/lib/git_breeze/commit_message.rb

@@ -0,0 +1,45 @@
+module GitBreeze
+  class CommitMessage
+
+    def initialize(file)
+      @file = file
+      @message = File.read(@file)
+    end
+
+    def mentions_story?(number)
+      @message =~ /^(?!#).*\[(\w+\s)?(#\d+\s)*##{number}(\s#\d+)*(\s\w+)?\]/io
+    end
+
+#    def keyword
+#      @message =~ /\[(fix|fixes|fixed|complete|completes|completed|finish|finishes|finished|deliver|delivers|delivered)\]/io
+#      $1
+#    end
+
+    def append(text)
+      body, postscript = parse(@message)
+      new_message = format_message(body, text, postscript)
+      File.open(@file, 'w') do |f|
+        f.write(new_message)
+      end
+      new_message
+    end
+
+    private
+
+    def parse(message)
+      lines = message.split($/)
+      body = lines.take_while { |line| !line.start_with?('#') }
+        postscript = "# testing to see if I can add instructions here\n#\{story number\} should be put in automatically. use @\{username\} to call someone out. use m:\{ListName\} to move an item to a new list\n" + lines.slice(body.length..-1)
+      [body.join("\n"), postscript.join("\n")]
+    end
+
+    def format_message(preamble, text, postscript)
+      return <<-MESSAGE
+#{preamble.strip}
+
+#{text}
+#{postscript}
+MESSAGE
+    end
+  end
+end

data/lib/git_breeze/hook.rb

@@ -0,0 +1,38 @@
+require 'git_breeze/repository'
+
+module GitBreeze
+  class Hook
+    attr_reader :hook_file
+
+    def self.init
+      init_at(Repository.root)
+    end
+
+    def self.init_at(root)
+      new(root).write
+    end
+
+    def initialize(root)
+      @hook_file = File.join(root, '.git', 'hooks', 'prepare-commit-msg')
+    end
+
+    def write
+      File.open(hook_file, 'w') do |f|
+        f.write(hook_body)
+        f.chmod(0755)
+      end
+    end
+
+    private
+
+    def hook_body
+      return <<-HOOK
+#!/usr/bin/env bash
+
+git_breeze prepare-commit-msg "$@"
+
+      HOOK
+    end
+
+  end
+end

data/lib/git_breeze/prepare_commit_message.rb

@@ -0,0 +1,42 @@
+require 'git_breeze/branch'
+require 'git_breeze/commit_message'
+
+module GitBreeze
+  class PrepareCommitMessage
+    attr_reader :file, :source, :commit_sha
+
+    def self.run(file, source=nil, commit_sha=nil)
+      new(file, source, commit_sha).run
+    end
+
+    def initialize(file, source=nil, commit_sha=nil)
+      @file = file
+      @source = source
+      @commit_sha = commit_sha
+    end
+
+    def run
+      exit_when_commit_exists
+
+      story = story_number_from_branch
+      message = CommitMessage.new(file)
+      exit if message.mentions_story?(story)
+      keyword = message.keyword
+
+      message_addition = [keyword, "##{story}"].compact.join(' ')
+      message.append("[#{message_addition}]")
+    end
+
+    private
+
+    def exit_when_commit_exists
+      exit if source == 'commit'
+    end
+
+    def story_number_from_branch
+      story = Branch.story_number
+      exit unless story
+      story
+    end
+  end
+end

data/lib/git_breeze/repository.rb

@@ -0,0 +1,17 @@
+require 'English'
+
+module GitBreeze
+  module Repository
+
+    def self.root
+      path = `git rev-parse --show-toplevel`.chomp
+      abort unless $CHILD_STATUS.exitstatus == 0
+      path
+    end
+
+    def self.ensure_exists
+      root
+    end
+
+  end
+end

data/lib/git_breeze/runner.rb

@@ -0,0 +1,39 @@
+require 'git_breeze/prepare_commit_message'
+require 'git_breeze/hook'
+require 'git_breeze/version'
+
+module GitBreeze
+  module Runner
+
+    def self.execute(cmd_arg = 'help', *args)
+      command = cmd_arg.gsub(/-/, '_')
+      abort("[git_breeze] command: '#{cmd_arg}' does not exist.") unless respond_to?(command)
+      send(command, *args)
+    end
+
+    def self.prepare_commit_msg(*args)
+      PrepareCommitMessage.run(*args)
+    end
+
+    def self.init
+      Hook.init
+    end
+
+    def self.install
+      puts '`git-breeze install` is deprecated. Please use `git-breeze init`'
+      self.init
+    end
+
+    def self.help
+      puts <<-HELP
+git-breeze #{VERSION} is installed.
+
+Remember, git-breeze is a hook which Git interacts with during its normal
+lifecycle of committing, rebasing, merging, etc. You need to initialize this
+hook by running `git-breeze init` from each repository in which you wish to
+use it. Cheers!
+      HELP
+    end
+  end
+
+end

data/lib/git_breeze/standalone.rb

@@ -0,0 +1,70 @@
+module GitBreeze
+  module Standalone
+    extend self
+
+    GIT_BREEZE_ROOT = File.expand_path('../../..', __FILE__)
+    PREAMBLE = <<-preamble
+#
+# This file is generated code. DO NOT send patches for it.
+#
+# Original source files with comments are at:
+# https://bitbucket.org/mobileigniter/git_breeze
+#
+
+preamble
+
+    def save(filename, path = '.')
+      dest = File.join(File.expand_path(path), filename)
+      File.open(dest, 'w') do |f|
+        build(f)
+        f.chmod(0755)
+      end
+    end
+
+    def build(io)
+      io.puts "#!#{ruby_executable}"
+      io << PREAMBLE
+
+      each_source_file do |filename|
+        File.open(filename, 'r') do |source|
+          inline_source(source, io)
+        end
+      end
+
+      io.puts 'GitBreeze::Runner.execute(*ARGV)'
+      io
+    end
+
+    def ruby_executable
+      if File.executable? '/usr/bin/ruby' then '/usr/bin/ruby'
+      else
+        require 'rbconfig'
+        File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+      end
+    end
+
+    private
+
+    def inline_source(code, io)
+      code.each_line do |line|
+        io << line unless require_own_file?(line)
+      end
+      io.puts ''
+    end
+
+    def require_own_file?(line)
+      line =~ /^\s*require\s+["']git_breeze\//
+    end
+
+    def each_source_file
+      File.open(File.join(GIT_BREEZE_ROOT, 'lib/git_breeze.rb'), 'r') do |main|
+        main.each_line do |req|
+          if req =~ /^require\s+["'](.+)["']/
+            yield File.join(GIT_BREEZE_ROOT, 'lib', "#{$1}.rb")
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/git_breeze/version.rb

@@ -0,0 +1,3 @@
+module GitBreeze
+  VERSION = '0.1.0'
+end

data/lib/git_tracker.rb

@@ -0,0 +1,7 @@
+require 'git_breeze/version'
+require 'git_breeze/hook'
+require 'git_breeze/repository'
+require 'git_breeze/prepare_commit_message'
+require 'git_breeze/runner'
+require 'git_breeze/branch'
+require 'git_breeze/commit_message'

data/prepare-commit-msg.example

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+git-tracker prepare-commit-msg "$@"
+