cloud-templates 0.2.0 → 0.3.0

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

@@ -1,8 +1,4 @@
-require 'aws/templates/utils/contextualized/filters'
-require 'aws/templates/utils/contextualized/proc'
-require 'aws/templates/utils/contextualized/hash'
-require 'aws/templates/utils/contextualized/nil'
-require 'aws/templates/utils/inheritable'
+require 'aws/templates/utils'
 
 module Aws
   module Templates
@@ -22,7 +18,8 @@ module Aws
       # by "filter" mixed method is a functor. No operations are performed
       # on options.
       module Contextualized
-        include Inheritable
+        include Utils::Inheritable
+        include Filter::Dsl
 
         instance_scope do
           ##
@@ -35,7 +32,7 @@ module Aws
           # The method is working correctly with both parent classes and all
           # Contextualized mixins used in between.
           def context
-            @context ||= filter(:scoped, self.class.context, self)
+            @context ||= Filter::Scoped.new(self.class.context, self)
           end
 
           ##
@@ -48,14 +45,14 @@ module Aws
             if blk
               clone._set_context(context.scoped_filter & arg).instance_exec(&blk)
             else
-              filter(:scoped, context.scoped_filter & arg, self)
+              Filter::Scoped.new(context.scoped_filter & arg, self)
             end
           end
 
           protected
 
           def _set_context(new_context)
-            @context = filter(:scoped, new_context, self)
+            @context = Filter::Scoped.new(new_context, self)
             self
           end
         end
@@ -72,7 +69,7 @@ module Aws
           # The method returns only the filter for the current class
           # without consideration of the class hierarchy.
           def module_context
-            @module_context ||= filter(:identity)
+            @module_context ||= Filter::Identity.new
           end
 
           ##
@@ -82,17 +79,11 @@ module Aws
           # The method returns aggregate filter include module's own filters
           # concatenated with all ancestor's filters.
           def context
-            @context ||= _contextualized_ancestors.inject(filter(:identity)) do |acc, mod|
+            @context ||= ancestors_with(Contextualized).inject(Filter::Identity.new) do |acc, mod|
               acc & mod.module_context
             end
           end
 
-          def _contextualized_ancestors
-            ancestors
-              .select { |mod| (mod != Contextualized) && mod.ancestors.include?(Contextualized) }
-              .reverse
-          end
-
           ##
           # Add context filter
           #

data/lib/aws/templates/utils/contextualized/filter.rb

@@ -0,0 +1,62 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        ##
+        # Filter functor class
+        #
+        # A filter is a Proc accepting input hash and providing output
+        # hash which is expected to be a permutation of the input.
+        # The proc is executed in instance context so instance methods can
+        # be used for calculation.
+        #
+        # The class implements functor pattern through to_proc method and
+        # closure. Essentially, all filters can be used everywhere where
+        # a block is expected.
+        #
+        # It provides protected method filter which should be overriden in
+        # all concrete filter classes.
+        class Filter
+          using Contextualized::Refinements
+          ##
+          # Chain filters
+          def &(other)
+            fltr = other.to_filter
+            return self if fltr.is_a?(Identity)
+            Chain.new(self, fltr)
+          end
+
+          ##
+          # Creates closure with filter invocation
+          #
+          # It's an interface method required for Filter to expose
+          # functor properties. It encloses invocation of Filter
+          # filter method into a closure. The closure itself is
+          # executed in the context of Filtered instance which provides
+          # proper set "self" variable.
+          #
+          # The closure itself accepts just one parameter:
+          # * +opts+ - input hash to be filtered
+          # ...where instance is assumed from self
+          def to_proc
+            fltr = self
+            ->(opts, memo = {}) { fltr.filter(opts, memo, self) }
+          end
+
+          ##
+          # Filter method
+          #
+          # * +opts+ - input hash to be filtered
+          # * +instance+ - the instance filter is executed in
+          def filter(opts, memo, instance); end
+
+          def to_filter
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/add.rb

