story_branch 0.7.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38598ac513a6f1681731cfd2fa3c01a59adb5ceefd21b13c1f522f278d0dbfeb
-  data.tar.gz: 19aa50f492337817aeaab621f12db12cb7b035cfc1323cff704063cb689520f6
+  metadata.gz: 53a5f42efde29c37e024d47aa0d0542d3645499eaf8ae518a7b1fbc03eb2d50f
+  data.tar.gz: 7ffdcf865cbd091cff86dc516ac4bc3daa8fc29f55cbbea3f4b9f707b41d9990
 SHA512:
-  metadata.gz: 2a7f8523bc5dd537eaf6195d51449843d4cb6c9860da05cb1a5caf582cf7244ff7dc481881d517221b6e3772fb9492a59a821351fdee786ed902b938e5773282
-  data.tar.gz: 716a2494b92218c4ba0ce1b2b73aa8fe1b8ea635a549312e31b2721405710d706cbe4ad905c30a3b4a8f6700732aa677bcfc10d1490b3ad9fecf17f536681521
+  metadata.gz: 911475a7844a3efe57ffa0fe0f2aab02abf42b8c90ad4083ecefd1b0d03dc987d5987bde4a512902cf76048ee3132521f98f4d36db1b2be1453a363de6831578
+  data.tar.gz: 270037755290c76896cd4c288d1741bb70a34c0dbd60e702e21b9fa59b95a1284efb4dbbf7a260ef780afdfd620c40fcdec8546771a7236c6ba05246d18a8f26

data/.circleci/config.yml

@@ -1,15 +1,14 @@
-version: 2
-
-defaults: &defaults
-  docker:
-    - image: circleci/ruby:2.6.5-node
-  working_directory: ~/repo
+version: 2.1
 
 workflows:
   version: 2
   test-and-publish:
     jobs:
       - test:
+          matrix:
+            parameters:
+              ruby_version: ["ruby:2.6-buster", "ruby:2.7-buster", "ruby:3.0-buster"]
+
           filters:
             tags:
               # this enables circleci to trigger on tags
@@ -26,14 +25,22 @@ workflows:
 
 jobs:
   test:
-    <<: *defaults
+    parameters:
+      ruby_version:
+        type: string
+    docker:
+      - image: circleci/<< parameters.ruby_version >>
+    working_directory: ~/repo
+
     steps:
       - checkout
 
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          - v1-dependencies-
+      - run:
+          name: Install Code Climate Test Reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+      - run: ./cc-test-reporter before-build
 
       - run:
           name: install dependencies
@@ -41,11 +48,6 @@ jobs:
             gem install bundler
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
       - run:
           name: run tests
           command: |
@@ -61,29 +63,31 @@ jobs:
           path: /tmp/test-results
       - store_artifacts:
           path: /tmp/test-results
-          destination: test-results
+
+      - run:
+          name: Code Climate Test Coverage convert to json
+          command: |
+            ./cc-test-reporter format-coverage -t simplecov
+
+      - run:
+          name: Code Climate Test Coverage upload results
+          command: |
+            ./cc-test-reporter after-build -t simplecov --exit-code $?
 
   publish:
-    <<: *defaults
+    docker:
+      - image: circleci/ruby:3.0-buster
+    working_directory: ~/repo
+
     steps:
       - checkout
 
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          - 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:
           name: Setup Rubygems
           command: bash .circleci/setup-rubygems.sh

data/.github/weekly-digest.yml

@@ -0,0 +1,7 @@
+# Configuration for weekly-digest - https://github.com/apps/weekly-digest
+publishDay: sun
+canPublishIssues: true
+canPublishPullRequests: true
+canPublishContributors: true
+canPublishStargazers: true
+canPublishCommits: true

data/.gitignore

@@ -2,3 +2,6 @@
 story_branch-*.gem
 /.pairs
 .byebug_history
+coverage
+tools/release*.*
+Gemfile.lock

data/.rubocop.yml

@@ -7,3 +7,45 @@ AllCops:
     - 'exe/*'
     - '**/Gemfile'
     - '.github/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.7.1

data/README.md

@@ -4,11 +4,17 @@
 
 # Story Branch
 
