story_branch 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d477c2727de7887ac34b2d2e4a5bb1082db251
-  data.tar.gz: 4e0e0c00d4eb031bd680c39476e880e71fc98adb
+  metadata.gz: 3d7d4d41d52f404121543545261d35ee4549bf4c
+  data.tar.gz: 501c4cbf920c86d5d3e161e232670b2e3f813570
 SHA512:
-  metadata.gz: b39a085f360679091be09fdacf51d5905ec1f85293ea1f4987c9b3fd4dd2f87a663308182bcd23c9b465fff2c408d7514fc349469b55bebcf9d469518b366123
-  data.tar.gz: c8adc6a6c9c6630ff2868573654898cf0b1e4541bdc108701a4a467bf3df004c9e22eeeeb11ce3b5aa6d7f6dffb863a7d16623da071360e939bc13827b76061e
+  metadata.gz: d41edd251bb11ec5adb61e0e852574f6d3bd27a7d475a00c91d025e8a6bed44f1c2d7356c169b0eb0c4eab864de1f270d3c410a357564f378b948b186e9526d7
+  data.tar.gz: 3d3016b1ae2ea18df7b6c7c5cf1730d7bb011567fd55eec5866698e4dfff8456d45a508fd3095a6d46ea864c194dbcaa21da359d06279332b1298a0f02b455d0

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    story_branch (0.4.0)
+    story_branch (0.4.1)
       blanket_wrapper (~> 3.0)
-      git (~> 1.2)
       levenshtein-ffi (~> 1.0)
       pastel (~> 0.7.2)
       thor (~> 0.20.0)
@@ -23,10 +22,14 @@ GEM
     fakefs (0.18.0)
     ffi (1.9.25)
     git (1.5.0)
-    httparty (0.16.2)
+    httparty (0.16.3)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     levenshtein-ffi (1.1.0)
       ffi (~> 1.9)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     multi_xml (0.6.0)
     necromancer (0.4.0)
     pastel (0.7.2)
@@ -54,7 +57,7 @@ GEM
       unicode-display_width (~> 1.4.0)
       unicode_utils (~> 1.4.0)
     strings-ansi (0.1.0)
-    thor (0.20.0)
+    thor (0.20.3)
     timers (4.2.0)
     tty-color (0.4.3)
     tty-command (0.8.2)
@@ -87,6 +90,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   fakefs (~> 0.14)
+  git (~> 1.5)
   rake (~> 10.0)
   rspec (~> 3)
   rspec_junit_formatter (~> 0.4)

data/lib/story_branch/git_utils.rb

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
 
-require 'git'
 require 'levenshtein'
+require_relative './git_wrapper'
 
 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.g
-      ::Git.open '.'
-    end
-
     def self.existing_branch?(name)
-      branch_names.each do |n|
+      GitWrapper.branch_names.each do |n|
         return true if Levenshtein.distance(n, name) < 3
-        branch_name_match = n.match(/(.*)(-[1-9][0-9]+$)/)
+
+        branch_name_match = n.match(/(.*)(-[1-9]+[0-9]*$)/)
         next unless branch_name_match
+
         levenshtein_distance = Levenshtein.distance branch_name_match[1], name
         return true if levenshtein_distance < 3
       end
@@ -23,64 +21,31 @@ module StoryBranch
     end
 
     def self.branch_for_story_exists?(id)
-      branch_names.each do |n|
-        branch_id = n.match(/-[1-9][0-9]+$/)
+      GitWrapper.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
-      /(.*)-(\d+$)/.match current_branch
+      /(.*)-(\d+$)/.match GitWrapper.current_branch
     end
 
     def self.current_branch_story_parts
       matches = current_story
       return {} unless matches.length == 3
