cloud-templates 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dd48a14067126047f160caf3ffdd1c48e2ff4e7
-  data.tar.gz: ef684b50d03d1fb6b69170b8aa10444895743c52
+  metadata.gz: 836e106f34778808188ac4200dd45f36a91f675d
+  data.tar.gz: 505466ae879f3544b9a9577e57798691c9f5131a
 SHA512:
-  metadata.gz: c79052077800068fa8b569b2785f5ca6941a2193c23ead7f48713698a1e3443e9e735e849fec75166db08b66f5574d0e86877db0f7a0bab30fd421665be408e7
-  data.tar.gz: be49da0fd91ad960a80cdd07f72bf7306ceee9e8ebddada8f11cada9e70ba397d296a831254af515a247d3167edcfe9c847904486299f56e8c139ee2f3f55df4
+  metadata.gz: ae62c2f030a6f5262f565953dd0f4329cddfe70f53e7ac882061bd6ed10074741b397325d89053f13e30b9cf73712d20e4d8b1d6878c1ca65338c5718cb56f37
+  data.tar.gz: c8c4f1f13b841e2d0c597875349c60d149bc1227f7a13ee838dbc263ad59226c0406843aafe4a2d60bd29dd863e999d8f604b447a8ab624b00553a2447da8a47

data/cloud-templates.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'cloud-templates'
-  s.version     = '0.1.0'
+  s.version     = '0.2.0'
   s.license     = 'Apache 2.0'
   s.summary     = 'Hierarchical data templates'
   s.description = 'MVC-based templating framework for hierarchical data structures. ' \

data/lib/aws/templates/artifact.rb

@@ -107,6 +107,20 @@ module Aws
         options[:root]
       end
 
+      # Artifact's look-up path through all ancestors
+      def lookup_path
+        acc = [label]
+        ancestor = parent
+
+        until ancestor.nil?
+          acc << ancestor.label
+          ancestor = ancestor.parent
+        end
+
+        acc << root
+        acc.reverse!
+      end
+
       ##
       # Artifact's parent
       #
@@ -132,8 +146,7 @@ module Aws
       # * +params+ - input parameters hash to be used during following
       #              hash transformations and expansions.
       def initialize(params)
-        @options = Utils::Options.new(params)
-        process_options(params)
+        @options = Utils::Options.new(defaults, params)
       end
     end
   end

data/lib/aws/templates/render/utils/inspect.rb

@@ -0,0 +1,88 @@
+require 'aws/templates/render'
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/dependency'
+
+module Aws
+  module Templates
+    module Render
+      module Utils
+        ##
+        # Render for object introspection
+        #
+        # Used by Inspectable to provide introspection mechanism (inspect) detached from the objects
+        # themselves. Standard framework rendering mechanism is used.
+        module Inspect
+          extend Aws::Templates::Render
+
+          DEFAULT_RECURSION_DEPTH = 3
+
+          def self.recursion_depth
+            @recursion_depth || DEFAULT_RECURSION_DEPTH
+          end
+
+          def self.recursion_depth=(depth)
+            @recursion_depth = Integer(depth)
+          end
+
+          ##
+          # Basic inspection render
+          #
+          # Defines "depth" property which is used to control recursion depth during object
+          # introspection.
+          class InspectView < BasicView
+            def depth
+              (parameters.nil? ? Inspect.recursion_depth : Integer(parameters)) - 1
+            end
+          end
+
+          define_view(::Object, InspectView) do
+            def to_rendered
+              depth > 0 ? instance.inspect : instance.to_s
+            end
+          end
+
+          define_view(::Hash, InspectView) do
+            def to_rendered
+              if depth > 0
+                "{#{instance.map { |k, v| render_pair(k, v) }.join(',')}}"
+              else
+                instance.empty? ? '{}' : '{...}'
+              end
+            end
+
+            def render_pair(k, v)
+              "#{rendered_for(k, depth)}: #{rendered_for(v, depth)}"
+            end
+          end
+
+          define_view(::Enumerable, InspectView) do
+            def to_rendered
+              if depth > 0
+                "#{instance.class}[#{instance.map { |elem| rendered_for(elem, depth) }.join(',')}]"
+              else
+                "#{instance.class}#{instance.empty? ? '[]' : '[...]'}"
+              end
+            end
+          end
+
+          define_view(Templates::Utils::Dependency, InspectView) do
+            def to_rendered
+              'Dependency(' \
+                "#{rendered_for(instance.object, depth)}" \
+                " => #{rendered_for(instance.dependencies, depth)})"
+            end
+          end
+
+          define_view(Templates::Utils::Parametrized, InspectView) do
+            def to_rendered
+              return instance.to_s unless depth > 0
+              "#{instance}" \
+                "{parameters: #{rendered_for(instance.parameters_map, depth)}," \
+                " dependencies: #{rendered_for(instance.dependencies, depth)}}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/render/utils/stringify.rb

