dtk-dsl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6850c2038d1af4481513a9d06fdf9391d589241
+  data.tar.gz: 8ff25444f0f40e76ebcdab8672ead6a2d71e06b8
+SHA512:
+  metadata.gz: aa6414e6bc8f983c86f4416ce750c4d2754311e48bd6beabe22eab121e013a8326b1d487237f4c1baed66f46a00487a2c2a20aed3b7ad9e982a8336628c15b77
+  data.tar.gz: c843fe596c4c9d9ecd5f53d06eb5c612c374b736d1af3ddf2d76094a83c3821dcb68e439580ef22d8cfd8a34ab38d7db465e81f3b21a6d9e7c678d1fa804af5a

data/.byebug_history

@@ -0,0 +1,70 @@
+c
+s
+@valid_tags
+s
+c
+b 70
+c
+quit
+tag_split.size
+tag_split.split.size
+tag_split.split >= tag_type_split.size
+n
+ split(tag)
+ split(tag_type)
+pp [tag_type, tag]
+s
+n
+b 43
+compute_valid_tags
+s
+c
+b /tmp/t.rb:17
+c
+quit
+tag_split
+n
+ split(tag)
+c
+b 49
+c
+quit
+exit
+t.to_s.split(DELIMITER).map(&:to_sym)
+t.to_s.split(DELIMITER).map(to_sym)
+t.to_s.split(DELIMITER).map(&to_sym)
+t.to_s.split(DELIMITER).map { |x| x.to_sym}
+  t.to_s.split(DELIMITER).map(&to_sym)
+t.to_s.split(DELIMITER)
+t
+s
+pp tag
+c
+b 49
+c
+s
+ base_dsl_file_obj.file_type
+base_dsl_file_obj.path?
+n
+base_dsl_file_obj.path?
+s
+c
+b /home/cli/dtk-cli/lib/cli/context.rb:40
+c
+pp base_dsl_file_obj
+base_dsl_file_obj
+base_dsl_file_obj.path?
+s
+n
+s
+c
+b /home/cli/dtk-cli/lib/cli/directory_parser/file_system.rb:38
+c
+quit
+s
+c
+b /home/cli/.gem/ruby/2.0/gems/dtk-dsl-0.0.1/lib/dtk_dsl.rb:20
+n
+s
+n
+s

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+sftp-config*.json

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,2 @@
+# dtk-client2
+DTK client

data/dtk-dsl.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path('../lib/dsl/version', __FILE__)
+
+Gem::Specification.new do |spec| 
+  spec.name        = 'dtk-dsl' 
+  spec.version     = DTK::DSL::VERSION
+  spec.author      = 'Reactor8'
+  spec.email       = 'support@reactor8.com'
+  spec.description = %q{Library for parsing DT DSL files.}
+  spec.summary     = %q{Library for parsing DT DSL files.}
+  spec.license     = 'Apache 2.0'
+  spec.platform    = Gem::Platform::RUBY
+  spec.required_ruby_version = Gem::Requirement.new('>= 1.9.3')
+
+  spec.require_paths = ['lib']
+  spec.files =  `git ls-files`.split("\n")
+end

data/lib/dsl/directory_generator.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
+  # Abstract class; application that uses this library must provide a concrete class that inherits from this
+  class DirectoryGenerator
+    # Adds or modifies file; returns true if new file or any change
+    def self.add_file?(file_type, file_content, opts = {})
+      raise Error::NoMethodForConcreteClass.new(self.class)
+    end
+  end
+end

data/lib/dsl/directory_parser/path_info.rb

