gitlab_support_readiness 1.0.73 → 1.0.74

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46aedda90f84ce671f2d8d19160f07fd95a391659bdb9141d8c3e7f2b559e04
-  data.tar.gz: 746d13244c25e4dc918a3b3d85f262fb4affbd4e73e1cc305ea2a1220b005acf
+  metadata.gz: 6b3f87e5a80045ca0cd3f959d9e6b3e2afb6dfa08ae7e3954b9b73cb65fe1f03
+  data.tar.gz: 80d6535997df8341d0bb23dadb13b31057467197438d4ddfa805fe083b5fb4dd
 SHA512:
-  metadata.gz: cb42a7fea9bc27b6239bb376fcc2fdaa793c5b2615b115cfec1aad97fd9072a4bb0c72d6d6e0195084e13ff4ff4ace6dede4457ce646e3b305e6e9e46c9d2a15
-  data.tar.gz: 33a27e8f9ed7a7b507cdfd76cfafb4c2f1ac6b2cf9e995d1737c173ee18e81baf42b2f360bfb5230eb7005b59b4a1c144c683b2bbac86dbf5267b201883b1a70
+  metadata.gz: '0947da13e747aeff24ba01433326d3b3ef1a8e2a155a1669453b29da532b3a8aa116fc94c43de4ced83f188b5fed901511abe72e452f2d1309301f4dbd22def2'
+  data.tar.gz: b04699bb4fe318b9d4382767ca4e65516982c684d6503d1bc275b5dfa21169200469087d6856900df46f110f5caaa1add7a6029616ee3ce8b09c37c9c94b307a

