story_branch 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71eaa77737e5c7d0b0f33de5bd0f2bddea608b37
-  data.tar.gz: dd9ffd60e2981b7b29f9cc874100407f31d099f4
+  metadata.gz: 27b478138908ff36d93a8c9c641136de6b789f1d
+  data.tar.gz: b7435c40b8257bb544f1379436a7559115100f2c
 SHA512:
-  metadata.gz: 18501105780a33a97970652d34d906722362b7f60b791bee54c26da8cf511d5e28525f2022874fe9c450c4d55b33e45b575910d3da27a6e803987994aed817d0
-  data.tar.gz: ae49ac7b0c07187ab62aa622aa0c416d17e36f89a0ffb0989d778e44b1fa8a615238b9078304414c48f94f3b0af6e8562ea799f032595b9fd6c178bbdc720b0d
+  metadata.gz: aa08dfe184feb00523a32995ea457952ef7881d34473d2aaf3423c4dbf2aedfa83050786090d1f84b2651bcf64061c2809ea0ef01eed3f052d53947f629af4e3
+  data.tar.gz: acec4e4033a5b0a6deff313be9b34253e89c379b614a0374c4e0b9a91d424e6377fb03644ecaf9867c14b964721a13d7314ab736509308bd6f44745bd8f6409f

data/README.md

@@ -12,12 +12,17 @@ Pivotal Tracker Story. It will get started stories from your active
 project.  You can enter text and press TAB to search for a story
 name, or TAB to show the full list. It will then suggest an editable
 branch name. When the branch is created the `story_id` will
-be appended to it.
+be appended to it. Enter a blank to exit.
 
 `git start`: Start a story in Pivotal Tracker from the terminal.
 It'll get all unstarted stories in your current project.  You can
 enter text and press TAB to search for a story name, or TAB to show
-the full list.
+the full list. Enter blank to exit.
+
+`git unstart`: Unstart a started story in Pivotal Tracker from the terminal.
+It'll get all started stories in your current project.  You can
+enter text and press TAB to search for a story name, or TAB to show
+the full list. Enter blank to exit.
 
 `git finish`: Create commit/message for the staged changes, e.g:
 "[Finishes #1234567] My Story Title" - optionally Finishes the story
@@ -48,7 +53,7 @@ Can be saved to `~/` or `./`
 
 You run story_branch from the git/project root folder.
 
-`start`, `branch`, are run interactively and will display a
+`start`, `unstart` and `story`, are run interactively and will display a
 list of stories to work with.
 
 `finish` will scan the current branch name for a story id (as its
@@ -56,6 +61,8 @@ suffix) and if a valid, active story is found on pivotal tracker it
 will create a commit with a message to trigger pivotal's git
 integraton features.
 
+All text entry supports Readline keyboard shortcuts / bindings, (word fwd/back, undo etc.)
+
 ### Command names
 
 It's possible to the commands in a few ways, we have deprecated the
@@ -63,10 +70,11 @@ old commmand names, and now encourage only the use of the `git`
 style usage.
 
       git style  | deprecated
-     ------------+--------------+--------------
-      git story  | story_branch | story-branch
-      git start  | story_start  | story-start
-      git finish | story_finish | story-finish
+     ------------+---------------+--------------
+      git story  | story_branch  | story-branch
+      git start  | story_start   | story-start
+      git unstart| story_unstart | story-unstart
+      git finish | story_finish  | story-finish
 
 ## Contributing
 

data/lib/story_branch.rb

@@ -5,7 +5,7 @@
 #          Dominic Wong <dominic.wong.617@gmail.com>
 #          Gabe Hollombe <gabe@neo.com>
 #
-# Version: 0.2.5
+# Version: 0.2.6
 #
 # ## Description
 #
@@ -86,50 +86,45 @@ require 'pivotal-tracker'
 require 'rb-readline'
 require 'readline'
 require 'git'
-require 'active_support/core_ext/string/inflections'
 require 'levenshtein'
 
 trap('INT') {exit}
 
 module StoryBranch
-
   class Main
-
     ERRORS = {
-      "Stories in the started state must be estimated." =>
+      'Stories in the started state must be estimated.' =>
       "Error: Pivotal won't allow you to start an unestimated story"
     }
 
