ruby-grafana-reporter 0.2.2 → 0.4.3

data/lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   grafana_panel_image::<panel_id>[<options>]
-      #
-      # Stores the queried panel as a temporary image file and returns an asciidoctor link
-      # to be included in the report.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # == Supported options
-      # +field+ - property to query for, e.g. +description+ or +title+ (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +dashboard+ - uid of grafana dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      class PanelImageBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_panel_image
-
-        # :nodoc:
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
-          @report.logger.debug("Processing PanelImageBlockMacro (instance: #{instance}, dashboard: #{dashboard},"\
-                               " panel: #{target})")
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
-          query.merge_hash_variables(parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            image = query.execute(@report.grafana(instance))
-            image_path = @report.save_image_file(image)
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            return create_paragraph(parent, e.message, attrs)
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            return create_paragraph(parent, e.message, attrs)
-          end
-
-          attrs['target'] = image_path
-          create_image_block(parent, attrs)
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   grafana_panel_image:<panel_id>[<options>]
-      #
-      # Stores the queried panel as a temporary image file and returns an asciidoctor link
-      # to be included in the report.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # == Supported options
-      # +field+ - property to query for, e.g. +description+ or +title+ (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +dashboard+ - uid of grafana dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      class PanelImageInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_panel_image
-
-        # :nodoc:
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
-          @report.logger.debug("Processing PanelImageInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
-                               " panel: #{target})")
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
-          query.merge_hash_variables(parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            image = query.execute(@report.grafana(instance))
-            image_path = @report.save_image_file(image)
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            return create_inline(parent, :quoted, e.message)
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            return create_inline(parent, :quoted, e.message)
-          end
-
-          create_inline(parent, :image, nil, { target: image_path, attributes: attrs })
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   grafana_panel_property:<panel_id>[<options>]
-      #
-      # Returns the requested panel property.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
-      #
-      # == Supported options
-      # +field+ - property to query for, e.g. +description+ or +title+ (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +dashboard+ - uid of grafana dashboard to use
-      class PanelPropertyInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_panel_property
-        name_positional_attributes :field
-
-        # :nodoc:
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
-          @report.logger.debug("Processing PanelPropertyInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
-                               " panel: #{target}, property: #{attrs[:field]})")
-          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), attrs[:field])
-          query.merge_hash_variables(parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            description = query.execute(@report.grafana(instance))
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            return create_inline(parent, :quoted, e.message)
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            return create_inline(parent, :quoted, e.message)
-          end
-
-          # translate linebreaks to asciidoctor syntax
-          # and HTML encode to make sure, that HTML formattings are respected
-          create_inline(parent, :quoted, CGI.escapeHTML(description.gsub(%r{//[^\n]*(?:\n)?}, '').gsub(/\n/, " +\n")))
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   include::grafana_panel_query_table:<panel_id>[<options>]
-      #
-      # Returns the results of the SQL query as a asciidoctor table.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # All other variables starting with +var-+ will be used to replace grafana templating strings
-      # in the given SQL query.
-      #
-      # == Supported options
-      # +query+ - query letter, which shall be used, e.g. +C+ (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +dashboard+ - uid of grafana dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # +format+ - see {QueryMixin#format_columns}
-      #
-      # +replace_values+ - see {QueryMixin#replace_values}
-      #
-      # +filter_columns+ - see {QueryMixin#filter_columns}
-      class PanelQueryTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_panel_query_table:'
-        end
-
-        # :nodoc:
-        def process(doc, reader, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          panel_id = target.split(':')[1]
-          instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
-          dashboard = attrs['dashboard'] || doc.attr('grafana_default_dashboard')
-          @report.logger.debug("Processing PanelQueryTableIncludeProcessor (instance: #{instance}, "\
-                               "dashboard: #{dashboard}, panel: #{panel_id}, query: #{attrs['query']})")
-          query = PanelTableQuery.new(@report.grafana(instance).dashboard(dashboard).panel(panel_id), attrs['query'])
-          query.merge_hash_variables(doc.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            reader.unshift_lines query.execute(@report.grafana(instance))
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            reader.unshift_line "|#{e.message}"
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            reader.unshift_line "|#{e.message}"
-          end
-
-          reader
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   grafana_panel_query_value:<panel_id>[<options>]
-      #
-      # Returns the first value of the resulting SQL query.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # All other variables starting with +var-+ will be used to replace grafana templating strings
-      # in the given SQL query.
-      #
-      # == Supported options
-      # +query+ - query letter, which shall be used, e.g. +C+ (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +dashboard+ - uid of grafana dashboard to use
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # +format+ - see {QueryMixin#format_columns}
-      #
-      # +replace_values+ - see {QueryMixin#replace_values}
-      #
-      # +filter_columns+ - see {QueryMixin#filter_columns}
-      class PanelQueryValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_panel_query_value
-
-        # :nodoc:
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
-          @report.logger.debug("Processing PanelQueryValueInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
-                               " panel: #{target}, query: #{attrs['query']})")
-          query = PanelFirstValueQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), attrs['query'])
-          query.merge_hash_variables(parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            create_inline(parent, :quoted, query.execute(@report.grafana(instance)))
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            create_inline(parent, :quoted, e.message)
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            create_inline(parent, :quoted, e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    # The classes within this module implement the interface to asciidoctor. Each class implements a specific extension
-    # to asciidoctor.
-    module Extensions
-      # This module contains common methods for all asciidoctor extensions.
-      module ProcessorMixin
-        # Used when initializing a object instance, to set the report object, which is currently in progress.
-        # @param report [GrafanaReporter::Asciidoctor::Report] current report
-        # @return [::Asciidoctor::Extensions::Processor] self
-        def current_report(report)
-          @report = report
-          self
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   include::grafana_environment[]
-      #
-      # Shows all available variables, which are accessible during this run of the asciidoctor
-      # grafana reporter in a asciidoctor readable form.
-      #
-      # This processor is very helpful during report template design, to find out the available
-      # variables, that can be accessed.
-      #
-      # == Used document parameters
-      # All, to be listed as the available environment.
-      class ShowEnvironmentIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_environment'
-        end
-
-        # :nodoc:
-        def process(doc, reader, _target, _attrs)
-          # return if @report.cancel
-          @report.next_step
-          @report.logger.debug('Processing ShowEnvironmentIncludeProcessor')
-
-          vars = ['== Accessible Variables',
-                  '|===']
-          doc.attributes.sort.each do |k, v|
-            vars << "| `+{#{k}}+` | #{v}"
-          end
-          vars << '|==='
-
-          reader.unshift_lines vars
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb

@@ -1,30 +0,0 @@
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   include::grafana_help[]
-      #
-      # Shows all available options for the asciidoctor grafana reporter in a asciidoctor readable form.
-      #
-      # == Used document parameters
-      # None
-      class ShowHelpIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_help'
-        end
-
-        # :nodoc:
-        def process(_doc, reader, _target, _attrs)
-          # return if @report.cancel
-          @report.next_step
-          @report.logger.debug('Processing ShowHelpIncludeProcessor')
-
-          reader.unshift_lines Asciidoctor::Help.new.asciidoctor.split("\n")
-        end
-      end
-    end
-  end
-end