pgit 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a72ba79fbaa4bfba38e13548cff4ac44812fb0b1
+  data.tar.gz: fd94693b8ff782640064f0a134d822b4922ab4bd
+SHA512:
+  metadata.gz: 5491115049d8c35b86df684a793be62ad71a7b3678379a3eb5337be7692c7e67903cd3a088cd0b729c419473db5a0a6d69031ec5386426de3a4e9f0a3cb3de75
+  data.tar.gz: ea5e67ecc7a8ca90e475ec261fec625581b6bbe92bd337d25631f345df57d8efee6dead19f0a49ca9db735da4569d4e152797513b5b1a0c29860feb0d6372d7a

data/.gitignore

@@ -0,0 +1 @@
+*.un~

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'pry'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    pgit (0.0.2)
+      gli (= 2.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    gli (2.12.2)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pgit!
+  pry
+  rake

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Edderic
+
+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,32 @@
+# PGit
+
+## Example Usage
+
+Assuming that:
+  - you have a project that uses Pivotal Tracker and Git that is listed under ~/.pgit.rc.yml
+  - your working directory is in that project,
+  - you want to automatically branch out based on the story title
+  - the story title with story id 10102004 is "Implement a really cool feature"
+
+```
+$ pgit story_branch -s 10102004
+```
+
+will create a branch for you named `implement-really-cool-feature-10102004`
+
+## Installation
+
+1. Install via RubyGems:
+
+```
+$ gem install pgit
+```
+
+2. Setup configuration file:
+
+```
+$ pgit install
+```
+
+This will generate a YAML file under `~/.pgit.rc.yml`. Edit that file to add information about projects that you're working on.  Each project needs a project `id`, Pivotal Tracker `api_token`, and `path`
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'PGit'
+end
+
+spec = eval(File.read('pgit.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+desc 'Run specs'
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |s|
+  s.libs << "spec"
+  s.test_files = FileList['spec/**/*_test.rb']
+end
+
+task :default => [:spec]

data/bin/pgit

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'pgit'
+include GLI::App
+
+program_desc 'Optimize your Pivotal Tracker and Git workflow'
+
+version Pgit::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+# desc 'Path to the config file'
+# default_value "#{ENV['HOME']}/.pgit.rc.yml"
+# arg_name '/path/to/.pivotal.yml'
+# flag [:c,:config]
+
+# desc 'Bypasses the app asking for confirmation'
+# switch [:force]
+
+# desc 'PivotalTracker API Token'
+# arg_name 'secr3tT0ken123'
+# flag [:'api-token']
+
+desc "Installs the pgit configuration file"
+command :install do |c|
+  c.action do |global_options,options,args|
+    PGit::Installer.new(global_options, options, args)
+  end
+end
+
+# desc 'Start, finish, etc. Pivotal Tracker story branches'
+desc 'Start Pivotal Tracker story branches'
+long_desc "Makes a cURL request to Pivotal Tracker to fetch the story, based
+on the given story id, parses the title, appends it with the story id. It then
+creates a branch name with that parsed title and does a `git checkout` to it.  "
+
+command :story_branch do |c|
+  c.desc "Parses the title of the given Pivotal Tracker story,\n" +
+    "  makes the branch name, and does a checkout"
+  c.arg_name 'STORY_ID'
+  c.flag :s, :start
+
+  # c.desc "Merge back to staging, remove local and remote (origin?) branches"
+  # c.switch :f, :finish
+
+  # c.desc "Attempts to join the story-branch that, presumably, already exists"
+  # c.arg_name 'STORY_ID'
+  # c.flag :j, :join
+
+  c.action do |global_options,options,args|
+    PGit::StoryBranch::Application.new(global_options, options, args)
+  end
+end
+
+# desc 'Wraps `git commit -m` and prepends the message with story id of the branch'
+
+# command :commit do |c|
+  # arg_name 'Describe arguments to commit here'
+  # c.action do |global_options,options,args|
+    # puts "commit command ran"
+  # end
+# end
+
+
+desc 'Initializes configuration file'
+
+arg_name 'path/to/config_file'
+
+# command :init_config do |c|
+  # c.action do |global_options,options,args|
+    # puts "init_config command ran"
+  # end
+# end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/lib/pgit.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'pgit/configuration'
+require 'pgit/current_branch'
+require 'pgit/current_project'
+require 'pgit/installer'
+require 'pgit/name_parser'
+require 'pgit/story'
+require 'pgit/story_branch'
+require 'pgit/story_branch/application'
+require 'pgit/version.rb'
+require 'yaml'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file

data/lib/pgit/configuration.rb

@@ -0,0 +1,77 @@
+#
+#   Loads the Pivotal-Git configuration file
+#
+# - config_path is the path to the pivotal-git configuration file
+#   This loads the file. Throws an error if a key (such as api_token, path, id)
+#   is missing. Check #general_error_message for more info
+#
+
+module PGit
+  class Configuration
+    def self.default_options
+      {
+        'projects' => [
+          {
+            'api_token' => 'somepivotalatoken124',
+            'id' => '12345',
+            "path" => "~/some/path/to/a/pivotal-git/project"
+          },
+          {
+            'api_token' => 'somepivotalatoken124',
+            'id' => '23429070',
+            "path" => "~/some/other/pivotal-git/project"
+          }
+        ]
+      }
+    end
+
+    def initialize(config_path = '~/.pgit.rc.yml')
+      @expanded_path = File.expand_path(config_path)
+      if File.exists? @expanded_path
+        config_file = File.open(@expanded_path, 'r')
+        @yaml = YAML.load(config_file)
+
+        validate_existence_of_at_least_one_project
+        validate_presence_of_items_in_each_project
+      else
+        raise missing_config_default
+      end
+    end
+
+    def to_yaml
+      @yaml
+    end
+
+    private
+
+    def missing_config_default
+      "Default configuration file does not exist. Please run `pgit install`"
+    end
+
+    def general_error_message
+      "Please have the following layout:\n" + YAML.dump(PGit::Configuration.default_options)
+    end
+
+    def validate_presence_of_items_in_each_project
+      projects = @yaml["projects"]
+      all_present = projects.all? do |project|
+        project["api_token"] &&
+          project["path"] &&
+          project["id"]
+      end
+
+      unless all_present
+        raise "Error: Must have a path, id, and api_token for each project.\n" +
+          general_error_message
+      end
+    end
+
+    def validate_existence_of_at_least_one_project
+      unless @yaml["projects"]
+        raise "Error: #{@expanded_path} needs at least one project.\n" +
+          general_error_message
+
+      end
+    end
+  end
+end

data/lib/pgit/current_branch.rb

@@ -0,0 +1,23 @@
+module PGit
+  class CurrentBranch
+    def initialize
+      @branches = `git branch`
+
+      raise @branches unless current.any?
+    end
+
+    def name
+      current.first.gsub(/\*\s*/, '')
+    end
+
+    def story_id
+      name.scan(/\d+$/).first
+    end
+
+    private
+
+    def current
+      @branches.scan(/\*.+/)
+    end
+  end
+end

data/lib/pgit/current_project.rb

@@ -0,0 +1,62 @@
+#
+#   Decides what the "current project" is, in relation to the pwd.
+#
+# - config_yaml: has the project configurations. It has at least one
+#   project. Each project has an (pivotal) api_token, path, and (pivotal)
+#   id
+#
+
+module PGit
+  class CurrentProject
+    def initialize(config_yaml)
+      @current_project = find_current_project(config_yaml)
+    end
+
+    def pwd
+      project_path = @current_project["path"]
+      File.expand_path(project_path, __FILE__)
+    end
+
+    def id
+      @current_project["id"]
+    end
+
+    def api_token
+      @current_project["api_token"]
+    end
+
+    private
+
+    def validate_pwd_match_at_least_one(matching_projects)
+      if matching_projects.length == 0
+        raise "None of the project paths matches the working directory"
+      end
+    end
+
+    def escape_slashes(project_path)
+      project_path.gsub('/','\/')
+    end
+
+    def find_matching_projects(projects)
+      projects.select do |project|
+        project_path = project["path"]
+        extended_path = File.expand_path(project_path, __FILE__)
+        escaped_project = escape_slashes(extended_path)
+        Dir.pwd.match(/#{escaped_project}/)
+      end
+    end
+
+    def find_current_project(config_yaml)
+      projects = config_yaml["projects"]
+      matching_projects = find_matching_projects(projects)
+
+      validate_pwd_match_at_least_one(matching_projects)
+      find_best_match(matching_projects)
+    end
+
+    def find_best_match(matching_projects)
+      matching_projects.sort! { |a,b| b["path"].length <=> a["path"].length }
+      matching_projects.first
+    end
+  end
+end

data/lib/pgit/installer.rb

@@ -0,0 +1,32 @@
+module PGit
+  class Installer
+    def initialize(glob_opts, opts, args)
+      file_path = "~/.pgit.rc.yml"
+      @expanded_path = File.expand_path(file_path)
+
+      if File.exists? @expanded_path
+        raise "Error: #{file_path} already exists"
+      else
+        ask_continue
+      end
+    end
+
+    def ask_continue
+      puts  "*** Installing example pgit configuration file under ~/.pgit.rc.yml. Continue? [Y/n]"
+      if STDIN.gets.chomp.match(/y/i)
+        puts "Saving example pgit config in ~/.pgit.rc.yml..."
+        write_example_pgit_rc_file
+      else
+        puts "Aborting installation..."
+      end
+    end
+
+    def write_example_pgit_rc_file
+      File.open(@expanded_path, 'w') do |f|
+        YAML.dump(PGit::Configuration.default_options, f)
+      end
+
+      puts "Saved! Please edit ~/.pgit.rc.yml and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+    end
+  end
+end

data/lib/pgit/name_parser.rb

@@ -0,0 +1,57 @@
+#
+#   Parses pivotal story titles and turns them into git branch names
+# - story.name: title of the pivotal tracker story
+#
+# - story_id: id of the pivotal tracker story
+#
+# ex: Fly so high in the sky 12345 becomes fly-so-high-sky-12345
+module PGit
+  class StoryBranch
+    class NameParser
+      def initialize(story)
+        @story = story
+        @story_name = story.name
+      end
+
+      def story_id
+        @story.id
+      end
+
+      def name
+        remove_fluff_words
+        remove_non_alphanumeric_characters
+        downcase
+        add_story_id
+      end
+
+      private
+
+      def remove_non_alphanumeric_characters
+        words = @story_name.split(' ')
+        split_words = words.each { |word| word.gsub!(/\W/, '') }
+        @story_name = split_words.select do |word|
+          !word.empty?
+        end.join('-')
+      end
+
+      def remove_fluff_words
+        fluff_words = %w{the on of}
+        fluff_words.each { |fluff_word| @story_name.gsub!(/\b#{fluff_word}\b/i, '') }
+        remove_extraneous_white_spaces
+      end
+
+      def remove_extraneous_white_spaces
+        @story_name.strip!
+        @story_name.gsub!(/\s+/, ' ')
+      end
+
+      def downcase
+        @story_name.downcase!
+      end
+
+      def add_story_id
+        "#{@story_name}-#{story_id}"
+      end
+    end
+  end
+end