story_branch 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601d26c296267a0ad82258cb4978d82a538e88b6
-  data.tar.gz: 3b667d1a51fb3a1a8ad509fb98a956c241e8edc2
+  metadata.gz: 658c404de733ae5763ff79161139eb48e746ed74
+  data.tar.gz: 2403a2c29aed765c73e6527358b9a484c7c60b7c
 SHA512:
-  metadata.gz: c1cdef1c858ccbfca16e4a79f98712eabfae71aa08aa6b8faed758eded648eae82df1c8d4ff7ec1af79b4f2ce8d9661f00cd0347048d14d18ac67adba7b5a130
-  data.tar.gz: 4a75f85aeea2b9a293378c5e05f0c258079c8d748f8bd553719372fe02aaf6d02e9e2d2a422024338641fd34287e8742a86383a516906fd933da1a70c0003b0c
+  metadata.gz: 35190816ff350d0b1cd2225caf3939a4eef48e08bb697c1db631e7320043a042d53dbeb0512340ae36b22c6aedb2a887f8e68b31b5b7ca74b2f014b0bfc35e89
+  data.tar.gz: cc011af10bb4a8bcedc68130a99e4173f7c6f4beda8415a5e15882cd179d422b0f4dc269fac390b275f125779320d4a6cd9972603e8aef952ba12e859de1d675

data/.circleci/config.yml

@@ -2,34 +2,50 @@ version: 2
 jobs:
   build:
     docker:
+      # specify the version you desire here
        - image: circleci/ruby:2.4.1-node-browsers
-    working_directory: ~/story_branch
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
     steps:
       - checkout
+
+      # Download and cache dependencies
       - restore_cache:
           keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
+
       - run:
           name: install dependencies
           command: |
+            gem install bundler
             bundle install --jobs=4 --retry=3 --path vendor/bundle
+
       - save_cache:
           paths:
             - ./vendor/bundle
           key: v1-dependencies-{{ checksum "Gemfile.lock" }}
 
+      # run tests!
       - run:
           name: run tests
           command: |
             mkdir -p /tmp/test-results
-
             TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
 
-            bundle exec rspec --format documentation \
-                              --format RspecJunitFormatter \
-                              --out /tmp/test-results/rspec.xml \
-                              -- $(sed -e 's/\n/\\n/' -e 's/ /\ /' <<< "${TEST_FILES}")
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            $TEST_FILES
 
+      # collect reports
       - store_test_results:
           path: /tmp/test-results
       - store_artifacts:

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in story_branch.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    story_branch (0.3.0)
+    story_branch (0.3.1)
       blanket_wrapper (~> 3.0)
       git (~> 1.2)
       levenshtein-ffi (~> 1.0)
@@ -22,9 +22,9 @@ GEM
     diff-lcs (1.3)
     equatable (0.5.0)
     fakefs (0.14.2)
-    ffi (1.9.23)
+    ffi (1.9.25)
     git (1.4.0)
-    hitimes (1.2.6)
+    hitimes (1.3.0)
     httparty (0.16.2)
       multi_xml (>= 0.5.2)
     levenshtein-ffi (1.1.0)
@@ -49,6 +49,8 @@ GEM
     rspec-mocks (3.0.4)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.4)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     strings (0.1.1)
       unicode-display_width (~> 1.3.0)
       unicode_utils (~> 1.4.0)
@@ -76,7 +78,7 @@ GEM
       wisper (~> 2.0.0)
     tty-screen (0.6.4)
     tty-which (0.3.0)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.3.3)
     unicode_utils (1.4.0)
     wisper (2.0.0)
 
@@ -88,6 +90,7 @@ DEPENDENCIES
   fakefs (~> 0.14)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter
   story_branch!
 
 BUNDLED WITH

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/exe/git-finish

@@ -1,3 +1,4 @@
+# rubocop:disable Style/FrozenStringLiteralComment
 #!/usr/bin/env ruby
 
 `story_branch finish`

data/exe/git-start

@@ -1,3 +1,4 @@
+# rubocop:disable Style/FrozenStringLiteralComment
 #!/usr/bin/env ruby
 
 `story_branch start`

data/exe/git-story

@@ -1,3 +1,4 @@
+# rubocop:disable Style/FrozenStringLiteralComment
 #!/usr/bin/env ruby
 
 `story_branch create`

data/exe/git-unstart

@@ -1,3 +1,4 @@
+# rubocop:disable Style/FrozenStringLiteralComment
 #!/usr/bin/env ruby
 
 `story_branch unstart`

