cloud-templates 0.2.0 → 0.3.0

data/examples/lib/user_directory/render.rb

@@ -0,0 +1,8 @@
+require 'aws/templates/utils'
+
+module UserDirectory
+  ##
+  # Namespace for different type of renders for organization models.
+  module Render
+  end
+end

data/examples/lib/user_directory/render/etc.rb

@@ -1,3 +1,5 @@
+require 'user_directory/render/etc/registry'
+
 Dir.glob("#{File.dirname(__FILE__)}/etc/*.rb").each do |file|
   require file
 end

data/examples/lib/user_directory/render/etc/artifact_view.rb

@@ -1,4 +1,4 @@
-require 'user_directory/render/etc/registry'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -8,7 +8,7 @@ module UserDirectory
       #
       # It just puts a link between children and type registrar
       class ArtifactView < Aws::Templates::Render::View
-        register_in Render::Etc
+        register_in Etc
       end
     end
   end

data/examples/lib/user_directory/render/etc/composite_view.rb

@@ -1,5 +1,4 @@
-require 'aws/templates/composite'
-require 'user_directory/render/etc/artifact_view'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render

data/examples/lib/user_directory/render/etc/group_view.rb

@@ -1,4 +1,4 @@
-require 'user_directory/render/etc/artifact_view'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -8,10 +8,10 @@ module UserDirectory
       #
       # Creates group file entry.
       class GroupView < ArtifactView
-        artifact UserDirectory::Group
+        artifact UserDirectory::Artifacts::Group
 
         def prepare
-          Diff.new [], [group_record.join(':')]
+          Render::Etc::Diff.new [], [group_record.join(':')]
         end
 
         def group_record

data/examples/lib/user_directory/render/etc/person_view.rb

@@ -1,4 +1,4 @@
-require 'user_directory/render/etc/user_view'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -8,7 +8,7 @@ module UserDirectory
       #
       # The same as POSIX user but with customized GECOS field.
       class PersonView < UserView
-        artifact UserDirectory::Person
+        artifact UserDirectory::Artifacts::Person
 
         def user_info
           in_instance { "#{cn},,#{phone}" }

data/examples/lib/user_directory/render/etc/registry.rb

@@ -1,6 +1,4 @@
-require 'aws/templates/render/utils/base_type_views'
-require 'aws/templates/render/view'
-require 'pathname'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -12,16 +10,16 @@ module UserDirectory
     module Etc
       extend Aws::Templates::Render::Utils::BaseTypeViews
       initialize_base_type_views
-      register Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
+      register ::Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
       Diff = Struct.new(:passwd, :group)
 
       ##
       # Diff view
       #
-      # Creates Diff object out of the instance atached with recursively rendered passwd and group
+      # Creates Diff object out of the instance attached with recursively rendered passwd and group
       # fields.
       class DiffView < Aws::Templates::Render::BasicView
-        register_in Etc
+        register_in Render::Etc
         artifact Diff
 
         def to_rendered

data/examples/lib/user_directory/render/etc/user_view.rb

@@ -1,5 +1,4 @@
-require 'user_directory/render/etc/artifact_view'
-require 'user_directory/artifacts/user'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -9,7 +8,7 @@ module UserDirectory
       #
       # It creates passwd file entry
       class UserView < ArtifactView
-        artifact UserDirectory::User
+        artifact UserDirectory::Artifacts::User
 
         def prepare
           Diff.new [user_record.join(':')], []

data/examples/lib/user_directory/render/ldap.rb

@@ -1,3 +1,5 @@
+require 'user_directory/render/ldap/registry'
+
 Dir.glob("#{File.dirname(__FILE__)}/ldap/*.rb").each do |file|
   require file
 end

data/examples/lib/user_directory/render/ldap/artifact_view.rb

@@ -1,15 +1,14 @@
-require 'aws/templates/artifact'
-require 'user_directory/render/ldap/registry'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # Basic render
       #
       # It just puts a link between children and type registrar
       class ArtifactView < Aws::Templates::Render::View
-        register_in Render::LDAP
+        register_in Render::Ldap
         artifact Aws::Templates::Artifact
 
         def prepare

data/examples/lib/user_directory/render/ldap/composite_view.rb

@@ -1,16 +1,15 @@
-require 'aws/templates/composite'
-require 'user_directory/render/ldap/registry'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # Composite render
       #
       # It aggregates LDIF entries from the children into a single list
       # putting composite's own LDIF entry into the list head.
       class CompositeView < Aws::Templates::Render::View
-        register_in Render::LDAP
+        register_in Render::Ldap
         artifact Aws::Templates::Composite
 
         def prepare

data/examples/lib/user_directory/render/ldap/group_view.rb

