dtk-dsl 1.0.0 → 1.0.1

data/lib/dsl/input_output_common/canonical/hash.rb

@@ -49,7 +49,13 @@ module DTK::DSL
             ret
           end
         end
-        
+
+        def remove_all_except!(*output_keys)
+          matching_internal_indexes = output_keys.inject([]) { |a, k| a + possible_key_forms_from_output_key(k) }
+          keys.each { |internal_index| delete(internal_index) unless matching_internal_indexes.include?(internal_index) }
+          self
+        end
+
         private
         
         def canonical_key_form_from_output_key(output_key)

data/lib/dsl/input_output_common/canonical/hash_key.rb

@@ -28,9 +28,22 @@ module DTK::DSL
       Assembly = :asssembly
 
       # Used in assembly
-      Components = :components
       Workflows  = :workflows
 
+      # Used in nested module
+      Module = :module
+      Version = :version      
+
+      # Used in workflows
+      Subtasks          = :subtasks
+      SubtaskOrder      = :subtask_order
+      Node              = :node
+      ExecutionBlocks   = :exec_blocks
+      Flatten           = :flatten
+      Action            = :action
+      Actions           = :actions
+      OrderedComponents = :ordered_components     
+
       # Used at multiple levels
       Name          = :name
       Description   = :description
@@ -40,6 +53,12 @@ module DTK::DSL
       Attributes    = :attributes
       Value         = :value
       Nodes         = :nodes
+      Target        = :target
+      Components = :components
+
+      # meta info
+      Import                = :import
+      HiddenImportStatement = :hidden_import_statement
 
       def self.index(output_key)
         begin

data/lib/dsl/qualified_key.rb

@@ -18,6 +18,8 @@
 module DTK
   module DSL
     class QualifiedKey 
+      attr_reader :key_elements
+
       Element = Struct.new(:type, :key)
       def initialize(elements_to_copy = [])
         @key_elements = copy(elements_to_copy)

data/lib/dsl/template/constant_class_mixin.rb

@@ -20,13 +20,18 @@ module DTK::DSL
     # assumption is that where this included could have a Variations module
     module ClassMixin
       module Constant
-        def matches?(object, constant)
+        # opts can have keys:
+        #   :set_matching_key - if specified this wil be an empty array to add matching_key to
+        def matches?(object, constant, opts = {})
           unless object.nil?
             variations = variations(constant)
             if object.is_a?(Hash)
-              hash_value_of_matching_key?(object, variations)
+              if matching_key = hash_key_if_match?(object, variations)
+                opts[:set_matching_key] << matching_key if opts[:set_matching_key]
+                object[matching_key]
+              end
             elsif object.is_a?(String) || object.is_a?(Symbol)
-               variations.include?(object.to_s)
+              variations.include?(object.to_s)
             else
               fail Error.new("Unexpected object class (#{object.class})")
             end
@@ -79,12 +84,6 @@ module DTK::DSL
           variations.find { |key| hash.key?(key) }
         end
 
-        def hash_value_of_matching_key?(hash, variations)
-          if matching_key = hash_key_if_match?(hash, variations)
-            hash[matching_key]
-          end
-        end
-
       end
     end
   end

data/lib/dsl/template/generation/class_mixin.rb

@@ -27,11 +27,15 @@ module DTK::DSL
         private
 
         def generate_element(content, parent)
-          create_for_generation(content, :filter => parent.filter).generate_yaml_object
+          create_for_generation(content, generation_opts(parent)).generate_yaml_object
         end
 
         def generate_element?(content, parent)
-          create_for_generation(content, :filter => parent.filter).generate_yaml_object?
+          create_for_generation(content, generation_opts(parent)).generate_yaml_object?
+        end
+
+        def generation_opts(parent)
+          { :filter => parent.filter, :top => parent.top }
         end
 
       end

data/lib/dsl/template/generation/mixin.rb

@@ -29,18 +29,21 @@ module DTK::DSL
           generate!
         end
 
-        attr_reader :filter
+        attr_reader :filter, :top
 
         # opts can have keys
         #  :content (required)
         #  :filter
+        #  :top
         def generation_initialize(opts = {})
           unless content = opts[:content]
             raise Error, "Unexpected that opts[:content] is nil"
           end
           @content     = content
           @filter      = opts[:filter]
-          @yaml_object = empty_yaml_object(content)
+          @yaml_object = empty_yaml_object(content_input: content)
+          @top         = opts[:top] || self
+          generation_initialize_nested_dsl_files
         end
         private :generation_initialize
 
@@ -60,6 +63,13 @@ module DTK::DSL
           YamlHelper.generate(@yaml_object)
         end
 
