ruby-grafana-reporter 0.1.7 → 0.2.0

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

@@ -1,65 +1,66 @@
-module GrafanaReporter
-
-  module Asciidoctor
-    module Extensions
-
-      # Implements the hook
-      #   grafana_sql_value:<datasource_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
-      #
-      # +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 SqlValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_sql_value
-
-        # @see GrafanaReporter::Asciidoctor::SqlFirstValueQuery
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          @report.logger.debug("Processing SqlValueInlineMacro (instance: #{instance}, datasource: #{target}, sql: #{attrs['sql']})")
-          query = SqlFirstValueQuery.new(attrs['sql'], target)
-          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
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # Implements the hook
+      #   grafana_sql_value:<datasource_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
+      #
+      # +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 SqlValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+        include ProcessorMixin
+        use_dsl
+
+        named :grafana_sql_value
+
+        # @see GrafanaReporter::Asciidoctor::SqlFirstValueQuery
+        def process(parent, target, attrs)
+          return if @report.cancel
+
+          @report.next_step
+          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
+          @report.logger.debug("Processing SqlValueInlineMacro (instance: #{instance}, datasource: #{target},"\
+                               " sql: #{attrs['sql']})")
+          query = SqlFirstValueQuery.new(attrs['sql'], target)
+          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/value_as_variable_include_processor.rb

@@ -1,57 +1,61 @@
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # TODO: add documentation
-      class ValueAsVariableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_value_as_variable'
-        end
-
-        # :nodoc:
-        def process(doc, reader, target, attrs)
-          return if @report.cancel
-
-          # do NOT increase step, as this is done by sub processor
-          #@report.next_step
-
-          call_attr = attrs.delete('call')
-          call, target = call_attr.split(":") if call_attr
-          attribute = attrs.delete('variable_name')
-          @report.logger.debug("Processing ValueAsVariableIncludeProcessor (call: #{call}, target: #{target}, variable_name: #{attribute}, attrs: #{attrs.to_s})")
-          if not call or not attribute
-            @report.logger.error("Missing mandatory attribute 'call' or 'variable_name'.")
-            return reader
-          end
-
-          # TODO: remove dirty hack to allow the document as parameter for other processors
-          def doc.document
-            self
-          end
-          
-          # TODO: properly show error messages also in document
-          ext = doc.extensions.find_inline_macro_extension(call) if doc.extensions.inline_macros?
-          if not ext
-            @report.logger.error("Could not find inline macro extension for '#{call}'.")
-          else
-            @report.logger.debug("ValueAsVariableIncludeProcessor: Calling sub-method.")
-            item = ext.process_method.call(doc, target, attrs)
-            if not item.text.to_s.empty?
-	      result = ":#{attribute}: #{item.text}"
-              @report.logger.debug("ValueAsVariableIncludeProcessor: Adding '#{result}' to document.")
-              reader.unshift_line(result)
-            else
-              @report.logger.debug("ValueAsVariableIncludeProcessor: Not adding variable '#{attribute}', as query result was empty.")
-            end
-          end
-          
-          reader
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # TODO: add documentation
+      class ValueAsVariableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
+        include ProcessorMixin
+
+        # :nodoc:
+        def handles?(target)
+          target.start_with? 'grafana_value_as_variable'
+        end
+
+        # :nodoc:
+        def process(doc, reader, target, attrs)
+          return if @report.cancel
+
+          # do NOT increase step, as this is done by sub processor
+          # @report.next_step
+
+          call_attr = attrs.delete('call')
+          call, target = call_attr.split(':') if call_attr
+          attribute = attrs.delete('variable_name')
+          @report.logger.debug("Processing ValueAsVariableIncludeProcessor (call: #{call}, target: #{target},"\
+                               " variable_name: #{attribute}, attrs: #{attrs})")
+          if !call || !attribute
+            @report.logger.error("Missing mandatory attribute 'call' or 'variable_name'.")
+            return reader
+          end
+
+          # TODO: remove dirty hack to allow the document as parameter for other processors
+          def doc.document
+            self
+          end
+
+          # TODO: properly show error messages also in document
+          ext = doc.extensions.find_inline_macro_extension(call) if doc.extensions.inline_macros?
+          if !ext
+            @report.logger.error("Could not find inline macro extension for '#{call}'.")
+          else
+            @report.logger.debug('ValueAsVariableIncludeProcessor: Calling sub-method.')
+            item = ext.process_method.call(doc, target, attrs)
+            if !item.text.to_s.empty?
+              result = ":#{attribute}: #{item.text}"
+              @report.logger.debug("ValueAsVariableIncludeProcessor: Adding '#{result}' to document.")
+              reader.unshift_line(result)
+            else
+              @report.logger.debug("ValueAsVariableIncludeProcessor: Not adding variable '#{attribute}',"\
+                                   ' as query result was empty.')
+            end
+          end
+
+          reader
+        end
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_first_value_query.rb

