story_branch 0.2.11 → 0.3.0

data/lib/story_branch/config_manager.rb

@@ -0,0 +1,18 @@
+require 'tty-config'
+
+module StoryBranch
+  # Config manager class is simply a wrapper around
+  # TTY::Config with the configuration file name set
+  # so we DRY our code.
+  class ConfigManager
+    # TODO: Might be worht moving the configuration filename
+    # to a constant
+    def self.init_config(path, should_read = true)
+      config = ::TTY::Config.new
+      config.filename = '.story_branch'
+      config.append_path path
+      config.read if config.persisted? && should_read
+      config
+    end
+  end
+end

data/lib/story_branch/git_utils.rb

@@ -0,0 +1,85 @@
+require 'git'
+require 'levenshtein'
+
+module StoryBranch
+  class GitUtils
+    def self.g
+      ::Git.open '.'
+    end
+
+    def self.existing_branch?(name)
+      branch_names.each do |n|
+        return true if Levenshtein.distance(n, name) < 3
+        existing_branch_name = n.match(/(.*)(-[1-9][0-9]+$)/)
+        next unless existing_branch_name
+        levenshtein_distance = Levenshtein.distance existing_branch_name[1], name
+        return true if levenshtein_distance < 3
+      end
+      false
+    end
+
+    def self.existing_story?(id)
+      branch_names.each do |n|
+        branch_id = n.match(/-[1-9][0-9]+$/)
+        next unless branch_id
+        return true if branch_id.to_s == "-#{id}"
+      end
+      false
+    end
+
+    def self.branch_names
+      g.branches.map(&:name)
+    end
+
+    def self.current_branch
+      g.current_branch
+    end
+
+    def self.current_story
+      current_branch.match(/(.*)-(\d+$)/)
+    end
+
+    def self.current_branch_story_parts
+      matches = current_story
+      return unless matches.length == 3
+      { title: matches[1], id: matches[2] }
+    end
+
+    def self.create_branch(name)
+      g.branch(name).create
+      g.branch(name).checkout
+    end
+
+    def self.status_collect(status, regex)
+      status.select{|e|
+        e.match(regex)
+      }.map{ |e|
+        e.match(regex)[1]
+      }
+    end
+
+    def self.status
+      modified_rx  = /^ M (.*)/
+      untracked_rx = /^\?\? (.*)/
+      staged_rx    = /^M  (.*)/
+      added_rx     = /^A  (.*)/
+      status = g.lib.send(:command, 'status', '-s').lines
+      return nil if status.empty?
+      {
+        modified:  status_collect(status, modified_rx),
+        untracked: status_collect(status, untracked_rx),
+        added:     status_collect(status, added_rx),
+        staged:    status_collect(status, staged_rx)
+      }
+    end
+
+    def self.status?(state)
+      return false unless status
+      !status[state].empty?
+    end
+
+    def self.commit(message)
+      g.commit(message)
+    end
+  end
+end

data/lib/story_branch/main.rb

@@ -0,0 +1,124 @@
+require_relative './string_utils'
+require_relative './pivotal_utils'
+require_relative './config_manager'
+
+module StoryBranch
+  class Main
+    ERRORS = {
+      'Stories in the started state must be estimated.' =>
+      "Error: Pivotal won't allow you to start an unestimated story"
+    }.freeze
+
+    attr_accessor :p
+
+    def initialize
+      @p = PivotalUtils.new
+      @p.project_id = project_id
+      @p.api_key = config.fetch(project_id, :api_key)
+      @p.finish_tag = config.fetch(project_id, :finish_tag, default: 'Finishes')
+      exit unless @p.valid?
+    end
+
+    # TODO:
+    # Move these methods to the command logic.
+    def create_story_branch
+      puts 'Connecting with Pivotal Tracker'
+      @p.project
+      puts 'Getting stories...'
+      stories = @p.display_stories :started, false
+      if stories.empty?
+        puts 'No stories started, exiting'
+        exit
+      end
+      story = @p.select_story stories
+      return unless story
+      @p.create_feature_branch story
+    rescue Blanket::Unauthorized
+      unauthorised_message
+      return nil
+    end
+
+    def story_finish
+      puts 'Connecting with Pivotal Tracker'
+      @p.project
+
+      unless @p.is_current_branch_a_story?
+        warn "Your current branch: '#{GitUtils.current_branch}' is not linked to a Pivotal Tracker story."
+        return nil
+      end
+
+      if GitUtils.status?(:untracked) || GitUtils.status?(:modified)
+        puts 'There are unstaged changes'
+        puts 'Use git add to stage changes before running git finish'
+        puts 'Use git stash if you want to hide changes for this commit'
+        return nil
+      end
+
+      unless GitUtils.status?(:added) || GitUtils.status?(:staged)
+        puts 'There are no staged changes.'
+        puts 'Nothing to do'
+        return nil
+      end
+
+      puts 'Use standard finishing commit message: [y/N]?'
+      commit_message = "[Finishes ##{GitUtils.current_branch_story_parts[:id]}] #{StoryBranch::StringUtils.undashed GitUtils.current_branch_story_parts[:title]}"
+      puts commit_message
+
+      if gets.chomp!.casecmp('y').zero?
+        GitUtils.commit commit_message
+      else
+        puts 'Aborted'
+      end
+    rescue Blanket::Unauthorized
+      unauthorised_message
+      return nil
+    end
+
+    def story_start
+      pick_and_update(:unstarted, { current_state: 'started' }, 'started', true)
+    end
+
+    def story_unstart
+      pick_and_update(:started, { current_state: 'unstarted' }, 'unstarted', false)
+    end
+
+    private
+
+    def config
+      return @config if @config
+      @config = ConfigManager.init_config(Dir.home)
+      @config
+    end
+
+    def project_id
+      return @project_id if @project_id
+      local_config = ConfigManager.init_config('.')
+      @project_id = local_config.fetch(:project_id)
+      @project_id
+    end
+
+    def unauthorised_message
+      warn 'Pivotal API key or Project ID invalid'
+    end
+
+    def pick_and_update(filter, hash, msg, is_estimated)
+      puts 'Connecting with Pivotal Tracker'
+      @p.project
+      puts 'Getting stories...'
+      stories = @p.filtered_stories_list filter, is_estimated
+      story = @p.select_story stories
+      if story
+        result = @p.story_update story, hash
+        raise result.error if result.error
+        puts "#{story.id} #{msg}"
+      end
+    rescue Blanket::Unauthorized
+      unauthorised_message
+      return nil
+    end
+
+    def story_estimate
+      # TODO: estimate a story
+    end
+  end
+end

data/lib/story_branch/pivotal_utils.rb

