tefoji 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9bb72bd908fda02253da35856c56dd5aa0c889af3abcdb5bfea31b329563bee
-  data.tar.gz: 8e50beef2605dec8298ede53aca85413e5dd547ea911bafcbb38a7968a7b93b4
+  metadata.gz: 427d2dac516388b9bfe1db4ce55a164621c0530d30a9a79ce322fe098372d3a4
+  data.tar.gz: 756adc133f20f25d43f422149df86e17c685a741c10801150092ffd633265bf6
 SHA512:
-  metadata.gz: cfa17bc65afb628477b49ebbcb383bd6f1864acea598a6333751ffb1327895bd427f5c03e38f0d8f4fd622afaf5854ebd4b097f3cf96fba976086e2831f4527f
-  data.tar.gz: 857c3522c6397462163b74257edd7a1c7f145399da45000ad95d941a4bf315bc6695f3a2935ad879dc78c729088e1f8f5335b7e7a72eca551c808ba03896fe31
+  metadata.gz: 42c08df5f8727ad1b052b780478d1f66022a35eb2148001f5576eb41874a6334028a91552f02729d526ff96b9c1774606c8cbdc8666e2f83289ae9663ff8ab01
+  data.tar.gz: 1eb096e1869ae3bcedfebb77aacd69b4241d9f0062625850cbd8b1f3ecc4b04325c8e12eaa114ad6083f084b65e59029e46e26cfe0628f31543f049a01730483

data/lib/tefoji.rb

@@ -18,6 +18,8 @@ module Tefoji
     include Logging
     include UserFunctions
 
+    attr_accessor :template_data, :jira_api
+
     # @param [Hash] user_options options provided by the user through the CLI.
     # @see CLI
     def initialize(user_options = {}, log_location = $stderr)
@@ -41,6 +43,7 @@ module Tefoji
       @feature_issue = nil
       @default_target_epic = nil
       @epic_security = nil
+      @deferral_data = {}
 
       # Logging
       @log_level = Logger::INFO
@@ -282,8 +285,6 @@ module Tefoji
       @jira_api.save_authentication(@jira_auth_file, @jira_cloud)
     end
 
-    private
-
     # Generate a feature, a list of epics, and associated issues
     def generate_feature_with_issues
       @feature_issue = generate_feature
@@ -300,7 +301,13 @@ module Tefoji
       feature = variable_substitute(feature_to_do)
       feature['type'] = JiraApi::ISSUE_NEW_FEATURE
 
+      short_name = feature['short_name'] || feature['summary']
+
       @feature_issue = @jira_api.create_issue(feature, @jira_cloud)
+      @deferral_data[short_name.to_s] = {
+        'jira' => @feature_issue,
+        'raw' => feature
+      }
       @logger.info "Feature issue: #{@feature_issue['key']}"
       @feature_issue
     end
@@ -366,6 +373,10 @@ module Tefoji
         epic_issue['short_name'] = short_name
         @logger.info 'Epic: %16s [%s]' % [epic_issue['key'], short_name]
         @jira_api.link_issues(@feature_issue['key'], epic_issue['key']) if @feature_issue
+        @deferral_data[short_name.to_s] = {
+          'jira' => epic_issue,
+          'raw' => epic
+        }
         epic_issue
       end
     end
@@ -385,10 +396,6 @@ module Tefoji
     # Iterate through all issues in the template, creating each one in Jira.
     # Link the issues back to their epic, if required
     def generate_ordinary_issues
-      # Need to keep a map of tefoji data and associated responses from Jira to perform
-      # deferred updates, like blocked_by or watchers
-      deferral_data = {}
-
       issue_defaults = {}
       if @template_data.key?('issue_defaults')
         issue_defaults = variable_substitute(@template_data['issue_defaults'])
@@ -417,12 +424,12 @@ module Tefoji
 
         # deferral_data is kept to match the jira raw request data to the jira response data.
         # This is needed so that deferred actions (like 'blocked_by') can be correctly mapped.
-        deferral_data[raw_issue_data['short_name'].to_s] = {
+        @deferral_data[raw_issue_data['short_name'].to_s] = {
           'jira' => jira_issue,
           'raw' => raw_issue_data
         }
       end
-      process_deferred_updates(deferral_data)
+      process_deferred_updates
     end
 
     # Transform the tefoji issue data and tefoji issue_defaults into a hash that is ready to
@@ -538,16 +545,16 @@ module Tefoji
     #
     # @param deferral_data [Hash] raw template and jira response data
     # @see generate_ordinary_issues
-    def process_deferred_updates(deferral_data)
+    def process_deferred_updates
       ## Find deferred tags in the jira_epic_issues and do the required work
       deferred_tags.each do |deferred_tag|
         case deferred_tag
         when 'blocked_by'
-          process_blocked_by(deferral_data)
+          process_blocked_by
         when 'status'
-          process_status(deferral_data)
+          process_status
         when 'watchers'
-          process_watchers(deferral_data)
+          process_watchers
         else
           raise "Unimplemented deferred_tag: #{deferred_tag}"
         end
@@ -557,10 +564,10 @@ module Tefoji
     ## The process_* methods have repeated code. This could be cleaned up
     ## with some well-thought-through functional techniques. Since the list
     ## of methods is short, I'll pass on that for now.
-    def process_blocked_by(deferral_data)
+    def process_blocked_by
       deferred_tag = 'blocked_by'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
         next unless raw_issue_data.key?(deferred_tag)
@@ -568,10 +575,9 @@ module Tefoji
         target_issues = [raw_issue_data[deferred_tag].value].flatten
         target_issues.each do |target_issue_name|
           this_issue_key = jira_issue_data['key']
-
           # If we skipped creating the target issue because of a 'conditional',
           # don't try to link to it.
-          target_issue_key = deferral_data.dig(target_issue_name, 'jira', 'key')
+          target_issue_key = @deferral_data.dig(target_issue_name, 'jira', 'key')
           next if target_issue_key.nil?
 
           @jira_api.link_issues(target_issue_key, this_issue_key)
@@ -580,10 +586,10 @@ module Tefoji
       end
     end
 
-    def process_status(deferral_data)
+    def process_status
       deferred_tag = 'status'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
         next unless raw_issue_data.key?(deferred_tag)
@@ -600,10 +606,10 @@ module Tefoji
       end
     end
 
-    def process_watchers(deferral_data)
+    def process_watchers
       deferred_tag = 'watchers'
 
-      deferral_data.each_value do |deferral_hash|
+      @deferral_data.each_value do |deferral_hash|
         raw_issue_data = deferral_hash['raw']
         jira_issue_data = deferral_hash['jira']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tefoji
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug