RubyGems - sparkle_formation - Versions diffs - 3.0.36 → 3.0.38 - Mend

sparkle_formation 3.0.36 → 3.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +3 -0
data/bin/generate_sparkle_docs +3 -0
data/lib/sparkle_formation/provider/aws.rb +1 -1
data/lib/sparkle_formation/provider/azure.rb +1 -1
data/lib/sparkle_formation/provider/google.rb +1 -1
data/lib/sparkle_formation/provider/heat.rb +1 -1
data/lib/sparkle_formation/provider/terraform.rb +1 -1
data/lib/sparkle_formation/sparkle.rb +1 -1
data/lib/sparkle_formation/sparkle_attribute.rb +2 -2
data/lib/sparkle_formation/sparkle_attribute/aws.rb +1 -1
data/lib/sparkle_formation/sparkle_collection.rb +1 -1
data/lib/sparkle_formation/sparkle_formation.rb +18 -8
data/lib/sparkle_formation/sparkle_struct.rb +1 -1
data/lib/sparkle_formation/utils.rb +3 -3
data/lib/sparkle_formation/version.rb +1 -1
metadata +3 -4

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354d57e9781c395c6cecaedf6e80e602db3d29afc063dcd240bb82a19a9b6e13
-  data.tar.gz: 4b34ece3ddb9f5514d0a59ea4bfe74f8fe4dd9e763dd082b95b996283ef95a8a
+  metadata.gz: 50546ecd070328989d5938eeb94e73740158ccca0696f9ad774c3313bc747190
+  data.tar.gz: 86e63295a0ec22cea46785c60c0fbb2e07c55602ea442e67288f9513ccf0b6e8
 SHA512:
-  metadata.gz: cda465c5335a6092926f91b069b0e1745e76b54e59ea1786747e408e7b185304540a69a132eaaccb8482e54f37a4e70eeeb7258823f67b87427b579823b0c8ea
-  data.tar.gz: 628a65f847c332c73ee6bb8c4658901552adf6a94b60c49cb4dd1e1ac880c6904d0f7f80c704fe7b1fc7131e299c3d93018cd649f1b89082eb3239c444297b94
+  metadata.gz: fec18b30a1357b633a243967e3cf8177c739886d22be4ca1e1dbc3bd84a8e812e8d9af9b7a68878ebe8ee69e35bbd15037619032b47f3f6da74d2b99eb254bab
+  data.tar.gz: f2683788101c688649bed5178e939dd0372edaa5972c3616478a812585ae8471abfe3f69af3cb876061173f6f3bb7f9971b378c2763e97866fb948befc0795e3

data/CHANGELOG.md CHANGED

@@ -1,3 +1,6 @@
+# v3.0.38
+* Fix root template audit log setup
 # v3.0.36
 * Add audit log feature to record template construction

data/bin/generate_sparkle_docs CHANGED

@@ -49,4 +49,7 @@ File.open('doc/UserDocs/index.html', 'w') do |file|
   file.puts '<html><head><meta http-equiv="refresh" content="0; url=README.html" /></head></html>'
 end
+FileUtils.mkdir_p('doc/img')
+FileUtils.cp('img/sparkle-formation.png', 'doc/img/')
 puts 'done.'

data/lib/sparkle_formation/provider/aws.rb CHANGED

@@ -112,7 +112,7 @@ class SparkleFormation
       #
       # @param output_name [String] name of output
       # @param outputs [Hash] listing of outputs
-      # @reutrn [Hash] reference to output value (used for setting parameter)
+      # @return [Hash] reference to output value (used for setting parameter)
       def make_output_available(output_name, outputs)
         bubble_path = outputs[output_name].root_path - root_path
         drip_path = root_path - outputs[output_name].root_path

data/lib/sparkle_formation/provider/azure.rb CHANGED

@@ -92,7 +92,7 @@ class SparkleFormation
       #
       # @param output_name [String] name of output
       # @param outputs [Hash] listing of outputs