@@ -0,0 +1,67 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # Add specified keys into the hash
+          #
+          # Selective version of Copy filter. It adds key-value pairs or whole subtrees from
+          # options into the memo hash. It does this according to specified schema represented
+          # by combination of nested hashes and arrays. User can specify addition of values
+          # at arbitrary depth in options hash hierarchy with arbitrar granularity.
+          #
+          # === Example
+          #
+          #    class Piece
+          #      include Aws::Templates::Utils::Contextualized
+          #
+          #      contextualize filter(:add, :a, :b, c: [:d])
+          #    end
+          #
+          #    i = Piece.new()
+          #    opts = Options.new(a: { q: 1 }, b: 2, c: { d: { r: 5 }, e: 1 })
+          #    opts.filter(i.filter) # => { a: { q: 1 }, b: 2, c: { d: { r: 5 } } }
+          class Add < RecursiveSchemaFilter
+            using Contextualized::Refinements
+
+            def filter(options, memo, _)
+              _recurse_add(options, memo, scheme)
+            end
+
+            private
+
+            def _recurse_add(opts, memo, schm)
+              return unless Utils.recursive?(opts)
+
+              if Utils.hashable?(schm)
+                _scheme_add(opts, memo, schm.to_hash)
+              elsif Utils.list?(schm)
+                _list_add(opts, memo, schm.to_ary)
+              end
+
+              memo
+            end
+
+            def _list_add(opts, memo, list)
+              list.each { |field| memo[field] = Utils.merge(memo[field], opts[field]) }
+            end
+
+            def _scheme_add(opts, memo, schm)
+              schm.each_pair do |field, sub_scheme|
+                next unless opts.include?(field)
+                memo[field] = if sub_scheme.nil?
+                  Utils.merge(memo[field], opts[field])
+                else
+                  _recurse_add(opts[field], memo[field] || {}, sub_scheme)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/chain.rb

