cloud-templates 0.2.0 → 0.3.0

data/lib/aws/templates/utils/dependency.rb

@@ -1,7 +1,4 @@
-require 'set'
-require 'aws/templates/utils/dependency/object'
-require 'aws/templates/utils/dependency/enumerable'
-require 'aws/templates/utils/inspectable'
+require 'aws/templates/utils'
 
 module Aws
   module Templates
@@ -16,7 +13,9 @@ module Aws
       # * Dependecy can be applied case-by-case basis whereas singleton is attached to the object
       #   itself
       class Dependency < BasicObject
-        include Inspectable
+        using Refinements
+
+        include ::Aws::Templates::Utils::Inspectable
 
         ##
         # Equality
@@ -56,6 +55,8 @@ module Aws
         attr_reader :object
         attr_reader :dependencies
 
+        alias not_a_dependency object
+
         ##
         # Redirect every method call to the proxied object if the object supports it
         def method_missing(name, *args, &block)
@@ -65,7 +66,7 @@ module Aws
         ##
         # It supports every method proxied object supports
         def respond_to_missing?(name, include_private = false)
-          object.respond_to?(name, include_private) || super(name, include_private)
+          object.respond_to?(name, include_private)
         end
 
         ##

data/lib/aws/templates/utils/dependency/refinements.rb

@@ -0,0 +1,80 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      class Dependency
+        ##
+        # Refinements for transparent dependecy handling
+        #
+        # Dependency mechanism requres transparent language support to work correctly with
+        # arbitrary objects and object collections. This refinement introduces methods used
+        # for dependency processing.
+        module Refinements
+          EMPTY_SET = ::Set.new.freeze
+
+          ##
+          # Dependency method stubs
+          #
+          # To avoid checking classes directly to filter out dependencies and non-dependencies,
+          # we're monkey-patching Object class with stubs for Dependency class.
+          refine ::Object do
+            # By default an object is not a dependency
+            def dependency?
+              false
+            end
+
+            # It returns self
+            def object
+              self
+            end
+
+            ##
+            # Object root
+            #
+            # It is used to gracefully process dependencies
+            def root; end
+
+            alias_method :not_a_dependency, :object
+
+            # it returns a set containing a single dependency on itself
+            def dependencies
+              EMPTY_SET
+            end
+
+            # mark the object as dependency
+            def as_a_dependency
+              Aws::Templates::Utils::Dependency.new(object)
+            end
+
+            # mark the object as dependency of itself
+            def as_a_self_dependency
+              as_a_dependency.to_self
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+##
+# Methods to be added to all collections
+#
+# NOTICE: We are not using refinements for it because of Ruby 2.3 support. This version doesn't
+#         support mixin-level refinements.
+module Enumerable
+  using Aws::Templates::Utils::Dependency::Refinements
+
+  def dependencies
+    # rubocop:disable Style/SymbolProc
+    # Refinements don't support dynamic dispatch yet. So, symbolic methods don't work
+    find_all { |obj| obj.dependency? }
+      .inject(::Set.new) { |acc, elem| acc.merge(elem.dependencies) }
+    # rubocop:enable Style/SymbolProc
+  end
+
+  def dependency?
+    true
+  end
+end

data/lib/aws/templates/utils/dependent.rb

@@ -1,5 +1,4 @@
-require 'aws/templates/utils/dependency/object'
-require 'set'
+require 'aws/templates/utils'
 
 module Aws
   module Templates
@@ -10,6 +9,8 @@ module Aws
       # Introduces methods needed to track dependencies of an object. The object needs to implement
       # options method and root method.
       module Dependent
+        using Utils::Dependency::Refinements
+
         ##
         # Introduce dependencies manually
         #
@@ -17,7 +18,9 @@ module Aws
         # of all dependencies automatically. If some dependency is not logical/parametrical but
         # purely chronological, it can be introduced into the dependency list with this method.
         def depends_on(*depends)
-          new_dependencies = depends.dependencies
+          new_dependencies = depends.map { |obj| obj.dependency? ? obj.dependencies : Set[obj] }
+                                    .reduce(&:merge)
+
           new_dependencies.select! { |obj| obj.root == root } unless root.nil?
           dependencies.merge(new_dependencies)
           self

data/lib/aws/templates/utils/guarded.rb

@@ -0,0 +1,30 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      ##
+      # Remember Alan Turing's halting problem and don't believe in miracles. The method will
+      # only work with parameters because they are supposed to be pure unmodifying functions.
+      # Hence we can terminate if a parameter method was invoked twice in the stack with the same
+      # context.
+      module Guarded
+        Call = Struct.new(:instance, :entity)
+
+        def guarded_for(instance, entity)
+          current_call = Call.new(instance, entity)
+          return unless trace.add?(current_call)
+          ret = yield
+          trace.delete(current_call)
+          ret
+        end
+
+        private
+
+        def trace
+          Thread.current[Guarded.name] ||= ::Set.new
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/inheritable.rb