@@ -1,15 +1,14 @@
-require 'user_directory/render/ldap/artifact_view'
-require 'user_directory/artifacts/group'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # POSIX group render
       #
       # Creates group LDIF entry.
       class GroupView < ArtifactView
-        artifact UserDirectory::Group
+        artifact UserDirectory::Artifacts::Group
 
         def prepare
           super().merge(

data/examples/lib/user_directory/render/ldap/organization_view.rb

@@ -1,15 +1,14 @@
-require 'user_directory/render/ldap/composite_view'
-require 'user_directory/artifacts/organization'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # Catalog's organization render
       #
       # It renders into organization's LDIF entry with merged list of children.
       class OrganizationView < CompositeView
-        artifact UserDirectory::Organization
+        artifact UserDirectory::Artifacts::Organization
 
         protected
 

data/examples/lib/user_directory/render/ldap/person_view.rb

@@ -1,16 +1,15 @@
-require 'user_directory/render/ldap/user_view'
-require 'user_directory/artifacts/person'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # Person render
       #
       # It merges POSIX user entry with additional fields and object
       # types valid for a real person.
       class PersonView < UserView
-        artifact UserDirectory::Person
+        artifact UserDirectory::Artifacts::Person
 
         def prepare
           hsh = in_instance do

data/examples/lib/user_directory/render/ldap/registry.rb

@@ -1,5 +1,4 @@
-require 'aws/templates/render/utils/base_type_views'
-require 'pathname'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
@@ -7,10 +6,10 @@ module UserDirectory
     # LDIF render
     #
     # Transforms formed catalog artifacts into LDIF definition.
-    module LDAP
+    module Ldap
       extend Aws::Templates::Render::Utils::BaseTypeViews
       initialize_base_type_views
-      register Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
+      register ::Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
     end
   end
 end

data/examples/lib/user_directory/render/ldap/unit_view.rb

@@ -1,15 +1,14 @@
-require 'user_directory/render/ldap/composite_view'
-require 'user_directory/artifacts/unit'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # Catalog's org unit render
       #
       # It renders into unit's LDIF entry with merged list of children.
       class UnitView < CompositeView
-        artifact UserDirectory::Unit
+        artifact UserDirectory::Artifacts::Unit
 
         protected
 

data/examples/lib/user_directory/render/ldap/user_view.rb

@@ -1,15 +1,14 @@
-require 'user_directory/render/ldap/artifact_view'
-require 'user_directory/artifacts/user'
+require 'aws/templates/utils'
 
 module UserDirectory
   module Render
-    module LDAP
+    module Ldap
       ##
       # POSIX user render
       #
       # It creates POSIX user LDIF entry
       class UserView < ArtifactView
-        artifact UserDirectory::User
+        artifact UserDirectory::Artifacts::User
 
         def prepare
           super().merge(cn: instance.cn).merge(passwd_block)

data/examples/lib/user_directory/utils.rb

@@ -1,4 +1,4 @@
-require 'aws/templates/utils/parametrized/constraints'
+require 'aws/templates/utils'
 
 module UserDirectory
   ##

data/examples/spec/user_directory_spec.rb

@@ -1,24 +1,13 @@
 require 'spec_helper'
-
-require 'user_directory/artifacts/user'
-require 'user_directory/artifacts/person'
-require 'user_directory/artifacts/group'
-require 'user_directory/artifacts/unit'
-require 'user_directory/artifacts/team'
-require 'user_directory/artifacts/organization'
-
-require 'user_directory/render/etc'
-require 'user_directory/render/ldap'
-
-include UserDirectory
+require 'aws/templates/utils'
 
 # rubocop:disable Metrics/BlockLength
 describe UserDirectory do
   let(:directory) do
-    Organization.new(name: 'example.com', root: Object.new) do
-      artifact(Unit, name: 'Business') do
+    UserDirectory::Artifacts::Organization.new(name: 'example.com', root: Object.new) do
+      artifact(UserDirectory::Artifacts::Unit, name: 'Business') do
         artifact(
-          Team,
+          UserDirectory::Artifacts::Team,
           name: 'Sales',
           group_id: 120,
           manager: {
@@ -57,7 +46,7 @@ describe UserDirectory do
         )
 
         artifact(
-          Team,
+          UserDirectory::Artifacts::Team,
           name: 'Finances',
           group_id: 110,
           manager: {
@@ -85,12 +74,15 @@ describe UserDirectory do
           ]
         )
 
-        artifact Group, name: 'business', id: 100, members: search(klass: User, recursive: true)
+        artifact UserDirectory::Artifacts::Group,
+                 name: 'business',
+                 id: 100,
+                 members: search(klass: UserDirectory::Artifacts::User, recursive: true)
       end
 
-      artifact(Unit, name: 'Engineering', shell: { path: '/bin/zsh' }) do
+      artifact(UserDirectory::Artifacts::Unit, name: 'Engineering', shell: { path: '/bin/zsh' }) do
         artifact(
-          Team,
+          UserDirectory::Artifacts::Team,
           name: 'Production',
           group_id: 210,
           manager: {
@@ -119,7 +111,7 @@ describe UserDirectory do
         )
 
         artifact(
-          Team,
+          UserDirectory::Artifacts::Team,
           name: 'Development',
           group_id: 220,
           manager: {
@@ -155,7 +147,7 @@ describe UserDirectory do
         )
 
         artifact(
-          Team,
+          UserDirectory::Artifacts::Team,
           name: 'QA',
           group_id: 230,
           manager: {
@@ -190,15 +182,21 @@ describe UserDirectory do
           ]
         )
 
-        artifact Group, name: 'engineering', id: 200, members: search(klass: User, recursive: true)
+        artifact UserDirectory::Artifacts::Group,
+                 name: 'engineering',
+                 id: 200,
+                 members: search(klass: UserDirectory::Artifacts::User, recursive: true)
       end
 
-      artifact Group, name: 'managers', id: 300, members: search(label: 'manager', recursive: true)
+      artifact UserDirectory::Artifacts::Group,
+               name: 'managers',
+               id: 300,
+               members: search(label: 'manager', recursive: true)
     end
   end
 
   describe 'etc render' do
-    let(:rendered) { Render::Etc.view_for(directory).to_rendered }
+    let(:rendered) { UserDirectory::Render::Etc.view_for(directory).to_rendered }
 
     let(:expected) do
       UserDirectory::Render::Etc::Diff.new(
@@ -241,7 +239,7 @@ describe UserDirectory do
   end
 
   describe 'ldap render' do
-    let(:rendered) { Render::LDAP.view_for(directory).to_rendered }
+    let(:rendered) { UserDirectory::Render::Ldap.view_for(directory).to_rendered }
 
     let(:expected) do
       [
@@ -566,3 +564,4 @@ describe UserDirectory do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/aws/templates.rb

@@ -1,11 +1,3 @@
-require 'aws/templates/artifact'
-require 'aws/templates/composite'
-require 'aws/templates/render'
-require 'aws/templates/utils/named'
-require 'aws/templates/utils/parametrized/constraints'
-require 'aws/templates/utils/parametrized/transformations'
-require 'aws/templates/utils/parametrized/getters'
-
 ##
 # :main: README.md
 module Aws

data/lib/aws/templates/artifact.rb

@@ -1,9 +1,4 @@
-require 'aws/templates/utils/parametrized'
-require 'aws/templates/utils/parametrized/getters'
-require 'aws/templates/utils/parametrized/constraints'
-require 'aws/templates/utils/default'
-require 'aws/templates/utils/options'
-require 'aws/templates/utils/dependent'
+require 'aws/templates/utils'
 
 module Aws
   module Templates
@@ -53,9 +48,10 @@ module Aws
     # any auto-generated parameter with input hash if they have the same
     # name/path.
     class Artifact
-      include Utils::Default
-      include Utils::Parametrized
-      include Utils::Dependent
+      include Templates::Utils::Default
+      include Templates::Utils::Parametrized
+      include Templates::Utils::Dependent
+      include Templates::Help::Dsl
 
       attr_accessor :options
 
@@ -95,18 +91,30 @@ module Aws
 
       parameter :label, description: 'Artifact\'s label', constraint: not_nil
 
+      ##
+      # Meta field
+      #
+      # The field is used to attach arbitrary information to artifacts which is not directly
+      # relevant to artifact properties. This attribute can be used for tagginng, for instance.
+      def meta
+        return @meta if @meta
+
+        meta_option = options[:meta]
+        @meta = meta_option.nil? ? {} : meta_option.to_hash
+      end
+
       ##
       # Artifact's root
       #
       # A root is an object which bundles artifacts into common rendering group helping to find
       # disconnected pieces of dependency graph. If two artifacts have different roots they
       # definitelly belong to different graphs.
-      default root: proc { object_id }
-
       def root
         options[:root]
       end
 
+      default root: proc { object_id }
+
       # Artifact's look-up path through all ancestors
       def lookup_path
         acc = [label]
@@ -146,7 +154,7 @@ module Aws
       # * +params+ - input parameters hash to be used during following
       #              hash transformations and expansions.
       def initialize(params)
-        @options = Utils::Options.new(defaults, params)
+        @options = Templates::Utils::Options.new(defaults, params)
       end
     end
   end