data/lib/support_readiness/repos/dynamic_content.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Repos
+  module Repos
+    ##
+    # Defines the class DynamicContent within the module {Readiness::Repos}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.74
+    class DynamicContent < Readiness::Client
+      ##
+      # Compares the repo dynamic content files to the Zendesk instance dynamic content
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param zendesk_client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @param verbose [Boolean] Whether you want a detailed report or not
+      # @return [Hash]
+      def self.compare(zendesk_client, location = 'data', verbose = false)
+        @locales = Zendesk::Locales.list(zendesk_client)
+        @from_repo = gather(location)
+        @from_zendesk = Zendesk::DynamicContent.list(zendesk_client)
+        @diffs = {
+          item_creates: [],
+          item_updates: [],
+          variant_creates: [],
+          variant_updates: [],
+          variant_deletes: []
+        }
+        @from_repo.each do |repo|
+          zd = @from_zendesk.detect { |z| z.name == repo[:item].name }
+          if zd.nil?
+            @diffs[:item_creates].push(repo[:item])
+            repo[:variants].each do |v|
+              object = {
+                item: repo[:item].name,
+                variant: v
+              }
+              @diffs[:variant_creates].push(object)
+            end
+          else
+            comparable_zd = zd.dup
+            comparable_zd.id = nil
+            comparable_zd.outdated = nil
+            if to_clean_json(comparable_zd) != to_clean_json(repo[:item])
+              @diffs[:item_updates].push(item_update_object(repo[:item], zd))
+              detailed_diff(repo[:item], comparable_zd) if verbose
+            end
+            zd_variants = Readiness::Zendesk::DynamicContent.variants(zendesk_client, zd)
+            repo[:variants].each do |v|
+              zd_variant = zd_variants.detect { |z| z.locale_id == v.locale_id }
+              if zd_variant.nil?
+                object = {
+                  item: repo[:item].name,
+                  variant: v
+                }
+                @diffs[:variant_creates].push(object)
+              else
+                comparable_zd_variant = zd_variant.dup
+                comparable_zd_variant.id = nil
+                comparable_zd_variant.outdated = nil
+                if to_clean_json(comparable_zd_variant) != to_clean_json(v)
+                  @diffs[:variant_updates].push(variant_update_object(repo[:item], v, zd_variant))
+                  detailed_variant_diff(repo[:item], v, comparable_zd_variant) if verbose
+                end
+              end
+              zd_variants.each do |z|
+                unless repo[:variants].map { |v| v.locale_id }.include? z.locale_id
+                  object = {
+                    item: repo[:item].name,
+                    variant: z
+                  }
+                  @diffs[:variant_deletes].push(object)
+                end
+              end
+            end
+          end
+        end
+        report_diffs if verbose
+        @diffs
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      def self.report_diffs
+        puts 'Compare report:'
+        puts "- Item Creates:    #{@diffs[:item_creates].count}"
+        puts "- Item Updates:    #{@diffs[:item_updates].count}"
+        puts "- Variant Creates: #{@diffs[:variant_creates].count}"
+        puts "- Variant Updates: #{@diffs[:variant_updates].count}"
+        puts "- Variant Deletes: #{@diffs[:variant_deletes].count}"
+      end
+
+      ##
+      # Outputs a detailed comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param repo [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      def self.detailed_diff(repo, zendesk)
+        puts "Detailed diff of #{repo.name}"
+        repo.instance_variables.each do |v|
+          next if v == :@id
+
+          if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
+            puts "- #{v} Repo:"
+            pp repo.instance_variable_get(v)
+            puts "  #{v} Zendesk:"
+            pp zendesk.instance_variable_get(v)
+          end
+        end
+      end
+
+      ##
+      # Outputs a detailed comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param item [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      # @param repo [Object] An instance of {Readiness::Zendesk::DynamicContentVariants}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::DynamicContentVariants}
+      def self.detailed_variant_diff(item, repo, zendesk)
+        puts "Detailed diff of variant for '#{item.name}' with locale ID #{repo.locale_id}"
+        repo.instance_variables.each do |v|
+          next if v == :@id
+
+          if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
+            puts "- #{v} Repo:"
+            pp repo.instance_variable_get(v)
+            puts "  #{v} Zendesk:"
+            pp zendesk.instance_variable_get(v)
+          end
+        end
+      end
+
+      ##
+      # Creates an instance of {Readiness::Zendesk::DynamicContent} to use for updates
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param repo [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      # @return [Object]
+      def self.item_update_object(repo, zendesk)
+        object = repo
+        object.id = zendesk.id
+        object
+      end
+
+      ##
+      # Creates a Hash to use for updates
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param item [Object] An instance of {Readiness::Zendesk::DynamicContent}
+      # @param repo [Object] An instance of {Readiness::Zendesk::DynamicContentVariants}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::DynamicContentVariants}
+      # @return [Hash]
+      def self.variant_update_object(item, repo, zendesk)
+        object = {
+          item: item.name,
+          variant: repo
+        }
+        object[:variant].id = zendesk.id
+        object
+      end
+
+      ##
+      # Parses repo user field files
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @return [Array]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   repo = Readiness::Repos::DynamicContent.gather('data')
+      #   pp repo.count
+      #   # => 2
+      def self.gather(location)
+        @errors = []
+        @location = location
+        array = []
+        Dir["#{@location}/*.yaml"].each do |f|
+          object = YAML.safe_load_file(f)
+          data = {
+            item: Zendesk::DynamicContent.new(object),
+            variants: object['variants'].map { |v| Zendesk::DynamicContentVariants.new(v) }
+          }
+          array.push(data)
+        end
+        repo_check(array)
+        report_errors unless @errors.count.zero?
+        array
+      end
+
+      ##
+      # Outputs an error report and exits with a status code of 1
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      def self.report_errors
+        puts 'The following errors were found in the repo files:'
+        @errors.each do |e|
+          puts "- #{e}"
+        end
+        puts 'Rectify the errors and retry. We cannot proceed with those errors occurring.'
+        exit 1
+      end
+
+      ##
+      # Performs basic checks on the repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.74
+      # @param objects [Array] The Array of Hashes derived from parsing the repo files
+      def self.repo_check(objects)
+        duplicate_names = objects.map { |o| o[:item] }.group_by { |o| o.name }.select { |k, v| v.size > 1 }.map(&:first)
+        unless duplicate_names.count.zero?
+          duplicate_names.each do |d|
+            @errors.push("The item '#{d}' is used in multiple files")
+          end
+        end
+        objects.select { |o| o[:variants].count.zero? }.each do |o|
+          @errors.push("The item '#{o[:item].name}' has no variants")
+        end
+        objects.each do |o|
+          @errors.push("Bad default locale id for the item '#{o[:item].name}'") unless @locales.map { |l| l.id }.include? o[:item].default_locale_id
+          @errors.push("The item '#{o[:item].name}' has no default variant") unless o[:variants].detect { |v| v.default }
+          o[:variants].each_with_index do |v, i|
+            @errors.push("Variant #{i + 1} on item '#{o[:item].name}' has a bad locale") unless @locales.map { |l| l.id }.include? v.locale_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/support_readiness/repos.rb

@@ -9,6 +9,7 @@ module Readiness
   module Repos
     require "#{__dir__}/repos/articles"
     require "#{__dir__}/repos/automations"
+    require "#{__dir__}/repos/dynamic_content"
     require "#{__dir__}/repos/groups"
     require "#{__dir__}/repos/macros"
     require "#{__dir__}/repos/organization_fields"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.73
+  version: 1.0.74
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -292,6 +292,7 @@ files:
 - lib/support_readiness/repos.rb
 - lib/support_readiness/repos/articles.rb
 - lib/support_readiness/repos/automations.rb
+- lib/support_readiness/repos/dynamic_content.rb
 - lib/support_readiness/repos/groups.rb
 - lib/support_readiness/repos/macros.rb
 - lib/support_readiness/repos/organization_fields.rb