@@ -1,32 +1,34 @@
-require_relative 'sql_first_value_query'
-
-module GrafanaReporter
-  module Asciidoctor
-    # (see SqlFirstValueQuery)
-    #
-    # The SQL query as well as the datasource configuration are thereby captured from a
-    # {Grafana::Panel}.
-    class PanelFirstValueQuery < SqlFirstValueQuery
-      include QueryMixin
-
-      # (see PanelTableQuery#initialize)
-      def initialize(panel, query_letter)
-        super(nil, nil)
-        @panel = panel
-        @query_letter = query_letter
-        extract_dashboard_variables(@panel.dashboard)
-      end
-
-      # (see PanelTableQuery#pre_process)
-      def pre_process(grafana)
-        @sql = @panel.query(@query_letter)
-        # resolve datasource name
-        @datasource = @panel.field('datasource')
-        @datasource_id = grafana.datasource_id(@datasource)
-        super(grafana)
-        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
-        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'sql_first_value_query'
+
+module GrafanaReporter
+  module Asciidoctor
+    # (see SqlFirstValueQuery)
+    #
+    # The SQL query as well as the datasource configuration are thereby captured from a
+    # {Grafana::Panel}.
+    class PanelFirstValueQuery < SqlFirstValueQuery
+      include QueryMixin
+
+      # (see PanelTableQuery#initialize)
+      def initialize(panel, query_letter)
+        super(nil, nil)
+        @panel = panel
+        @query_letter = query_letter
+        extract_dashboard_variables(@panel.dashboard)
+      end
+
+      # (see PanelTableQuery#pre_process)
+      def pre_process(grafana)
+        @sql = @panel.query(@query_letter)
+        # resolve datasource name
+        @datasource = @panel.field('datasource')
+        @datasource_id = grafana.datasource_id(@datasource)
+        super(grafana)
+        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
+        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_image_query.rb

@@ -1,23 +1,25 @@
-module GrafanaReporter
-  module Asciidoctor
-    # This class is used to create an image out of a {Grafana::Panel}.
-    class PanelImageQuery < Grafana::PanelImageQuery
-      include QueryMixin
-
-      # Sets the proper render variables.
-      def pre_process(grafana)
-        super
-        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
-        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
-        # rename "render-" variables
-        @variables.transform_keys! { |k| k.gsub(/^render-/, '') }
-      end
-
-      # Returns the body of the http query, which contains the raw image.
-      def post_process
-        super
-        @result = @result.body
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    # This class is used to create an image out of a {Grafana::Panel}.
+    class PanelImageQuery < Grafana::PanelImageQuery
+      include QueryMixin
+
+      # Sets the proper render variables.
+      def pre_process(grafana)
+        super
+        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
+        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
+        # rename "render-" variables
+        @variables.transform_keys! { |k| k.gsub(/^render-/, '') }
+      end
+
+      # Returns the body of the http query, which contains the raw image.
+      def post_process
+        super
+        @result = @result.body
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_property_query.rb

@@ -1,43 +1,44 @@
-module GrafanaReporter
-  module Asciidoctor
-    # This class is used to query properties from a {Grafana::Panel}, such as +description+,
-    # +title+ etc.
-    class PanelPropertyQuery < ::Grafana::AbstractPanelQuery
-      include QueryMixin
-
-      # @param panel [Grafana::Panel] panel object, for which the property shall be retrieved
-      # @param property [String] queried property, e.g. +title+
-      def initialize(panel, property)
-        super(panel)
-        @property = property
-      end
-
-
-      # Overrides the default method, as the query does not have to run against a SQL table,
-      # but rather against the panel model.
-      # @param grafana [Grafana::Grafana] grafana instance against which the panel property is queried
-      # @return [String] fetched property
-      def execute(grafana)
-        return @result unless @result.nil?
-
-        pre_process(grafana)
-        @result = panel.field(@property)
-        post_process
-        @result
-
-# TODO handle text (markdown and similar) properly
-      end
-
-      # Prepare query. Mainly here nothing special has to take place.
-      def pre_process(_grafana)
-        @from = nil
-        @to = nil
-      end
-
-      # Replaces variables in the property field, if any are available.
-      def post_process
-        @result = replace_variables(@result, grafana_variables)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    # This class is used to query properties from a {Grafana::Panel}, such as +description+,
+    # +title+ etc.
+    class PanelPropertyQuery < ::Grafana::AbstractPanelQuery
+      include QueryMixin
+
+      # @param panel [Grafana::Panel] panel object, for which the property shall be retrieved
+      # @param property [String] queried property, e.g. +title+
+      def initialize(panel, property)
+        super(panel)
+        @property = property
+      end
+
+      # Overrides the default method, as the query does not have to run against a SQL table,
+      # but rather against the panel model.
+      # @param grafana [Grafana::Grafana] grafana instance against which the panel property is queried
+      # @return [String] fetched property
+      def execute(grafana)
+        return @result unless @result.nil?
+
+        pre_process(grafana)
+        @result = panel.field(@property)
+        post_process
+        @result
+
+        # TODO: handle text (markdown and similar) properly
+      end
+
+      # Prepare query. Mainly here nothing special has to take place.
+      def pre_process(_grafana)
+        @from = nil
+        @to = nil
+      end
+
+      # Replaces variables in the property field, if any are available.
+      def post_process
+        @result = replace_variables(@result, grafana_variables)
+      end
+    end
+  end
+end