Add latest changes from gitlab-org/gitlab@13-9-stable-eev13.9.0-rc42

4 files changed, 149 insertions, 0 deletions

diff --git a/lib/gitlab/usage/docs/helper.rb b/lib/gitlab/usage/docs/helper.rb
new file mode 100644
index 00000000000..8483334800b
--- /dev/null
+++ b/lib/gitlab/usage/docs/helper.rb
@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Usage
+    module Docs
+      # Helper with functions to be used by HAML templates
+      module Helper
+        HEADER = %w(field value).freeze
+        SKIP_KEYS = %i(description).freeze
+
+        def auto_generated_comment
+          <<-MARKDOWN.strip_heredoc
+            ---
+            stage: Growth
+            group: Product Intelligence
+            info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+            ---
+
+            <!---
+              This documentation is auto generated by a script.
+
+              Please do not edit this file directly, check generate_metrics_dictionary task on lib/tasks/gitlab/usage_data.rake.
+            --->
+
+            <!-- vale gitlab.Spelling = NO -->
+          MARKDOWN
+        end
+
+        def render_name(name)
+          "## `#{name}`\n"
+        end
+
+        def render_description(object)
+          object.description
+        end
+
+        def render_attribute_row(key, value)
+          value = Gitlab::Usage::Docs::ValueFormatter.format(key, value)
+          table_row(["`#{key}`", value])
+        end
+
+        def render_attributes_table(object)
+          <<~MARKDOWN
+
+            #{table_row(HEADER)}
+            #{table_row(HEADER.map { '---' })}
+            #{table_value_rows(object.attributes)}
+          MARKDOWN
+        end
+
+        def table_value_rows(attributes)
+          attributes.reject { |k, _| k.in?(SKIP_KEYS) }.map do |key, value|
+            render_attribute_row(key, value)
+          end.join("\n")
+        end
+
+        def table_row(array)
+          "| #{array.join(' | ')} |"
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/usage/docs/renderer.rb b/lib/gitlab/usage/docs/renderer.rb
new file mode 100644
index 00000000000..7a7c58005bb
--- /dev/null
+++ b/lib/gitlab/usage/docs/renderer.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Usage
+    module Docs
+      class Renderer
+        include Gitlab::Usage::Docs::Helper
+        DICTIONARY_PATH = Rails.root.join('doc', 'development', 'usage_ping')
+        TEMPLATE_PATH = Rails.root.join('lib', 'gitlab', 'usage', 'docs', 'templates', 'default.md.haml')
+
+        def initialize(metrics_definitions)
+          @layout = Haml::Engine.new(File.read(TEMPLATE_PATH))
+          @metrics_definitions = metrics_definitions.sort
+        end
+
+        def contents
+          # Render and remove an extra trailing new line
+          @contents ||= @layout.render(self, metrics_definitions: @metrics_definitions).sub!(/\n(?=\Z)/, '')
+        end
+
+        def write
+          filename = DICTIONARY_PATH.join('dictionary.md').to_s
+
+          FileUtils.mkdir_p(DICTIONARY_PATH)
+          File.write(filename, contents)
+
+          filename
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/usage/docs/templates/default.md.haml b/lib/gitlab/usage/docs/templates/default.md.haml
new file mode 100644
index 00000000000..86e93be66c7
--- /dev/null
+++ b/lib/gitlab/usage/docs/templates/default.md.haml
@@ -0,0 +1,28 @@
+= auto_generated_comment
+
+:plain
+  # Metrics Dictionary
+
+  This file is autogenerated, please do not edit directly.
+
+  To generate these files from the GitLab repository, run:
+
+  ```shell
+  bundle exec rake gitlab:usage_data:generate_metrics_dictionary
+  ```
+
+  The Metrics Dictionary is based on the following metrics definition YAML files:
+
+  - [`config/metrics`]('https://gitlab.com/gitlab-org/gitlab/-/tree/master/config/metrics')
+  - [`ee/config/metrics`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/config/metrics)
+
+Each table includes a `milestone`, which corresponds to the GitLab version when the metric
+was released.
+\
+- metrics_definitions.each do |name, object|
+
+  = render_name(name)
+
+  = render_description(object)
+
+  = render_attributes_table(object)
diff --git a/lib/gitlab/usage/docs/value_formatter.rb b/lib/gitlab/usage/docs/value_formatter.rb
new file mode 100644
index 00000000000..a2dc9b081f8
--- /dev/null
+++ b/lib/gitlab/usage/docs/value_formatter.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Usage
+    module Docs
+      class ValueFormatter
+        def self.format(key, value)
+          case key
+          when :key_path
+            "**`#{value}`**"
+          when :data_source
+            value.to_s.capitalize
+          when :product_group
+            "`#{value}`"
+          when :introduced_by_url
+            "[Introduced by](#{value})"
+          when :distribution, :tier
+            Array(value).join(', ')
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end