@@ -0,0 +1,62 @@
+#
+# 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 DirectoryParser    
+    class PathInfo
+      attr_reader :regexp, :depth, :base_dir
+      # opts can have keys
+      #  :depth - used for pruning when a git directory
+      def initialize(regexp_or_string, opts = {})
+        @regexp   = ret_regexp(regexp_or_string)
+        @depth    = opts[:depth]
+        @base_dir = opts[:base_dir]
+      end
+
+      # opts can have keys:
+      #  :exact - Booelan (default: false) - meaning regexp completely matches file_path
+      def matches?(file_path, opts = {})
+        self.class.matches?(file_path, @regexp, opts)
+      end
+      def self.matches?(file_path, regexp, opts = {})
+        if opts[:exact]
+          file_path =~ Regexp.new("^#{regexp.source}$")
+        else
+          # extra check to see if regexp is just for file part or has '/' seperators
+          if '/' =~ regexp
+            file_path.split('/').last =~ Regexp.new("^#{regexp.source}$")
+          else
+            file_path =~ Regexp.new("#{regexp.source}$")
+          end
+        end
+      end
+
+      private
+
+      def ret_regexp(regexp_or_string)
+        if regexp_or_string.kind_of?(String)
+          Regexp.new(regexp_or_string)
+        elsif regexp_or_string.kind_of?(Regexp)
+          regexp_or_string
+        else
+          raise Error, "Unexpected class '#{regexp_or_string.class}'"
+        end
+      end
+    end
+  end
+end

data/lib/dsl/directory_parser.rb

@@ -0,0 +1,33 @@
+#
+# 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
+  # Abstract class; application that uses this library must provide a concrete class that inherits from this
+  class DirectoryParser
+    require_relative('directory_parser/path_info')
+    # file_types - a single or array of FileObj objects
+    # opts can have keys
+    #   :file_path - string
+    #   :dir_path - string
+    # Returns  FileObj that matches a file_typeo bject that matches a file_type in file_types
+    #   or returns nil if no match found
+    def self.matching_file_obj?(file_types, opts = {})
+      raise Error::NoMethodForConcreteClass.new(self.class)
+    end
+  end
+end

data/lib/dsl/dsl_version.rb

@@ -0,0 +1,36 @@
+#
+# 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 refers to semnatic dsl version
+  class DSLVersion < ::String
+    DSL_VERSIONS = ['1.0.0']
+
+    def self.legal?(str)
+      DSL_VERSIONS.include?(str)
+    end 
+
+    def self.lataset
+      DSL_VERSIONS.last
+    end
+
+    def self.default
+      lataset
+    end
+  end
+end

data/lib/dsl/error/subclasses.rb

