story_branch 0.6.1 → 1.0.0

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

@@ -6,8 +6,9 @@ module StoryBranch
   module Jira
     # Jira Project representation
     class Project
-      def initialize(jira_project)
+      def initialize(jira_project, query_addon = '')
         @project = jira_project
+        @query_addon = query_addon
       end
 
       # Returns an array of Jira issues (Issue Class)
@@ -15,17 +16,24 @@ 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
-                    # rubocop:disable Layout/LineLength
-                    @project.client.Issue.jql(
-                      "project=#{@project.key} AND status='To Do' AND assignee=currentUser()"
-                    )
-                    # rubocop:enable Layout/LineLength
+                    @project.client.Issue.jql(jql_query)
                   end
 
         stories.map { |s| Issue.new(s, @project) }
       end
+
+      private
+
+      def jql_query
+        base_query = "project=#{@project.key} AND assignee=currentUser()"
+        if @query_addon.length.positive?
+          [base_query, @query_addon].join(' AND ')
+        else
+          base_query
+        end
+      end
     end
   end
 end

data/lib/story_branch/jira/tracker.rb

@@ -5,22 +5,22 @@
 # my tracker and issues will still provide a similar api. This jira-ruby
 # is used to get the data.
 require 'jira-ruby'
+require_relative '../tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Jira
     # JIRA API wrapper for story branch tracker
-    class Tracker
-      TYPE = 'jira'
+    class Tracker < StoryBranch::TrackerBase
+      def initialize(tracker_domain:, project_id:, api_key:, username:, extra_query:)
+        super
 
-      attr_reader :type
-
-      def initialize(tracker_domain:, project_id:, api_key:, username:)
         @tracker_url = "https://#{tracker_domain}.atlassian.net"
         @project_id = project_id
+        @issue_regex = Regexp.new("#{@project_id}-(\\d+)")
         @api_key = api_key
         @username = username
-        @type = TYPE
+        @extra_query = extra_query
       end
 
       def valid?
@@ -52,10 +52,8 @@ module StoryBranch
         }
       end
 
-      def api
-        raise 'API key must be specified' unless @api_key
-
-        @api ||= JIRA::Client.new(options)
+      def configure_api
+        JIRA::Client.new(options)
       end
 
       def project
@@ -63,7 +61,9 @@ module StoryBranch
         raise 'project key must be set' unless @project_id
 
         jira_project = api.Project.find(@project_id)
-        @project = Project.new(jira_project)
+        @project = Project.new(jira_project, @extra_query)
+      rescue JIRA::HTTPError => e
+        raise "failed to authenticate: #{e.inspect}"
       end
     end
   end

data/lib/story_branch/main.rb

@@ -6,6 +6,7 @@ require_relative './jira/tracker'
 require_relative './git_utils'
 require_relative './git_wrapper'
 require_relative './config_manager'
+require_relative './url_opener'
 require 'tty-prompt'
 
 module StoryBranch
@@ -17,14 +18,9 @@ module StoryBranch
     attr_accessor :tracker
 
     def initialize
-      # TODO: Config manager should be responsible for handling the
-      # configuration and the story branch should only initialize one
-      # config manager that has attr accessors for needed values
-      # Read local config and decide what Utility to use
-      # (e.g. PivotalUtils, GithubUtils, ...)
-      @local_config = ConfigManager.init_config('.')
-      @global_config = ConfigManager.init_config(Dir.home)
-      initialize_tracker
+      @config = ConfigManager.new
+      abort(@config.errors.join("\n")) unless @config.valid?
+      @tracker = initialize_tracker
       abort('Invalid tracker configuration setting.') unless @tracker.valid?
     end
 
@@ -72,34 +68,32 @@ module StoryBranch
       update_status('started', 'unstarted', 'unstart')
     end
 
+    def open_current_url
+      if current_story
+        prompt.say 'Opening story in browser...'
+        StoryBranch::UrlOpener.open_url(current_story.html_url)
+      else
+        prompt.say 'Could not find matching story in configured tracker'
+      end
+    end
+
     private
 
     def require_pivotal
-      if @tracker.type != 'pivotal'
-        prompt.say 'The configured tracker does not support this feature'
-        return false
-      end
-      true
+      return true if @tracker.class.name.match?('Pivotal')
+
+      prompt.say 'The configured tracker does not support this feature'
+      false
     end
 
     def current_story
-      return @current_story if @current_story
-
-      current_story = GitUtils.current_branch_story_parts
-
-      unless current_story.empty?
-        @current_story = @tracker.get_story_by_id(current_story[:id])
-        return @current_story if @current_story
-      end
+      return nil unless @tracker
 
-      prompt.error('No tracked feature associated with this branch')
-      nil
+      @tracker.current_story
     end
 
     def unstaged_changes?
-      unless GitUtils.status?(:untracked) || GitUtils.status?(:modified)
-        return false
-      end
+      return false unless GitUtils.status?(:untracked) || GitUtils.status?(:modified)
 
       message = <<~MESSAGE
         There are unstaged changes
@@ -159,54 +153,26 @@ module StoryBranch
       @prompt ||= TTY::Prompt.new(interrupt: :exit)
     end
 
-    def finish_tag
-      return @finish_tag if @finish_tag
-
-      fallback = @global_config.fetch(project_id,
-                                      :finish_tag,
-                                      default: 'Finishes')
-      @finish_tag = @local_config.fetch(:finish_tag, default: fallback)
-      @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 = [@config.finish_tag, "##{current_story.id}"].join(' ').strip
       "[#{message_tag}] #{current_story.title}"
     end
 
     def create_feature_branch(story)
       return if story.nil?
 
-      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)
+      branch_name = prompt.ask('Provide a new branch name', default: story.dashed_title)
       feature_branch_name = StringUtils.truncate(branch_name.chomp)
 
       validate_branch_name(feature_branch_name)
@@ -216,8 +182,7 @@ module StoryBranch
     # 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.')
+        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
@@ -233,65 +198,30 @@ module StoryBranch
     # rubocop:enable Metrics/MethodLength
 
     def build_branch_name(branch_name, story_id)
-      if issue_placement.casecmp('beginning').zero?
+      if @config.issue_placement.casecmp('beginning').zero?
         "#{story_id}-#{branch_name}"
       else
         "#{branch_name}-#{story_id}"
       end
     end
 
-    def project_id
-      return @project_id if @project_id
-
-      project_ids = @local_config.fetch(:project_id)
-      @project_id = choose_project_id(project_ids)
-    end
-
-    def choose_project_id(project_ids)
-      return project_ids unless project_ids.is_a? Array
-      return project_ids[0] unless project_ids.length > 1
-
-      prompt.select('Which project you want to fetch from?', project_ids)
-    end
-
-    def api_key
-      @api_key ||= @global_config.fetch(project_id, :api_key)
-    end
-
-    def username
-      @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
-      if project_id.nil?
-        prompt.say 'Project ID not set'
-        exit 0
+      # TODO: Ideally this would be mapped out somewhere so we don't need to
+      # evaluate anything from the config here
+      tracker_type = @config.tracker_type
+      case tracker_type
+      when 'github'
+        StoryBranch::Github::Tracker.new(**@config.tracker_params)
+      when 'pivotal-tracker'
+        StoryBranch::Pivotal::Tracker.new(**@config.tracker_params)
+      when 'jira'
+        StoryBranch::Jira::Tracker.new(**@config.tracker_params)
       end
-      tracker_type = @local_config.fetch(:tracker, default: 'pivotal-tracker')
-      @tracker = case tracker_type
-                 when 'github'
-                   StoryBranch::Github::Tracker.new(project_id, api_key)
-                 when 'pivotal-tracker'
-                   StoryBranch::Pivotal::Tracker.new(project_id, api_key)
-                 when 'jira'
-                   tracker_domain, project_key = project_id.split('|')
-                   options = {
-                     tracker_domain: tracker_domain,
-                     project_id: project_key,
-                     api_key: api_key,
-                     username: username
-                   }
-                   StoryBranch::Jira::Tracker.new(options)
-                 end
     end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/story_branch/pivotal/tracker.rb

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
 require 'blanket'
+require_relative '../tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Pivotal
     # Utility class for integration with PivotalTracker. It relies on Blanket
     # wrapper to communicate with pivotal tracker's api.
-    class Tracker
+    class Tracker < StoryBranch::TrackerBase
       API_URL = 'https://www.pivotaltracker.com/services/v5/'
-      TYPE = 'pivotal'
 
-      attr_reader :type
-
-      def initialize(project_id, api_key)
+      def initialize(project_id:, api_key:, **)
+        super
         @project_id = project_id
         @api_key = api_key
-        @type = TYPE
       end
 
       def valid?
@@ -41,9 +39,7 @@ module StoryBranch
 
       private
 
-      def api
-        raise 'API key must be specified' unless @api_key
-
+      def configure_api
         Blanket.wrap API_URL, headers: { 'X-TrackerToken' => @api_key }
       end
 

data/lib/story_branch/string_utils.rb

@@ -11,7 +11,7 @@ module StoryBranch
         undef: :replace, # Replace anything not defined in ASCII
         replace: '-' # Use a dash for those replacements
       }
-      res.encode(Encoding.find('ASCII'), encoding_options)
+      res.encode(Encoding.find('ASCII'), **encoding_options)
     end
 
     def self.dashed(text)

data/lib/story_branch/templates/open_issue/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/tracker_base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module StoryBranch
+  # Base story branch tracker class that will define the expected interface
+  class TrackerBase
+    def initialize(_options = {})
+      @issue_regex = Regexp.new('(\\d+)')
+    end
+
+    def valid?
+      raise 'valid? > must be implemented in the custom tracker'
+    end
+
+    # TODO: This should probably be renamed to something more meaningful
+    # in the sense that it should be workable stories/issues
+    # which depend on the tracker's workflow. PivotalTracker they need to
+    # be started and estimated, while for Github they just need to be open
+    def stories
+      []
+    end
+
+    def get_story_by_id(_story_id)
+      []
+    end
+
+    def current_story
+      return @current_story if @current_story
+
+      # TODO: This should look at the tracker configuration and search
+      # for the string either in the beginning or the end, according
+      # to what is configured
+      story_from_branch = GitUtils.branch_to_story_string(@issue_regex)
+      if story_from_branch.length == 2
+        @current_story = get_story_by_id(story_from_branch[0])
+        return @current_story
+      end
+      prompt.error('No tracked feature associated with this branch')
+      nil
+    end
+
+    private
+
+    def api
+      raise 'API key must be specified' unless @api_key
+
+      @api ||= configure_api
+    end
+
+    def project
+      return @project if @project
+      raise 'project key must be set' unless @project_id
+
+      raise 'project > must be implemented in the custom tracker'
+    end
+  end
+end