@@ -0,0 +1,45 @@
+require 'aws/templates/render'
+require 'aws/templates/artifact'
+require 'aws/templates/utils/parametrized/nested'
+require 'aws/templates/utils/dependency'
+
+module Aws
+  module Templates
+    module Render
+      module Utils
+        ##
+        # Stringifying render
+        #
+        # Used by Inspectable module to provide stringification mechanism (to_s) detached from
+        # the objects themselves. Standard framework rendering mechanism is used.
+        module Stringify
+          extend Aws::Templates::Render
+
+          define_view(::Object) do
+            def to_rendered
+              instance.to_s
+            end
+          end
+
+          define_view(::Aws::Templates::Utils::Dependency) do
+            def to_rendered
+              instance.object.to_s
+            end
+          end
+
+          define_view(Templates::Artifact) do
+            def to_rendered
+              "#{instance.class}(#{instance.lookup_path.map(&:inspect).join('/')})"
+            end
+          end
+
+          define_view(Templates::Utils::Parametrized::Nested) do
+            def to_rendered
+              "#{instance.class}(in: #{instance.parent})"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/render/view.rb

@@ -86,8 +86,9 @@ module Aws
         # Render the object
         #
         # Renders passed object with the view default render
-        def rendered_for(obj)
-          render.view_for(obj, parameters).to_rendered
+        def rendered_for(obj, parameters_override = nil)
+          render.view_for(obj, parameters_override.nil? ? parameters : parameters_override)
+                .to_rendered
         end
 
         ##

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

@@ -61,6 +61,11 @@ module Aws
             @hash.include?(k)
           end
 
+          # The class already supports recursive concept so return self
+          def to_recursive
+            self
+          end
+
           ##
           # Create wrapper object
           #
@@ -103,18 +108,13 @@ module Aws
           # prioritizing the ones made later in the class hierarchy. The method
           # is working correctly with both parent classes and all Default
           # mixins used in between.
-          def process_options(params = nil)
+          def defaults
             # iterating through all ancestors with defaults
-            ancestors_with_defaults.reverse_each do |mod|
-              # ... through all defaults of particular ancestor
-              mod.defaults.each do |defaults_definition|
-                # merge the default definition with options
-                options.merge!(Definition.new(defaults_definition, self))
+            ancestors_with_defaults.inject(Options.new) do |opts, mod|
+              mod.defaults.inject(opts) do |acc, defaults_definition|
+                acc.merge!(Definition.new(defaults_definition, self))
               end
             end
-
-            # re-inforce caller-specified overrides
-            options.merge!(params) if params
           end
 
           private
@@ -123,9 +123,8 @@ module Aws
             self
               .class
               .ancestors
-              .select do |mod|
-                (mod != Default) && mod.ancestors.include?(Default)
-              end
+              .select { |mod| (mod != Default) && mod.ancestors.include?(Default) }
+              .reverse!
           end
         end
 
@@ -134,6 +133,12 @@ module Aws
         #
         # It's a DSL extension to declaratively define defaults
         class_scope do
+          ##
+          # To mark hash branch as deleted
+          def deleted
+            Aws::Templates::Utils::DELETED_MARKER
+          end
+
           ##
           # Defaults for the input hash
           #

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

@@ -1,6 +1,7 @@
 require 'set'
 require 'aws/templates/utils/dependency/object'
 require 'aws/templates/utils/dependency/enumerable'
+require 'aws/templates/utils/inspectable'
 
 module Aws
   module Templates
@@ -15,6 +16,8 @@ module Aws
       # * Dependecy can be applied case-by-case basis whereas singleton is attached to the object
       #   itself
       class Dependency < BasicObject
+        include Inspectable
+
         ##
         # Equality
         #
