cloud-templates 0.2.0 → 0.3.0

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

@@ -0,0 +1,22 @@
+require 'aws/templates/utils'
+
+module Aws
+  module Templates
+    module Utils
+      ##
+      # Recusrsive refinement
+      #
+      # The refinement adds to_recursive method to all standard classes which support recursive
+      # concept.
+      module Recursive
+        ##
+        # Hash implements resursive concept
+        refine ::Hash do
+          def to_recursive
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/spec/aws/templates/artifact_spec.rb

@@ -25,7 +25,7 @@ describe Aws::Templates::Artifact do
     Struct.new(:root)
   end
 
-  context 'featuring class is created' do
+  context 'when featuring class is created' do
     let(:featuring_class) { artifact_class.featuring(TestTest::A, TestTest::B) }
 
     it 'returns correct class name' do
@@ -33,7 +33,7 @@ describe Aws::Templates::Artifact do
     end
   end
 
-  context 'instance created' do
+  context 'when instance created' do
     let(:params) do
       {
         c: 'qwe',
@@ -48,13 +48,13 @@ describe Aws::Templates::Artifact do
 
     let(:instance) { artifact_class.new(params) }
 
-    context 'label is not specified' do
+    context 'without label' do
       it 'contains auto-generated label' do
         expect(instance.label).not_to be_nil
       end
     end
 
-    context 'root is not specified' do
+    context 'without root' do
       it 'root is not empty' do
         expect(instance.root).not_to be_nil
       end
@@ -62,13 +62,13 @@ describe Aws::Templates::Artifact do
         expect(instance.dependencies).to be_empty
       end
     end
-    context 'label is specified' do
+    context 'with label' do
       before { params[:label] = 'b' }
       it 'contains passed label' do
         expect(instance.label).to be == 'b'
       end
     end
-    context 'root is specified' do
+    context 'with root' do
       before { params[:root] = 1 }
       it 'contains one dependency' do
         expect(instance.dependencies).to be == [just_object.new(1)].to_set
@@ -77,13 +77,13 @@ describe Aws::Templates::Artifact do
         expect(instance.root).to be == 1
       end
     end
-    context 'different root is specified' do
+    context 'with different root' do
       before { params[:root] = 2 }
       it 'contains one dependency' do
         expect(instance.dependencies).to be == [just_object.new(2)].to_set
       end
     end
-    context 'no overrides specified' do
+    context 'without overrides' do
       before { params.merge!(root: 3, label: 'thing') }
 
       let(:expected) do
@@ -106,7 +106,7 @@ describe Aws::Templates::Artifact do
         expect(instance.options.to_hash).to be == expected
       end
     end
-    context 'override is present in input hash' do
+    context 'with override' do
       before { params.merge!(root: 3, label: 'thing', a: 'rty') }
 
       let(:expected) do
@@ -131,7 +131,7 @@ describe Aws::Templates::Artifact do
     end
   end
 
-  context 'instance of child class created' do
+  context 'when instance of child class created' do
     let(:child_class) do
       Class.new(artifact_class) do
         default a: deleted,

data/spec/aws/templates/cli_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+module DummyRender
+  extend Aws::Templates::Render
+
+  define_view(Aws::Templates::Artifact) do
+    def to_rendered
+      instance.options.to_hash.to_a
+    end
+  end
+end
+
+class StubShell < ::Thor::Shell::Basic
+  def initialize(output, error)
+    @output = output
+    @error = error
+    super()
+  end
+
+  protected
+
+  def stdout
+    @output || STDOUT
+  end
+
+  def stderr
+    @error || STDERR
+  end
+end
+
+describe Aws::Templates::Cli do
+  let(:parameters) {}
+
+  let(:command) {}
+
+  let(:arguments) {}
+
+  let(:argv) { [command].concat(arguments).concat(parameters.map { |k, v| "#{k}#{v}" }) }
+
+  let(:stdout) { StringIO.new('', 'w+') }
+
+  let(:stderr) { StringIO.new('', 'w+') }
+
+  let(:shell) { StubShell.new(stdout, stderr) }
+
+  describe 'render' do
+    let(:parameters) do
+      {
+        '--render=' => 'DummyRender',
+        '--options=' => { label: 1, root: 2 }.to_json
+      }
+    end
+
+    let(:command) { 'render' }
+
+    let(:arguments) { ['Aws::Templates::Artifact'] }
+
+    before do
+      described_class.start(argv, shell: shell)
+    end
+
+    it 'prints rendered output' do
+      expect(stdout.string).to be == "[[\"label\",1],[\"root\",2]]\n"
+    end
+  end
+
+  describe 'document' do
+    let(:parameters) { {} }
+
+    let(:command) { 'document' }
+
+    let(:arguments) { ['Aws::Templates::Artifact'] }
+
+    before do
+      described_class.start(argv, shell: shell)
+    end
+
+    it 'prints documentation' do
+      expect(stdout.string).to match(/Artifact.*Parents.*Parameters/m)
+    end
+  end
+end

data/spec/aws/templates/composite_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 require 'aws/templates/composite'
 
+using Aws::Templates::Utils::Dependency::Refinements
+
 class A
   attr_reader :params
 
@@ -54,7 +56,7 @@ describe Aws::Templates::Composite do
     instance.artifacts.each_with_object({}) { |(k, v), memo| memo[k] = v.params.to_hash }
   end
 
-  context 'a parameter is overriden' do
+  context 'when a parameter is overriden' do
     let(:instance) { composite_class.new(parameters) }
 
     let(:result) do
@@ -312,7 +314,7 @@ describe Aws::Templates::Composite do
       }
     end
 
