cloud-templates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd48a14067126047f160caf3ffdd1c48e2ff4e7
+  data.tar.gz: ef684b50d03d1fb6b69170b8aa10444895743c52
+SHA512:
+  metadata.gz: c79052077800068fa8b569b2785f5ca6941a2193c23ead7f48713698a1e3443e9e735e849fec75166db08b66f5574d0e86877db0f7a0bab30fd421665be408e7
+  data.tar.gz: be49da0fd91ad960a80cdd07f72bf7306ceee9e8ebddada8f11cada9e70ba397d296a831254af515a247d3167edcfe9c847904486299f56e8c139ee2f3f55df4

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require: rubocop-rspec
+
+RSpec/NestedGroups:
+  Max: 4
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+Metrics/BlockLength:
+  ExcludedMethods:
+    - class_scope
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Metrics/LineLength:
+  Max: 100
+
+Performance/HashEachMethods:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+
+SimpleCov.start do
+  add_filter '/spec'
+  add_group 'Lib', 'lib'
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2016-2017 Amazon.com, Inc. or its affiliates.
+All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may not use this file except in compliance with the License.
+A copy of the License is located at
+
+    http://aws.amazon.com/apache2.0/
+
+or in the "LICENSE" file accompanying this file. This file is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+or implied. See the License for the specific language governing permissions
+and limitations under the License.

data/README.md

