story_branch 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1826485750874314fb2570c93b1330a89f88e36571a84fe63482a33ffbb50d34
-  data.tar.gz: 2914e9113a13b0ab0546485faa0b8acea1906f84b459f54c2d835433891bbb0c
+  metadata.gz: 0adf65a12d1ab52998ada7760645345d76c1dbe817ce52724005a71cf1b7bb30
+  data.tar.gz: 63a19f6f253be9459618ecfb8d23f099c1e2ea5c65b3152394b49a6dce335094
 SHA512:
-  metadata.gz: baf40433309c1939869490828cdb7cbd2749ba9cb22f09579e0003f989fecf84ced996bc0ae64a6babc58debc43c601093659a231c1c3ef5a12e31055f9badde
-  data.tar.gz: b24f7b09b8eadee1960cd4a053f6007c23bb46535af08667e5fab08b6bbb15e622664110e05ba2783eacb6e07fe4033d901bd9b0e8d5ab5abd4c71e38fc359d2
+  metadata.gz: c7a2c1923c37f423f7f2a946e6ecf19371cae814b33489ec59069567711b3de50a3c49e054d4c30042c04ebfe4b16c032584f854a758ab1f0871bb7f27d67ca7
+  data.tar.gz: a59cb14660ed656598170978e63ccc2e51e414028d28a6af35c3e0de82d96fd9cea10c93e033c4c9a12850b880fbd922b1b60a035e700fea8b73ee292b59ad11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    story_branch (0.6.0)
+    story_branch (0.6.1)
       blanket_wrapper (~> 3.0)
       damerau-levenshtein (~> 1.3)
       jira-ruby (~> 1.7)
@@ -14,12 +14,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     atlassian-jwt (0.2.0)
       jwt (~> 2.1.0)
     blanket_wrapper (3.0.2)
@@ -27,12 +27,12 @@ GEM
       recursive-open-struct
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    damerau-levenshtein (1.3.1)
+    damerau-levenshtein (1.3.2)
     diff-lcs (1.3)
     equatable (0.6.1)
     fakefs (0.20.1)
     git (1.5.0)
-    httparty (0.17.1)
+    httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     i18n (1.7.0)
@@ -46,41 +46,41 @@ GEM
     method_source (0.9.2)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