data/exe/story_branch

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 lib_path = File.expand_path('../lib', __dir__)
-$:.unshift(lib_path) if !$:.include?(lib_path)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 require 'story_branch/cli'
 
 Signal.trap('INT') do

data/lib/story_branch.rb

@@ -1,5 +1,8 @@
+# rubocop:disable Style/FrozenStringLiteralComment
 require 'story_branch/version'
+# rubocop:enable Style/FrozenStringLiteralComment
 
+# Module initial definition
 module StoryBranch
   # Your code goes here...
 end

data/lib/story_branch/cli.rb

@@ -42,7 +42,8 @@ module StoryBranch
       end
     end
 
-    desc 'finish', 'Creates a git commit message for the staged changes with a [Finishes] tag'
+    desc 'finish',
+         'Creates a commit message for the staged changes with the finish tag'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
     def finish(*)

data/lib/story_branch/command.rb

@@ -3,6 +3,8 @@
 require 'forwardable'
 
 module StoryBranch
+  # TTY Command base class. All commands available for the gem will be based
+  # of this class.
   class Command
     extend Forwardable
 

data/lib/story_branch/commands/migrate.rb

@@ -10,8 +10,8 @@ module StoryBranch
     # Migrate command is intended to make the migration from old version
     # of story branch to the latest one easier.
     class Migrate < StoryBranch::Command
-      GLOBAL_CONFIG_FILE = "#{Dir.home}/.story_branch".freeze
-      LOCAL_CONFIG_FILE = '.story_branch'.freeze
+      GLOBAL_CONFIG_FILE = "#{Dir.home}/.story_branch"
+      LOCAL_CONFIG_FILE = '.story_branch'
       OLD_CONFIG_FILES = [LOCAL_CONFIG_FILE, GLOBAL_CONFIG_FILE].freeze
 
       def initialize(options)
@@ -83,14 +83,14 @@ module StoryBranch
       end
 
       def old_config_file_not_found
-        <<-MESSAGE
-Old configuration not found.
-Trying to start from scratch? Use story_branch add
+        <<~MESSAGE
+          Old configuration not found.
+          Trying to start from scratch? Use story_branch add
         MESSAGE
       end
 
       def cant_migrate_missing_value
-        <<-MESSAGE
+        <<~MESSAGE
           Old configuration not found. Nothing has been migrated
           Trying to start from scratch? Use story_branch add
         MESSAGE

data/lib/story_branch/config_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tty-config'
 
 module StoryBranch

data/lib/story_branch/git_utils.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'git'
 require 'levenshtein'
 
 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 '.'
@@ -10,9 +14,9 @@ module StoryBranch
     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
+        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
       false
@@ -36,13 +40,13 @@ module StoryBranch
     end
 
     def self.current_story
-      current_branch.match(/(.*)-(\d+$)/)
+      /(.*)-(\d+$)/.match current_branch
     end
 
     def self.current_branch_story_parts
       matches = current_story
       return unless matches.length == 3
-      { title: matches[1], id: matches[2] }
+      { title: matches[1], id: matches[2].to_i }
     end
 
     def self.create_branch(name)
@@ -51,11 +55,8 @@ module StoryBranch
     end
 
     def self.status_collect(status, regex)
-      status.select{|e|
-        e.match(regex)
-      }.map{ |e|
-        e.match(regex)[1]
-      }
+      chosen_stati = status.select { |e| e.match(regex) }
+      chosen_stati.map { |e| e.match(regex)[1] }
     end
 
     def self.status

data/lib/story_branch/main.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require_relative './string_utils'
 require_relative './pivotal_utils'
 require_relative './config_manager'
+require 'tty-prompt'
 
 module StoryBranch
