ruby-grafana-reporter 0.1.7 → 0.2.0

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

@@ -1,75 +1,78 @@
-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
+# 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,70 +1,73 @@
-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
+# 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,18 +1,20 @@
-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
+# 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,41 +1,43 @@
-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.to_s + '}+`' + ' | ' + v.to_s
-          end
-          vars << '|==='
-
-          reader.unshift_lines vars
-        end
-      end
-    end
-  end
-end
+# 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/sql_table_include_processor.rb

@@ -1,67 +1,70 @@
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   include::grafana_sql_table:<datasource_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
-      #
-      # +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
-      # +sql+ - sql statement (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +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 SqlTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_sql_table:'
-        end
-
-        # :nodoc:
-        def process(doc, reader, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
-          @report.logger.debug("Processing SqlTableIncludeProcessor (instance: #{instance}, datasource: #{target.split(':')[1]}, sql: #{attrs['sql']})")
-          query = SqlTableQuery.new(attrs['sql'], target.split(':')[1])
-          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
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # Implements the hook
+      #   include::grafana_sql_table:<datasource_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
+      #
+      # +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
+      # +sql+ - sql statement (*mandatory*)
+      #
+      # +instance+ - name of grafana instance, 'default' if not specified
+      #
+      # +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 SqlTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
+        include ProcessorMixin
+
+        # :nodoc:
+        def handles?(target)
+          target.start_with? 'grafana_sql_table:'
+        end
+
+        # :nodoc:
+        def process(doc, reader, target, attrs)
+          return if @report.cancel
+
+          @report.next_step
+          instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
+          @report.logger.debug("Processing SqlTableIncludeProcessor (instance: #{instance},"\
+                               " datasource: #{target.split(':')[1]}, sql: #{attrs['sql']})")
+          query = SqlTableQuery.new(attrs['sql'], target.split(':')[1])
+          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