@@ -0,0 +1,124 @@
+# Hierarchical data templates
+
+> MVC-based templating framework for hierarchical data structures
+
+The purpose of the framework is to bring templating capabilities to
+the areas where traditional approach for auto-generation
+(ERB can be an example) is problematic to apply.
+
+Text-based templating frameworks work well when the resulting output has
+moderate number of parameter-driven parts. For example, HTML output
+is perfect candidate for such templating.
+
+Problem arises when you try to template:
+* A data structure
+* A hierarchy of nested datastructures
+* All of the above with parent-child relations in types of the data
+  structures
+
+"Data structure" can be anything from XML, JSON, YAML, ASN or any
+domain-specific language. The problem manifests itself in the fact
+that data representation is very condensed so user ends up with
+a template where number of substitutions is bigger than static content.
+Also, usually, text template engines don't provide mechanisms for
+template inheritance.
+
+A practical examples of condensed data structure definition can be:
+* CloudFormation template
+* LDAP LDIF record
+* SQL DML script
+
+The core idea of the framework is to use hierarchical hash merges
+and transformations employing standard language class hierarchy and
+object embedding. Class hierarchy models commonalities in data
+structure types like LDAP classes.
+
+Framework also accommodates for the fact that there might be graph
+of relations between data structures in definition. Examples of
+such dependencies could be people org structure where some people
+can work on different project with their peers, can be participants
+of different groups or virtual teams. Another example is
+CloudFormation resource in CFN stack definition which can be depend
+on other resources outputs or sole fact of existence.
+
+The framework build with documentation and extended introspection
+features in mind. To support that there is a part of DSL which is
+designed for input hash checks and extracting parameters from it
+needed at the current processing step. For instance, you can specify
+parameter definition with constraints, default value, input hash
+extraction path or calculation block. This way you can use this
+parameter later in hash amendment to be sure that all constraints
+are met, default value is substituted and intermediate computations
+have been performed with all errors happening in this process
+wrapped in exceptions containing explaining what should be fixed.
+
+The framework consists of a few decoupled parts which can be used
+independently. Namely:
+* Options class. It implements the core part of hash merging mechanics.
+  Also it implements hierarchical structure look-up mechanism so
+  you can specify wildcard configurations in your input parameters
+  or output hash if it is to be consumed by someone else
+* Parametrized mixin. It implements hash parameter checking and depends
+  on presence of "options" method in your class which should implement
+  multiparameter look-up method []. It defines DSL for parameter
+  description. When applied it auto-generates options accessors
+  with value lookup in input hash, constraints validation,
+  value transformations and extended exceptions handling if an error
+  encountered during those stages
+* Amendable mixin. It implements class instance-based definitions of
+  so-called amendments. Amendments are input hash alterations and
+  transformations which are defined per-class basis and applied
+  according to class hierarchy when invoked. Amendment can be
+  a hash to be added to options, a Proc which will be invoked in
+  instance context and which should produce a hash to be added to
+  options or a Module in which case it's just an alias for "include"
+* Optionable class. A convenience intersection of embedded accessor
+  for Options field and Parametrized mixin. The basis for artifacts.
+* Constraint class and children. They are concrete constraint types
+  for Parametrized mixin.
+* Getter class and children. They are concrete look-up methods for
+  Parametrized mixin.
+* Transformation class and children. They are concrete type
+  transformation methods for Parametrized mixin.
+* Named mixin. A convenience util mixin which can be used for either
+  parameters as_object definitions which should contain "name" field
+  or as an artifact parameters definition mixin
+* BasicArtifact class. Represents basic datastructure type class and
+  the main vehicle of the framework.
+* BasicComposite class. A kind of BasicArtifact which is able to
+  embed other artifacts. This is a recursive structure so composite
+  can contain other composites since a composite is an artifact.
+* Render and Render::Type classes. Decoupled rendering helper.
+  "render" means to transform an artifact into a domain-specific
+  representation like SQL DML statement, LDIF definition, etc.
+  Each artifact to be rendered should have attached render. The link
+  between two is defined in a concrete child of Render class. Renders
+  can be inherited so if you have a universal way to render all your
+  artifacts you can just link the single render to BasicArtifact class.
+  Artifact can have *multiple* renders. For instance, you can generate
+  both SQL DML and JSON from the same artifact definition. Or
+  you can automate human-readable description creation like wiki
+  pages if you want to describe in words what CloudFromation stack
+  definition would create.
+
+## Roadmap
+
+* Optimization of internal logic
+* Error message and exception handling improvements:
+  * Each exception should have clear indication of where the problem originates
+* Embedded, class-based help
+  * Blurb should contain general description
+  * Help messages and documentation should support embedded pieces of sample code from examples
+    instead of inlining Ruby code directly into the doc
+  * Examples should be runnable directly inside of IRB
+  * Supported options list and provided defaults should be auto-generated from parameter
+    descriptions
+* Internationalization
+  * Help messages should support pluggable content
+  * Exceptions should support regionalized messages
+* Model-agnostic HTML/JS/SVG render
+* Integrated IDE for constructing object schemas (Ruby interactive interpreter combined with
+  GUI)
+* Assessment of the need of deep processing speed optimization:
+  * Assessment of alternative language technologies (Rust, Scala, C++, D) for re-implementation
+  * Assessment of moving separate parts to native code

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'yard'
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb']
+end
+
+desc 'Check code notation'
+RuboCop::RakeTask.new(:lint) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'examples/lib/**/*.rb', 'examples/spec/**/*.rb']
+  task.formatters += ['html']
+  task.options += [
+    '--fail-level', 'convention',
+    '--out', 'rubocop.html'
+  ]
+end
+
+desc 'Run unit tests'
+RSpec::Core::RakeTask.new(:test) do |task|
+  task.rspec_opts = '--require ./examples/lib_path.rb'
+  task.pattern = '{spec/,examples/spec/}**{,/*/**}/*_spec.rb'
+end
+
+task default: [:test, :lint, :doc]

data/cloud-templates.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name        = 'cloud-templates'
+  s.version     = '0.1.0'
+  s.license     = 'Apache 2.0'
+  s.summary     = 'Hierarchical data templates'
+  s.description = 'MVC-based templating framework for hierarchical data structures. ' \
+                  'It is created to fulfil different needs of putting your entire application ' \
+                  'configuration and infrastructure definition under the same roof.'
+  s.authors     = ['Ivan Matylitski', 'Corrado Primier']
+  s.email       = ['buffovich@gmail.com', 'cp@corradoprimier.it']
+  s.files       = Dir['lib/**/*'] +
+                  Dir['spec/**/*'] +
+                  Dir['examples/**/*'] +
+                  [
+                    'LICENSE', 'Gemfile', 'NOTICE', 'README.md', 'Rakefile',
+                    '.rubocop.yml', '.simplecov', 'cloud-templates.gemspec'
+                  ]
+  s.test_files = Dir['spec/**/*'] + Dir['examples/spec/**/*']
+  s.homepage    = 'https://rubygems.org/gems/cloud-templates'
+  s.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
+  s.add_development_dependency('rspec', '>= 3.2', '~> 3')
+  s.add_development_dependency('rubocop', '~> 0.46')
+  s.add_development_dependency('rubocop-rspec', '~> 1.17')
+  s.add_development_dependency('byebug', '>= 9.0.5', '~> 9')
+  s.add_development_dependency('yard', '~> 0.9')
+  s.add_development_dependency('simplecov', '~> 0.14')
+end

