RubyGems - jira-auto-tool - Versions diffs - 1.2.0 → 1.2.1 - Mend

jira-auto-tool 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/README.md +47 -9
data/ext/no_wrappers_win.rb +6 -0
data/features/configure_environment.feature +48 -8
data/features/create_sprints_using_existing_ones_as_reference.feature +31 -3
data/lib/jira/auto/tool/environment_loader.rb +25 -1
data/lib/jira/auto/tool/helpers/environment_based_value.rb +6 -1
data/lib/jira/auto/tool/performer/planning_increment_sprint_creator.rb +4 -3
data/lib/jira/auto/tool/version.rb +1 -1
data/lib/jira/auto/tool.rb +23 -21
data/lib/tasks/version.rake +1 -1
data/spec/jira/auto/tool/environment_loader_spec.rb +64 -9
data/spec/jira/auto/tool/performer/planning_increment_sprint_creator_spec.rb +76 -13
data/spec/jira/auto/tool_spec.rb +13 -4
metadata +2 -4
data/bin/setup +0 -8
data/bin/setup-dev-win.bat +0 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f848715468127f8c2d342bdd77fd68f78b2e9684c67d506c0761e6982ce325d2
-  data.tar.gz: 3c578b782fce257b587e09c0261fe60c8fcb59293b6419e097b8f9fdd52e1bd4
+  metadata.gz: a991321a0f8768d42b913499a80fd76ff32cbea71f243e651c0097a6e9c1f10a
+  data.tar.gz: 346c3e37814218b13f5b3cb57d74b0431655b9dbca95edf3406f7b1d036252b8
 SHA512:
-  metadata.gz: 98c0d515b13ecf5f7f145eec5729435c7378d7325dae29bd250822461badcd47081a58ace1450b51c5b68eeb59d3552ff3905ae968c3e41fdc082c7af3141f37
-  data.tar.gz: 94871345d52b7809ad2267bf12f0d62114d0d10b1032fc93856a2fd78fef6c5c6308951fa6804e073ea3a0df046d81f3c648a6caadcacaac091ec1a98babe2b9
+  metadata.gz: c66c77d800f993de4821e03711585976c1cb021258add0d2ee5cb940d7fa92915d66d1b8754a2a4f245d768bbf19b7e71d791673ac9d30b0cf6bff23bcaadfc8
+  data.tar.gz: 8e3c54c724e47e4267a3ed4c65d23ff723a5c67764fdce38a05aae3ffdbc6a10d35691c4618fabc2b429a8f26af09e3303ac1004ffa0cc6ce94b1f0999b65b4c

data/README.md CHANGED Viewed