@@ -1,3 +1,5 @@
+require 'aws/templates/utils'
+
 module Aws
   module Templates
     module Utils
@@ -11,14 +13,20 @@ module Aws
         # in every including module/class to expose appropriate module-level primitives for
         # handling inheritance of class-scope methods.
         module ClassMethods
-          DEFAULT_MODULE = Module.new.freeze
+          ##
+          # Empty class scope
+          #
+          # Identity class scope which contains nothing. Used as base case for class scope
+          # inheritance hierarchy.
+          module ClassScope
+          end
 
           ##
           # To add class methods also while including the module
           def included(base)
             super(base)
-            base.extend(Inheritable::ClassMethods)
-            base._merge_class_scope(class_scope || DEFAULT_MODULE)
+            base.extend(ClassMethods)
+            base.extend(ClassScope)
           end
 
           def instance_scope(&blk)
@@ -26,22 +34,19 @@ module Aws
           end
 
           def class_scope(&blk)
-            if blk
-              @class_scope.module_eval(&blk)
-              extend @class_scope
-            end
-
-            @class_scope
+            raise ScriptError.new('class_scope should have a block') if blk.nil?
+            _define_class_scope unless _class_scope_defined?
+            ClassScope.module_eval(&blk)
+            extend ClassScope
           end
 
-          def _merge_class_scope(mod)
-            if @class_scope.nil?
-              @class_scope = mod.dup
-            else
-              @class_scope.include(mod)
-            end
+          def _class_scope_defined?
+            @class_scope_defined || false
+          end
 
-            extend @class_scope
+          def _define_class_scope
+            const_set(:ClassScope, ClassScope.dup)
+            @class_scope_defined = true
           end
         end
 

data/lib/aws/templates/utils/inspectable.rb

@@ -1,3 +1,5 @@
+require 'aws/templates/utils'
+
 module Aws
   module Templates
     module Utils
@@ -8,13 +10,11 @@ module Aws
       # mechanism.
       module Inspectable
         def to_s
-          ::Kernel.require 'aws/templates/render/utils/stringify'
-          ::Aws::Templates::Render::Utils::Stringify.view_for(self).to_rendered
+          Render::Utils::Stringify.view_for(self).to_rendered
         end
 
         def inspect
-          ::Kernel.require 'aws/templates/render/utils/inspect'
-          ::Aws::Templates::Render::Utils::Inspect.view_for(self).to_rendered
+          Render::Utils::Inspect.view_for(self).to_rendered
         end
       end
     end

data/lib/aws/templates/utils/late_bound.rb

@@ -1,4 +1,4 @@
-require 'aws/templates/utils/inheritable'
+require 'aws/templates/utils'
 
 module Aws
   module Templates
@@ -12,7 +12,7 @@ module Aws
       #
       # The module provides DSL for creating late binding points known as References.
       module LateBound
-        include Inheritable
+        include Utils::Inheritable
 
         ##
         # Reference

data/lib/aws/templates/utils/memoized.rb

@@ -1,3 +1,5 @@
+require 'aws/templates/utils'
+
 module Aws
   module Templates
     module Utils

data/lib/aws/templates/utils/options.rb

@@ -1,13 +1,10 @@
-require 'set'
-require 'aws/templates/exceptions'
 require 'aws/templates/utils'
-require 'aws/templates/utils/memoized'
+
+# rubocop:disable Metrics/ClassLength
 
 module Aws
   module Templates
     module Utils
-      # rubocop:disable Metrics/ClassLength
-
       ##
       # Options hash-like class
       #
@@ -19,7 +16,15 @@ module Aws
       # select the best combination if it doesn't see the exact match
       # during lookup.
       class Options
-        include Memoized
+        using Utils::Contextualized::Refinements
+        using Utils::Dependency::Refinements
+
+        include Utils::Memoized
+        include Templates::Exception
+
+        def structures
+          @structures ||= []
+        end
 
         ##
         # Get a parameter from resulting hash or any nested part of it
@@ -51,10 +56,10 @@ module Aws
         #    # multi-level wildcard match
         #    opts['a', 'z', 'r'] # => 2
         def [](*path)
-          @structures.reverse_each.inject(nil) do |memo, container|
+          structures.reverse_each.inject(nil) do |memo, container|
             ret = begin
               Utils.lookup(container, path.dup)
-            rescue OptionValueDeleted, OptionScalarOnTheWay
+            rescue Exception::OptionValueDeleted, Exception::OptionScalarOnTheWay
               # we discovered that this layer either have value deleted or parent was overriden
               # by a scalar. Either way we just return what we have in the memo
               break memo
@@ -77,10 +82,13 @@ module Aws
         end
 
         def dependencies
+          # rubocop:disable Style/SymbolProc
+          # Refinements don't support dynamic dispatch yet. So, symbolic methods don't work
           memoize(:dependencies) do
-            select_recursively(&:dependency?)
-              .inject(Set.new) { |acc, elem| acc.merge(elem.dependencies) }
+            select_recursively { |obj| obj.dependency? }
+              .inject(::Set.new) { |acc, elem| acc.merge(elem.dependencies) }
           end