data/examples/lib/user_directory/artifacts/catalogized.rb

@@ -0,0 +1,11 @@
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/parametrized/constraints'
+
+module UserDirectory
+  ##
+  # Parameter mixin containing universal catalog entry fields
+  module Catalogized
+    include Aws::Templates::Utils::Parametrized
+    parameter :dn, description: 'Object distinguished name', constraint: not_nil
+  end
+end

data/examples/lib/user_directory/artifacts/group.rb

@@ -0,0 +1,37 @@
+require 'aws/templates/artifact'
+require 'aws/templates/utils/parametrized/constraints'
+require 'aws/templates/utils/parametrized/transformations'
+require 'user_directory/artifacts/ided'
+require 'user_directory/artifacts/catalogized'
+require 'user_directory/artifacts/pathed'
+
+module UserDirectory
+  ##
+  # POSIX Group
+  class Group < Aws::Templates::Artifact
+    include IDed
+    include Catalogized
+
+    default dn: proc { "cn=#{name},ou=System,#{organization.dn}" },
+            cn: proc { name }
+
+    parameter :cn, description: 'Group canonical name', constraint: not_nil
+    parameter :name, description: 'Group name'
+    parameter :organization,
+              description: 'Organization object',
+              constraint: not_nil,
+              transform: as_object(Catalogized)
+    parameter :members,
+              description: 'Group members list',
+              transform: as_list(
+                name: :member,
+                description: 'Member in the group',
+                constraint: not_nil,
+                transform: as_object do
+                  parameter :login,
+                            description: 'User login',
+                            constraint: not_nil
+                end
+              )
+  end
+end

data/examples/lib/user_directory/artifacts/ided.rb

@@ -0,0 +1,11 @@
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/parametrized/constraints'
+
+module UserDirectory
+  ##
+  # Parameter mixin containing universal parameters for indexed objects
+  module IDed
+    include Aws::Templates::Utils::Parametrized
+    parameter :id, description: 'Object ID', constraint: not_nil
+  end
+end

data/examples/lib/user_directory/artifacts/organization.rb

@@ -0,0 +1,17 @@
+require 'aws/templates/composite'
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/parametrized/constraints'
+require 'user_directory/artifacts/catalogized'
+
+module UserDirectory
+  ##
+  # Catalog's organization
+  class Organization < Aws::Templates::Composite
+    include Catalogized
+
+    default dn: proc { "o=#{name}" }
+    parameter :name, description: 'Organization name', constraint: not_nil
+
+    contextualize filter(:override) { { organization: self, unit: self } }
+  end
+end

data/examples/lib/user_directory/artifacts/pathed.rb

@@ -0,0 +1,22 @@
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/parametrized/constraints'
+require 'pathname'
+
+module UserDirectory
+  ##
+  # Parameter mixin containing universal fields for file objects
+  #
+  # It contains "path" field with constraint checking if the path
+  # passed is absolute.
+  module Pathed
+    include Aws::Templates::Utils::Parametrized
+
+    parameter :path,
+              description: 'Path',
+              transform: ->(_, s) { Pathname.new(s) },
+              constraint: all_of(
+                not_nil,
+                satisfies('The path is a valid absolute path', &:absolute?)
+              )
+  end
+end

data/examples/lib/user_directory/artifacts/person.rb