@@ -0,0 +1,146 @@
+require 'blanket'
+require 'rb-readline'
+require_relative './git_utils'
+
+module StoryBranch
+  class PivotalUtils
+    API_URL = 'https://www.pivotaltracker.com/services/v5/'.freeze
+    attr_accessor :api_key, :project_id, :finish_tag
+
+    def valid?
+      !@api_key.nil? && !@project_id.nil?
+    end
+
+    def api
+      fail 'API key must be specified' unless @api_key
+      Blanket.wrap API_URL, headers: { 'X-TrackerToken' => @api_key }
+    end
+
+    def project
+      return @project if @project
+      fail 'Project ID must be set' unless @project_id
+      @project = api.projects(@project_id.to_i)
+      @project
+    end
+
+    def story_accessor
+      project.stories
+    end
+
+    def is_current_branch_a_story?
+      StoryBranch::GitUtils.current_story and
+        StoryBranch::GitUtils.current_story.length == 3 and
+        filtered_stories_list(:started, true)
+          .map(&:id)
+          .include? StoryBranch::GitUtils.current_story[2].to_i
+    end
+
+    def story_from_current_branch
+      story_accessor.get(StoryBranch::GitUtils.current_story[2].to_i) if StoryBranch::GitUtils.current_story.length == 3
+    end
+
+    # TODO: Maybe add some other predicates
+    # - Filtering on where a story lives (Backlog, IceBox)
+    # - Filtering on labels
+    # as the need arises...
+    #
+    def filtered_stories_list(state, estimated)
+      options = { with_state: state.to_s }
+      stories = [* story_accessor.get(params: options).payload]
+      if estimated
+        stories.select do |s|
+          s.story_type == 'bug' || s.story_type == 'chore' ||
+            (s.story_type == 'feature' && s.estimate && s.estimate >= 0)
+        end
+      else
+        stories
+      end
+    end
+
+    def display_stories(state, estimated)
+      filtered_stories_list(state, estimated).each {|s| puts one_line_story s }
+    end
+
+    def one_line_story(s)
+      "#{s.id} - #{s.name}"
+    end
+
+    # TODO: Use TTY prompt with pagination
+    def select_story(stories)
+      story_texts = stories.map { |s| one_line_story s }
+      puts 'Leave blank to exit, use <up>/<down> to scroll through stories, TAB to list all and auto-complete'
+      story_selection = readline('Select a story: ', story_texts)
+      return nil if story_selection == '' || story_selection.nil?
+      story = stories.select { |s| story_matcher s, story_selection }.first
+      if story.nil?
+        puts "Not found: #{story_selection}"
+        return nil
+      else
+        puts "Selected : #{one_line_story story}"
+        return story
+      end
+    end
+
+    def story_update(story, hash)
+      project.stories(story.id).put(body: hash).payload
+    end
+
+    def story_matcher(story, selection)
+      m = selection.match(/^(\d*) /)
+      return false unless m
+      id = m.captures.first
+      story.id.to_s == id
+    end
+
+    def create_feature_branch(story)
+      dashed_story_name = StoryBranch::StringUtils.normalised_branch_name story.name
+      feature_branch_name = nil
+      puts "You are checked out at: #{StoryBranch::GitUtils.current_branch}"
+      while feature_branch_name.nil? || feature_branch_name == ''
+        puts 'Provide a new branch name... (TAB for suggested name)' if [nil, ''].include? feature_branch_name
+        feature_branch_name = readline('Name of feature branch: ', [dashed_story_name])
+      end
+      feature_branch_name.chomp!
+      return unless validate_branch_name(feature_branch_name, story.id)
+      feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
+      puts "Creating: #{feature_branch_name_with_story_id} with #{StoryBranch::GitUtils.current_branch} as parent"
+      StoryBranch::GitUtils.create_branch feature_branch_name_with_story_id
+    end
+
+    # Branch name validation
+    def validate_branch_name(name, id)
+      if StoryBranch::GitUtils.existing_story? id
+        puts "Error: An existing branch has the same story id: #{id}"
+        return false
+      end
+      if StoryBranch::GitUtils.existing_branch? name
+        puts 'Error: This name is very similar to an existing branch. Avoid confusion and use a more unique name.'
+        return false
+      end
+      unless valid_branch_name? name
+        puts "Error: #{name}\nis an invalid name."
+        return false
+      end
+      true
+    end
+
+    def valid_branch_name?(name)
+      # Valid names begin with a letter and are followed by alphanumeric
+      # with _ . - as allowed punctuation
+      valid = /[a-zA-Z][-._0-9a-zA-Z]*/
+      name.match valid
+    end
+
+    def readline(prompt, completions = [])
+      # Store the state of the terminal
+      RbReadline.clear_history
+      if completions.length.positive?
+        completions.each { |i| Readline::HISTORY.push i }
+        RbReadline.rl_completer_word_break_characters = ''
+        Readline.completion_proc = proc { |s| completions.grep(/#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = ''
+      end
+      Readline.readline(prompt, false)
+    end
+  end
+end

data/lib/story_branch/string_utils.rb

@@ -0,0 +1,23 @@
+module StoryBranch
+  class StringUtils
+    def self.dashed(s)
+      s.tr(' _,./:;+&', '-')
+    end
+
+    def self.simple_sanitize(s)
+      strip_newlines(s.tr('\'"%!@#$(){}[]*\\?', ''))
+    end
+
+    def self.normalised_branch_name(s)
+      simple_sanitize((dashed s).downcase).squeeze('-')
+    end
+
+    def self.strip_newlines(s)
+      s.tr "\n", '-'
+    end
+
+    def self.undashed(s)
+      s.tr(/-/, ' ').capitalize
+    end
+  end
+end

data/lib/story_branch/templates/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/add/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/config/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/create/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/finish/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/migrate/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/start/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/templates/unstart/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/version.rb

@@ -0,0 +1,3 @@
+module StoryBranch
+  VERSION = '0.3.0'.freeze
+end

data/story_branch.gemspec

@@ -0,0 +1,54 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'story_branch/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'story_branch'
+  spec.license = 'MIT'
+  spec.version = StoryBranch::VERSION
+  spec.authors = [
+    'Jason Milkins',
+    'Rui Baltazar',
+    'Dominic Wong',
+    'Ranhiru Cooray',
+    'Gabe Hollombe'
+  ]
+  spec.email = [
+    'jasonm23@gmail.com',
+    'rui.p.baltazar@gmail.com',
+    'dominic.wong.617@gmail.com',
+    'ranhiru@gmail.com',
+    'gabe@neo.com'
+  ]
+
+  spec.summary = 'Create git branches based on pivotal tracker stories'
+  spec.description = 'Simple gem that fetches the available stories in your \
+  pivotaltracker project and allows you to create a git branch with the name \
+  based on the selected story'
+  spec.homepage = 'https://github.com/story-branch/story_branch'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'blanket_wrapper', '~> 3.0'
+  spec.add_runtime_dependency 'git', '~> 1.2'
+  spec.add_runtime_dependency 'levenshtein-ffi', '~> 1.0'
+  spec.add_runtime_dependency 'pastel', '~> 0.7.2'
+  spec.add_runtime_dependency 'rb-readline', '~> 0.5'
+  spec.add_runtime_dependency 'thor', '~> 0.20.0'
+  spec.add_runtime_dependency 'tty-command', '~> 0.8.0'
+  spec.add_runtime_dependency 'tty-config', '~> 0.2.0'
+  spec.add_runtime_dependency 'tty-pager', '~> 0.11.0'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.16.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'fakefs', '~> 0.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end