-      # @reutrn [Hash] reference to output value (used for setting parameter)
+      # @return [Hash] reference to output value (used for setting parameter)
       def make_output_available(output_name, outputs)
         bubble_path = outputs[output_name].root_path - root_path
         drip_path = root_path - outputs[output_name].root_path

data/lib/sparkle_formation/provider/google.rb CHANGED

@@ -156,7 +156,7 @@ class SparkleFormation
       # @param output_name [String] name of output
       # @param outputs [Hash] listing of outputs
       # @param source_stack [SparkleFormation] requesting stack
-      # @reutrn [Hash] reference to output value (used for setting parameter)
+      # @return [Hash] reference to output value (used for setting parameter)
       def make_output_available(output_name, outputs, source_stack)
         bubble_path = outputs[output_name].root_path - root_path
         drip_path = root_path - outputs[output_name].root_path

data/lib/sparkle_formation/provider/heat.rb CHANGED

@@ -76,7 +76,7 @@ class SparkleFormation
       #
       # @param output_name [String] name of output
       # @param outputs [Hash] listing of outputs
-      # @reutrn [Hash] reference to output value (used for setting parameter)
+      # @return [Hash] reference to output value (used for setting parameter)
       def make_output_available(output_name, outputs)
         bubble_path = outputs[output_name].root_path - root_path
         drip_path = root_path - outputs[output_name].root_path

data/lib/sparkle_formation/provider/terraform.rb CHANGED

@@ -111,7 +111,7 @@ class SparkleFormation
       # @param output_name [String] name of output
       # @param outputs [Hash] listing of outputs
       # @param source_stack [SparkleFormation] requesting stack
-      # @reutrn [Hash] reference to output value (used for setting parameter)
+      # @return [Hash] reference to output value (used for setting parameter)
       def make_output_available(output_name, outputs, source_stack)
         bubble_path = outputs[output_name].root_path - root_path
         drip_path = root_path - outputs[output_name].root_path

data/lib/sparkle_formation/sparkle.rb CHANGED

@@ -287,7 +287,7 @@ class SparkleFormation
     # @param name [String, Symbol] name of item
     # @param target_provider [String, Symbol] restrict to provider
     # @return [Smash] requested item
-    # @raises [NameError, Error::NotFound]
+    # @raise [NameError, Error::NotFound]
     def get(type, name, target_provider = nil)
       unless TYPES.keys.include?(type.to_s)
         raise NameError.new "Invalid type requested (#{type})! Valid types: #{TYPES.keys.join(", ")}"

data/lib/sparkle_formation/sparkle_attribute.rb CHANGED

@@ -94,7 +94,7 @@ class SparkleFormation
     #   @param options [Hash]
     #   @option options [String, Symbol] :provider override provider restriction when fetching dynamic
     #   @note All options are passed to dynamic with custom_name
-    # @yieldblock [new_struct] Provides newly inserted structure
+    # @yield [new_struct] Provides newly inserted structure
     # @yieldparam new_struct [SparkleStruct] newly inserted structure which can be modified
     # @yieldreturn [Object] discarded
     # @return [self]
@@ -132,7 +132,7 @@ class SparkleFormation
     #   @option options [Truthy, Falsey] :overwrite_name when set to true, will not include
     #     template name in resource name
     #   @option options [Hash] :parameters compile time parameter values to pass to nested template
-    # @yieldblock [new_struct] Provides newly inserted structure
+    # @yield [new_struct] Provides newly inserted structure
     # @yieldparam new_struct [SparkleStruct] newly inserted structure which can be modified
     # @yieldreturn [Object] discarded
     # @return [self]

data/lib/sparkle_formation/sparkle_attribute/aws.rb CHANGED

@@ -392,7 +392,7 @@ class SparkleFormation
       # Reference output value from nested stack
       #
       # @param stack_name [String, Symbol] logical resource name of stack
-      # @apram output_name [String, Symbol] stack output name
+      # @param output_name [String, Symbol] stack output name
       def _cf_stack_output(stack_name, output_name)
         _cf_attr(_process_key(stack_name), "Outputs.#{__attribute_key(output_name)}")
       end