-    context 'using constructor block' do
+    context 'when using constructor block' do
       let(:instance) do
         composite_class.new(parameters) do
           artifact(
@@ -326,7 +328,7 @@ describe Aws::Templates::Composite do
       it_behaves_like 'an artifact storage'
     end
 
-    context 'using instance components method' do
+    context 'when using instance components method' do
       let(:instance) do
         composite_class.new(parameters).components do
           artifact(
@@ -340,7 +342,7 @@ describe Aws::Templates::Composite do
       it_behaves_like 'an artifact storage'
     end
 
-    context 'using subclass' do
+    context 'when using subclass' do
       let(:subclass) do
         Class.new(composite_class) do
           components do

data/spec/aws/templates/help/rdoc/artifact_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+describe Aws::Templates::Help::Rdoc::Artifact do
+  let(:klass) do
+    Class.new(Aws::Templates::Artifact) do
+      help 'Very good thing'
+
+      def self.name
+        'Test'
+      end
+
+      default undocumented: 3,
+              label: :ert,
+              root: :a
+
+      default :ancestors.to_proc
+
+      default a: { b: :name.to_proc }
+
+      default a: { b: { d: 1 } }
+
+      parameter :undocumented
+      parameter :undocumented_with_constraint, constraint: not_nil
+      parameter :undocumented_with_constraint_and_transform,
+                constraint: not_nil,
+                transform: as_string
+      parameter :documented,
+                description: 'Documented parameter'
+      parameter :documented_with_constraint,
+                description: 'Documented parameter with constraint',
+                constraint: enum(1, 2, 3)
+      parameter :documented_with_constraint_and_transform,
+                description: 'Documented parameter with constraint and transformation',
+                constraint: all_of(
+                  not_nil,
+                  satisfies('not too big') { |v| v.size < 10 }
+                ),
+                transform: as_list
+    end
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(klass) }
+
+  let(:blurb) do
+    "\e[0m  \n" \
+    "\e[1mTest\e[m\n" \
+    "  \e[4mParents\e[m: Aws::Templates::Artifact\n\n" \
+    "  \e[4mDescription\e[m\n" \
+    "    Very good thing\n\n\n" \
+    "  \e[4mParameters\e[m\n" \
+    "  * \e[4mlabel\e[m Artifact's label\n" \
+    "    * constraint:\n" \
+    "      * can't be nil\n" \
+    "  * \e[4mparent\e[m Artifact parent\n" \
+    "  * \e[4mundocumented\e[m \n" \
+    "  * \e[4mundocumented_with_constraint\e[m \n" \
+    "    * constraint:\n" \
+    "      * can't be nil\n" \
+    "  * \e[4mundocumented_with_constraint_and_transform\e[m \n" \
+    "    * transformation:\n" \
+    "      * to string\n" \
+    "    * constraint:\n" \
+    "      * can't be nil\n" \
+    "  * \e[4mdocumented\e[m Documented parameter\n" \
+    "  * \e[4mdocumented_with_constraint\e[m Documented parameter with constraint\n" \
+    "    * constraint:\n" \
+    "      * one of: 1,2,3\n" \
+    "  * \e[4mdocumented_with_constraint_and_transform\e[m Documented parameter with\n" \
+    "    constraint and transformation\n" \
+    "    * transformation:\n" \
+    "      * as a list where elements can be anything\n" \
+    "    * constraint:\n" \
+    "      * satisfies all of the following:\n" \
+    "        * can't be nil\n" \
+    "        * not too big\n\n" \
+    "  \e[4mDefaults\e[m\n" \
+    "    * \e[4mlabel\e[m :ert\n" \
+    "    * \e[4mroot\e[m :a\n" \
+    "    * \e[4mundocumented\e[m 3\n" \
+    "    \e[4moverlayed\e[m \e[4mwith\e[m\n" \
+    "    Calculated\n" \
+    "    \e[4moverlayed\e[m \e[4mwith\e[m\n" \
+    "    * \e[4ma\e[m\n" \
+    "      * \e[4mb\e[m Calculated\n" \
+    "        \e[4moverlayed\e[m \e[4mwith\e[m\n" \
+    "        \e[4mb\e[m\n" \
+    "        * \e[4md\e[m 1\n\n\n"
+  end
+
+  it 'generates help correctly' do
+    expect(help).to be == blurb
+  end
+end

data/spec/aws/templates/help/rdoc/composite_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+class RdocTestComposite < Aws::Templates::Composite
+  help 'Very good thing'
+
+  default undocumented: 3,
+          label: 23,
+          root: 56
+
+  parameter :undocumented
+
+  contextualize filter(:copy)
+end
+
+describe Aws::Templates::Help::Rdoc::Composite do
+  let(:blurb) do
+    "\e[0m  \n" \
+    "\e[1mRdocTestComposite\e[m\n" \
+    "  \e[4mParents\e[m: Aws::Templates::Composite->Aws::Templates::Artifact\n\n" \
+    "  \e[4mDescription\e[m\n" \
+    "    Very good thing\n\n\n" \
+    "  \e[4mParameters\e[m\n" \
+    "  * \e[4mlabel\e[m Artifact's label\n" \
+    "    * constraint:\n" \
+    "      * can't be nil\n" \
+    "  * \e[4mparent\e[m Artifact parent\n" \
+    "  * \e[4mundocumented\e[m \n\n" \
+    "  \e[4mDefaults\e[m\n" \
+    "    * \e[4mlabel\e[m 23\n" \
+    "    * \e[4mroot\e[m 56\n" \
+    "    * \e[4mundocumented\e[m 3\n\n\n" \
+    "  \e[4mComponents\e[m \e[4mscope\e[m \e[4mfilters\e[m\n" \
+    "  * a chain of the following filters:\n" \
+    "    * merge the following options from the parent context:\n" \
+    "      * [:root]\n" \
+    "    * merge the context with the following override:\n"
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(RdocTestComposite) }
+
+  it 'generates help blurb correctly' do
+    expect(help.include?(blurb)).to be true
+  end
+
+  it 'generates defaults correctly' do
+    expect(help).to match(/undocumented.*3/m)
+  end
+
+  it 'generates context filters' do
+    expect(help).to match(/Components[^\n]+scope.*copy the entire/m)
+  end
+end