@@ -0,0 +1,20 @@
+require 'user_directory/utils'
+require 'user_directory/artifacts/user'
+
+module UserDirectory
+  ##
+  # Catalog's person
+  #
+  # Represents UNIX user who is a real person. Contains all related
+  # attributes.
+  class Person < User
+    default cn: proc { "#{given_name} #{last_name} (#{login})" }
+
+    parameter :given_name, description: 'Person\'s given name', constraint: not_nil
+    parameter :middle_name, description: 'Person\'s middle name'
+    parameter :last_name, description: 'Person\'s last name', constraint: not_nil
+    parameter :patronimic, description: 'Person\'s patronimic'
+    parameter :phone, description: 'Desk phone number', constraint: Utils.phone_number
+    parameter :manager, description: 'Person\'s manager', transform: as_object(Catalogized)
+  end
+end

data/examples/lib/user_directory/artifacts/team.rb

@@ -0,0 +1,31 @@
+require 'user_directory/artifacts/unit'
+
+module UserDirectory
+  ##
+  # Team composite
+  #
+  # Each team has a POSIX group assigned to its members, a manager,
+  # and subordinates. That's exactly what is represented here.
+  class Team < Unit
+    parameter :manager, description: 'Manager description hash', constraint: not_nil
+    parameter :subordinates,
+              description: 'List of subordinates\' descriptions',
+              constraint: not_nil
+    parameter :group_id, description: 'Team\'s group ID'
+
+    components do
+      group = artifact Group, label: 'group', name: name.downcase.tr(' ', '_'), id: group_id
+
+      contextualize(group: group) do
+        manager_artifact = artifact Person, manager.merge(label: 'manager')
+
+        # Circular dependency between group and its members
+        subordinates_artifacts = contextualize(manager: manager_artifact) do
+          subordinates.map { |subordinate| artifact Person, subordinate }
+        end
+
+        group.options[:members] = subordinates_artifacts << manager_artifact
+      end
+    end
+  end
+end

data/examples/lib/user_directory/artifacts/unit.rb

@@ -0,0 +1,24 @@
+require 'aws/templates/composite'
+require 'aws/templates/utils/parametrized'
+require 'aws/templates/utils/parametrized/constraints'
+require 'user_directory/artifacts/user'
+require 'user_directory/artifacts/catalogized'
+
+module UserDirectory
+  ##
+  # Catalog's organizational unit
+  class Unit < Aws::Templates::Composite
+    include Catalogized
+
+    default label: proc { name },
+            dn: proc { "ou=#{name},#{unit.dn}" }
+
+    parameter :unit,
+              description: 'Hierarchical parent of the unit',
+              constraint: not_nil,
+              transform: as_object(Catalogized)
+    parameter :name, description: 'Organizational unit name', constraint: not_nil
+
+    contextualize filter(:add, :shell, :organization) & filter(:override) { { unit: self } }
+  end
+end

data/examples/lib/user_directory/artifacts/user.rb

@@ -0,0 +1,29 @@
+require 'aws/templates/artifact'
+require 'aws/templates/utils/parametrized/constraints'
+require 'aws/templates/utils/parametrized/transformations'
+require 'user_directory/artifacts/ided'
+require 'user_directory/artifacts/pathed'
+require 'user_directory/artifacts/catalogized'
+
+module UserDirectory
+  ##
+  # POSIX user
+  class User < Aws::Templates::Artifact
+    include IDed
+    include Catalogized
+
+    default dn: proc { "cn=#{cn},#{unit.dn}" },
+            home_directory: proc { { path: "/home/#{login}" } },
+            shell: { path: '/bin/sh' }
+
+    parameter :cn, description: 'Object canonical name', constraint: not_nil
+    parameter :login, description: 'User login', constraint: not_nil
+    parameter :group,
+              description: 'User main group',
+              constraint: not_nil,
+              transform: as_object(IDed)
+    parameter :home_directory, description: 'Home directory', transform: as_object(Pathed)
+    parameter :shell, description: 'Shell path', transform: as_object(Pathed)
+    parameter :unit, description: 'User\'s organizational unit', transform: as_object(Catalogized)
+  end
+end