-    PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
+    PIVOTAL_CONFIG_FILES = ['.story_branch', "#{ENV['HOME']}/.story_branch"]
+    PIVOTAL_API_CONFIG_FILES = ['.pivotal_api_key', "#{ENV['HOME']}/.pivotal_api_key"]
 
     attr_accessor :p
 
     def initialize
-      if config_file
-        @pivotal_info = YAML.load_file config_file
-      end
-      @p            = PivotalUtils.new
-      @p.api_key    = config_value "api", 'PIVOTAL_API_KEY'
-      @p.project_id = config_value "project", 'PIVOTAL_PROJECT_ID'
+      @pivotal_info     = YAML.load_file config_file(PIVOTAL_CONFIG_FILES) if config_file(PIVOTAL_CONFIG_FILES)
+      @pivotal_api_info = YAML.load_file config_file(PIVOTAL_API_CONFIG_FILES) if config_file(PIVOTAL_API_CONFIG_FILES)
+      @p                = PivotalUtils.new
+      @p.api_key        = api_config_value
+      @p.project_id     = config_value 'project', 'PIVOTAL_PROJECT_ID'
       exit unless @p.valid?
     end
 
     def create_story_branch
       begin
-        puts "Connecting with Pivotal Tracker"
+        puts 'Connecting with Pivotal Tracker'
         @p.get_project
-        puts "Getting stories..."
+        puts 'Getting stories...'
         stories = @p.display_stories :started, false
         if stories.length < 1
-          puts "No stories started, exiting"
+          puts 'No stories started, exiting'
           exit
         end
         story   = @p.select_story stories
-        if story
-          @p.create_feature_branch story
-        end
+        @p.create_feature_branch story if story
       rescue RestClient::Unauthorized
-        $stderr.puts "Pivotal API key or Project ID invalid"
+        $stderr.puts 'Pivotal API key or Project ID invalid'
         return nil
       end
     end
@@ -178,39 +173,44 @@ module StoryBranch
         end
 
         if GitUtils.has_status? :untracked or GitUtils.has_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"
+          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
         end
 
         unless GitUtils.has_status? :added or GitUtils.has_status? :staged
-          puts "There are no staged changes."
-          puts "Nothing to do"
+          puts 'There are no staged changes.'
+          puts 'Nothing to do'
           return
         end
 
-        puts "Use standard finishing commit message: [y/N]?"
+        puts 'Use standard finishing commit message: [y/N]?'
         commit_message = "[Finishes ##{GitUtils.current_branch_story_parts[:id]}] #{StringUtils.undashed GitUtils.current_branch_story_parts[:title]}"
         puts commit_message
 
-        if gets.chomp!.downcase == "y"
+        if gets.chomp!.downcase == 'y'
           GitUtils.commit commit_message
         else
           puts "Aborted"
         end
       rescue RestClient::Unauthorized
-        $stderr.puts "Pivotal API key or Project ID invalid"
+        $stderr.puts 'Pivotal API key or Project ID invalid'
         return nil
       end
     end
 
-    def config_file
-      PIVOTAL_CONFIG_FILES.select{|conf| File.exists? conf}.first
+    def config_file file_set
+      file_set.select{|conf| File.exists? conf}.first
+    end
+
+    def api_config_value
+      return @pivotal_api_info['api'] if @pivotal_api_info && @pivotal_api_info['api']
+      config_value 'api', 'PIVOTAL_API_KEY'
     end
 
     def config_value key, env
-      value = @pivotal_info[key] if @pivotal_info and @pivotal_info[key]
+      value = @pivotal_info[key] if @pivotal_info && @pivotal_info[key]
       value ||= env_required env
       value
     end
@@ -222,62 +222,52 @@ module StoryBranch
       end
       ENV[var_name]
     end
-
   end
 
   class StringUtils
-
     def self.dashed s
       s.tr(' _,./:;+&', '-')
     end
 
     def self.simple_sanitize s
-      strip_newlines (s.tr '\'"%!@#$(){}[]*\\?', '')
+      strip_newlines s.tr '\'"%!@#$(){}[]*\\?', ''
     end
 
     def self.normalised_branch_name s
-      StringUtils.simple_sanitize((StringUtils.dashed s).downcase).squeeze("-")
+      StringUtils.simple_sanitize StringUtils.dashed(s).downcase.squeeze('-')
     end
 
     def self.strip_newlines s
-      s.tr "\n", "-"
+      s.tr "\n", '-'
     end
 
     def self.undashed s
       s.underscore.humanize
     end