@@ -0,0 +1,38 @@
+#
+# 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
+  module DSL
+    class Error
+      class Usage < GlobalForDSL::ErrorUsage
+      end
+      
+      class NoMethodForConcreteClass < self
+        def initialize(klass)
+          method_string = caller[1]
+          method_ref =
+            if method_string =~ /`(.+)'$/
+              method = $1
+              " '#{method}'"
+            end
+          super("No method#{method_ref} for concrete class #{klass}")
+        end
+      end
+    end
+  end
+end
+

data/lib/dsl/error.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
+  module DSL
+    class Error < GlobalForDSL::Error
+      require_relative('error/subclasses')
+    end
+  end
+end

data/lib/dsl/file_generator/content_input/array.rb

@@ -0,0 +1,31 @@
+#
+# 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
+    class ContentInput
+      class Array < InputOutputCommon::Canonical::Array
+        include Mixin
+
+        def initialize(*args)
+          super
+          initialize_tags_and_id_handle!
+        end
+      end
+    end
+  end
+end

data/lib/dsl/file_generator/content_input/hash.rb

@@ -0,0 +1,53 @@
+#
+# 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
+    class ContentInput
+      class Hash < InputOutputCommon::Canonical::Hash
+        include Mixin
+
+        def initialize(*args)
+          super
+          initialize_tags_and_id_handle!
+        end
+
+        # opts can have keys
+        #  :tags
+        #  :tag
+        def set(output_key, val, opts = {})
+          ret = super(output_key, val)
+          tags = opts[:tag] || opts[:tags]
+          add_tags_to_obj?(ret, tags) unless tags.nil?
+          ret
+        end
+
+        # opts can have keys
+        #  :tag - tag to filter on
+        def val(output_key, opts = {})
+          ret = super(output_key)
+          if tag = opts[:tag]
+            ret = nil unless obj_has_tag?(ret, tag)
+          end
+          ret
+        end
+
+      end
+    end
+  end
+end
+

data/lib/dsl/file_generator/content_input/mixin.rb

@@ -0,0 +1,68 @@
+#
+# 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::ContentInput
+    # Mixin for tags and id_handle object attributes
+    module Mixin
+      attr_reader :tags
+      def initialize_tags_and_id_handle!
+        @tags      = []
+        @id_handle = nil
+      end
+
+      def set_id_handle(model_object)
+        @id_handle = model_object.id_handle
+      end
+      
+      def id_handle
+        @id_handle || raise(Error,"@id_handle is not set")
+      end
+        
+      def add_tags!(new_tags)
+        Tags.raise_error_if_invalid(new_tags)
+        new_tags = [new_tags] unless new_tags.kind_of?(::Array)
+        @tags += new_tags
+        @tags.uniq!
+        self
+      end
+
+      def add_tags?(new_tags)
+        add_tags!(new_tags) unless new_tags.nil? or new_tags.empty?
+      end
+      
+      def matches_tag_type?(tag_type)
+        !! @tags.find { |tag| Tags.matches_tag_type?(tag_type, tag) }
+      end
+
+      def add_tags_to_obj?(obj, new_tags) 
+        obj.add_tags!(new_tags) if obj.respond_to?(:add_tags!)
+        obj
+      end
+      
+      def obj_has_tag_type?(obj, tag_type)  
+        if obj.respond_to?(:matches_tag_type?)
+          obj.matches_tag_type?(tag_type)
+        else
+          # vacuously succeeds
+          true
+        end
+      end
+    end
+  end
+end
+

data/lib/dsl/file_generator/content_input/string.rb

@@ -0,0 +1,31 @@
+#
+# 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
+    class ContentInput
+      class String < ::String
+        include Mixin
+
+        def initialize(*args)
+          super
+          initialize_tags_and_id_handle!
+        end
+      end
+    end
+  end
+end

data/lib/dsl/file_generator/content_input/tags.rb

@@ -0,0 +1,87 @@
+#
+# 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::ContentInput
+    module Tags
+      #####
+      # In this module a 'tag_type' subsumes a tag and consitutes an element in BASE_LEVEL_TAGS or one its prefixes
+      #
+      DELIMITER = '__'
+      BASE_LEVEL_TAGS = 
+        [:desired__asserted, 
+         :desired__derived__default, 
+         :desired__derived__propagated, 
+         :actual,
+         :hidden
+        ]
+      
+      def self.matches_tag_type?(tag_type, tag)
+        tag_type_split = split(tag_type)
+        tag_split = split(tag)
+        if tag_split.size >= tag_type_split.size
+          tag_type_split.each_with_index do |tag_type_part, i|
+            return nil unless tag_type_part == tag_split[i]
+          end
+          true
+        end
+      end
+      
+      def self.valid?(tag_type)
+        valid_tag_types.include?(tag_type)
+      end
+      
+      def self.raise_error_if_invalid(tag_types)
+        tag_types = [tag_types] unless tag_types.kind_of?(::Array)
+        bad_tag_types = tag_types.select { |tag| !valid?(tag)}
+        unless bad_tag_types.empty?
+          err_msg = bad_tag_types.size == 1 ? "Invalid tag '#{bad_tag_types.first}'" : "Invalid tag_types: #{bad_tag_types.join(', ')}"
+          raise Error, err_msg
+        end
+      end
+      
+      private
+      
+      def self.valid_tag_types
+        @valid_tag_tag_types ||= compute_valid_tag_types
+      end
+      
+      # Iterates over BASE_LEVEL_TAGS and puts in prefixes
+      def self.compute_valid_tag_types
+        ret = []
+        BASE_LEVEL_TAGS.each do |tag|
+          tag_split = split(tag)
+          until tag_split.empty?
+            ret << join(tag_split)
+            tag_split.pop
+          end
+        end
+        ret.uniq
+      end 
+      
+      def self.split(t)
+        t.to_s.split(DELIMITER).map(&:to_sym)
+      end
+  
+      def self.join(t_split)
+        t_split.map(&:to_s).join(DELIMITER).to_sym
+      end
+
+    end
+  end
+end
+

data/lib/dsl/file_generator/content_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 FileGenerator
+    class ContentInput < InputOutputCommon::Canonical
+      require_relative('content_input/tags')
+      require_relative('content_input/mixin')
+      # mixin must go before the files below
+      require_relative('content_input/hash')
+      require_relative('content_input/array')
+      require_relative('content_input/string')
+    end
+  end
+end

data/lib/dsl/file_generator/yaml_object.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 FileGenerator
+    class YamlObject < InputOutputCommon
+      extend InputOutputCommon::OutputClassMixin
+    end
+  end
+end