cloud-templates 0.2.0 → 0.3.0

data/lib/aws/templates/help/rdoc/contextualized/filters.rb

@@ -0,0 +1,14 @@
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          ##
+          # Filters namespace
+          module Filters
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/add.rb

@@ -0,0 +1,21 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Add filter documentation provider
+            class Add < RecursiveSchemaFilter
+              for_entity Templates::Utils::Contextualized::Filter::Add
+
+              blurb 'merge the following options from the parent context:'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/chain.rb

@@ -0,0 +1,33 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Chained filter documentation provider
+            #
+            # Goes over all elements in the chain composing a list of filters
+            class Chain < Rdoc::Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Chain
+
+              def provide
+                sub(text('a chain of the following filters:'), filters)
+              end
+
+              private
+
+              def filters
+                list do |l|
+                  context.filters.each { |filter| l << processed_for(filter) }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/copy.rb

@@ -0,0 +1,23 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Copy filter documentation provider
+            class Copy < Rdoc::Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Copy
+
+              def provide
+                sub(text('copy the entire context'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/identity.rb

@@ -0,0 +1,23 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # No-op filter documenation provider
+            class Identity < Rdoc::Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Identity
+
+              def provide
+                sub(text('don not change the context'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/override.rb

@@ -0,0 +1,29 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Override filter documentation provider
+            #
+            # Generates blurb and documentation for override object whatever the object is.
+            # The object provider is taken from standard documenation provider
+            class Override < Rdoc::Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Override
+
+              def provide
+                sub(
+                  text('merge the context with the following override:'),
+                  processed_for(context.override)
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/proxy.rb

@@ -0,0 +1,28 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Proxy filter documentation provider
+            #
+            # Prints documenation for the nested filter/proc.
+            class Proxy < Rdoc::Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Proxy
+
+              def provide
+                sub(
+                  text('delegates to the following entity:'),
+                  processed_for(context.proc)
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/recursive_schema_filter.rb

@@ -0,0 +1,28 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Common class for schema-based filters
+            #
+            # Outputs schema object with specified blurb as the header.
+            class RecursiveSchemaFilter < Contextualized::Filter
+              def self.blurb(str = nil)
+                return @description_blurb if str.nil?
+                @description_blurb = str
+              end
+
+              def provide
+                sub(text(self.class.blurb), processed_for(context.scheme))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/remove.rb

@@ -0,0 +1,21 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Remove filter documentation provider
+            class Remove < RecursiveSchemaFilter
+              for_entity Templates::Utils::Contextualized::Filter::Remove
+
+              blurb 'remove the following parameters from the target context:'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/contextualized/filters/scoped.rb

@@ -0,0 +1,29 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          module Filters
+            ##
+            # Scope filter documentation provider
+            #
+            # Outputs documentation for the nested filter and scope.
+            class Scoped < Contextualized::Filter
+              for_entity Templates::Utils::Contextualized::Filter::Scoped
+
+              def provide
+                sub(
+                  text('scoped filter'),
+                  processed_for(context.scoped_filter),
+                  text("... to be executed in the scope #{context.scope}")
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Contextualized
+          ##
+          # Context filtering documentation aspect provider
+          #
+          # Describes context filtering in a separate text block.
+          class Provider < Rdoc::Inheritable
+            for_entity Templates::Utils::Contextualized
+
+            header 'Components scope filters'
+
+            protected
+
+            def description_for(mod)
+              return if mod.module_context.is_a?(Templates::Utils::Contextualized::Filter::Identity)
+              processed_for(mod.module_context)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        ##
+        # Default namespace
+        module Default
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/default/definition.rb

@@ -0,0 +1,89 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Default
+          ##
+          # Default's definition documentation provider
+          class Definition < Rdoc::Provider
+            using Templates::Utils::Default::Refinements
+
+            for_entity Templates::Utils::Default::Definition
+
+            ##
+            # Empty definition provider
+            #
+            # Doesn't provide actually anything. Returns nil.
+            class Empty < Definition
+              register_in Rdoc
+              for_entity Templates::Utils::Default::Definition::Empty
+
+              def provide; end
+            end
+
+            ##
+            # Combined definition documentation provider
+            #
+            # Composes left and right component of the pair into a documentation block.
+            class Pair < Definition
+              register_in Rdoc
+              for_entity Templates::Utils::Default::Definition::Pair
+
+              def provide
+                sub do |s|
+                  _add_parts(context.a, s)
+                  s << text('_overlayed_ _with_')
+                  _add_parts(context.b, s)
+                end
+              end
+
+              private
+
+              def _add_parts(side, container)
+                processed_for(side).parts.each { |part| container << part }
+              end
+            end
+
+            ##
+            # Scalar/override documentation provider
+            #
+            # Just generates documentation for the scalar.
+            class Scalar < Definition
+              for_entity Templates::Utils::Default::Definition::Scalar
+
+              def provide
+                processed_for(context.value)
+              end
+            end
+
+            ##
+            # Calculable documentation provider
+            #
+            # Generates documentation for the given code block.
+            class Calculable < Definition
+              for_entity Templates::Utils::Default::Definition::Calculable
+
+              def provide
+                processed_for(context.block)
+              end
+            end
+
+            ##
+            # Scheme documentation provider
+            #
+            # Generates documentation for the given defaults scheme.
+            class Scheme < Definition
+              for_entity Templates::Utils::Default::Definition::Scheme
+
+              def provide
+                processed_for(context.scheme)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Default
+          ##
+          # Defaults documentation provider
+          #
+          # Describes defaults attached to the object. Generates a text block with header and
+          # definition's description.
+          class Provider < Rdoc::Provider
+            for_entity Templates::Utils::Default
+
+            def provide
+              definition = processed_for(context.defaults_definition)
+              definition && sub(text('_Defaults_'), definition)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        ##
+        # Documentation blurb provider
+        #
+        # Outputs description blurb attached to the object in a separate text block.
+        class Dsl < Rdoc::Provider
+          def provide
+            return if context.help.nil?
+            sub(text('_Description_'), parsed_for(context.help))
+          end
+        end
+      end
+    end
+  end
+end