-
   end
 
   class GitUtils
-
     def self.g
-      Git.open "."
+      Git.open '.'
     end
 
     def self.is_existing_branch? name
       branch_names.each do |n|
-        if Levenshtein.distance(n, name) < 3
-          return true
-        end
+        return true if Levenshtein.distance(n, name) < 3
         existing_branch_name = n.match(/(.*)(-[1-9][0-9]+$)/)
         if existing_branch_name
           levenshtein_distance = Levenshtein.distance existing_branch_name[1], name
-          if levenshtein_distance < 3
-            return true
-          end
+          return true if levenshtein_distance < 3
         end
       end
-      return false
+      false
     end
 
     def self.is_existing_story? id
       branch_names.each do |n|
         branch_id = n.match(/-[1-9][0-9]+$/)
         if branch_id
-          if branch_id.to_s == "-#{id}"
-            return true
-          end
+          return true if branch_id.to_s == "-#{id}"
         end
       end
       false
@@ -297,11 +287,7 @@ module StoryBranch
 
     def self.current_branch_story_parts
       matches = current_branch.match(/(.*)-(\d+$)/)
-      if matches.length == 3
-        { title: matches[1], id: matches[2] }
-      else
-        nil
-      end
+      { title: matches[1], id: matches[2] } if matches.length == 3
     end
 
     def self.create_branch name
@@ -310,11 +296,7 @@ module StoryBranch
     end
 
     def self.status_collect status, regex
-      status.select{|e|
-        e.match(regex)
-      }.map{|e|
-        e.match(regex)[1]
-      }
+      status.select { |s| s.match(regex) }.map { |e| e.match(regex)[1] }
     end
 
     def self.status
@@ -340,11 +322,9 @@ module StoryBranch
     def self.commit message
       g.commit(message)
     end
-
   end
 
   class PivotalUtils
-
     attr_accessor :api_key, :project_id, :project
 
     def valid?
@@ -357,11 +337,10 @@ module StoryBranch
     end
 
     def is_current_branch_a_story?
-      GitUtils.current_story and
-      GitUtils.current_story.length == 3 and
-      filtered_stories_list(:started, true).
-        map(&:id).
-          include? GitUtils.current_story[2].to_i
+      GitUtils.current_story && GitUtils.current_story.length == 3 &&
+        filtered_stories_list(:started, true)
+        .map(&:id)
+        .include?(GitUtils.current_story[2].to_i)
     end
 
     def story_from_current_branch
@@ -377,9 +356,9 @@ module StoryBranch
       stories = project.stories.all({current_state: state})
       if estimated
         stories.select{|s|
-          s.story_type == "bug" or
-          s.story_type == "chore" or
-          (s.story_type == "feature" and s.estimate and s.estimate >= 0)}
+          s.story_type == 'bug' ||
+          s.story_type == 'chore' ||
+          (s.story_type == 'feature' && s.estimate && s.estimate >= 0)}
       else
         stories
       end
@@ -421,16 +400,17 @@ module StoryBranch
       dashed_story_name = StringUtils.normalised_branch_name story.name
       feature_branch_name = nil
       puts "You are checked out at: #{GitUtils.current_branch}"
-      while feature_branch_name == nil or 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])
+      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!
-      if 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 #{GitUtils.current_branch} as parent"
-        GitUtils.create_branch feature_branch_name_with_story_id
-      end
+
+      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 #{GitUtils.current_branch} as parent"
+      GitUtils.create_branch feature_branch_name_with_story_id
     end
 
     # Branch name validation
@@ -440,7 +420,7 @@ module StoryBranch
         return false
       end
       if GitUtils.is_existing_branch? name
-        puts "Error: This name is very similar to an existing branch. Avoid confusion and use a more unique name."
+        puts "Error: The name: #{name}, is very similar to an existing branch. To avoid confusion use a more unique name."
         return false
       end
       unless valid_branch_name? name
@@ -461,10 +441,10 @@ module StoryBranch
       # Store the state of the terminal
       RbReadline.clear_history
       if completions.length > 0
-        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 = ""
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Jason Milkins
@@ -17,70 +17,70 @@ dependencies:
   name: pivotal-tracker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: levenshtein-ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Simple gem that fetches the available stories in your pivotaltracker
@@ -142,17 +142,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Story Branch - create git branches based on pivotal tracker stories