cloud-templates 0.2.0 → 0.3.0

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

@@ -0,0 +1,48 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        ##
+        # Common functionality for documenting inheritable properties.
+        #
+        # Examples of inheritable properties:
+        # * parameters
+        # * context filters
+        # Those have one thing in common: they are inherited from a parent class to any child and
+        # to generate full documentation you need to go over all of them respecting class/module
+        # hierarchy. The class implements utility methods and provides IoC stubs to define
+        # specific behaviors with ease.
+        class Inheritable < Rdoc::Provider
+          def self.header(header = nil)
+            return @header if header.nil?
+            @header = header
+          end
+
+          def provide
+            desc = ancestors_description
+            sub(text(self.class.header.gsub(/(\S+)/, '_\1_')), desc) if desc
+          end
+
+          protected
+
+          def description_for(_mod)
+            raise Templates::Exception::NotImplementedError.new('The method should be overriden')
+          end
+
+          private
+
+          def ancestors_description
+            descriptions = context.ancestors_with(self.class.entity)
+                                  .map { |mod| description_for(mod) }
+                                  .reject(&:nil?)
+                                  .to_a
+
+            list(:BULLET, *descriptions) unless descriptions.empty?
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,31 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Abstract constraint provider
+          #
+          # Prints constraint-specific description and constraint condition.
+          class Constraint < Rdoc::Provider
+            for_entity Templates::Utils::Parametrized::Constraint
+
+            def provide
+              sub do |s|
+                s << super unless add_description(s)
+                condition_description = processed_for(context.pre_condition)
+                s << condition_description if condition_description
+              end
+            end
+
+            protected
+
+            def add_description(_); end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/aws/templates/help/rdoc/parametrized/constraints/all_of.rb

@@ -0,0 +1,39 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Chained constraint provider
+            #
+            # Prints documentation blocks for all of the nexted constraints in the chain.
+            class AllOf < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::AllOf
+
+              protected
+
+              def add_description(item)
+                item << text('satisfies all of the following:')
+                item << members
+              end
+
+              private
+
+              def members
+                list(:BULLET) do |l|
+                  context.constraints
+                         .lazy
+                         .map { |constraint| processed_for(constraint) }
+                         .each { |part| l << part }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/condition.rb

@@ -0,0 +1,44 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Abstract condition documentation provider
+            class Condition < Rdoc::Provider
+              for_entity Templates::Utils::Parametrized::Constraint::Condition
+
+              ##
+              # Equality condition documentation provider
+              #
+              # Outputs text block with value description.
+              class Equal < Condition
+                for_entity Templates::Utils::Parametrized::Constraint::Condition::Equal
+
+                def provide
+                  value = context.expected
+                  text("_when_ value #{value.nil? ? 'is nil' : "== #{value.inspect}"}")
+                end
+              end
+
+              ##
+              # Code-block condition documentation
+              class Conditional < Condition
+                for_entity Templates::Utils::Parametrized::Constraint::Condition::Conditional
+
+                def provide
+                  text("_when_ #{context.condition.source_location.join(':')}")
+                end
+              end
+
+              def provide; end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/depends_on_value.rb

@@ -0,0 +1,41 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Case-like constraint documentation provider
+            #
+            # Prints all handled value and respective constraints.
+            class DependsOnValue < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::DependsOnValue
+
+              protected
+
+              def add_description(item)
+                item << text('depends on value:')
+                item << _members
+              end
+
+              private
+
+              def _members
+                context.selector
+                       .lazy
+                       .map { |value, constraint| _constraint_variant_for(value, constraint) }
+                       .each_with_object(list) { |part, l| l << part }
+              end
+
+              def _constraint_variant_for(value, constraint)
+                sub(text("when _#{value}_ :"), processed_for(constraint))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/enum.rb

@@ -0,0 +1,33 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Enumerable constraint documentation provider
+            #
+            # Outputs a list of all possible values for the parameter.
+            class Enum < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::Enum
+
+              protected
+
+              def add_description(item)
+                item << text("one of: #{enumerate}")
+              end
+
+              private
+
+              def enumerate
+                context.set.map(&:inspect).join(',')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/matches.rb

@@ -0,0 +1,27 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Regular expression constraint documentation provider
+            #
+            # Outputs regular expression.
+            class Matches < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::Matches
+
+              protected
+
+              def add_description(item)
+                item << text("matches regular expression #{context.expression.inspect}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/not_nil.rb

@@ -0,0 +1,27 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Not-nil constraint documentation
+            #
+            # Just prints the blurb
+            class NotNil < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::NotNil
+
+              protected
+
+              def add_description(item)
+                item << text('can\'t be nil')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/requires.rb

@@ -0,0 +1,33 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Requires dependency provider
+            #
+            # Prints all requirements for the constraint.
+            class Requires < Parametrized::Constraint
+              for_entity Templates::Utils::Parametrized::Constraint::Requires
+
+              protected
+
+              def add_description(item)
+                item << text("requires the following parameters: #{requirements}")
+              end
+
+              private
+
+              def requirements
+                context.dependencies.map(&:to_s).join(',')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/templates/help/rdoc/parametrized/constraints/satisfies_condition.rb

@@ -0,0 +1,28 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          module Constraints
+            ##
+            # Condition constraint
+            #
+            # Just prints condition description.
+            class SatisfiesCondition < Parametrized::Constraint
+              register_in Rdoc
+              for_entity Templates::Utils::Parametrized::Constraint::SatisfiesCondition
+
+              protected
+
+              def add_description(item)
+                item << text(context.description)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,32 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Help
+      module Rdoc
+        module Parametrized
+          ##
+          # Nested object definition documentation provider
+          #
+          # Very similar to Artifact provider except it doesn't have a few aspects.
+          class Nested < Help::Aggregate
+            include Rdoc::Texting
+
+            register_in Rdoc
+            for_entity Templates::Utils::Parametrized::Nested
+
+            after Templates::Utils::Parametrized, Templates::Utils::Default
+
+            protected
+
+            def fragment; end
+
+            def compose(fragments)
+              list(:BULLET, *fragments)
+            end
+          end
+        end
+      end
+    end
+  end
+end