cloud-templates 0.2.0 → 0.3.0

data/lib/aws/templates/help/rdoc/parametrized/parameter.rb

@@ -0,0 +1,55 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Parameter documentation provider
+          #
+          # Combines parameter description and documentation blocks for constraint, getter and
+          # transformation if they are assigned to the parameter.
+          class Parameter < Rdoc::Provider
+            for_entity Templates::Utils::Parametrized::Parameter
+
+            def provide
+              sub(description) do |s|
+                s << list(:BULLET) do |l|
+                  add_transformation(l)
+                  add_constraint(l)
+                end
+              end
+            end
+
+            private
+
+            def description
+              desc = "_#{context.name}_ "
+              desc.concat(context.description) if context.description
+              text(desc)
+            end
+
+            def add_transformation(l)
+              return unless context.transform
+
+              l << sub(
+                text('transformation:'),
+                processed_for(context.transform)
+              )
+            end
+
+            def add_constraint(l)
+              return unless context.constraint
+
+              l << sub(
+                text('constraint:'),
+                processed_for(context.constraint)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/provider.rb

@@ -0,0 +1,32 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Parametrized documentation aspect provider
+          #
+          # Composes documentation blocks of all parameters assigned to the class or its' parents.
+          class Provider < Rdoc::Inheritable
+            for_entity Templates::Utils::Parametrized
+
+            header 'Parameters'
+
+            protected
+
+            def description_for(mod)
+              return if mod.parameters.empty?
+
+              list do |l|
+                mod.parameters
+                   .each_value { |parameter| l << processed_for(parameter) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformation.rb

@@ -0,0 +1,17 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Abstract transformation provider
+          class Transformation < Rdoc::Provider
+            for_entity Templates::Utils::Parametrized::Transformation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations.rb

@@ -0,0 +1,14 @@
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Transformations namespace
+          module Transformations
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_boolean.rb

@@ -0,0 +1,25 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Boolean transformation documentation
+            #
+            # Just prints the documentation blurb.
+            class AsBoolean < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsBoolean
+
+              def provide
+                sub(text('to boolean'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_chain.rb

@@ -0,0 +1,34 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Chained transformation documentation
+            #
+            # Generates documentation blocks for all transformation steps in the chain.
+            class AsChain < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsChain
+
+              def provide
+                sub(text('as chain of transformations:'), transformations)
+              end
+
+              private
+
+              def transformations
+                context.components
+                       .lazy
+                       .map { |c| processed_for(c) }
+                       .each_with_object(list) { |part, l| l << part }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_hash.rb

@@ -0,0 +1,40 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Hash transformation documentation
+            #
+            # Outputs documentation blocks for key and value sub-parameters.
+            class AsHash < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsHash
+
+              def provide
+                sub(text('as a hash where:'), key_value_description)
+              end
+
+              private
+
+              def key_value_description
+                list(
+                  :BULLET,
+                  description_for('key', context.key_parameter),
+                  description_for('value', context.value_parameter)
+                )
+              end
+
+              def description_for(name, value)
+                return sub(text("_#{name}_ can be anything")) if value.nil?
+                processed_for(value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_integer.rb

@@ -0,0 +1,26 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Integer transformation documentation
+            #
+            # Just prints the blurb since the transformation is not parametrizable.
+            class AsInteger < Rdoc::Parametrized::Transformation
+              register_in Rdoc
+              for_entity Templates::Utils::Parametrized::Transformation::AsInteger
+
+              def provide
+                sub(text('to integer'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_list.rb

@@ -0,0 +1,32 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # List transformation documentation
+            #
+            # Outputs documentation for sub-parameter (element).
+            class AsList < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsList
+
+              def provide
+                parameter = context.sub_parameter
+                sub do |s|
+                  if parameter.nil?
+                    s << text('as a list where elements can be anything')
+                  else
+                    s << text('as a list where elements are:') << processed_for(parameter)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_module.rb

@@ -0,0 +1,25 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Module transformation documentation
+            #
+            # Just prints documentation blurb since the transformation is not parametrizable.
+            class AsModule < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsModule
+
+              def provide
+                sub(text('lookup as a module'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_object.rb

@@ -0,0 +1,32 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Object transformation documentation
+            #
+            # Prints documentation for the transformation of a parameter where nested structure is
+            # defined. Nested class description is provided.
+            class AsObject < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsObject
+
+              def provide
+                klass = processed_for(context.klass)
+
+                if klass.nil?
+                  sub(text('as an object'))
+                else
+                  sub(text('as an object with:'), processed_for(context.klass))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_rendered.rb

@@ -0,0 +1,28 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # Render transformation documentation
+            #
+            # Prints Render type and assigned parameters.
+            class AsRendered < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsRendered
+
+              def provide
+                description = "render with #{context.type}"
+                description.concat(" (#{context.parameters})") if context.parameters
+
+                sub(text(description))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/transformations/as_string.rb

@@ -0,0 +1,25 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Transformations
+            ##
+            # String transformation documentation
+            #
+            # Just prints the documentation blurb since the transformation is not parametrizable.
+            class AsString < Rdoc::Parametrized::Transformation
+              for_entity Templates::Utils::Parametrized::Transformation::AsRendered
+
+              def provide
+                sub(text('to string'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/provider.rb

@@ -0,0 +1,20 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        ##
+        # Abstract Rdoc provider
+        class Provider < Help::Provider
+          register_in Rdoc
+          include Rdoc::Texting
+
+          def provide
+            text "#{context.class.name} (No specific documentation found)"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/routing.rb

@@ -0,0 +1,104 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        ##
+        # Lazy provider-entity routing
+        #
+        # It is used to avoid loading too much code into the memory even when it's not required.
+        module Routing
+          extend Templates::Processor::Routing
+
+          register Templates.lazy::Help::Dsl, Rdoc.lazy::Dsl
+          register Templates.lazy::Artifact, Rdoc.lazy::Artifact
+          register Templates.lazy::Composite, Rdoc.lazy::Composite
+
+          register Templates.lazy::Utils::Default, Rdoc.lazy::Default::Provider
+          register Templates.lazy::Utils::Default::Definition, Rdoc.lazy::Default::Definition
+          register Templates.lazy::Utils::Default::Definition::Empty,
+                   Rdoc.lazy::Default::Definition::Empty
+          register Templates.lazy::Utils::Default::Definition::Pair,
+                   Rdoc.lazy::Default::Definition::Pair
+          register Templates.lazy::Utils::Default::Definition::Calculable,
+                   Rdoc.lazy::Default::Definition::Calculable
+          register Templates.lazy::Utils::Default::Definition::Scheme,
+                   Rdoc.lazy::Default::Definition::Scheme
+
+          register Templates.lazy::Utils::Parametrized, Rdoc.lazy::Parametrized::Provider
+          register Templates.lazy::Utils::Parametrized::Parameter,
+                   Rdoc.lazy::Parametrized::Parameter
+          register Templates.lazy::Utils::Parametrized::Nested, Rdoc.lazy::Parametrized::Nested
+          register Templates.lazy::Utils::Parametrized::Constraint,
+                   Rdoc.lazy::Parametrized::Constraint
+          register Templates.lazy::Utils::Parametrized::Constraint::AllOf,
+                   Rdoc.lazy::Parametrized::Constraints::AllOf
+          register Templates.lazy::Utils::Parametrized::Constraint::DependsOnValue,
+                   Rdoc.lazy::Parametrized::Constraints::DependsOnValue
+          register Templates.lazy::Utils::Parametrized::Constraint::Enum,
+                   Rdoc.lazy::Parametrized::Constraints::Enum
+          register Templates.lazy::Utils::Parametrized::Constraint::Matches,
+                   Rdoc.lazy::Parametrized::Constraints::Matches
+          register Templates.lazy::Utils::Parametrized::Constraint::NotNil,
+                   Rdoc.lazy::Parametrized::Constraints::NotNil
+          register Templates.lazy::Utils::Parametrized::Constraint::Requires,
+                   Rdoc.lazy::Parametrized::Constraints::Requires
+          register Templates.lazy::Utils::Parametrized::Constraint::SatisfiesCondition,
+                   Rdoc.lazy::Parametrized::Constraints::SatisfiesCondition
+
+          register Templates.lazy::Utils::Parametrized::Constraint::Condition,
+                   Rdoc.lazy::Parametrized::Constraints::Condition
+          register Templates.lazy::Utils::Parametrized::Constraint::Condition::Equal,
+                   Rdoc.lazy::Parametrized::Constraints::Condition::Equal
+          register Templates.lazy::Utils::Parametrized::Constraint::Condition::Conditional,
+                   Rdoc.lazy::Parametrized::Constraints::Condition::Conditional
+
+          register Templates.lazy::Utils::Parametrized::Getter,
+                   Rdoc.lazy::Parametrized::Getter
+
+          register Templates.lazy::Utils::Parametrized::Transformation,
+                   Rdoc.lazy::Parametrized::Transformation
+          register Templates.lazy::Utils::Parametrized::Transformation::AsBoolean,
+                   Rdoc.lazy::Parametrized::Transformations::AsBoolean
+          register Templates.lazy::Utils::Parametrized::Transformation::AsChain,
+                   Rdoc.lazy::Parametrized::Transformations::AsChain
+          register Templates.lazy::Utils::Parametrized::Transformation::AsHash,
+                   Rdoc.lazy::Parametrized::Transformations::AsHash
+          register Templates.lazy::Utils::Parametrized::Transformation::AsInteger,
+                   Rdoc.lazy::Parametrized::Transformations::AsInteger
+          register Templates.lazy::Utils::Parametrized::Transformation::AsList,
+                   Rdoc.lazy::Parametrized::Transformations::AsList
+          register Templates.lazy::Utils::Parametrized::Transformation::AsModule,
+                   Rdoc.lazy::Parametrized::Transformations::AsModule
+          register Templates.lazy::Utils::Parametrized::Transformation::AsObject,
+                   Rdoc.lazy::Parametrized::Transformations::AsObject
+          register Templates.lazy::Utils::Parametrized::Transformation::AsRendered,
+                   Rdoc.lazy::Parametrized::Transformations::AsRendered
+          register Templates.lazy::Utils::Parametrized::Transformation::AsString,
+                   Rdoc.lazy::Parametrized::Transformations::AsString
+
+          register Templates.lazy::Utils::Contextualized, Rdoc.lazy::Contextualized::Provider
+          register Templates.lazy::Utils::Contextualized::Filter,
+                   Rdoc.lazy::Contextualized::Filter
+          register Templates.lazy::Utils::Contextualized::Filter::Add,
+                   Rdoc.lazy::Contextualized::Filters::Add
+          register Templates.lazy::Utils::Contextualized::Filter::Chain,
+                   Rdoc.lazy::Contextualized::Filters::Chain
+          register Templates.lazy::Utils::Contextualized::Filter::Copy,
+                   Rdoc.lazy::Contextualized::Filters::Copy
+          register Templates.lazy::Utils::Contextualized::Filter::Identity,
+                   Rdoc.lazy::Contextualized::Filters::Identity
+          register Templates.lazy::Utils::Contextualized::Filter::Override,
+                   Rdoc.lazy::Contextualized::Filters::Override
+          register Templates.lazy::Utils::Contextualized::Filter::Proxy,
+                   Rdoc.lazy::Contextualized::Filters::Proxy
+          register Templates.lazy::Utils::Contextualized::Filter::Remove,
+                   Rdoc.lazy::Contextualized::Filters::Remove
+          register Templates.lazy::Utils::Contextualized::Filter::Scoped,
+                   Rdoc.lazy::Contextualized::Filters::Scoped
+        end
+      end
+    end
+  end
+end