jira-auto-tool 0.1.1

data/lib/jira/auto/tool/next_sprint_creator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "delegate"
+require "jira-ruby"
+
+require_relative "sprint_state_controller"
+require_relative "sprint/name"
+
+module Jira
+  module Auto
+    class Tool
+      class NextSprintCreator
+        def self.create_sprint_following(sprint)
+          new(sprint).create
+        end
+
+        attr_reader :sprint
+
+        def initialize(sprint)
+          log.debug { "Creating next sprint for #{sprint}" }
+          @sprint = sprint
+        end
+
+        def next_sprint_length_in_days
+          sprint.length_in_days
+        end
+
+        def create
+          RequestBuilder::SprintCreator.create_sprint(sprint.tool, sprint.origin_board_id, {
+                                                        name: next_sprint_name,
+                                                        start_date: next_sprint_start_date.utc.to_s,
+                                                        length_in_days: next_sprint_length_in_days
+                                                      })
+        end
+
+        INDEX_FIRST_SPRINT_IN_QUARTER = 1
+
+        def next_sprint_name
+          index_in_quarter =
+            if same_quarter?
+              sprint.index_in_quarter + 1
+            else
+              INDEX_FIRST_SPRINT_IN_QUARTER
+            end
+
+          Sprint::Name.new(sprint.name_prefix, next_sprint_start_date.year, next_sprint_start_date.quarter,
+                           index_in_quarter).to_s
+        end
+
+        def same_quarter?
+          sprint.start_date.quarter == next_sprint_start_date.quarter
+        end
+
+        def next_sprint_start_date
+          sprint.end_date
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/options.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "optparse/time"
+require "jira/auto/tool/helpers/option_parser"
+require "jira/auto/tool/performer/quarterly_sprint_renamer"
+require "jira/auto/tool/performer/sprint_renamer"
+require "jira/auto/tool/performer/sprint_time_in_dates_aligner"
+require "jira/auto/tool/performer/sprint_end_date_updater"
+require "jira/auto/tool/performer/planning_increment_sprint_creator"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        module Options
+          def self.add(tool, parser)
+            parser.section_header "Sprint"
+            add_sprint_add(parser, tool)
+            add_sprint_align_time_in_dates(parser, tool)
+            add_quarterly_sprint_rename(parser, tool)
+            add_sprint_rename(parser, tool)
+            add_sprint_update_end_date(parser, tool)
+          end
+
+          def self.add_quarterly_sprint_rename(parser, tool)
+            parser.on("--quarterly-sprint-rename=FROM_STRING,TO_STRING", "--qsr", Array,
+                      "Rename sprints starting with FROM_STRING to TO_STRING. The following sprints in the same " \
+                      "planning increment will also be renamed. ") do |from_string, to_string|
+              QuarterlySprintRenamer.new(tool, from_string, to_string).run
+            end
+          end
+
+          SR_SHORT_OPTION_NAME = "--sr"
+          def self.add_sprint_rename(parser, tool)
+            parser.on("--sprint-rename=FROM_STRING,TO_STRING", SR_SHORT_OPTION_NAME, Array,
+                      "Rename sprints starting with FROM_STRING to TO_STRING. The following sprints in the same " \
+                      "prefix are also all going to be renamed " \
+                      "irrespective of their original planning interval " \
+                      "(e.g., #{SR_SHORT_OPTION_NAME}=25.3.6,25.4.1).") do |from_string, to_string|
+              SprintRenamer.new(tool, from_string, to_string).run
+            end
+          end
+
+          def self.add_sprint_update_end_date(parser, tool)
+            parser.on("--sprint-update-end-date=REGEX,NEW_END_DATE", "--sued", Array,
+                      "Update the end of the sprint matching REGEX to NEW_END_DATE. " \
+                      "The following sprints are shifted " \
+                      "while keeping their original length planning increment will " \
+                      "also be renamed. ") do |sprint_name_regex, new_end_date|
+              SprintEndDateUpdater.new(tool, sprint_name_regex, new_end_date).run
+            end
+          end
+
+          SATID_SHORT_OPTION_NAME = "--satid"
+          def self.add_sprint_align_time_in_dates(parser, tool)
+            parser.on("--sprint-align-time-in-dates=TIME", SATID_SHORT_OPTION_NAME, Time,
+                      "Update the start and end dates of sprints to all have the specified time " \
+                      "(e.g., #{SATID_SHORT_OPTION_NAME}=\"14:15 UTC\").") do |time|
+              SprintTimeInDatesAligner.new(tool, time).run
+            end
+          end
+
+          SA_SHORT_OPTION_NAME = "--sa"
+          def self.add_sprint_add(parser, tool)
+            parser.on("--sprint-add=YY.PI.START,COUNT", SA_SHORT_OPTION_NAME, Array,
+                      "Add COUNT sprints for each sprint prefix/team sprints using " \
+                      "the specified YY.PI.START (e.g., #{SA_SHORT_OPTION_NAME}=25.3.1) and " \
+                      "the existing sprints as templates.") do |sprint_suffix, iteration_count|
+              PlanningIncrementSprintCreator.new(tool, sprint_suffix, Integer(iteration_count)).run
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/planning_increment_sprint_creator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/performer/prefix_sprint_updater"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class PlanningIncrementSprintCreator < PrefixSprintUpdater
+          attr_reader :sprint_suffix, :iteration_count
+
+          def initialize(tool, sprint_suffix, iteration_count)
+            super(tool)
+
+            @sprint_suffix = sprint_suffix
+            @iteration_count = iteration_count
+          end
+
+          def act_on_sprints_for_sprint_prefix(sprint_prefix)
+            last_sprint = sprint_prefix.last_sprint
+            parsed_new_name = Sprint::Name.new_with(sprint_prefix.name, sprint_suffix)
+
+            iteration_count.times do |_iteration|
+              last_sprint = create_sprint_for(last_sprint, parsed_new_name.to_s)
+
+              sprint_prefix << last_sprint
+
+              parsed_new_name = parsed_new_name.next_in_planning_interval
+            end
+          end
+
+          def create_sprint_for(last_sprint, new_name)
+            RequestBuilder::SprintCreator.create_sprint(
+              tool, last_sprint.origin_board_id,
+              name: new_name, start_date: last_sprint.end_date, length_in_days: last_sprint.length_in_days
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/prefix_sprint_updater.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class PrefixSprintUpdater
+          attr_reader :tool
+
+          def initialize(tool)
+            @tool = tool
+          end
+
+          def sprint_prefixes
+            tool.unclosed_sprint_prefixes
+          end
+
+          def run
+            sprint_prefixes.each do |sprint_prefix|
+              @first_sprint_already_identified = false
+              act_on_sprints_for_sprint_prefix(sprint_prefix)
+            end
+          end
+
+          def act_on_sprints_for_sprint_prefix(sprint_prefix)
+            raise NotImplementedError
+          end
+
+          def first_sprint_to_act_on?(sprint_name)
+            if @first_sprint_already_identified
+              false
+            else
+              @first_sprint_already_identified = (sprint_name =~ from_string_regex)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/quarterly_sprint_renamer/next_name_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/performer/quarterly_sprint_renamer"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class QuarterlySprintRenamer
+          class NextNameGenerator
+            attr_reader :original_name_of_first_renamed_sprint, :name_of_first_renamed_sprint
+
+            def initialize(original_name_of_first_renamed_sprint, name_of_first_renamed_sprint)
+              @original_name_of_first_renamed_sprint = Sprint::Name.parse(original_name_of_first_renamed_sprint)
+              @name_of_first_renamed_sprint = Sprint::Name.parse(name_of_first_renamed_sprint)
+            end
+
+            def name_for(sprint_name)
+              if outside_planning_interval_of_sprint_next_to_first_renamed_sprint?(sprint_name)
+                sprint_name
+              else
+                next_name_in_planning_interval
+              end
+            end
+
+            def new_name_of_sprint_next_to_first_renamed_sprint
+              @new_name_of_sprint_next_to_first_renamed_sprint ||=
+                if pulling_sprint_into_previous_planning_interval?
+                  original_name_of_first_renamed_sprint
+                else
+                  name_of_first_renamed_sprint.next_in_planning_interval
+                end
+            end
+
+            def next_name_in_planning_interval
+              @next_name_in_planning_interval ||= new_name_of_sprint_next_to_first_renamed_sprint
+
+              next_name = @next_name_in_planning_interval.to_s
+
+              @next_name_in_planning_interval = @next_name_in_planning_interval.next_in_planning_interval
+
+              next_name
+            end
+
+            def pulling_sprint_into_previous_planning_interval?
+              (name_of_first_renamed_sprint.planning_interval <=>
+                original_name_of_first_renamed_sprint.planning_interval)
+                .negative?
+            end
+
+            def outside_planning_interval_of_sprint_next_to_first_renamed_sprint?(sprint_name)
+              new_name_of_sprint_next_to_first_renamed_sprint.planning_interval !=
+                Sprint::Name.parse(sprint_name).planning_interval
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/quarterly_sprint_renamer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "sprint_renamer"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class QuarterlySprintRenamer < SprintRenamer
+          require_relative "quarterly_sprint_renamer/next_name_generator"
+
+          def next_sprint_name_generator_class
+            QuarterlySprintRenamer::NextNameGenerator
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/sprint_end_date_updater.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "prefix_sprint_updater"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class SprintEndDateUpdater < PrefixSprintUpdater
+          attr_reader :from_string_regex, :new_end_date
+
+          def initialize(tool, from_string, new_end_date)
+            super(tool)
+
+            @from_string_regex = Regexp.new(Regexp.escape(from_string))
+            @new_end_date = Time.parse(new_end_date)
+          end
+
+          def act_on_sprints_for_sprint_prefix(sprint_prefix)
+            prefix_sprints = sprint_prefix.sprints
+            update_action = :do_nothing
+            new_start_date = nil
+
+            prefix_sprints.each do |sprint|
+              if first_sprint_to_act_on?(sprint.name)
+                update_sprint_end_date(sprint)
+                update_action = :shift_sprint_to_new_start_date
+              else
+                send(update_action, sprint, new_start_date)
+              end
+
+              new_start_date = sprint.end_date
+            end
+          end
+
+          def do_nothing(_sprint, _new_start_date) end
+
+          def update_sprint_end_date(sprint)
+            sprint.end_date = new_end_date
+            sprint.save
+          end
+
+          def shift_sprint_to_new_start_date(sprint, new_start_date)
+            length_in_days = sprint.length_in_days
+
+            sprint.start_date = new_start_date
+            sprint.end_date = new_start_date + length_in_days.days
+
+            sprint.save
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/sprint_renamer/keep_same_name_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/performer/sprint_renamer"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class SprintRenamer
+          class KeepSameNameGenerator
+            def name_for(sprint_name)
+              sprint_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/sprint_renamer/next_name_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/performer/sprint_renamer"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class SprintRenamer
+          class NextNameGenerator
+            attr_reader :original_name_of_first_renamed_sprint, :name_of_first_renamed_sprint
+
+            def initialize(original_name_of_first_renamed_sprint, name_of_first_renamed_sprint)
+              @original_name_of_first_renamed_sprint = Sprint::Name.parse(original_name_of_first_renamed_sprint)
+              @name_of_first_renamed_sprint = Sprint::Name.parse(name_of_first_renamed_sprint)
+            end
+
+            def name_for(_sprint_name)
+              next_name_in_planning_interval
+            end
+
+            def new_name_of_sprint_next_to_first_renamed_sprint
+              @new_name_of_sprint_next_to_first_renamed_sprint ||=
+                name_of_first_renamed_sprint.next_in_planning_interval
+            end
+
+            def next_name_in_planning_interval
+              @next_name_in_planning_interval ||= new_name_of_sprint_next_to_first_renamed_sprint
+
+              next_name = @next_name_in_planning_interval.to_s
+
+              @next_name_in_planning_interval = @next_name_in_planning_interval.next_in_planning_interval
+
+              next_name
+            end
+
+            def pulling_sprint_into_previous_planning_interval?
+              (name_of_first_renamed_sprint.planning_interval <=>
+                original_name_of_first_renamed_sprint.planning_interval)
+                .negative?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/sprint_renamer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "prefix_sprint_updater"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class SprintRenamer < PrefixSprintUpdater
+          require_relative "sprint_renamer/keep_same_name_generator"
+          require_relative "sprint_renamer/next_name_generator"
+
+          attr_reader :from_string_regex, :to_string
+
+          def initialize(tool, from_string, to_string)
+            super(tool)
+
+            @from_string_regex = Regexp.new(Regexp.escape(from_string))
+            @to_string = to_string
+          end
+
+          def act_on_sprints_for_sprint_prefix(sprint_prefix)
+            prefix_sprints = sprint_prefix.sprints
+
+            new_sprint_names = calculate_sprint_new_names(prefix_sprints.collect(&:name))
+
+            prefix_sprints.zip(new_sprint_names).each do |sprint, new_sprint_name|
+              sprint.rename_to(new_sprint_name)
+            end
+          end
+
+          def calculate_sprint_new_names(sprint_names)
+            name_generator = Performer::SprintRenamer::KeepSameNameGenerator.new
+
+            sprint_names.collect do |sprint_name|
+              if first_sprint_to_act_on?(sprint_name)
+                sprint_new_name = sprint_name.sub(from_string_regex, to_string)
+
+                name_generator = next_sprint_name_generator_class.new(sprint_name, sprint_new_name)
+
+                sprint_new_name
+              else
+                name_generator.name_for(sprint_name)
+              end
+            end
+          end
+
+          def next_sprint_name_generator_class
+            NextNameGenerator
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/performer/sprint_time_in_dates_aligner.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool"
+
+module Jira
+  module Auto
+    class Tool
+      class Performer
+        class SprintTimeInDatesAligner
+          attr_reader :tool, :sprint_time_in_dates
+
+          def initialize(tool, sprint_time_in_dates)
+            @tool = tool
+            @sprint_time_in_dates =
+              if sprint_time_in_dates.is_a?(String)
+                Time.parse(sprint_time_in_dates)
+              else
+                sprint_time_in_dates
+              end
+          end
+
+          def run
+            update_sprint_dates_with_expected_time
+          end
+
+          def update_sprint_dates_with_expected_time
+            tool.unclosed_sprints.each { |sprint| update_sprint_dates_for(sprint) }
+          end
+
+          def update_sprint_dates_for(sprint)
+            return if sprint.closed? || !(sprint.start_date? || sprint.end_date?)
+
+            sprint.start_date = date_with_expected_time(sprint.start_date) if sprint.start_date?
+            sprint.end_date = date_with_expected_time(sprint.end_date) if sprint.end_date?
+
+            sprint.save
+          end
+
+          private
+
+          def date_with_expected_time(original_date)
+            original_date = Time.parse(original_date) if original_date.is_a?(String)
+
+            original_date.change(
+              hour: sprint_time_in_dates.hour, min: sprint_time_in_dates.min, sec: sprint_time_in_dates.sec
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/project/options.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "jira/auto/tool/project"
+
+module Jira
+  module Auto
+    class Tool
+      class Project
+        class Options
+          def self.add(tool, parser)
+            parser.section_header "Project"
+
+            parser.on("--project-field-list",
+                      "Display the fields pertaining to the ticket types of a project") do
+              tool.project.list_ticket_fields
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/project/ticket_fields.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Jira
+  module Auto
+    class Tool
+      class Project
+        class TicketFields
+          attr_reader :tool, :project
+
+          def initialize(tool, project)
+            @tool = tool
+            @project = project
+          end
+
+          def list
+            table = Terminal::Table.new(
+              title: "Project #{project.key} Ticket Fields",
+              headings: table_row_header,
+              rows: table_rows
+            )
+
+            puts table
+          end
+
+          def table_row_header
+            ["Ticket Type", "Field Key", "Field Name", "Field Type", "Allowed Values"]
+          end
+
+          def table_rows
+            rows = []
+
+            each_issue_type_field do |issue_type_name, field|
+              rows << [issue_type_name, field["key"], field["name"], field["schema"]["type"], allowed_values(field)]
+            end
+
+            rows.sort
+          end
+
+          def each_issue_type_field
+            tool.jira_client.Createmeta.all({ projectKeys: project.key, "expand" => "projects.issuetypes.fields" })
+                .each do |createmeta|
+              createmeta.attrs["issuetypes"].each do |issue_type|
+                issue_type_name = issue_type["name"]
+                issue_type["fields"].each_value do |field|
+                  yield(issue_type_name, field)
+                end
+              end
+            end
+          end
+
+          private
+
+          def allowed_values(field)
+            field_allowed_values = field["allowedValues"]
+
+            if field_allowed_values
+              field_allowed_values.collect do |allowed_value|
+                value = allowed_value["value"] || allowed_value["name"]
+
+                "#{value} (#{allowed_value["id"]})"
+              end
+            else
+              "n/a"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/auto/tool/project.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "terminal-table"
+require "jira/auto/tool/field_controller"
+require "jira/auto/tool/project/ticket_fields"
+
+module Jira
+  module Auto
+    class Tool
+      class Project
+        def self.find(tool, project_key)
+          new(tool, tool.jira_client.Project.find(project_key))
+        end
+
+        def initialize(tool, jira_project)
+          @tool = tool
+          @jira_project = jira_project
+        end
+
+        def key
+          jira_project.key
+        end
+
+        def list_ticket_fields
+          ticket_fields.list
+        end
+
+        def ticket_fields
+          TicketFields.new(tool, self)
+
+          # FieldController.new(jira_client).ticket_fields
+        end
+
+        private
+
+        attr_reader :tool, :jira_project
+      end
+    end
+  end
+end