-      { title: matches[1], id: matches[2].to_i }
-    end
-
-    def self.create_branch(name)
-      g.branch(name).create
-      g.branch(name).checkout
-    end
-
-    def self.status_collect(status, regex)
-      chosen_stati = status.select { |e| e.match(regex) }
-      chosen_stati.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)
-      }
+      title = matches[1].tr('-', ' ')
+      { title: title, id: matches[2].to_i }
     end
 
     def self.status?(state)
+      status = GitWrapper.status
       return false unless status
-      !status[state].empty?
-    end
 
-    def self.commit(message)
-      g.commit(message)
+      !status[state].empty?
     end
   end
 end

data/lib/story_branch/git_wrapper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# NOTE: Consider extracting this to a separate gem
+module StoryBranch
+  # GitWrapper to help running git commands with direct system calls
+  # Essentially it provides a couple of commands to interact with git
+  # - StoryBranch::GitWrapper.command('<cmd>', [<opts>])
+  #   Returns the output as is
+  #
+  # - StoryBranch::GitWrapper.command_lines('<cmd>', [<opts>])
+  #   Returns the output split into an array of lines, stripped and chomped
+  #
+  # - StoryBranch::GitWrapper.branch_names
+  #   Returns the list of available branch names, locally and configured remotes
+  class GitWrapper
+    STATI_MATCHERS = {
+      modified_rx: /^ M (.*)/,
+      untracked_rx: /^\?\? (.*)/,
+      staged_rx: /^M  (.*)/,
+      added_rx: /^A  (.*)/
+    }.freeze
+
+    def self.command(cmd, opts = [])
+      gw = new
+      gw.call(cmd, opts)
+    end
+
+    def self.command_lines(cmd, opts = [])
+      result = command(cmd, opts)
+      lines = result.split("\n")
+      lines.each(&:strip!)
+    end
+
+    def self.branch_names
+      # NOTE: Regex matcher for cases as:
+      # remotes/origin/allow.... <- remote branch (remove 'remotes/origin')
+      # * allow.... <- * indicates current branch (remove '* ')
+      # allow <- local branch (do nothing)
+      regex = %r{(^remotes\/.*\/|\s|[*])}
+      all_branches.map do |line|
+        line = line.sub(regex, '')
+        line
+      end
+    end
+
+    def self.current_branch
+      current_branch_line = all_branches.detect do |line|
+        line.match(/\*/)
+      end
+      current_branch_line.tr('*', ' ')
+    end
+
+    def self.all_branches
+      command_lines('branch', '-a')
+    end
+
+    def self.create_branch(name)
+      command('checkout', ['-b', name])
+    end
+
+    def self.status
+      g_status = command_lines('status', '-s')
+      return nil if g_status.empty?
+
+      {
+        modified: status_collect(g_status, STATI_MATCHERS[:modified_rx]),
+        untracked: status_collect(g_status, STATI_MATCHERS[:untracked_rx]),
+        added: status_collect(g_status, STATI_MATCHERS[:added_rx]),
+        staged: status_collect(g_status, STATI_MATCHERS[:staged_rx])
+      }
+    end
+
+    def self.status_collect(status, regex)
+      chosen_stati = status.select { |e| e.match(regex) }
+      chosen_stati.map { |e| e.match(regex)[1] }
+    end
+
+    def self.commit(message)
+      command('commit', ['-m', message])
+    end
+
+    def initialize
+      @system_git = 'git'
+    end
+
+    def call(cmd, opts = [])
+      opts = prepare_opts(opts)
+      git_cmd = "#{@system_git} #{cmd} #{opts}"
+      `#{git_cmd}`.chomp.strip
+    end
+
+    private
+
+    # NOTE: Taken from ruby git gem
+    def escape(str = '')
+      str = str.to_s
+      return "'#{str.gsub('\'', '\'"\'"\'')}'" if RUBY_PLATFORM !~ /mingw|mswin/
+
+      # Keeping the old escape format for windows users
+      escaped = str.gsub('\'', '\'\\\'\'')
+      %("#{escaped}")
+    end
+
+    def prepare_opts(opts = [])
+      [opts].flatten.map { |s| escape(s) }.join(' ')
+    end
+  end
+end