+        # Array where each element has keys :path and :content
+        def generate_yaml_file_path__content_array(top_file_path)
+          self.generate!
+          [{ :path => top_file_path, :content => YamlHelper.generate(@yaml_object) }] + generate_nested_dsl_file_path__content_array
+        end
+
+
         # The methods yaml_object_type can be set on concrete class; it wil be set if input and output types are different
         def yaml_object_type
           nil
@@ -71,7 +81,7 @@ module DTK::DSL
           if content.nil?
             nil
           else
-            template_class(parse_template_type).create_for_generation(content, :filter => @filter).generate_yaml_object
+            template_class(parse_template_type).create_for_generation(content, :filter => @filter, :top => @top).generate_yaml_object
           end
         end
         
@@ -81,11 +91,16 @@ module DTK::DSL
           end
         end
 
-        def empty_yaml_object(content_input)
-          if self.yaml_object_type
-            FileGenerator::YamlObject.create(:output_type => yaml_object_type)
-          else
+        # opts can have keys
+        #  :content_input
+        #  :output_type
+        def empty_yaml_object(opts = {})
+          if output_type = opts[:output_type] || self.yaml_object_type
+            FileGenerator::YamlObject.create(:output_type => output_type)
+          elsif content_input = opts[:content_input]
             FileGenerator::YamlObject.create(:input => content_input)
+          else
+            raise Error, "If opts[:content_input] is nil, self.yaml_object_type or opts[:output_type] must have a value" 
           end
         end
 
@@ -99,32 +114,32 @@ module DTK::DSL
           obj.respond_to?(:empty?) and obj.empty?
         end
 
+        def generation_val(key)
+          @content.val(key)
+        end
+
+        def generation_req(key)
+          @content.req(key)
+        end
+
         def skip_for_generation?
           @content.skip_for_generation?
         end
 
         def generation_set(constant, val)
-          set_generation_hash(@yaml_object, constant, val)
-        end
-
-        def generation_set_scalar(scalar)
-          @yaml_object = scalar
+          set_generation_hash(select_yaml_object_or_nested_dsl_file, constant, val)
         end
 
         def generation_merge(hash)
-          @yaml_object.merge!(hash)
+          select_yaml_object_or_nested_dsl_file.merge!(hash)
         end        
 
         def generation_add(array_element)
-          @yaml_object << array_element
+          select_yaml_object_or_nested_dsl_file << array_element
         end
 
-        def generation_val(key)
-          @content.val(key)
-        end
-
-        def generation_req(key)
-          @content.req(key)
+        def generation_set_scalar(scalar)
+          @yaml_object = scalar
         end
 
       end

data/lib/dsl/template/loader.rb

@@ -52,7 +52,7 @@ module DTK::DSL
       def self.template_class_aux(template_type, template_version)
         base_class = Template.const_get("V#{template_version}")
         begin 
-          base_class.const_get(::DTK::Common::Aux.snake_to_camel_case(template_type.to_s))
+          base_class.const_get(Aux.snake_to_camel_case(template_type.to_s))
         rescue
           raise Error, "Invalid template_type '#{template_type}'"
         end

data/lib/dsl/template/nested_dsl_file/mixin.rb

@@ -0,0 +1,77 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module DTK::DSL
+  class Template
+    module NestedDSLFile
+      module Mixin
+        attr_reader :nested_file_content
+
+        private
+        def generation_initialize_nested_dsl_files
+          # If there iis any nested dsl in conetnt being generated then tese wil go on @nested_file_content
+          # which has keys that are relative paths and values being 
+          @nested_file_content = {}
+        end
+
+        def generate_nested_dsl_file_path__content_array
+          @nested_file_content.inject([]) do |a, (path, content)|
+            a + [{ :path => path, :content => YamlHelper.generate(content) }]
+          end
+        end
+
+        # returns the path of a file if @yaml_object should be written to a nested dsl file
+        def nested_dsl_file?
+          val(:Import)
+        end
+
+        def add_nested_dsl_file_import?(nested_dsl_file)
+          unless val(:HiddenImportStatement)
+            if @yaml_object.kind_of?(::Hash)
+              add_import_statement!(nested_dsl_file, @yaml_object)
+            elsif @yaml_object.kind_of?(::Array)
+              @yaml_object << add_import_statement!(nested_dsl_file)
+            else
+              raise Error, "Unexpected that @yaml_object is not a hash or array" 
+            end
+          end
+        end
+        
+        def add_import_statement!(nested_dsl_file, yaml_object = nil)
+          yaml_object ||= empty_yaml_object(:output_type => :hash)
+          set_generation_hash(yaml_object, :Import, nested_dsl_file)
+          yaml_object
+        end
+        
+        def select_yaml_object_or_nested_dsl_file
+          if nested_dsl_file = nested_dsl_file?
+            add_nested_dsl_file_import?(nested_dsl_file)
+            empty_nested_dsl_file_hash(nested_dsl_file, InputOutputCommon.obj_type(@yaml_object))
+          else
+            @yaml_object
+          end
+        end
+
+        def empty_nested_dsl_file_hash(nested_dsl_file, output_type)
+          @top.nested_file_content[nested_dsl_file] ||= empty_yaml_object(output_type: output_type) 
+        end
+
+      end
+    end
+  end
+end
+

