dtk-dsl 1.0.0

data/lib/dsl/file_generator.rb

@@ -0,0 +1,39 @@
+#
+# 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 FileGenerator
+    require_relative('file_generator/content_input')
+    require_relative('file_generator/yaml_object')
+
+    # opts can have keys
+    #   :filter
+    def self.generate_yaml_object(parse_template_type, content_input, dsl_version, opts = {})
+      template_class = Template.template_class(parse_template_type, dsl_version)
+      template_class.create_for_generation(content_input, opts).generate_yaml_object
+    end
+
+    # opts can have keys
+    #   :filter
+    def self.generate_yaml_text(parse_template_type, content_input, dsl_version, opts = {})
+      template_class = Template.template_class(parse_template_type, dsl_version)
+      template_class.create_for_generation(content_input, opts).generate_yaml_text
+    end
+  end
+end
+

data/lib/dsl/file_obj.rb

@@ -0,0 +1,119 @@
+#
+# 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 FileObj
+    # opts can have keys
+    #  :dir_path
+    #  :current_dir
+    #  :content 
+    #  :file_parser - this is class
+    def initialize(file_type, file_path, opts = {})
+      @file_type         = file_type
+      @path              = file_path
+      @dir_path          = opts[:dir_path]
+      @current_dir       = opts[:current_dir]  
+      @content           = opts[:content]
+      @file_parser_class = opts[:file_parser] || FileParser
+      # below computed on demand
+      @parsed_templates = {}
+      @yaml_parse_hash = nil
+    end
+
+    attr_accessor :yaml_parse_hash    
+    attr_reader :file_type
+
+    # opts can have keys:
+    #  :dsl_version
+    def add_parse_content!(parse_template_type, opts = {})
+      parse_content(parse_template_type, opts)
+      self
+    end
+    def parse_content(parse_template_type, opts = {})
+      @parsed_templates[parse_template_type] ||= @file_parser_class.parse_content(parse_template_type, self, opts)
+    end
+
+    def content_or_raise_error
+      @content || raise(Error::Usage, error_msg_no_content)
+    end
+    def content
+      @content || raise(Error, 'Method should not be called if @content is nil')
+    end
+    def content?
+      @content 
+    end
+
+    def raise_error_if_no_content
+      raise(Error::Usage, error_msg_no_content) unless @content
+      self
+    end
+
+    def raise_error_if_no_content_flag(type)
+      raise(Error::Usage, error_msg_no_content_flag(type)) unless @content
+      self
+    end
+
+    def exists?
+      ! @content.nil?
+    end
+
+    def path?
+      @path
+    end
+
+    def hash_content?
+      @file_parser_class.yaml_parse!(self) if exists?
+    end
+
+    private
+
+    def error_msg_no_content
+      if @path
+        "No #{file_ref} found at '#{@path}'"
+      else
+        "Cannot find a #{file_ref} in the #{dir_ref} or ones nested under it"
+      end
+    end
+
+    def error_msg_no_content_flag(type)
+      type = type.to_s
+      type = type.slice!(0..(type.index('_')-1))
+      if @path
+        "No #{file_ref} found at '#{@path}'"
+      else
+        "Cannot find a #{type} #{file_ref} in the #{dir_ref}"
+      end
+    end
+
+    def file_ref
+      (@file_type && @file_type.print_name) || 'DSL file'
+    end
+
+    def dir_ref
+      if @dir_path 
+        "specified directory '#{@dir_path}'" 
+      elsif @current_dir
+        "current directory '#{@current_dir}'"
+      else
+        'directory'
+      end
+    end
+  end
+end
+
+
+

data/lib/dsl/file_parser/input/array.rb

@@ -0,0 +1,27 @@
+#
+# 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 FileParser
+    class Input
+      class Array < InputOutputCommon::Array 
+      end
+    end
+  end
+end
+
+

data/lib/dsl/file_parser/input/hash.rb

