sparkle_formation 3.0.22 → 3.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5859104b23538649891d59cfbb13e0074559def6
-  data.tar.gz: 8cd95968b6fe6a2d959ad896675dd88d32700574
+  metadata.gz: 7f10d97f5400c05205b7164247b875d778ae0491
+  data.tar.gz: 6b3dd43d3cbd5a63117f03c7241bb47cc1fa3926
 SHA512:
-  metadata.gz: 8ed5c62ff322bb1ca0234c6d46953f8150ff93f22227b3f93ecb35597bdb65908877c441252847f0204c9e5fb6f082731ae39fe2d60b674de7e68642bd16ddf6
-  data.tar.gz: b2faee5e3a49d2148798a75763281a134b3a7382e57196576e5a4721b0fa2975e439b21727c746e15469f29c686592531f3efb95930416f6fba8f809dc8e99ae
+  metadata.gz: d7aafb751e1c143ac1e19fbb2b18965f66a7d7b92d6d5254495dc05603462bec8359d0866f7be643bb5603106e9be2352fd627e6669f13873d27c0d0e27a2dc6
+  data.tar.gz: 12e0402332fd2b41605847be8c10243648203a3e8d63facfe230cd86a3660f8e9a4335c9e51f76c4466a93e322f18ebd2fc5c43afcc3e69d51cc077a1ceb0e58

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v3.0.24
+* Update value storage to handle FunctionStruct usage
+* Add Complex data type to allowed compile time parameter types
+
 # v3.0.22
 * Add support for non-string like data keys (#217)
 * Customize compile time parameter setting (#218)

data/docs/compile-time-parameters.md

@@ -53,7 +53,7 @@ defining options for the parameter. The available items within the option
 |-----------------------|-------------|-----------------------------------------
 | `:type`               | Description | Data type of parameter
 |                       | Required    | yes
-|                       | Valid       | `:number`, `:string`
+|                       | Valid       | `:number`, `:string`, `:complex`
 |                       | Default     | none
 |-----------------------|-------------|-----------------------------------------
 | `:description`        | Description | Description of the parameter
@@ -140,6 +140,28 @@ The resulting value when accessed will be:
 ]
 ~~~
 
+##### Complex type support
+
+Complex types are supported but should rarely be used. Defining these types of compile
+time parameters impose restrictions on templates and make them much less flexible. However,
+there may be cases where providing a complex type to a template is ideal. It is important to
+note these restrictions:
+
+* No `:multiple` support
+* No user defined input via sfn CLI
+* No template serialization
+
+The last restriction is extremely important. Compile time parameters are stored in a template's
+outputs. This is done to support template reprocessing and change detection. Complex types are
+not stored within the template output due to the fragility introduced by the dependency on the
+complex type to properly serialize itself. The size of the serialization is also a concern which
+can easily invalidate a template due to size restrictions given a sufficiently complex type.
+
+In general complex types should never be used. Given a situation where complex types may seem
+like the correct solution, re-evaluate the usage and determine no other solution can be implemented
+to solve the problem. Compile time parameters already make templates less flexible and complex
+types increases this rigidity.
+
 ##### Prompting when nested
 
 The `:prompt_when_nested` is used by implementations to suppress parameter prompts

data/lib/sparkle_formation/sparkle_formation.rb

@@ -597,7 +597,7 @@ class SparkleFormation
     'max_value', 'min_value'
   ]
   # Allowed data types for parameters
-  VALID_GENERATION_PARAMETER_TYPES = ['String', 'Number']
+  VALID_GENERATION_PARAMETER_TYPES = ['String', 'Number', 'Complex']
 
   # Get or set the compile time parameter setting block. If a get
   # request the ancestor path will be searched to root
@@ -752,7 +752,13 @@ class SparkleFormation
   # @param compiled [AttributeStruct]
   # @return [AttributeStruct]
   def set_compiled_state(compiled)
-    compiled.outputs.compile_state.value MultiJson.dump(compile_state)
+    storage_compile_state = Smash.new
+    parameters.each do |param_key, param_config|
+      if(param_config.fetch(:type, 'string').to_s.downcase.to_sym != :complex)
+        storage_compile_state[param_key] = compile_state[param_key]
+      end
+    end
+    compiled.outputs.compile_state.value MultiJson.dump(storage_compile_state)
     compiled
   end
 

data/lib/sparkle_formation/sparkle_struct.rb

@@ -123,11 +123,15 @@ class SparkleFormation
       else
         sym = function_bubbler(sym)
       end
-      @table[sym] = function_bubbler(@table[sym])
       # Always reset parent in case this is a clone
       if(@table[sym].is_a?(::AttributeStruct))
-        @table[sym]._parent(self)
+        if(@table[sym]._parent.nil?)
+          @table[sym] = @table[sym]._clone
+        else
+          @table[sym]._parent(self)
+        end
       end
+      @table[sym] = function_bubbler(@table[sym])
       @table[sym]
     end
 

data/lib/sparkle_formation/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 3.0.22
+  version: 3.0.24
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct