inspec-reporter-flex 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 462241a08906f9500cc8ac2eff3d66cf9419d933b4166502dd35b5bc4445834c
-  data.tar.gz: c6aefa556b71a5ef91ce07f3d406c4f4dddedf16c89cd577919813aa4ce3fc26
+  metadata.gz: 4a3a407e8d18f6b3322ae80be9966b218b3e7c74afe5ba7cebf50b2888f2121a
+  data.tar.gz: 272924c807526f524a99805f2d6ffc2999d1fd8f6cfe138ee63baa56efaf4a20
 SHA512:
-  metadata.gz: ffc434833148c5c32706ebc64c479a94b05a673d1fb526ec6d4514c2ac549b542018ed7e0412f0304af4aeeb2205253ef68392a3f429679d6e7f66da9b26bb2c
-  data.tar.gz: a737d31db943e3755e73a695bf58030851d5191e0015b9dd84a2dbe993049f98f30669ba73c4ea700e49aa896a436883853854a069670d26d749e6d5aee8b835
+  metadata.gz: b59accab7656b4a910ad433b862d822d0bd7cb518f965c808ed93fed7288f54c8d8b7716cebca723afe9c7bb49df4a4eb30634b5dcc6c7f4f7691bb9c9a37cff
+  data.tar.gz: 77667735300b220f165cc89aa14835d3f2ace950c6801d8674e3f25e2cc96413a28634a3c643f7c998e5825aafdf88670e123fb190807ffa6d80b25a624fa6dc

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## v0.1.1
+
+- Add configurability via environment variable
+- Fix documentation and reporter to use `template_file`
+- Refactor to allow better testing
 
 ## v0.1.0
 

data/README.md

@@ -35,7 +35,7 @@ For example:
   "version": "1.2",
   "plugins": {
     "inspec-reporter-flex": {
-      "template_file":"template/markdown.rb"
+      "template_file": "template/markdown.erb"
     }
   }
 }
@@ -43,9 +43,9 @@ For example:
 
 See below all customization options available:
 
-| Option           |        Default       |   Description  |
-|------------------|:--------------------:|:--------------:|
-| `template_file`  | `templates/flex.erb` |  Name of the file for templating. Will look up in order "absolute path", "relative to current directory", "relative to gem directory" |
+| Option           |              Env Variable            |        Default       |  Description  |
+|------------------|:------------------------------------:|:--------------------:|---------------|
+| `template_file`  | `INSPEC_REPORTER_FLEX_TEMPLATE_FILE` | `templates/flex.erb` | Name of the file for templating. Will look up in order "absolute path", "relative to current directory", "relative to gem directory" |
 
 ## Writing Templates
 

data/lib/inspec-reporter-flex/mixin/file_resolver.rb

@@ -4,7 +4,7 @@ module InspecPlugins::FlexReporter
     #
     # @param [String] name Name or path of a file to resolve
     # @return [String] Absolute path to the file, if any
-    # @raise [RuntimeError] if file not found
+    # @raise [IOError] if file not found
     def resolve_path(name)
       if absolute_path?(name)
         name
@@ -13,7 +13,7 @@ module InspecPlugins::FlexReporter
       elsif gem_path?(name)
         gem_path(name)
       else
-        raise "Template file #{name} not found"
+        raise IOError, "Template file #{name} not found"
       end
     end
 

data/lib/inspec-reporter-flex/reporter.rb

@@ -8,9 +8,13 @@ module InspecPlugins::FlexReporter
     include InspecPlugins::FlexReporter::ErbHelpers
     include InspecPlugins::FlexReporter::FileResolver
 
+    ENV_PREFIX = "INSPEC_REPORTER_FLEX_".freeze
+
+    attr_writer :config, :env, :inspec_config, :logger
+
     # Render report
     def render
-      template_file = resolve_path(config["template"])
+      template_file = resolve_path(config["template_file"])
       template = ERB.new(File.read(template_file))
 
       # Use JSON Reporter base's `report` to have pre-processed data
@@ -58,10 +62,44 @@ module InspecPlugins::FlexReporter
 
       # Defaults
       @config = {
-        "template" => "templates/flex.erb",
+        "template_file" => "templates/flex.erb",
       }
 
-      @config.merge! Inspec::Config.cached.fetch_plugin_config("inspec-reporter-flex")
+      @config.merge! inspec_config.fetch_plugin_config("inspec-reporter-flex")
+      @config.merge! config_environment
+
+      logger.debug format("Configuration: %<config>s", config: @config)
+
+      @config
+    end
+
+    # Allow (top-level) setting overrides from environment.
+    #
+    # @return [Hash] Configuration data from environment
+    def config_environment
+      env_reporter = env.select { |var, _| var.start_with?(ENV_PREFIX) }
+      env_reporter.transform_keys { |key| key.delete_prefix(ENV_PREFIX).downcase }
+    end
+
+    # Return environment variables.
+    #
+    # @return [Hash] Mapping of environment variables
+    def env
+      @env ||= ENV
+    end
+
+    # Return InSpec Config object.
+    #
+    # @return [Inspec::Config] The InSpec config object
+    def inspec_config
+      @inspec_config ||= Inspec::Config.cached
+    end
+
+    # Return InSpec logger.
+    #
+    # @return [Inspec:Log] The Logger object
+    def logger
+      @logger ||= Inspec::Log
     end
 
     # Return InSpec Runner for further inspection.

data/lib/inspec-reporter-flex/version.rb

@@ -1,5 +1,5 @@
 module InspecPlugins
   module FlexReporter
-    VERSION = "0.1.0".freeze
+    VERSION = "0.1.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inspec-reporter-flex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Thomas Heinen