+          # rubocop:enable Style/SymbolProc
         end
 
         def select_recursively(&blk)
@@ -113,7 +121,7 @@ module Aws
           value = path_and_value.pop
           path = path_and_value
           dirty!.cow! # mooo
-          Utils.set_recursively(@structures.last, value, path)
+          Utils.set_recursively(structures.last, value, path)
         end
 
         ##
@@ -123,7 +131,7 @@ module Aws
         # with special marker that it was deleted. It helps avoid hash recalculation leading to
         # memory thrashing simultaneously maintaining semantics close to Hash#delete
         def delete(*path)
-          self[*path] = DELETED_MARKER
+          self[*path] = Utils::DELETED_MARKER
         end
 
         ##
@@ -133,7 +141,7 @@ module Aws
         # recursively.
         def to_hash
           memoize(:to_hash) do
-            _process_hashed(@structures.inject({}) { |acc, elem| Utils.merge(acc, elem) })
+            _process_hashed(structures.inject({}) { |acc, elem| Utils.merge(acc, elem) })
           end
         end
 
@@ -156,10 +164,10 @@ module Aws
         # Produces a list of top-level keys from all layers. Deleted branches are not included.
         def keys
           memoize(:keys) do
-            @structures
-              .each_with_object(Set.new) do |container, keyset|
+            structures
+              .each_with_object(::Set.new) do |container, keyset|
                 container.keys.each do |k|
-                  container[k] == DELETED_MARKER ? keyset.delete(k) : keyset.add(k)
+                  container[k] == Utils::DELETED_MARKER ? keyset.delete(k) : keyset.add(k)
                 end
               end
               .to_a
@@ -171,8 +179,8 @@ module Aws
         #
         # Checks if top-level key exists. Deleted branches are excluded.
         def include?(k)
-          found = @structures.reverse_each.find { |container| container.include?(k) }
-          !found.nil? && (found[k] != DELETED_MARKER)
+          found = structures.reverse_each.find { |container| container.include?(k) }
+          !found.nil? && (found[k] != Utils::DELETED_MARKER)
         end
 
         ##
@@ -182,7 +190,7 @@ module Aws
         # The object must be "recusrsive" meaning it should satisfy minimum contract for
         # "recursive". See Utils::recursive? for details
         def merge(other)
-          self.class.new(*@structures, other)
+          self.class.new(*structures, other)
         end
 
         ##
@@ -192,8 +200,14 @@ module Aws
         # The object must be "recursive" meaning it should satisfy minimum contract for
         # "recursive". See Utils::recursive? for details
         def merge!(other)
-          raise OptionShouldBeRecursive.new(other) unless Utils.recursive?(other)
-          @structures << other
+          raise Exception::OptionShouldBeRecursive.new(other) unless Utils.recursive?(other)
+
+          if other.is_a?(self.class)
+            structures.concat(other.structures)
+          else
+            structures << other
+          end
+
           dirty!
         end
 
@@ -209,15 +223,7 @@ module Aws
         ##
         # Initialize Options with list of recursive structures (See Options#recursive?)
         def initialize(*structures)
-          @structures = structures.map do |container|
-            if Utils.recursive?(container)
-              container
-            elsif Utils.hashable?(container)
-              container.to_hash
-            else
-              raise OptionShouldBeRecursive.new(container)
-            end
-          end
+          structures.reject(&:nil?).each { |container| merge!(container) }
         end
 
         ##
@@ -226,7 +232,7 @@ module Aws
         # Duplicates the object itself and puts another layer of hash map. All original hash maps
         # are not touched if the duplicate is modified.
         def dup
-          Options.new(*@structures)
+          Options.new(*structures)
         end
 
         ##
@@ -250,14 +256,20 @@ module Aws
         # from ActiveSupport. It puts the "recursive" object passed to the bottom of the layer
         # stack of the Options instance effectively making it the least prioritized layer.
         def unshift_layer!(layer)
-          raise OptionShouldBeRecursive.new(layer) unless Utils.recursive?(layer)
-          @structures.unshift(layer)
+          raise Exception::OptionShouldBeRecursive.new(layer) unless Utils.recursive?(layer)
+
+          if layer.is_a?(self.class)
+            layer.structures.dup.concat(structures)
+          else
+            structures.unshift(layer)
+          end
+
           dirty!
         end
 
         def cow!
           unless @is_cowed
-            @structures << {}
+            structures << {}
             @is_cowed = true
           end
 
@@ -269,7 +281,7 @@ module Aws
         # :nodoc: process hashable recursively removing all keys marked as deleted
         def _process_hashed(hashed)
           hashed.each_pair do |key, value|
-            if value == DELETED_MARKER
+            if value == Utils::DELETED_MARKER
               hashed.delete(key)
             elsif Utils.hashable?(value)
               _process_hashed(value.to_hash).freeze
@@ -282,3 +294,5 @@ module Aws
     end
   end
 end
+
+# rubocop:enable Metrics/ClassLength