@@ -46,7 +49,7 @@ module Aws
         end
 
         # mark the object as dependency
-        def as_dependency
+        def as_a_dependency
           self
         end
 

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

@@ -0,0 +1,22 @@
+module Aws
+  module Templates
+    module Utils
+      ##
+      # Inspect mixin.
+      #
+      # Mixin provides means of composing inspect strings for objects through framework's rendering
+      # mechanism.
+      module Inspectable
+        def to_s
+          ::Kernel.require 'aws/templates/render/utils/stringify'
+          ::Aws::Templates::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
+        end
+      end
+    end
+  end
+end

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

@@ -137,6 +137,11 @@ module Aws
           end
         end
 
+        # The class already supports recursive concept so return self
+        def to_recursive
+          self
+        end
+
         ##
         # Create filter
         #

data/lib/aws/templates/utils/parametrized/nested.rb

@@ -51,7 +51,11 @@ module Aws
             true
           end
 
-          attr_reader :root
+          def root
+            parent.root
+          end
+
+          attr_reader :parent
 
           def dependencies
             @dependencies ||= Set.new
@@ -59,11 +63,15 @@ module Aws
 
           protected
 
-          def initialize(root_link, obj)
-            @root = root_link
+          def initialize(parent, obj)
+            unless obj.respond_to?(:to_recursive)
+              raise "Value #{obj} can't be transformed " \
+                    'into a recursive container'
+            end
+
+            @parent = parent
             depends_on(obj) if obj.dependency?
-            @options = Options.new(obj)
-            process_options(obj)
+            @options = Options.new(defaults, obj.to_recursive)
           end
         end
       end

data/lib/aws/templates/utils/parametrized/transformations.rb

@@ -1,7 +1,6 @@
 require 'aws/templates/exceptions'
 require 'aws/templates/utils/parametrized'
 require 'aws/templates/utils/parametrized/nested'
-require 'aws/templates/utils/parametrized/mapper'
 require 'singleton'
 
 module Aws
@@ -130,14 +129,7 @@ module Aws
 
             def transform(_, value, instance)
               return if value.nil?
-              klass.new instance.root,
-                        if Utils.hashable?(value)
-                          value
-                        elsif Utils.parametrized?(value)
-                          Mapper.new(value)
-                        else
-                          raise "Value #{value} doesn't have parameters"
-                        end
+              klass.new(instance, value)
             end
           end
 

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

@@ -2,6 +2,7 @@ require 'aws/templates/exceptions'
 require 'aws/templates/utils/parametrized/guarded'
 require 'aws/templates/utils/inheritable'
 require 'aws/templates/utils/dependent'
+require 'aws/templates/utils/inspectable'
 require 'set'
 
 module Aws
@@ -16,8 +17,9 @@ module Aws
       # it's domain-specific extended implementation of attr_reader.
       module Parametrized
         include Guarded
-        include Inheritable
         include Dependent
+        include Inheritable
+        include Inspectable
 
         ##
         # Parameter object
@@ -135,6 +137,38 @@ module Aws
           end
         end
 
+        ##
+        # Makes parametrized accessible as recursive concept
+        class RecursiveAdapter
+          attr_reader :target
+
+          ##
+          # Defined hash keys
+          def keys
+            target.parameter_names.merge(target.options.keys)
+          end
+
+          ##
+          # Index operator
+          #
+          # Performs intermediate transformation of value if needed (if value is a lambda) and
+          # returns it wrapping into Definition instance with the same context if needed
+          # (if value is a map)
+          def [](k)
+            target.parameter_names.include?(k) ? target.send(k) : target.options[k]
+          end
+
+          ##
+          # Check if the key is present in the hash
+          def include?(k)
+            target.parameter_names.include?(k) || target.options.include?(k)
+          end
+
+          def initialize(target)
+            @target = target
+          end
+        end
+
         instance_scope do
           ##
           # Lazy initializer
@@ -163,6 +197,20 @@ module Aws
             parameter_names.each { |name| send(name) }
           end
 
+          ##
+          # Evaluate all parameters
+          #
+          # Return parameters as a hash
+          def parameters_map
+            parameter_names.each_with_object({}) { |name, obj| obj[name] = send(name) }
+          end
+
+          ##
+          # Transforms parametrized into an instance of recursive concept
+          def to_recursive
+            RecursiveAdapter.new(self)
+          end
+
           attr_reader :getter
         end
 