+  # Main story branch class. It is resposnible for the main interaction between
+  # the user and Pivotal Tracker. It is also responsible for config init.
   class Main
     ERRORS = {
       'Stories in the started state must be estimated.' =>
@@ -22,12 +27,12 @@ module StoryBranch
     # TODO:
     # Move these methods to the command logic.
     def create_story_branch
-      puts 'Connecting with Pivotal Tracker'
+      prompt.say 'Connecting with Pivotal Tracker'
       @p.project
-      puts 'Getting stories...'
+      prompt.say 'Getting stories...'
       stories = @p.display_stories :started, false
       if stories.empty?
-        puts 'No stories started, exiting'
+        prompt.say 'No stories started, exiting'
         exit
       end
       story = @p.select_story stories
@@ -39,7 +44,7 @@ module StoryBranch
     end
 
     def story_finish
-      puts 'Connecting with Pivotal Tracker'
+      prompt.say 'Connecting with Pivotal Tracker'
       @p.project
 
       unless @p.is_current_branch_a_story?
@@ -48,26 +53,28 @@ module StoryBranch
       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'
+        prompt.say 'There are unstaged changes'
+        prompt.say 'Use git add to stage changes before running git finish'
+        prompt.say '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'
+        prompt.say 'There are no staged changes.'
+        prompt.say '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
+      current_story = GitUtils.current_branch_story_parts
+      commit_message = "[#{@p.finish_tag} ##{current_story[:id]}] "\
+        "#{StoryBranch::StringUtils.undashed(current_story[:title])}"
 
-      if gets.chomp!.casecmp('y').zero?
-        GitUtils.commit commit_message
+      prompt.say(commit_message)
+      abort_commit = prompt.no?('Use standard finishing commit message?')
+      if abort_commit
+        prompt.say 'Aborted'
       else
-        puts 'Aborted'
+        GitUtils.commit commit_message
       end
     rescue Blanket::Unauthorized
       unauthorised_message
@@ -84,6 +91,11 @@ module StoryBranch
 
     private
 
+    def prompt
+      return @prompt if @prompt
+      @prompt = TTY::Prompt.new
+    end
+
     def config
       return @config if @config
       @config = ConfigManager.init_config(Dir.home)

data/lib/story_branch/pivotal_utils.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 require 'blanket'
 require 'rb-readline'
 require_relative './git_utils'
 
 module StoryBranch
+  # Utility class for integration with PivotalTracker. It relies on Blanket
+  # wrapper to communicate with pivotal tracker's api.
   class PivotalUtils
-    API_URL = 'https://www.pivotaltracker.com/services/v5/'.freeze
+    API_URL = 'https://www.pivotaltracker.com/services/v5/'
     attr_accessor :api_key, :project_id, :finish_tag
 
     def valid?
@@ -28,15 +32,14 @@ module StoryBranch
     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
+      current_story = StoryBranch::GitUtils.current_branch_story_parts
+      return unless current_story
+      filtered_stories_list(:started, true).map(&:id).include? current_story[:id]
     end
 
     def story_from_current_branch
-      story_accessor.get(StoryBranch::GitUtils.current_story[2].to_i) if StoryBranch::GitUtils.current_story.length == 3
+      return unless StoryBranch::GitUtils.current_story.length == 3
+      story_accessor.get(StoryBranch::GitUtils.current_story[2].to_i)
     end
 
     # TODO: Maybe add some other predicates

data/lib/story_branch/string_utils.rb

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 module StoryBranch
+  # Utility class for string manipulation
   class StringUtils
-    def self.dashed(s)
-      s.tr(' _,./:;+&', '-')
+    def self.sanitize(s)
+      res = s.strip
+      res.tr!("\n", '-')
+      encoding_options = {
+        invalid: :replace, # Replace invalid byte sequences
+        undef: :replace, # Replace anything not defined in ASCII
+        replace: '-' # Use a dash for those replacements
+      }
+      res.encode(Encoding.find('ASCII'), encoding_options)
     end
 
-    def self.simple_sanitize(s)
-      strip_newlines(s.tr('\'"%!@#$(){}[]*\\?', ''))
+    def self.dashed(s)
+      sanitize(s).tr(" _,./:;+&'\"?", '-').squeeze('-')
     end
 
     def self.normalised_branch_name(s)
-      simple_sanitize((dashed s).downcase).squeeze('-')
-    end
-
-    def self.strip_newlines(s)
-      s.tr "\n", '-'
+      dashed(s).downcase
     end
 
     def self.undashed(s)
-      s.tr(/-/, ' ').capitalize
+      s.tr('-', ' ').squeeze(' ').strip.capitalize
     end
   end
 end

data/lib/story_branch/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StoryBranch
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'
 end

data/story_branch.gemspec

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'story_branch/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name = 'story_branch'
   spec.license = 'MIT'
@@ -22,15 +25,22 @@ Gem::Specification.new do |spec|
   ]
 
   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.description = <<~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
+  DESCRIPTION
+
   spec.homepage = 'https://github.com/story-branch/story_branch'
+  spec.required_ruby_version = '>= 2.3'
 
   # 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.
+  # 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)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -51,4 +61,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fakefs', '~> 0.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jason Milkins
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -210,10 +210,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-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
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
 email:
 - jasonm23@gmail.com
 - rui.p.baltazar@gmail.com
@@ -233,6 +247,7 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -280,7 +295,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="