data/spec/aws/templates/help/rdoc/parametrized/constraints/all_of_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+describe Aws::Templates::Help::Rdoc::Parametrized::Constraints::AllOf do
+  let(:parametrized) do
+    Module.new do
+      include Aws::Templates::Utils::Parametrized
+      parameter :all_of_field, constraint: all_of(not_nil, enum(:a, :b, :c))
+    end
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(parametrized) }
+
+  it 'prints documentation' do
+    expect(help).to match(/all_of_field.*be nil.*one of.*a..b..c/m)
+  end
+end

data/spec/aws/templates/help/rdoc/parametrized/constraints/depends_on_value_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+describe Aws::Templates::Help::Rdoc::Parametrized::Constraints::DependsOnValue do
+  let(:parametrized) do
+    Module.new do
+      include Aws::Templates::Utils::Parametrized
+      parameter :field
+      parameter :depends_on_value_requires_field,
+                constraint: depends_on_value(a: requires(:field))
+    end
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(parametrized) }
+
+  it 'prints documentation' do
+    expect(help).to match(
+      /depends_on_value_requires_field.*depends.*when[^\n]+a.*requires.*field/m
+    )
+  end
+end

data/spec/aws/templates/help/rdoc/parametrized/constraints/enum_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+describe Aws::Templates::Help::Rdoc::Parametrized::Constraints::Enum do
+  let(:parametrized) do
+    Module.new do
+      include Aws::Templates::Utils::Parametrized
+      parameter :enum_field, constraint: enum(1, 2, '3')
+    end
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(parametrized) }
+
+  it 'prints documentation' do
+    expect(help).to match(/enum_field.*one of.+1.+2.+3/m)
+  end
+end

data/spec/aws/templates/help/rdoc/parametrized/constraints/matches_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'aws/templates/utils'
+
+describe Aws::Templates::Help::Rdoc::Parametrized::Constraints::Matches do
+  let(:parametrized) do
+    Module.new do
+      include Aws::Templates::Utils::Parametrized
+      parameter :matches_field, constraint: matches(/ABC/)
+    end
+  end
+
+  let(:help) { Aws::Templates::Help::Rdoc.show(parametrized) }
+
+  it 'prints documentation' do
+    expect(help).to match(/matches_field.*matches.*ABC/m)
+  end
+end