data/lib/aws/templates/utils.rb

@@ -1,5 +1,13 @@
 require 'aws/templates/exceptions'
 
+##
+# Hash implements resursive concept
+class Hash
+  def to_recursive
+    self
+  end
+end
+
 module Aws
   module Templates
     ##

data/spec/aws/templates/artifact_spec.rb

@@ -134,7 +134,7 @@ describe Aws::Templates::Artifact do
   context 'instance of child class created' do
     let(:child_class) do
       Class.new(artifact_class) do
-        default a: 'c',
+        default a: deleted,
                 c: proc { options[:d].tr(' ', '.') }
       end
     end
@@ -147,7 +147,6 @@ describe Aws::Templates::Artifact do
       {
         root: 3,
         label: 'thing',
-        a: 'c',
         b: 'Q.W.E',
         c: 'q.w.e',
         d: 'q w e'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud-templates
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ivan Matylitski
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -162,6 +162,8 @@ files:
 - lib/aws/templates/render.rb
 - lib/aws/templates/render/registry.rb
 - lib/aws/templates/render/utils/base_type_views.rb
+- lib/aws/templates/render/utils/inspect.rb
+- lib/aws/templates/render/utils/stringify.rb
 - lib/aws/templates/render/view.rb
 - lib/aws/templates/utils.rb
 - lib/aws/templates/utils/artifact_storage.rb
@@ -176,6 +178,7 @@ files:
 - lib/aws/templates/utils/dependency/object.rb
 - lib/aws/templates/utils/dependent.rb
 - lib/aws/templates/utils/inheritable.rb
+- lib/aws/templates/utils/inspectable.rb
 - lib/aws/templates/utils/late_bound.rb
 - lib/aws/templates/utils/memoized.rb
 - lib/aws/templates/utils/named.rb
@@ -184,7 +187,6 @@ files:
 - lib/aws/templates/utils/parametrized/constraints.rb
 - lib/aws/templates/utils/parametrized/getters.rb
 - lib/aws/templates/utils/parametrized/guarded.rb
-- lib/aws/templates/utils/parametrized/mapper.rb
 - lib/aws/templates/utils/parametrized/nested.rb
 - lib/aws/templates/utils/parametrized/transformations.rb
 - spec/aws/templates/artifact_spec.rb

data/lib/aws/templates/utils/parametrized/mapper.rb

@@ -1,73 +0,0 @@
-require 'set'
-
-module Aws
-  module Templates
-    module Utils
-      module Parametrized
-        ##
-        # Map from "parametrized" to "recursive"
-        #
-        # The class is adapter used to wrap any "parametrized" object (implementing "parametrized"
-        # concept) into an object implementing "hashable" and "recursive" concepts.
-        class Mapper
-          attr_reader :delegate
-
-          SPECIAL_CASE = [:root].freeze
-
-          def [](key)
-            @delegate.public_send(key) if @parameter_names.include?(key)
-          end
-
-          def include?(key)
-            @parameter_names.include?(key)
-          end
-
-          def to_hash
-            @parameter_names.each_with_object({}) do |method_name, hsh|
-              hsh[method_name] = @delegate.public_send(method_name)
-            end
-          end
-
-          def keys
-            @parameter_names.to_a
-          end
-
-          def dependency?
-            delegate.dependency?
-          end
-
-          def dependencies
-            delegate.dependencies
-          end
-
-          def object
-            delegate.object
-          end
-
-          def initialize(obj)
-            obj.parameter_names.each { |pname| _check_parameter(obj, pname) }
-            @delegate = obj
-            @parameter_names = Set.new(@delegate.parameter_names).merge(SPECIAL_CASE)
-          end
-
-          private
-
-          PROPERTY_LIKE = /^[^_!?][^!?]*$/
-
-          def _check_parameter(obj, name)
-            _raise_misnamed(obj, name) unless name.to_s =~ PROPERTY_LIKE
-            _raise_arity(obj, name) unless obj.public_method(name).arity.zero?
-          end
-
-          def _raise_misnamed(obj, name)
-            raise "Parameter #{name} of #{obj} is mis-named"
-          end
-
-          def _raise_arity(obj, name)
-            raise "Parameter #{name} of #{obj} has arity"
-          end
-        end
-      end
-    end
-  end
-end