@@ -4,15 +4,33 @@
 ![Main Workflow - all branches](https://github.com/cbroult/jira-auto-tool/actions/workflows/main.yml/badge.svg?label=Ruby%20-%20all%20branches)
 ****
-The purpose of this tool it support managing the sprints of multiple teams so it is easier to adjust to changes.
+The purpose of this tool is to make it easier to make adjustments to the sprints of multiple teams.
 See the [feature files](./features) for some behavior examples.
 ## Table of Contents
-<!-- Generated using jekyll-toc -->
-* TOC
-  {:toc}
+- [Principles](#principles)
+- [Installation](#installation)
+- [Setup](#setup)
+- [Usage](#usage)
+    - [Warning](#warning)
+    - [Add Sprints](#add-sprints)
+    - [Adjusting The End Date Of Sprints](#adjusting-the-end-date-of-sprints)
+    - [Align Time In Sprint Dates](#align-time-in-sprint-dates)
+    - [List Sprints](#list-sprints)
+    - [List Sprint Prefixes (Teams)](#list-sprint-prefixes-teams)
+    - [Rename Sprints](#rename-sprints)
+    - [Team Sprint Mapping](#team-sprint-mapping)
+    - [Team Ticket Sprint Dispatching](#team-ticket-sprint-dispatching)
+- [Development](#development)
+    - [Install Dependencies](#install-dependencies)
+    - [Continuous Testing While Making Changes](#continuous-testing-while-making-changes)
+    - [Experiment Using An Interactive Prompt](#experiment-using-an-interactive-prompt)
+    - [Install Locally](#install-locally)
+    - [Release](#release)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
 ## Principles
@@ -49,7 +67,7 @@ will use the existing ones as a reference for the prefix and the length of the s
    ```
 2. Adjust the file to your context.
-The following environment variables have to be set to use this tool. **Except** for te `JIRA_API_TOKEN` that should
+The following environment variables have to be set to use this tool. **Except** for the `JIRA_API_TOKEN` that should
 be done via the configuration file.
 Some explanations:
@@ -72,9 +90,9 @@ Optional environment variables:
 See [sprint filtering](./features/sprint_filtering.feature).
 - `JIRA_CONTEXT_PATH` - Context path for Jira instance (if needed typically "/jira").
 - `JIRA_HTTP_DEBUG` - Enable HTTP debug logging (set to "true" or "false").
-- `JAT_RATE_LIMIT_PER_INTERVAL` - Rate limit for Jira API calls (e.g., "1")
-See [Control Jira HTTP request rate.](./features/control_http_request_rate_limit.feature).
 - `JAT_RATE_INTERVAL_IN_SECONDS` - Interval for rate limiting in seconds (e.g., "1").
+- `JAT_RATE_LIMIT_PER_INTERVAL` - Rate limit for Jira API calls (e.g., "1")
+See [Control Jira HTTP request rate](./features/control_http_request_rate_limit.feature).
 ## Usage
@@ -106,6 +124,15 @@ to the teams respective sprint prefixes.
 jira-auto-tool --sprint-add=25.4.3,4
 ```
+### Adjusting The End Date Of Sprints
+The following is going to
+[adjust the end date of sprints](./features/update_sprint_end_date_and_shift_following_ones.feature)
+named `sprint_prefix_25.1.5` and shift the subsequent ones by adjust their start and end dates:
+```bash
+jira-auto-tool --sprint-update-end-date=25.1.5,"2025-02-25 16:00:00 UTC"
+```
 ### Align Time In Sprint Dates
 ````bash
@@ -170,7 +197,18 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 ### Release
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Bump the gem version:
+   ```bash
+   bundle exec rake version:bump[{major|minor|patch}]
+   ```
+2. Release the version to [rubygems.org](https://rubygems.org):
+   ```bash
+   bundle exec rake release
+   ```
+   which will:
+   * create a git tag for the version
+   * push git commits and the created tag
+   * push the `.gem` file to [rubygems.org](https://rubygems.org).
 ## Contributing

data/ext/no_wrappers_win.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# Disable wrappers only on Windows
+puts "Disabling wrappers for Windows installation"
+RubyGems.configuration.wrappers = false
+exit 0

data/features/configure_environment.feature CHANGED Viewed

@@ -63,7 +63,7 @@ Feature: Environment Configuration Management
       Please remove first before running this again!
       """
-  Scenario: Tool successfully loads the config
+  Scenario: Tool successfully loads the config from the current directory and hides secret values when listing them
     Given a file named "jira-auto-tool.env.yaml.erb" with:
       """
       ---
@@ -104,7 +104,7 @@ Feature: Environment Configuration Management
 | JAT_RATE_LIMIT_IMPLEMENTATION                     |                                    |
 | JAT_RATE_LIMIT_PER_INTERVAL                       |                                    |
 | JAT_TICKETS_FOR_TEAM_SPRINT_TICKET_DISPATCHER_JQL | project = PROJ AND Sprint IS EMPTY |
-| JIRA_API_TOKEN                                    | current API TOKEN                  |
+| JIRA_API_TOKEN                                    | ****                               |
 | JIRA_BOARD_NAME                                   | Team Board                         |
 | JIRA_BOARD_NAME_REGEX                             | ART 16|unconventional board name   |
 | JIRA_CONTEXT_PATH                                 | /jira                              |
@@ -116,7 +116,7 @@ Feature: Environment Configuration Management
 +---------------------------------------------------+------------------------------------+
       """
-  Scenario: Tool looks first for configuration in the current directory
+  Scenario: Tool looks first for configuration in the current directory (hiding secret when listing)
     Given a file named "./jira-auto-tool.env.yaml.erb" with:
       """
       ---
@@ -136,8 +136,16 @@ Feature: Environment Configuration Management
       """
       Using configuration from ./jira-auto-tool.env.yaml.erb
       """
+    And the output should match:
+      """
+      JIRA_API_TOKEN\s+\|\s\*{4}
+      """
+    And the output should match:
+      """
+      JIRA_USERNAME\s+\|\scurrent@company.com
+      """
-  Scenario: Tool looks for home directory config folder when no config file in the current directory
+  Scenario: Tool looks for home directory config folder when no config file in the current directory (hiding secret when listing)
     Given a file named "./jira-auto-tool.env.yaml.erb" does not exist
     And a file named "~/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb" with:
       """
@@ -150,14 +158,23 @@ Feature: Environment Configuration Management
       """
       Using configuration from .+/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb
       """
+    And the output should match:
+      """
+      JIRA_API_TOKEN\s+\|\s\*{4}\s+
+      """
+    And the output should match:
+      """
+      JIRA_USERNAME\s+\|\shome@company.com
+      """
-  Scenario: Tool uses the existing environment values if no config file found
+  Scenario: Tool uses the existing environment values if no config file found (hiding secret when listing)
     Given the following files should not exist:
       | ./jira-auto-tool.env.yaml.erb                        |
       | ~/.config/jira-auto-tool/jira-auto-tool.env.yaml.erb |
     And the following environment variables are set:
-      | name           | value       |
-      | JIRA_API_TOKEN | token-value |
+      | name           | value           |
+      | JIRA_API_TOKEN | token-value     |
+      | JIRA_USERNAME  | env@company.com |
     When I successfully run `jira-auto-tool --env-list`
     Then the output should match:
       """
@@ -167,5 +184,28 @@ Feature: Environment Configuration Management
       """
     And the output should match:
       """
-      JIRA_API_TOKEN\s+|token-value\s+
+      JIRA_API_TOKEN\s+\|\s\*{4}
+      """
+    And the output should match:
+      """
+      JIRA_USERNAME\s+\|\senv@company.com
       """
+  Scenario: Tool displays a useful error message in case of error
+    Given a file named "./jira-auto-tool.env.yaml.erb" with:
+      """
+      ---
+      JIRA_USERNAME: "error@company.com"
+      JIRA_API_TOKEN: "error-token"
+      JIRA_SITE_URL: "https://home.atlassian.net"
+      <%
+      raise "This is meant to fail while loading!"
+      %>
+      """
+    When I run `jira-auto-tool --env-list`
+    Then it should fail with:
+      """
+      ERROR  Jira::Auto::Tool::EnvironmentLoader : ./jira-auto-tool.env.yaml.erb:6: failed to load with the following error:
+      This is meant to fail while loading!
+      """

data/features/create_sprints_using_existing_ones_as_reference.feature CHANGED Viewed

@@ -5,14 +5,14 @@ Feature: Add sprints using existing ones as reference
   Background:
     Given a Jira Scrum board
-    And the board only has the following sprints:
+  Scenario: Add several sprints using existing sprint prefixes
+    Given the board only has the following sprints:
       | comment                 | name                   | length | start_date              | state  |
       | none added since closed | Food_Supply_25.1.3     | 2-week | 2025-02-01 11:00:00 UTC | closed |
       | "sprints                | Food_Delivery_25.1.4   | 4-day  | 2025-02-01 11:00:00 UTC | future |
       | expected to be          | Food_Market_25.2.1     | 3-week | 2025-02-01 11:00:00 UTC | active |
       | added"                  | Food_Restaurant_25.2.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
-  Scenario: Add several sprints using existing sprint prefixes
     When I successfully run `jira-auto-tool --sprint-add=25.3.1,4`
     Then afterwards the board only has the following sprints:
       | name                   | start_date              | state  |
@@ -34,6 +34,12 @@ Feature: Add sprints using existing ones as reference
       | Food_Restaurant_25.3.4 | 2025-06-13 11:00:00 UTC | future |
   Scenario: Add several planning interval sprints
+    Given the board only has the following sprints:
+      | comment                 | name                   | length | start_date              | state  |
+      | none added since closed | Food_Supply_25.1.3     | 2-week | 2025-02-01 11:00:00 UTC | closed |
+      | "sprints                | Food_Delivery_25.1.4   | 4-day  | 2025-02-01 11:00:00 UTC | future |
+      | expected to be          | Food_Market_25.2.1     | 3-week | 2025-02-01 11:00:00 UTC | active |
+      | added"                  | Food_Restaurant_25.2.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
     When I successfully run `jira-auto-tool --sa=25.2.2,3  --sa=25.3.1,4  --sa=25.4.1,5`
     Then afterwards the board only has the following sprints:
       | name                   | start_date              | state  |
@@ -77,3 +83,25 @@ Feature: Add sprints using existing ones as reference
       | Food_Restaurant_25.4.3 | 2025-11-28 11:00:00 UTC | future |
       | Food_Restaurant_25.4.4 | 2025-12-26 11:00:00 UTC | future |
       | Food_Restaurant_25.4.5 | 2026-01-23 11:00:00 UTC | future |
+  Scenario: Adding sprints is not creating duplicates or ones anterior to last sprints of prefixes
+    Given the board only has the following sprints:
+      | comment                                              | name                   | length | start_date              | state  |
+      | none added since closed                              | Food_Supply_25.1.3     | 2-week | 2025-02-01 11:00:00 UTC | closed |
+      | all sprints added                                    | Food_Delivery_25.1.4   | 4-day  | 2025-02-01 11:00:00 UTC | future |
+      | the last 3 added since the first already exist       | Food_Market_25.2.1     | 3-week | 2025-02-01 11:00:00 UTC | active |
+      | none added because would be anterior existing sprint | Food_Restaurant_25.3.1 | 4-week | 2025-02-21 11:00:00 UTC | future |
+    When I successfully run `jira-auto-tool --sa=25.2.1,4`
+    Then afterwards the board only has the following sprints:
+      | name                   | start_date              | state  |
+      | Food_Supply_25.1.3     | 2025-02-01 11:00:00 UTC | closed |
+      | Food_Delivery_25.1.4   | 2025-02-01 11:00:00 UTC | future |
+      | Food_Delivery_25.2.1   | 2025-02-05 11:00:00 UTC | future |
+      | Food_Delivery_25.2.2   | 2025-02-09 11:00:00 UTC | future |
+      | Food_Delivery_25.2.3   | 2025-02-13 11:00:00 UTC | future |
+      | Food_Delivery_25.2.4   | 2025-02-17 11:00:00 UTC | future |
+      | Food_Market_25.2.1     | 2025-02-01 11:00:00 UTC | active |
+      | Food_Market_25.2.2     | 2025-02-22 11:00:00 UTC | future |
+      | Food_Market_25.2.3     | 2025-03-15 11:00:00 UTC | future |
+      | Food_Market_25.2.4     | 2025-04-05 11:00:00 UTC | future |
+      | Food_Restaurant_25.3.1 | 2025-02-21 11:00:00 UTC | future |

data/lib/jira/auto/tool/environment_loader.rb CHANGED Viewed

@@ -46,11 +46,18 @@ module Jira
         def tool_environment
           Environment.constants.sort.to_h do |constant|
             constant_as_string = constant.to_s
+            actual_value = ENV.fetch(constant_as_string, nil)
+            value_to_display = environment_variable_holds_a_secret?(constant_as_string) ? "****" : actual_value
-            [constant_as_string, ENV.fetch(constant_as_string, nil)]
+            [constant_as_string, value_to_display]
           end
         end
+        def environment_variable_holds_a_secret?(env_var_name)
+          method_name = env_var_name.to_s.downcase
+          tool.send("#{method_name}_holds_a_secret?")
+        end
         def file_path
           File.exist?(current_dir_file_path) ? current_dir_file_path : config_dir_file_path
         end
@@ -81,10 +88,27 @@ module Jira
         def config_values
           @config_values ||= YAML.safe_load(config_file_content) || {}
+        rescue StandardError => e
+          error_line = e.backtrace_locations.first.lineno
+          message = <<~EOEMSG
+            #{file_path}:#{error_line}: failed to load with the following error:
+            #{e.message}
+          EOEMSG
+          raise message
         end
         def config_file_content
           @config_file_content ||= File.exist?(file_path) ? ERB.new(File.read(file_path)).result(binding) : ""
+        rescue StandardError => e
+          error_line = e.backtrace_locations.first.lineno
+          message = <<~EOEMSG
+            #{file_path}:#{error_line}: failed to load with the following error:
+            #{e.message}
+          EOEMSG
+          raise message
         end
         def table

data/lib/jira/auto/tool/helpers/environment_based_value.rb CHANGED Viewed

@@ -6,12 +6,13 @@ module Jira
       module Helpers
         module EnvironmentBasedValue
           # TODO: overly complex - simplify by moving this to the Config and define a Configurable module
-          def define_overridable_environment_based_value(method_name)
+          def define_overridable_environment_based_value(method_name, holds_a_secret)
             define_reader(method_name)
             define_predicate(method_name)
             define_reader_accepting_default_value(method_name)
             define_writer(method_name)
             define_environment_variable_name_constant(method_name)
+            define_holds_a_secret_predicate(method_name, holds_a_secret)
           end
           def define_reader(method_name)
@@ -32,6 +33,10 @@ module Jira
             end
           end
+          def define_holds_a_secret_predicate(method_name, holds_a_secret)
+            define_method(:"#{method_name}_holds_a_secret?") { holds_a_secret }
+          end
           def define_reader_accepting_default_value(method_name)
             define_method(:"#{method_name}_when_defined_else") do |value|
               if config.key?(method_name)

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

@@ -21,9 +21,10 @@ module Jira
             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
+              unless parsed_new_name <= last_sprint.parsed_name
+                last_sprint = create_sprint_for(last_sprint, parsed_new_name.to_s)
+                sprint_prefix << last_sprint
+              end
               parsed_new_name = parsed_new_name.next_in_planning_interval
             end

data/lib/jira/auto/tool/version.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 module Jira
   module Auto
     class Tool
-      VERSION = "1.2.0"
+      VERSION = "1.2.1"
     end
   end
 end

data/lib/jira/auto/tool.rb CHANGED Viewed

@@ -139,27 +139,29 @@ module Jira
         jira_base_url + url
       end
-      ENVIRONMENT_BASED_VALUE_SYMBOLS = %i[
-        art_sprint_regex
-        expected_start_date_field_name
-        implementation_team_field_name
-        jat_rate_interval_in_seconds
-        jat_rate_limit_implementation
-        jat_rate_limit_per_interval
-        jat_tickets_for_team_sprint_ticket_dispatcher_jql
-        jira_api_token
-        jira_board_name
-        jira_board_name_regex
-        jira_context_path
-        jira_http_debug
-        jira_project_key
-        jira_site_url
-        jira_sprint_field_name
-        jira_username
-      ].freeze
-      ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name|
-        define_overridable_environment_based_value(method_name)
+      HOLDS_A_SECRET = true
+      ENVIRONMENT_BASED_VALUE_SYMBOLS =
+        ([[:jira_api_token, HOLDS_A_SECRET]] + %i[
+          art_sprint_regex
+          expected_start_date_field_name
+          implementation_team_field_name
+          jat_rate_interval_in_seconds
+          jat_rate_limit_implementation
+          jat_rate_limit_per_interval
+          jat_tickets_for_team_sprint_ticket_dispatcher_jql
+          jira_board_name
+          jira_board_name_regex
+          jira_context_path
+          jira_http_debug
+          jira_project_key
+          jira_site_url
+          jira_sprint_field_name
+          jira_username
+        ].collect { |value_name| [value_name, !HOLDS_A_SECRET] }).freeze
+      ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
+        holds_a_secret ||= false
+        define_overridable_environment_based_value(method_name, holds_a_secret)
       end
       def board_controller

data/lib/tasks/version.rake CHANGED Viewed

@@ -29,7 +29,7 @@ end
 def amend_commit_to_include_gemfile_lock_changes
   puts "Amending commit to include Gemfile.lock update..."
   system("git add .")
-  system(%(git commit --amend --no-edit))
+  system("git commit --amend --no-edit")
 end
 namespace :version do

data/spec/jira/auto/tool/environment_loader_spec.rb CHANGED Viewed

@@ -5,6 +5,7 @@ require "rspec"
 module Jira
   module Auto
     class Tool
+      # rubocop:disable Metrics/ClassLength
       class EnvironmentLoader
         RSpec.describe EnvironmentLoader do
           let(:environment_loader) { described_class.new(tool, auto_setup: auto_setup) }
@@ -56,7 +57,7 @@ module Jira
           end
           describe "#tool_environment" do
-            let(:environment_keys) { %i[JIRA_HOST JIRA_USER JIRA_PASSWORD] }
+            let(:environment_keys) { %i[JIRA_SITE_URL JIRA_USERNAME JIRA_API_TOKEN] }
             before do
               allow(Environment).to receive(:constants).and_return(environment_keys)
@@ -64,14 +65,29 @@ module Jira
               environment_keys.each do |environment_key|
                 allow(ENV).to receive(:fetch).with(environment_key.to_s, nil).and_return("#{environment_key} value")
               end
+              allow(tool).to receive_messages(
+                jira_api_token_holds_a_secret?: true,
+                jira_site_url_holds_a_secret?: false,
+                jira_username_holds_a_secret?: false
+              )
             end
             it do
-              expect(environment_loader.tool_environment).to eq(
-                "JIRA_HOST" => "JIRA_HOST value",
-                "JIRA_USER" => "JIRA_USER value",
-                "JIRA_PASSWORD" => "JIRA_PASSWORD value"
-              )
+              expect(environment_loader.tool_environment)
+                .to eq(
+                  "JIRA_API_TOKEN" => "****",
+                  "JIRA_SITE_URL" => "JIRA_SITE_URL value",
+                  "JIRA_USERNAME" => "JIRA_USERNAME value"
+                )
+            end
+          end
+          describe "#environment_variable_holds_a_secret?" do
+            it "allows checking that the corresponding constant is a secret or not" do
+              allow(tool).to receive(:jira_api_token_holds_a_secret?).and_return(true)
+              expect(environment_loader).to be_environment_variable_holds_a_secret("JIRA_API_TOKEN")
             end
           end
@@ -132,10 +148,12 @@ module Jira
           end
           describe "#setup" do
-            it "sets up the value according to the configuration file content" do
-              allow(environment_loader).to receive_messages(file_path: "file_path")
+            before do
+              allow(environment_loader).to receive_messages(file_path: "path/to/config/file.yaml")
               allow(environment_loader).to receive_messages(config_file_content: "file_content")
+            end
+            it "sets up the value according to the configuration file content" do
               allow(YAML)
                 .to receive(:safe_load)
                 .with("file_content")
@@ -147,10 +165,25 @@ module Jira
               environment_loader.send(:setup)
             end
+            context "when the YAML parsing fails" do
+              it "generates an error message including the file name" do
+                allow(YAML).to receive(:safe_load)
+                  .with("file_content")
+                  .and_raise(RuntimeError, "could not find expected ':' at line 3 column 6)")
+                expect { environment_loader.send(:setup) }
+                  .to raise_error(RuntimeError, <<~EOEMSG
+                    path/to/config/file.yaml:188: failed to load with the following error:
+                    could not find expected ':' at line 3 column 6)
+                  EOEMSG
+                  )
+              end
+            end
           end
           describe "#config_file_content" do
-            let(:file_path) { "file_path" }
+            let(:file_path) { "path/to/config/file" }
             let(:file_content) do
               <<-YAML_ERB
                 ---
@@ -174,9 +207,31 @@ module Jira
             end
             it { expect(environment_loader.send(:config_file_content)).to eq(erb_result) }
+            context "when the ERB evaluation fails" do
+              let(:file_content) do
+                <<-YAML_ERB
+                  ---
+                  a_key: <%= 4*4 %>
+                  another_key: <%= 4*4 %>
+                  <%
+                  raise "An error that should be caught and reported!"#{" "}
+                  %>
+                YAML_ERB
+              end
+              it "generates an error message including the file name" do
+                expect { environment_loader.send(:config_file_content) }
+                  .to raise_error(RuntimeError, <<~EOEMSG)
+                    path/to/config/file:5: failed to load with the following error:
+                    An error that should be caught and reported!
+                  EOEMSG
+              end
+            end
           end
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/spec/jira/auto/tool/performer/planning_increment_sprint_creator_spec.rb CHANGED Viewed

@@ -33,27 +33,90 @@ module Jira
               end
             end
+            # rubocop:disable Naming/VariableNumber, RSpec/IndexedLet
             describe "#act_on_sprints_for_sprint_prefix" do
-              def get_sprint(name, attributes)
-                instance_double(Sprint, name: name, to_s: name, **attributes)
+              def get_sprint(name, attributes = {})
+                instance_double(Sprint, name: name, to_s: name, **attributes,
+                                        parsed_name: Sprint::Name.parse(name))
               end
-              let(:last_sprint) { get_sprint "Food_Delivery_25.2.1", end_date: "2025-02-16 12:45", length_in_days: 10 }
+              let(:sprint_prefix) do
+                instance_double(Sprint::Prefix, name: "Food_Delivery", last_sprint: last_sprint)
+              end
+              context "when the sprints to create are all posterior to the last sprint from a naming perspective" do
+                let(:last_sprint) do
+                  get_sprint "Food_Delivery_25.2.1", end_date: "2025-02-16 12:45", length_in_days: 10
+                end
+                let(:sprint_25_3_1) { get_sprint("Food_Delivery_25.3.1") }
+                let(:sprint_25_3_2) { get_sprint("Food_Delivery_25.3.2") }
+                let(:sprint_25_3_3) { get_sprint("Food_Delivery_25.3.3") }
+                let(:sprint_25_3_4) { get_sprint("Food_Delivery_25.3.4") }
+                before do
+                  allow(updater).to receive(:create_sprint_for).with(last_sprint,
+                                                                     "Food_Delivery_25.3.1")
+                                                               .and_return(sprint_25_3_1)
+                  allow(updater).to receive(:create_sprint_for).with(sprint_25_3_1, "Food_Delivery_25.3.2")
+                                                               .and_return(sprint_25_3_2)
+                  allow(updater).to receive(:create_sprint_for).with(sprint_25_3_2, "Food_Delivery_25.3.3")
+                                                               .and_return(sprint_25_3_3)
+                  allow(updater).to receive(:create_sprint_for).with(sprint_25_3_3, "Food_Delivery_25.3.4")
+                                                               .and_return(sprint_25_3_4)
+                end
+                it "creates the expected number of sprints with the expected names" do
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_1)
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_2)
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_3)
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_4)
+                  updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
+                end
+              end
+              context "when some sprints to create are anterior to the last sprint from a naming perspective" do
+                let(:last_sprint) do
+                  get_sprint "Food_Delivery_25.3.2", end_date: "2025-02-16 12:45", length_in_days: 10
+                end
+                let(:sprint_25_3_3) { get_sprint("Food_Delivery_25.3.3") }
+                let(:sprint_25_3_4) { get_sprint("Food_Delivery_25.3.4") }
+                before do
+                  allow(updater).to receive(:create_sprint_for).with(last_sprint, "Food_Delivery_25.3.3")
+                                                               .and_return(sprint_25_3_3)
+                  allow(updater).to receive(:create_sprint_for).with(sprint_25_3_3, "Food_Delivery_25.3.4")
+                                                               .and_return(sprint_25_3_4)
+                end
+                it "only creates the ones posterior to the last sprint" do
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_3)
+                  expect(sprint_prefix).to receive(:<<).with(sprint_25_3_4)
+                  updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
+                end
+              end
-              let(:sprint_prefix) { instance_double(Sprint::Prefix, name: "Food_Delivery", last_sprint: last_sprint) }
+              context "when requested sprints to create are anterior to the last sprint from a naming perspective" do
+                let(:last_sprint) do
+                  get_sprint "Food_Delivery_25.4.1", end_date: "2025-02-16 12:45", length_in_days: 10
+                end
-              # rubocop:disable RSpec/MultipleExpectations
-              it "creates the expected number of sprints with the expected names" do
-                expect(updater).to receive(:create_sprint_for).ordered.with(last_sprint, "Food_Delivery_25.3.1")
-                expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.2")
-                expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.3")
-                expect(updater).to receive(:create_sprint_for).ordered.with(nil, "Food_Delivery_25.3.4")
-                expect(sprint_prefix).to receive(:<<).exactly(4).times
+                it "does not create any since they would be anterior to the last sprint" do
+                  expect(updater).not_to receive(:create_sprint_for)
+                  expect(sprint_prefix).not_to receive(:<<)
-                updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
+                  updater.act_on_sprints_for_sprint_prefix(sprint_prefix)
+                end
               end
-              # rubocop:enable RSpec/MultipleExpectations
             end
+            # rubocop:enable Naming/VariableNumber, RSpec/IndexedLet
           end
         end
       end

data/spec/jira/auto/tool_spec.rb CHANGED Viewed

@@ -136,7 +136,7 @@ module Jira
         end
         # TODO: move that to environment_based_value_spec
-        RSpec.shared_examples "an overridable environment based value" do |method_name|
+        RSpec.shared_examples "an overridable environment based value" do |method_name, holds_a_secret_expectation|
           let(:env_var_name) { method_name.to_s.upcase }
           let(:method_name?) { :"#{method_name}_defined?" }
           let(:config) { Config.new(object_with_overridable_value) }
@@ -146,6 +146,13 @@ module Jira
             allow(config).to receive_messages(value_store: {})
           end
+          context "when dealing with sensitive information" do
+            it "defines a predicate informing about the value being a secret or not" do
+              expect(object_with_overridable_value.send("#{method_name}_holds_a_secret?"))
+                .to eq(holds_a_secret_expectation)
+            end
+          end
           context "when the environment variable is set" do
             let(:expected_value) { "#{env_var_name} env_value" }
@@ -222,11 +229,13 @@ module Jira
           end
         end
-        described_class::ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name|
-          describe "environment based values" do
+        described_class::ENVIRONMENT_BASED_VALUE_SYMBOLS.each do |method_name, holds_a_secret|
+          holds_a_secret ||= false
+          describe "environment based values - #{method_name} - holds_a_secret = #{holds_a_secret}}" do
             let(:object_with_overridable_value) { tool }
-            it_behaves_like "an overridable environment based value", method_name
+            it_behaves_like "an overridable environment based value", method_name, holds_a_secret
           end
         end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-auto-tool
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Christophe Broult
@@ -209,7 +209,6 @@ email:
 - cbroult@yahoo.com
 executables:
 - jira-auto-tool
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -223,13 +222,12 @@ files:
 - Rakefile
 - bin/jira-auto-tool
 - bin/jira-auto-tool.bat
-- bin/setup
-- bin/setup-dev-win.bat
 - config/examples/jira-auto-tool.env.yaml.erb
 - cucumber.yml
 - documentation/JiraToolClassDiagram.uml
 - documentation/class_diagram.md
 - documentation/principle.md
+- ext/no_wrappers_win.rb
 - features/align_sprint_time_in_dates.feature
 - features/assign_tickets_to_team_sprints.feature
 - features/cache_boards.feature

data/bin/setup DELETED Viewed

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-bundle install
-# Do any other automated setup that you need to do here

data/bin/setup-dev-win.bat DELETED Viewed

	@@ -1,3 +0,0 @@
1	-
2	-
3	- choco install act-cli