-    minitest (5.12.2)
+    mime-types-data (3.2019.1009)
+    minitest (5.13.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    necromancer (0.5.0)
+    necromancer (0.5.1)
     oauth (0.5.4)
     ostruct (0.1.0)
     pastel (0.7.3)
       equatable (~> 0.6)
       tty-color (~> 0.5)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rake (10.5.0)
     recursive-open-struct (1.1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    strings (0.1.6)
+    strings (0.1.8)
       strings-ansi (~> 0.1)
       unicode-display_width (~> 1.5)
       unicode_utils (~> 1.4)
-    strings-ansi (0.1.0)
+    strings-ansi (0.2.0)
     thor (0.20.3)
     thread_safe (0.3.6)
     tty-color (0.5.0)
@@ -92,11 +92,11 @@ GEM
       strings (~> 0.1.4)
       tty-screen (~> 0.6)
       tty-which (~> 0.4)
-    tty-prompt (0.19.0)
+    tty-prompt (0.20.0)
       necromancer (~> 0.5.0)
       pastel (~> 0.7.0)
-      tty-reader (~> 0.6.0)
-    tty-reader (0.6.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
       tty-cursor (~> 0.7)
       tty-screen (~> 0.7)
       wisper (~> 2.0.0)
@@ -106,8 +106,8 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     unicode_utils (1.4.0)
-    wisper (2.0.0)
-    zeitwerk (2.1.10)
+    wisper (2.0.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -124,4 +124,4 @@ DEPENDENCIES
   story_branch!
 
 BUNDLED WITH
-   1.17.3
+   2.1.2

data/exe/git-finish

@@ -1,3 +1,3 @@
-# !/usr/bin/env ruby
+#!/usr/bin/env ruby
 
 `story_branch finish`

data/lib/story_branch/commands/add.rb

@@ -46,10 +46,10 @@ module StoryBranch
 
         return unless tracker == 'jira'
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         username = prompt.ask('Please provide username (email most of the times) for this key:',
                               required: true)
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         @config.set(project_id, :username, value: username)
         @config.write(force: true)
       end
@@ -58,15 +58,15 @@ module StoryBranch
         return @project_id if @project_id
 
         if tracker == 'jira'
-          # rubocop:disable Metrics/LineLength
+          # rubocop:disable Layout/LineLength
           project_domain = prompt.ask("What is your JIRA's subdomain?", required: true)
           project_key = prompt.ask("What is your JIRA's project key?", required: true)
-          # rubocop:enable Metrics/LineLength
+          # rubocop:enable Layout/LineLength
           @project_id = "#{project_domain}|#{project_key}"
         else
-          # rubocop:disable Metrics/LineLength
+          # rubocop:disable Layout/LineLength
           @project_id = prompt.ask("Please provide this project's id:", required: true)
-          # rubocop:enable Metrics/LineLength
+          # rubocop:enable Layout/LineLength
         end
       end
 

data/lib/story_branch/git_utils.rb

@@ -7,7 +7,7 @@ module StoryBranch
   # Class used to interact with git. It relies on git gem as the wrapper
   # and levenshtein algo to determine branch name proximity
   class GitUtils
-    def self.existing_branch?(name)
+    def self.similar_branch?(name)
       GitWrapper.branch_names.each do |n|
         return true if DamerauLevenshtein.distance(n, name) < 3
 
@@ -35,7 +35,7 @@ module StoryBranch
 
     def self.current_branch_story_parts
       matches = current_story
-      return {} unless matches.length == 3
+      return {} unless matches&.length == 3
 
       title = matches[1].tr('-', ' ').strip
       { title: title, id: matches[2].to_i }

data/lib/story_branch/github/project.rb

@@ -12,7 +12,7 @@ module StoryBranch
 
       def stories(options = {})
         stories = if options[:id]
-                    [@repo.issues(options[:id]).get]
+                    [@repo.issues(options[:id]).get.payload]
                   else
                     @repo.issues.get(params: options)
                   end

data/lib/story_branch/jira/project.rb

@@ -17,11 +17,11 @@ module StoryBranch
         stories = if options[:id]
                     [@project.issues.find(options[:id])]
                   else
-                    # rubocop:disable Metrics/LineLength
+                    # rubocop:disable Layout/LineLength
                     @project.client.Issue.jql(
                       "project=#{@project.key} AND status='To Do' AND assignee=currentUser()"
                     )
-                    # rubocop:enable Metrics/LineLength
+                    # rubocop:enable Layout/LineLength
                   end
 
         stories.map { |s| Issue.new(s, @project) }

data/lib/story_branch/main.rb

@@ -25,7 +25,7 @@ module StoryBranch
       @local_config = ConfigManager.init_config('.')
       @global_config = ConfigManager.init_config(Dir.home)
       initialize_tracker
-      exit unless @tracker.valid?
+      abort('Invalid tracker configuration setting.') unless @tracker.valid?
     end
 
     def create_story_branch
@@ -42,7 +42,7 @@ module StoryBranch
     end
 
     def story_finish
-      current_story
+      return unless current_story
       return if unstaged_changes?
       return if nothing_to_add?
 
@@ -93,6 +93,7 @@ module StoryBranch
       end
 
       prompt.error('No tracked feature associated with this branch')
+      nil
     end
 
     def unstaged_changes?
@@ -168,6 +169,17 @@ module StoryBranch
       @finish_tag
     end
 
+    def issue_placement
+      return @issue_placement if @issue_placement
+
+      fallback = @global_config.fetch(project_id,
+                                      :issue_placement,
+                                      default: 'End')
+      @issue_placement = @local_config.fetch(:issue_placement,
+                                             default: fallback)
+      @issue_placement
+    end
+
     def build_finish_message
       message_tag = [finish_tag, "##{current_story.id}"].join(' ').strip
       "[#{message_tag}] #{current_story.title}"
@@ -176,33 +188,56 @@ module StoryBranch
     def create_feature_branch(story)
       return if story.nil?
 
-      current_branch = GitWrapper.current_branch
+      if GitUtils.branch_for_story_exists? story.id
+        prompt.error("An existing branch has the same story id: #{story.id}")
+        return
+      end
+
+      branch_name = valid_branch_name(story)
+      return unless branch_name
+
+      # rubocop:disable Layout/LineLength
+      feature_branch_name_with_story_id = build_branch_name(branch_name, story.id)
+      prompt.say("Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent")
+      # rubocop:enable Layout/LineLength
+      GitWrapper.create_branch feature_branch_name_with_story_id
+    end
+
+    def valid_branch_name(story)
       prompt.say "You are checked out at: #{current_branch}"
       branch_name = prompt.ask('Provide a new branch name',
                                default: story.dashed_title)
-      feature_branch_name = branch_name.chomp
-      return unless validate_branch_name(feature_branch_name, story.id)
+      feature_branch_name = StringUtils.truncate(branch_name.chomp)
 
-      feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
-      # rubocop:disable Metrics/LineLength
-      prompt.say("Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent")
-      # rubocop:enable Metrics/LineLength
-      GitWrapper.create_branch feature_branch_name_with_story_id
+      validate_branch_name(feature_branch_name)
     end
 
     # Branch name validation
-    def validate_branch_name(name, id)
-      if GitUtils.branch_for_story_exists? id
-        prompt.error("An existing branch has the same story id: #{id}")
-        return false
+    # rubocop:disable Metrics/MethodLength
+    def validate_branch_name(name)
+      if GitUtils.similar_branch? name
+        prompt.warn('This name is very similar to an existing branch.'\
+                    ' It is recommended to use a more unique name.')
+        decision = prompt.select('What to do?') do |menu|
+          menu.choice 'Rename the branch', 1
+          menu.choice 'Proceed with branch name', 2
+          menu.choice 'Abort branch creation', 3
+        end
+        return nil if decision == 3
+        return name if decision == 2
+
+        return prompt.ask('Provide a new branch name', default: name)
       end
-      if GitUtils.existing_branch? name
-        # rubocop:disable Metrics/LineLength
-        prompt.error('This name is very similar to an existing branch. Avoid confusion and use a more unique name.')
-        # rubocop:enable Metrics/LineLength
-        return false
+      name
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def build_branch_name(branch_name, story_id)
+      if issue_placement.casecmp('beginning').zero?
+        "#{story_id}-#{branch_name}"
+      else
+        "#{branch_name}-#{story_id}"
       end
-      true
     end
 
     def project_id
@@ -227,6 +262,10 @@ module StoryBranch
       @username ||= @global_config.fetch(project_id, :username)
     end
 
+    def current_branch
+      @current_branch ||= GitWrapper.current_branch
+    end
+
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
     def initialize_tracker

data/lib/story_branch/pivotal/project.rb

@@ -14,7 +14,7 @@ module StoryBranch
       # TODO: add other possible args
       def stories(options = {}, estimated = true)
         stories = if options[:id]
-                    [@project.stories(options[:id]).get]
+                    [@project.stories(options[:id]).get.payload]
                   else
                     @project.stories.get(params: options)
                   end

data/lib/story_branch/string_utils.rb

@@ -25,5 +25,11 @@ module StoryBranch
     def self.undashed(text)
       text.tr('-', ' ').squeeze(' ').strip.capitalize
     end
+
+    def self.truncate(text, max_length = 40)
+      return text if text.length <= max_length
+
+      text[0..max_length - 1]
+    end
   end
 end

data/lib/story_branch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoryBranch
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/story_branch.gemspec

@@ -31,11 +31,12 @@ Gem::Specification.new do |spec|
     JIRA. Different workflows shall be supported in the next versions.
   DESCRIPTION
 
+  spec.homepage    = 'https://github.com/story-branch/story_branch'
+
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/story-branch/story_branch/issues',
     'changelog_uri' => 'https://github.com/story-branch/story_branch/blob/master/Changelog.md',
     'documentation_uri' => 'https://github.com/story-branch/story_branch/blob/master/README.md',
-    'homepage_uri' => 'https://github.com/story-branch/story_branch',
     'source_code_uri' => 'https://github.com/story-branch/story_branch'
   }
   spec.required_ruby_version = ['>= 2.4', '< 2.7']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Rui Baltazar
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -315,14 +315,13 @@ files:
 - lib/story_branch/templates/unstart/.gitkeep
 - lib/story_branch/version.rb
 - story_branch.gemspec
-homepage: 
+homepage: https://github.com/story-branch/story_branch
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/story-branch/story_branch/issues
   changelog_uri: https://github.com/story-branch/story_branch/blob/master/Changelog.md
   documentation_uri: https://github.com/story-branch/story_branch/blob/master/README.md
-  homepage_uri: https://github.com/story-branch/story_branch
   source_code_uri: https://github.com/story-branch/story_branch
 post_install_message: 
 rdoc_options: []
@@ -342,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Create git branches based on your preferred tracker tickets