data/lib/dsl/template/nested_dsl_file.rb

@@ -0,0 +1,25 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module DTK::DSL
+  class Template
+    module NestedDSLFile
+      require_relative('nested_dsl_file/mixin')
+    end
+  end
+end
+

data/lib/dsl/template/parsing/class_mixin.rb

@@ -29,9 +29,14 @@ module DTK::DSL
         def elements_collection_type
           nil
         end
-        
-        private
 
+        def file_parser_output_array
+          FileParser::Output.create(:output_type => :array)
+        end
+        
+        def file_parser_output_hash
+          FileParser::Output.create(:output_type => :hash)
+        end
 
         # opts can have keys
         #  :index
@@ -45,13 +50,7 @@ module DTK::DSL
           end
         end
 
-        def file_parser_output_array
-          FileParser::Output.create(:output_type => :array)
-        end
-        
-        def file_parser_output_hash
-          FileParser::Output.create(:output_type => :hash)
-        end
+        private
 
         def input_hash?(input)
           input.kind_of?(FileParser::Input::Hash)

data/lib/dsl/template/parsing/mixin.rb

@@ -54,6 +54,13 @@ module DTK::DSL
           nil
         end
 
+        # args can have form 
+        #  (:ParsingErrorName,*parsing_error_params) or
+        #  (*parsing_error_params)
+        def parsing_error(*args)
+          parsing_error_with_opts(args)
+        end
+
         private
         
         def empty_parser_output(input, parent_key)
@@ -67,6 +74,20 @@ module DTK::DSL
           end
         end
 
+        def remove_processed_keys_from_input_hash!(&body)
+          @found_keys = []
+          body.call
+          @found_keys.each { |key| input_hash.delete(key) }
+        end
+
+        def add_found_key?(key)
+          @found_keys << key if @found_keys
+        end
+
+        def file_parser_output_array
+          self.class.file_parser_output_array
+        end
+
         # opts can have key
         #   :key_type
         def parse_child_elements(parse_template_type, key_constant, opts = {})
@@ -105,7 +126,12 @@ module DTK::DSL
         end
         def input_key_value?(constant, opts = {})
           input_hash = opts[:input_hash] || input_hash()
-          constant_class.matches?(input_hash, constant)
+          set_matching_key = []
+          ret = constant_class.matches?(input_hash, constant, :set_matching_key => set_matching_key)
+          if matching_key = set_matching_key.first
+            add_found_key?(matching_key)
+          end
+          ret
         end
 
         # returns nil or {key => value}
@@ -114,6 +140,10 @@ module DTK::DSL
         def input_key_and_value?(constant, opts = {})
           input_hash = opts[:input_hash] || input_hash()
           constant_class.matching_key_and_value?(input_hash, constant)
+          if ret = constant_class.matching_key_and_value?(input_hash, constant)
+            add_found_key?(ret.keys.first)
+          end
+          ret
         end
 
         def parsing_set(constant, val)
@@ -179,13 +209,6 @@ module DTK::DSL
           raise parsing_error(:MissingKeyValue, key)
         end
 
-        # args can have form 
-        #  (:ParsingErrorName,*parsing_error_params) or
-        #  (*parsing_error_params)
-        def parsing_error(*args)
-          parsing_error_with_opts(args)
-        end
-
         # opts can have keys
         #   :key
         def parsing_error_with_opts(args, opts = {})

data/lib/dsl/template/v1/assembly.rb

@@ -28,6 +28,7 @@ class DTK::DSL::Template
         Attributes  = 'attributes'
         Nodes       = 'nodes'
         Components  = 'components'
+        Target      = 'target'
 
         Workflows   = 'workflows'
         Variations::Workflows = ['workflows', 'workflow']
@@ -49,28 +50,24 @@ class DTK::DSL::Template
       end
 
       def parse!