data/lib/story_branch/main.rb

@@ -2,6 +2,7 @@
 
 require_relative './pivotal_utils'
 require_relative './git_utils'
+require_relative './git_wrapper'
 require_relative './config_manager'
 require 'tty-prompt'
 
@@ -65,7 +66,7 @@ module StoryBranch
       commit_message = "[#{finish_tag} ##{current_story[:id]}] #{current_story[:title]}"
       proceed = prompt.yes?("Commit with standard message? #{commit_message}")
       if proceed
-        GitUtils.commit commit_message
+        GitWrapper.commit commit_message
       else
         prompt.say 'Aborted'
       end
@@ -130,7 +131,7 @@ module StoryBranch
     def create_feature_branch(story)
       return if story.nil?
 
-      current_branch = GitUtils.current_branch
+      current_branch = GitWrapper.current_branch
       prompt.say "You are checked out at: #{current_branch}"
       branch_name = prompt.ask('Provide a new branch name',
                                default: story.dashed_title)
@@ -139,7 +140,7 @@ module StoryBranch
 
       feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
       prompt.say("Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent")
-      GitUtils.create_branch feature_branch_name_with_story_id
+      GitWrapper.create_branch feature_branch_name_with_story_id
     end
 
     # Branch name validation

data/lib/story_branch/pivotal_utils.rb

@@ -6,6 +6,7 @@ require_relative './string_utils'
 module StoryBranch
   # PivotalTracker Story representation
   class Story
+    NON_ESTIMATED_TYPES = %w[chore bug release].freeze
     attr_accessor :title, :id
 
     def initialize(blanket_story, project)
@@ -13,6 +14,8 @@ module StoryBranch
       @story = blanket_story
       @title = blanket_story.name
       @id = blanket_story.id
+      @story_type = blanket_story.story_type
+      @estimate = blanket_story.estimate
     end
 
     def update_state(new_state)
@@ -27,6 +30,11 @@ module StoryBranch
     def dashed_title
       StoryBranch::StringUtils.normalised_branch_name @title
     end
+
+    def estimated
+      (@story_type == 'feature' && !@estimate.nil?) ||
+        NON_ESTIMATED_TYPES.include?(@story_type)
+    end
   end
 
   # PivotalTracker Project representation
@@ -37,17 +45,19 @@ module StoryBranch
 
     # NOTE: takes in possible keys:
     # - with_state
-    # - estimated
     # Returns an array of PT Stories (Story Class)
     # TODO: add other possible args
-    def stories(options = {})
+    def stories(options = {}, estimated = true)
       stories = if options[:id]
                   [@project.stories(options[:id])]
                 else
                   params = { with_state: options[:with_state] }
                   @project.stories.get(params: params).payload
                 end
-      stories.map { |s| Story.new(s, @project) }
+      stories = stories.map { |s| Story.new(s, @project) }
+      return stories if estimated == false
+
+      stories.select(&:estimated)
     end
   end
 

data/lib/story_branch/version.rb

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

data/story_branch.gemspec

@@ -47,7 +47,6 @@ Gem::Specification.new do |spec|
   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 'thor', '~> 0.20.0'
@@ -58,6 +57,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'fakefs', '~> 0.14'
+  spec.add_development_dependency 'git', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Rui Baltazar
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -28,20 +28,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !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
@@ -168,6 +154,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -260,6 +260,7 @@ files:
 - lib/story_branch/commands/unstart.rb
 - lib/story_branch/config_manager.rb
 - lib/story_branch/git_utils.rb
+- lib/story_branch/git_wrapper.rb
 - lib/story_branch/main.rb
 - lib/story_branch/pivotal_utils.rb
 - lib/story_branch/string_utils.rb