@@ -0,0 +1,40 @@
+#
+# 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 FileParser
+    class Input
+      class Hash < InputOutputCommon::Hash
+        def [](index)
+          super(internal_key_form(index))
+        end
+        
+        def only_has_keys?(*only_has_keys)
+          (keys - only_has_keys.map{ |k| internal_key_form(k) }).empty?
+        end
+        
+        private
+        
+        def internal_key_form(key)
+          key.to_s
+        end
+        
+      end
+    end
+  end
+end
+

data/lib/dsl/file_parser/input.rb

@@ -0,0 +1,29 @@
+#
+# 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 FileParser
+    class Input < InputOutputCommon
+      require_relative('input/hash')
+      require_relative('input/array')
+
+      def self.create(raw_input)
+        create_aux(obj_type(raw_input), raw_input)
+      end
+    end
+  end
+end

data/lib/dsl/file_parser/output.rb

@@ -0,0 +1,24 @@
+#
+# 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 FileParser
+    class Output < InputOutputCommon::Canonical
+      extend InputOutputCommon::OutputClassMixin
+    end
+  end
+end

data/lib/dsl/file_parser.rb

@@ -0,0 +1,71 @@
+#
+# 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.
+#
+
+require 'dtk_common_core'
+
+module DTK::DSL
+  class FileParser                   
+    require_relative('file_parser/input')
+    require_relative('file_parser/output')
+
+    # opts can have keys:
+    #  :dsl_version
+    def self.parse_content(parse_template_type, file_obj, opts = {})
+      ret = Output.create(:output_type => :hash)
+      return ret unless file_obj.content?
+
+      input_hash = yaml_parse!(file_obj)
+      dsl_version =  opts[:dsl_version] || dsl_version__raise_error_if_illegal(input_hash, file_obj)
+
+      # parsing with respect to the parse_template_type
+      template_class = Template.template_class(parse_template_type, dsl_version)
+      template_class.create_for_parsing(input_hash, :file_obj => file_obj).parse
+    end
+
+    def self.yaml_parse!(file_obj)
+      if file_obj.respond_to?(:yaml_parse_hash) 
+        if ret = file_obj.yaml_parse_hash
+          ret
+        else
+          file_obj.yaml_parse_hash = YamlHelper.parse(file_obj)
+        end
+      else
+        YamlHelper.parse(file_obj)
+      end
+    end
+
+    def self.file_ref_in_error(file_obj)
+      (file_obj && file_obj.path?) ? " in file #{file_obj.path?}" : ''
+    end
+    
+    private
+
+    DSL_VERSION_KEY = 'dsl_version'
+    def self.dsl_version__raise_error_if_illegal(input_hash, file_obj)
+      if dsl_version = input_hash[DSL_VERSION_KEY]
+        unless DSLVersion.legal?(dsl_version)
+          raise Error::Usage, "Illegal DSL version '#{dsl_version}'#{file_ref_in_error(file_obj)}"
+        end
+        DSLVersion.new(dsl_version)
+      else
+        DSLVersion.default
+      end
+    end
+  end
+end
+

data/lib/dsl/file_type.rb

@@ -0,0 +1,79 @@
+#
+# 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
+  # This has specific file type meta info
+  class FileType
+    Types = 
+      [
+       {
+         :type           => :common_module,
+         :regexp         => "/dtk\.module\.(yml|yaml)/",
+         :canonical_path => 'dtk.module.yaml', 
+         :backup_path    => 'dtk.module.bak.yaml', 
+         :print_name     => 'module DSL file'
+       },
+       {
+         :type           => :service_instance,
+         :regexp         => "/dtk\.service\.(yml|yaml)/",
+         :canonical_path => 'dtk.service.yaml', 
+         :backup_path    => 'dtk.service.bak.yaml', 
+         :print_name     => 'service DSL file'
+       }
+      ]
+      # regexps purposely do not have ^ or $ so calling function can insert these depending on context
+
+    Types.each do |type_info|
+      # convert to camel case
+      class_name = type_info[:type].to_s.gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1')
+      class_eval("
+         class #{class_name} < self
+           def self.type
+             :#{type_info[:type]}
+           end
+           def self.print_name
+             '#{type_info[:print_name]}'
+           end
+           def self.canonical_path
+             '#{type_info[:canonical_path]}'
+           end
+           def self.backup_path
+             '#{type_info[:backup_path]}'
+           end
+
+           private
+
+           def self.regexp
+             #{type_info[:regexp]}
+           end
+        end")
+    end
+
+    def self.create_path_info
+      DirectoryParser::PathInfo.new(regexp)
+    end
+    
+    # opts can have keys:
+    #  :exact - Booelan (default: false) - meaning regexp completely matches file_path
+    def self.matches?(file_path, opts = {})
+      DirectoryParser::PathInfo.matches?(file_path, regexp, opts)
+    end
+  end
+end
+
+

data/lib/dsl/input_output_common/array.rb

@@ -0,0 +1,43 @@
+#
+# 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 InputOutputCommon
+    class Array < ::Array
+      def initialize(parent_class, array = nil)
+        array.each { |el| self << reify(parent_class, el) } if array
+      end
+
+      private
+
+      def reify(parent_class, obj)
+        if obj.kind_of?(self.class)
+          obj
+        elsif obj.kind_of?(::Array)
+          inject(self.class.new(parent_class)) { |a, el| a << reify(parent_class, el) }
+        elsif obj.kind_of?(::Hash)
+          parent_class::Hash.new(parent_class, obj)
+        else
+          obj
+        end
+      end
+
+    end
+  end
+end
+
+

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

@@ -0,0 +1,27 @@
+#
+# 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 InputOutputCommon
+    class Canonical
+      class Array < InputOutputCommon::Array 
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,69 @@
+#
+# 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 InputOutputCommon
+    class Canonical
+      class Hash < InputOutputCommon::Hash
+        def initialize(*args)
+          super
+        end
+
+        def set(output_key, val)
+          self[canonical_key_form_from_output_key(output_key)] = val
+        end
+
+        def set?(output_key, val)
+          set(output_key, val) unless val.nil?
+        end
+        
+        # value at index output_key
+        def val(output_key)
+          ret = nil
+          possible_key_forms_from_output_key(output_key).each do |internal_index|
+            return self[internal_index] if has_key?(internal_index)
+          end
+          ret
+        end
+        
+        # required that value at index is non nil
+        def req(output_key)
+          ret = val(output_key)
+          if ret.nil?
+            raise Error, "Unexpected nil value for output key '#{output_key}'"
+          else
+            ret
+          end
+        end
+        
+        private
+        
+        def canonical_key_form_from_output_key(output_key)
+          HashKey.index(output_key)
+        end
+        
+        # TODO: after converting so that all accessed keys are in canonical_key_form
+        # then can have do away with this method
+        def possible_key_forms_from_output_key(output_key)
+          key = canonical_key_form_from_output_key(output_key)
+          [key.to_s, key.to_sym]
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,54 @@
+#
+# 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 InputOutputCommon::Canonical
+    module HashKey
+      # Top level for common module
+      DSLVersion       = :dsl_version
+      Assemblies       = :assemblies
+      DependentModules = :dependent_modules
+      ModuleRef        = :module
+
+      # Top level for Service Instance
+      Assembly = :asssembly
+
+      # Used in assembly
+      Components = :components
+      Workflows  = :workflows
+
+      # Used at multiple levels
+      Name          = :name
+      Description   = :description
+      Namespace     = :namespace
+      ModuleName    = :module_name
+      ModuleVersion = :version
+      Attributes    = :attributes
+      Value         = :value
+      Nodes         = :nodes
+
+      def self.index(output_key)
+        begin
+          const_get(output_key.to_s)
+        rescue
+          raise Error, "Illegal output hash key '#{output_key}'"
+        end
+      end
+    end
+  end
+end
+

data/lib/dsl/input_output_common/canonical.rb

@@ -0,0 +1,28 @@
+#
+# 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 InputOutputCommon
+    # Canonical form that during parsing is form passed to client or server
+    # for generation, this is form that client or server writes to which then leads to generation
+    class Canonical < self
+      require_relative('canonical/hash_key')
+      require_relative('canonical/hash')
+      require_relative('canonical/array')
+    end
+  end
+end