data/lib/sparkle_formation/sparkle_collection.rb CHANGED

@@ -152,7 +152,7 @@ class SparkleFormation
     # @param name [String, Symbol] name of item
     # @param target_provider [String, Symbol] restrict to provider
     # @return [Smash] requested item
-    # @raises [NameError, Error::NotFound]
+    # @raise [NameError, Error::NotFound]
     def get(type, name, target_provider = nil)
       type_name = Sparkle::TYPES[type.to_s]
       unless type_name

data/lib/sparkle_formation/sparkle_formation.rb CHANGED

@@ -722,7 +722,7 @@ class SparkleFormation
   #
   # @param params [Hash] parameter set
   # @return [Hash] parameter set
-  # @raises [ArgumentError]
+  # @raise [ArgumentError]
   def set_generation_parameters!(params)
     params.each do |name, value|
       unless value.is_a?(Hash)
@@ -817,12 +817,22 @@ class SparkleFormation
         when Composition::Component
           if item.block
             if item.key == "__base__"
-              record = audit_log.push(
-                type: :template,
-                name: name,
-                location: item.block.source_location.first,
-                caller: [:template, 0],
-              ) if parent.nil?
+              if parent.nil?
+                record = audit_log.push(
+                  type: :template,
+                  name: name,
+                  location: item.block.source_location.first,
+                  caller: [:template, 0],
+                )
+                # NOTE: Move audit log records under new record's
+                # audit log. This allows components to be listed
+                # logically under the template record instead of
+                # at the same level.
+                record.audit_log.list.replace(audit_log.list)
+                record.audit_log.list.delete(record)
+                audit_log.list.clear
+                audit_log.list << record
+              end
             else
               record = audit_log.push(
                 type: :component,
@@ -1004,7 +1014,7 @@ class SparkleFormation
   #
   # @param output_name [String] name of output
   # @param outputs [Hash] listing of outputs
-  # @reutrn [Hash] reference to output value (used for setting parameter)
+  # @return [Hash] reference to output value (used for setting parameter)
   def make_output_available(output_name, outputs)
     {}
   end

data/lib/sparkle_formation/sparkle_struct.rb CHANGED

@@ -170,7 +170,7 @@ class SparkleFormation
     #
     # @param arg [String, Symbol] name of parameter
     # @return [Object]
-    # @raises [ArgumentError]
+    # @raise [ArgumentError]
     def _state(arg)
       result = super
       if @self && result.nil?

data/lib/sparkle_formation/utils.rb CHANGED

@@ -11,7 +11,7 @@ class SparkleFormation
       # @param val [Object] value
       # @param types [Class, Array<Class>] valid types
       # @return [NilClass]
-      # @raises [TypeError]
+      # @raise [TypeError]
       def __t_check(val, types)
         types = [types] unless types.is_a?(Array)
         if types.none? { |t| val.is_a?(t) }
@@ -28,7 +28,7 @@ class SparkleFormation
       # Validate given value is String or Symbol type
       #
       # @return [NilClass]
-      # @raises [TypeError]
+      # @raise [TypeError]
       def __t_stringish(val)
         __t_check(val, [String, Symbol])
       end
@@ -36,7 +36,7 @@ class SparkleFormation
       # Validate given value is a Hash type
       #
       # @return [NilClass]
-      # @raises [TypeError]
+      # @raise [TypeError]
       def __t_hashish(val)
         __t_check(val, Hash)
       end

data/lib/sparkle_formation/version.rb CHANGED

@@ -1,5 +1,5 @@
 # Unicorns and rainbows
 class SparkleFormation
   # Current library version
-  VERSION = Gem::Version.new("3.0.36")
+  VERSION = Gem::Version.new("3.0.38")
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 3.0.36
+  version: 3.0.38
 platform: ruby
 authors:
 - Chris Roberts
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct
@@ -341,8 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key:
 specification_version: 4
 summary: Orchestration Template Generator