-Story branch is a CLI application that interacts with Pivotal Tracker or Github at the
+Story branch is a CLI application that interacts with Pivotal Tracker, Github and Jira
 at the moment.
-It allows you to start and un-start stories in Pivotal Tracker, as well as creating
-branches based on the story name and id and have a final commit message marking
-the story as Finished.
+
+For all the trackers it supports creating local branches from the tickets or
+opening the ticket in your browser from the branch you're working on. In the future
+I plan to support different workflows in order to integrate your individual
+process in the tool.
+
+As for PivotalTracker, since the flow is mostly the same for everyone, it allows
+you to start and un-start stories as well.
+
 
 [View Changelog](Changelog.md)
 
@@ -30,8 +36,8 @@ You can see all the commands available by running
 $ story_branch -h
 
 Commands:
-  story_branch add             # Add a new story branch configuration
-  story_branch create          # Create branch from estimated stories in pivotal tracker
+  story_branch configure       # Configure a new story branch configuration
+  story_branch create          # Create branch from a ticket in the tracker
   story_branch finish          # Creates a git commit message for the staged changes with a [Finishes] tag
   story_branch help [COMMAND]  # Describe available commands or one specific command
   story_branch migrate         # Migrate old story branch configuration to the new format
@@ -113,14 +119,14 @@ the full list.
 
 ## Configuring PivotalTracker
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. tracker - You should select Pivotal Tracker
 2. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
 3. api key - this is your personal api key. You can get that from [your profile page](https://www.pivotaltracker.com/profile)
 
 ## Configuring Github
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. project id - This is the github repository name in the format `<owner>/<repo_name>`. E.g. `story-branch/story_branch`.
 2. tracker - You should select Github
 3. api key - this is your personal api token. You can create one under your

data/docs/index.md

@@ -33,13 +33,13 @@ You can see all the commands available by running
 $ story_branch -h
 
 Commands:
-  story_branch add             # Add a new story branch configuration
-  story_branch create          # Create branch from estimated stories in pivotal tracker
+  story_branch configure       # Setup story branch with a new/existing project
+  story_branch create          # Create branch from a ticket in the tracker
   story_branch finish          # Creates a git commit message for the staged changes with a [Finishes] tag
   story_branch help [COMMAND]  # Describe available commands or one specific command
   story_branch migrate         # Migrate old story branch configuration to the new format
-  story_branch start           # Mark an estimated story as started in Pivotal Tracker
-  story_branch unstart         # Mark a started story as un-started in Pivotal Tracker
+  story_branch start           # Mark an estimated story as started [Only for Pivotal Tracker]
+  story_branch unstart         # Mark a started story as un-started [Only for Pivotal Tracker]
   story_branch version         # story_branch gem version
 ```
 
@@ -116,14 +116,14 @@ the full list.
 
 ## Configuring PivotalTracker
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. tracker - You should select Pivotal Tracker
 2. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
 3. api key - this is your personal api key. You can get that from [your profile page](https://www.pivotaltracker.com/profile)
 
 ## Configuring Github
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. project id - This is the github repository name in the format `<owner>/<repo_name>`. E.g. `story-branch/story_branch`.
 2. tracker - You should select Github
 3. api key - this is your personal api token. You can create one under your

data/lib/story_branch/cli.rb

@@ -18,7 +18,19 @@ module StoryBranch
     end
     map %w[--version -v] => :version
 
-    desc 'unstart', 'Mark a started story as un-started in Pivotal Tracker'
+    desc 'open_issue', 'Open ticket in the configured tracker'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def open_issue(*)
+      if options[:help]
+        invoke :help, ['open_issue']
+      else
+        require_relative 'commands/open_issue'
+        StoryBranch::Commands::OpenIssue.new(options).execute
+      end
+    end
+
+    desc 'unstart', 'Mark a started story as un-started [Only for Pivotal Tracker]'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
     def unstart(*)
@@ -30,7 +42,7 @@ module StoryBranch
       end
     end
 
-    desc 'start', 'Mark an estimated story as started in Pivotal Tracker'
+    desc 'start', 'Mark an estimated story as started [Only for Pivotal Tracker]'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
     def start(*)
@@ -55,7 +67,7 @@ module StoryBranch
       end
     end
 
-    desc 'create', 'Create branch from estimated stories in pivotal tracker'
+    desc 'create', 'Create branch from a ticket in the tracker'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
     def create(*)
@@ -67,15 +79,15 @@ module StoryBranch
       end
     end
 
-    desc 'add', 'Add a new story branch configuration'
+    desc 'configure', 'Setup story branch with a new/existing project'
     method_option :help, aliases: '-h', type: :boolean,
                          desc: 'Display usage information'
-    def add(*)
+    def configure(*)
       if options[:help]
-        invoke :help, ['add']
+        invoke :help, ['configure']
       else
-        require_relative 'commands/add'
-        StoryBranch::Commands::Add.new(options).execute
+        require_relative 'commands/configure'
+        StoryBranch::Commands::Configure.new(options).execute
       end
     end
   end

data/lib/story_branch/commands/{add.rb → configure.rb}

@@ -12,8 +12,9 @@ module StoryBranch
     #
     # It will try to load the existing global story branch config
     # and then add the project id specified by the user.
-    class Add < StoryBranch::Command
+    class Configure < StoryBranch::Command
       def initialize(_options)
+        super()
         @new_config = ConfigManager.new
       end
 
@@ -45,10 +46,8 @@ module StoryBranch
 
         return unless tracker == 'jira'
 
-        # rubocop:disable Metrics/LineLength
         username = prompt.ask('Please provide username (email most of the times) for this key:',
                               required: true)
-        # rubocop:enable Metrics/LineLength
         @new_config.username = username
       end
 

data/lib/story_branch/commands/create.rb

@@ -8,6 +8,7 @@ module StoryBranch
     # started stories in the tracker
     class Create < StoryBranch::Command
       def initialize(options)
+        super()
         @options = options
       end
 

data/lib/story_branch/commands/finish.rb

@@ -7,6 +7,7 @@ module StoryBranch
     # Command to finish a story
     class Finish < StoryBranch::Command
       def initialize(options)
+        super()
         @options = options
       end
 

data/lib/story_branch/commands/open_issue.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module StoryBranch
+  module Commands
+    # OpenIssue command is used to open the associated ticket in the browser
+    class OpenIssue < StoryBranch::Command
+      def initialize(options)
+        super()
+        @options = options
+      end
+
+      def execute(_input: $stdin, output: $stdout)
+        require_relative '../main'
+        sb = StoryBranch::Main.new
+        res = sb.open_current_url
+        output.write(res)
+      end
+    end
+  end
+end

data/lib/story_branch/commands/start.rb

@@ -7,6 +7,7 @@ module StoryBranch
     # Command to start an estimated story
     class Start < StoryBranch::Command
       def initialize(options)
+        super()
         @options = options
       end
 

data/lib/story_branch/commands/unstart.rb

@@ -7,6 +7,7 @@ module StoryBranch
     # Command to unstart a previously started story
     class Unstart < StoryBranch::Command
       def initialize(options)
+        super()
         @options = options
       end
 

data/lib/story_branch/git_utils.rb

@@ -20,25 +20,8 @@ module StoryBranch
       false
     end
 
-    def self.branch_for_story_exists?(id)
-      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.current_story
-      /(.*)-(\d+$)/.match GitWrapper.current_branch
-    end
-
-    def self.current_branch_story_parts
-      matches = current_story
-      return {} unless matches&.length == 3
-
-      title = matches[1].tr('-', ' ').strip
-      { title: title, id: matches[2].to_i }
+    def self.branch_to_story_string(regex_matcher = /.*-(\d+$)/)
+      GitWrapper.current_branch.match(regex_matcher)
     end
 
     def self.status?(state)

data/lib/story_branch/git_wrapper.rb

@@ -36,7 +36,7 @@ module StoryBranch
       # remotes/origin/allow.... <- remote branch (remove 'remotes/origin')
       # * allow.... <- * indicates current branch (remove '* ')
       # allow <- local branch (do nothing)
-      regex = %r{(^remotes\/.*\/|\s|[*])}
+      regex = %r{(^remotes/.*/|\s|[*])}
       all_branches.map do |line|
         line = line.sub(regex, '')
         line
@@ -47,7 +47,7 @@ module StoryBranch
       current_branch_line = all_branches.detect do |line|
         line.match(/\*/)
       end
-      current_branch_line.tr('*', ' ')
+      current_branch_line.tr('*', ' ').strip
     end
 
     def self.all_branches

data/lib/story_branch/github/issue.rb

@@ -7,7 +7,7 @@ module StoryBranch
   module Github
     # GitHub Issue representation
     class Issue
-      attr_accessor :title, :id
+      attr_accessor :title, :id, :html_url
 
       def initialize(blanket_story, repo)
         @repo = repo
@@ -15,9 +15,8 @@ module StoryBranch
         @title = blanket_story.title
         @id = blanket_story.number
         @labels = blanket_story.labels.map { |label| Label.new(label) }
-        @milestone =  if blanket_story.milestone
-                        Milestone.new(blanket_story.milestone)
-                      end
+        @milestone = Milestone.new(blanket_story.milestone) if blanket_story.milestone
+        @html_url = blanket_story.html_url
       end
 
       def update_state

data/lib/story_branch/github/label.rb

@@ -5,6 +5,7 @@ module StoryBranch
     # Github Labels representation
     class Label
       attr_accessor :name, :color
+
       def initialize(label_data)
         @name = label_data.name
         @color = label_data.color

data/lib/story_branch/github/tracker.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'blanket'
-require 'story_branch/tracker_base'
+require_relative '../tracker_base'
 require_relative './project'
 
 module StoryBranch
@@ -11,6 +11,7 @@ module StoryBranch
       API_URL = 'https://api.github.com/'
 
       def initialize(project_id:, api_key:, **)
+        super
         # NOTE: RepoName should follow owner/repo_name format
         @repo_name = project_id
         @api_key = api_key

data/lib/story_branch/jira/issue.rb

@@ -4,7 +4,7 @@ module StoryBranch
   module Jira
     # Jira Issue representation
     class Issue
-      attr_accessor :title, :id
+      attr_accessor :title, :id, :html_url
 
       # TODO: Add component and labels to the info of the issue
       def initialize(jira_issue, project)
@@ -12,6 +12,7 @@ module StoryBranch
         @story = jira_issue
         @title = jira_issue.summary
         @id = jira_issue.key
+        @html_url = transform_url(jira_issue.self)
       end
 
       def update_state
@@ -25,6 +26,12 @@ module StoryBranch
       def dashed_title
         StoryBranch::StringUtils.normalised_branch_name @title
       end
+
+      private
+
+      def transform_url(url)
+        url.gsub(%r{rest/api.*$}, "browse/#{@id}")
+      end
     end
   end
 end

data/lib/story_branch/jira/project.rb

@@ -16,7 +16,7 @@ module StoryBranch
       # Probably will need a specific query builder per tracker
       def stories(options = {})
         stories = if options[:id]
-                    [@project.issues.find(options[:id])]
+                    [@project.client.Issue.find(options[:id])]
                   else
                     @project.client.Issue.jql(jql_query)
                   end

data/lib/story_branch/jira/tracker.rb

@@ -5,22 +5,23 @@
 # my tracker and issues will still provide a similar api. This jira-ruby
 # is used to get the data.
 require 'jira-ruby'
-require 'story_branch/tracker_base'
+require_relative '../tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Jira
     # JIRA API wrapper for story branch tracker
     class Tracker < StoryBranch::TrackerBase
-      # rubocop:disable Metrics/LineLength
       def initialize(tracker_domain:, project_id:, api_key:, username:, extra_query:)
+        super
+
         @tracker_url = "https://#{tracker_domain}.atlassian.net"
         @project_id = project_id
+        @issue_regex = Regexp.new("#{@project_id}-(\\d+)")
         @api_key = api_key
         @username = username
         @extra_query = extra_query
       end
-      # rubocop:enable Metrics/LineLength
 
       def valid?
         [@api_key, @project_id, @username, @tracker_url].none?(&:nil?)
@@ -61,6 +62,8 @@ module StoryBranch
 
         jira_project = api.Project.find(@project_id)
         @project = Project.new(jira_project, @extra_query)
+      rescue JIRA::HTTPError => e
+        raise "failed to authenticate: #{e.inspect}"
       end
     end
   end