@@ -0,0 +1,56 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # Chain filters
+          #
+          # The filter chains all passed filters to have chained
+          # filter semantics.
+          #
+          # === Example
+          #
+          #    class Piece
+          #      include Aws::Templates::Utils::Contextualized
+          #
+          #      contextualize filter(:copy) & filter(:remove, :c) & filter(:override, a: 12, b: 15)
+          #    end
+          #
+          #    i = Piece.new
+          #    opts = Options.new(c: { e: 1 })
+          #    opts.filter(i.filter) # => { a: 12, b: 15 }
+          class Chain < self
+            using Contextualized::Refinements
+
+            attr_reader :filters
+
+            def initialize(*flts)
+              wrong_objects = flts.reject { |f| f.respond_to?(:to_proc) }
+              unless wrong_objects.empty?
+                raise(
+                  "The following objects are not filters: #{wrong_objects.inspect}"
+                )
+              end
+
+              @filters = flts.flat_map { |f| _as_flattened_filters(f) }
+            end
+
+            def filter(options, memo, instance)
+              filters.inject(memo) { |acc, elem| instance.instance_exec(options, acc, &elem) }
+            end
+
+            private
+
+            def _as_flattened_filters(flt)
+              return flt unless flt.is_a?(self.class)
+              flt.filters.flat_map { |obj| _as_flattened_filters(obj) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/copy.rb

@@ -0,0 +1,38 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # Add all options into the context
+          #
+          # The filter performs deep copy of entire options hash with consecutive merge into the
+          # resulting context
+          #
+          # === Example
+          #
+          #    class Piece
+          #      contextualize filter(:copy)
+          #    end
+          #
+          #    i = Piece.new()
+          #    opts = Options.new(a: { q: 1 }, b: 2, c: { d: { r: 5 }, e: 1 })
+          #    opts.filter(i.filter) # => { a: { q: 1 }, b: 2, c: { d: { r: 5 }, e: 1 } }
+          class Copy < self
+            using Contextualized::Refinements
+
+            PRE_FILTER = %i[label root parent meta].freeze
+
+            def filter(opts, memo, _)
+              result = Utils.deep_dup(opts.to_hash)
+              PRE_FILTER.each { |k| result.delete(k) }
+              Utils.merge(memo, result)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/dsl.rb

@@ -0,0 +1,50 @@
+require 'aws/templates/utils'
+require 'facets/string/modulize'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # DSL for defining scope filters.
+          #
+          # The mixin adds DSL methods to both class context and instance context.
+          module Dsl
+            include Utils::Inheritable
+
+            ##
+            # Mixin for filter factory method
+            #
+            # Adds filter factory method to the target
+            module FilterFactory
+              ##
+              # Filter factory method
+              #
+              # It creates a filter based on type identifier and parameters with optional block
+              # which will be passed unchanged to the filter constructor.
+              # * +type+ - type identifier; can by either symbol or string
+              # * +args+ - filter constructor arguments
+              # * +blk+ - optional block to be passed to filter constructor
+              def filter(type, *args, &blk)
+                Filter.const_get(type.to_s.modulize).new(*args, &blk)
+              end
+            end
+
+            ##
+            # Class-level mixins
+            #
+            # It's a DSL extension to declaratively define context filters
+            class_scope do
+              include FilterFactory
+            end
+
+            instance_scope do
+              include FilterFactory
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/identity.rb

@@ -0,0 +1,45 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # No-op filter
+          #
+          # No-op filter or identity filter doesn't perform any operations on passed options. The
+          # role of this filter is to play the role of identity function in par with lambda
+          # calculus.
+          #
+          # === Examples
+          #
+          #    class Piece
+          #      include Aws::Templates::Utils::Contextualized
+          #
+          #      contextualize filter(:identity)
+          #    end
+          #
+          #    i = Piece.new
+          #    opts = Options.new(a: { q: 1 }, b: 2, c: { d: { r: 5 }, e: 1 })
+          #    opts.filter(i.filter) # => {}
+          class Identity < self
+            using Contextualized::Refinements
+
+            def self.new
+              @singleton ||= super()
+            end
+
+            def filter(_, memo, _)
+              memo
+            end
+
+            def &(other)
+              other.to_filter
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/utils/contextualized/filter/override.rb

@@ -0,0 +1,62 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      module Contextualized
+        class Filter
+          ##
+          # Override specified keys in options hash
+          #
+          # The filter performs merge the hash passed at initialization with
+          # options hash. Either hash itself or block returning a hash
+          # can be specified. The block will be evaluated in instance context
+          # so all instance methods are accessible.
+          #
+          # === Example
+          #
+          #    class Piece
+          #      include Aws::Templates::Utils::Contextualized
+          #
+          #      contextualize filter(:copy) & filter(:override, a: 12, b: 15, c: { d: 30 })
+          #    end
+          #
+          #    i = Piece.new
+          #    opts = Options.new(c: { e: 1 })
+          #    opts.filter(i.filter) # => { a: 12, b: 15, c: { d: 30, e: 1 } }
+          class Override < self
+            using Contextualized::Refinements
+
+            attr_reader :override
+
+            def initialize(override = nil, &override_block)
+              @override = _check_override_type(override || override_block)
+            end
+
+            def filter(_, memo, instance)
+              Utils.merge(
+                memo,
+                if override.respond_to?(:to_hash)
+                  override
+                elsif override.respond_to?(:to_proc)
+                  instance.instance_eval(&override)
+                end
+              )
+            end
+
+            private
+
+            def _check_override_type(ovrr)
+              raise "Wrong override value: #{ovrr.inspect}" unless _proper_override_type?(ovrr)
+              ovrr
+            end
+
+            def _proper_override_type?(ovrr)
+              ovrr.respond_to?(:to_hash) || ovrr.respond_to?(:to_proc)
+            end
+          end
+        end
+      end
+    end
+  end
+end