-        set  :Name, input_key_value(:Name)
-        set? :Description, input_key_value?(:Description)
-        set? :Attributes, parse_child_elements?(:attribute, :Attributes)
-        set? :Nodes, parse_child_elements?(:node, :Nodes)
-        set? :Components, parse_child_elements?(:component, :Components)
-        set? :Workflows, parse_child_elements?(:workflow, :Workflows)
-    
-        # TODO: This is a catchall that removes ones we so far are parsing and then has catch all
-        input_hash.delete('name')
-        input_hash.delete('description')
-        input_hash.delete('attributes')
-        input_hash.delete('nodes')
-        input_hash.delete('components')
-        input_hash.delete('workflow')
-        input_hash.delete('workflows')
-        merge input_hash
+        remove_processed_keys_from_input_hash! do
+          set  :Name, input_key_value(:Name)
+          set? :Description, input_key_value?(:Description)
+          set? :Target, input_key_value?(:Target)
+          set? :Attributes, parse_child_elements?(:attribute, :Attributes)
+          set? :Nodes, parse_child_elements?(:node, :Nodes)
+          set? :Components, parse_child_elements?(:component, :Components)
+          set? :Workflows, parse_child_elements?(:workflow, :Workflows)
+        end
+        # handle keys not processed
+         merge input_hash unless input_hash.empty?
       end
 
       ### For generation
       def generate!
         # TODO: add attributes
         set :Description, val(:Description)
+        set :Target, val(:Target)
         set :Components, generate_child_elements(:component, val(:Components))
         set :Nodes, generate_child_elements(:node, val(:Nodes))
         set :Workflows, generate_child_elements(:workflow, val(:Workflows))

data/lib/dsl/template/v1/common_module_summary.rb

@@ -32,7 +32,7 @@ class DTK::DSL::Template
       end
 
       def parse!
-        set :DSLVersion, input_key_value(:DSLVersion)
+        set :DSLVersion, input_key_value?(:DSLVersion) || dsl_version
         set :ModuleVersion, input_key_value(:ModuleVersion)
         merge parse_child(:module_ref, input_key_value(:Module), :parent_key => Constant::Module)
         set? :DependentModules, parse_child_elements?(:dependency, :DependentModules)

data/lib/dsl/template/v1/component.rb

@@ -42,7 +42,7 @@ module DTK::DSL
         
         def self.parse_elements(input_array, parent_info)
           input_array.inject(file_parser_output_hash) do |h, component|
-            name = name(component)
+            name = name(component, :parent => parent_info.parent)
             h.merge(name => parse_element(component, parent_info, :index => name))
           end
         end
@@ -85,18 +85,22 @@ module DTK::DSL
           ret
         end
         
-        def self.name(input)
+        # opts can have keys:
+        #  :parent
+        #  :this
+        # Will not have both keys
+        def self.name(input, opts = {})
           if input.kind_of?(::String)
             input
           elsif input.kind_of?(::Hash) and input.size > 0
             input.keys.first
           else
-            raise parsing_error(:WrongObjectType, input, [::String, ::Hash])
+            raise (opts[:this] || opts[:parent]).parsing_error([:WrongObjectType, input, [::String, ::Hash]])
           end
         end
         
         def name
-          self.class.name(@input)
+          self.class.name(@input, :this => self)
         end
         
         def parse_when_string!
@@ -104,14 +108,14 @@ module DTK::DSL
 
         def parse_when_hash!
           unless input_hash.size == 1 and input_hash.values.first.kind_of?(::Hash)
-            raise parsing_error("Component is ill-formed; it must be string or hash with has value")
+            raise parsing_error("Component is ill-formed; it must be string or hash")
           end
           properties = input_hash.values.first
           set? :Attributes, parse_child_elements?(:attribute, :Attributes, :input_hash => properties)
 
-          # TODO: This is a catchall that removes ones we so far are parsing and then has catch all
-          properties.delete('attributes')
-          merge properties
+          # handle keys not processed
+          properties.delete(Constant::Attributes)
+          merge properties unless properties.empty?
         end
 
       end

data/lib/dsl/template/v1/service_instance.rb

@@ -31,9 +31,11 @@ class DTK::DSL::Template
 
       ### For parsing
       def parse!
-        set :DSLVersion, input_key_value(:DSLVersion)
-        set :Name, input_key_value(:DSLVersion)
-        set? :DependentModules, input_key_value?(:DependentModules)
+        remove_processed_keys_from_input_hash! do
+          set :DSLVersion, input_key_value(:DSLVersion)
+          set :Name, input_key_value(:DSLVersion)
+          set? :DependentModules, input_key_value?(:DependentModules)
+        end
         merge parse_child(:assembly, input_hash)
       end