app_archetype 1.2.4 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712a81bd843f73805f693d41c2d2866b7c5953931385ec6011627ec924619c1a
-  data.tar.gz: a5947470c4ff4e17c537b5cd3fbe2d28eea2c7d601e40ee970717362d73e97cf
+  metadata.gz: 5e74cf25e1e7b6d3d39473af26d5ba9306658755b6e22e24f985fc1f20fda3e6
+  data.tar.gz: '090fa7d8d796c5a0f734980b9b6fc77689edc5937aa66735798b5110bd07bb2b'
 SHA512:
-  metadata.gz: 6700f0205d74ca6f5886cae5954c315032b93a70024c165be0586f7377ed7f49136106871b16584423db0e162427a6bf80ade4c39ac14d69e36c1b3ebfe79995
-  data.tar.gz: d221d2a1e8e973793223d94694461e89d8e5b8b6ababb74643815f05e3e943170337e5071522fde14fae69ee33675fc4e519d05ea62b8eb371b0f7aee7e2065d
+  metadata.gz: 4de9bfcc1e636ec9437498de6134f696132221358a55f63c70664fe0fd8a2e0652b3918c3942ac965c46e4a053585cc3cd831294f082530966ac9b88473d09bf
+  data.tar.gz: a5dc66e068d8a54a9e72de76560816a2c1ef72fe0a0069a7cd05296ca9b2b8e810983b5161c37e434e253b7569b82ef59ccc6d56ef460d83019db319ea1daeac

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_archetype (1.2.4)
+    app_archetype (1.2.6)
       cli-format (~> 0.2)
       highline (~> 2.0)
       json (~> 2.3)
@@ -16,7 +16,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/README.md

@@ -6,18 +6,20 @@ Code project template renderer
 
 ## Installation
 
-Add the following to your Gemfile
-
-```ruby
-gem 'app_archetype'
-```
-
-Or install the gem into your system:
+This is best run as a CLI tool installed into your system:
 
 ```bash
 gem install app_archetype
 ```
 
+For inclusion in another script or application, add this line to your application's Gemfile:
+
+Add the following to your Gemfile
+
+## Getting Started
+
+### Setting up your environment for CLI use
+
 If installed as a system gem, you'll need to create a template directory and set it in your environment:
 
 ```bash
@@ -57,7 +59,7 @@ Templates are a collection of files in the template folder with a manifest. The
  | - | - manifest.json
 ```
 
-Each template must include a manifest which has instructions necessary to render the template at run time. 
+Each template must include a manifest which has instructions necessary to render the template at run time.
 
 To create a blank template run the new command with the relative (from your template directory) path to your new template. For example to create a ruby gem you might:
 
@@ -89,7 +91,10 @@ A manifest has a name, version and set of variables. A sample manifest looks lik
     }
   },
   "variables": {
-    "foo": "bar",
+    "foo": {
+      "type": "string",
+      "default": "bar"
+    }
   }
 }
 ```
@@ -97,7 +102,30 @@ A manifest has a name, version and set of variables. A sample manifest looks lik
 - `name` should be a unique name that identifies a manifest for you
 - `version` should be the version of the template
 - `metadata.app_archetype` is information about the manifest for the app archetype gem. `metadata.app_archetype.version` is required, and must be less than the version of the currently installed gem.
-- `variables` is a schemaless object that you may use to provide variables at render time
+- `variables` is an object of variable descriptions
+
+#### Variable Descriptions
+
+Variable descriptions looks like this:
+
+```json
+{
+  "variables": {
+    "foo": {
+      "type": "string",
+      "description": "An example string",
+      "default": "bar"
+    },
+  }
+}
+```
+
+Below is a description of the supported attributes in a variable definition:
+
+- `type` (required) specifies the type of the variable. This can be one of `string`, `boolean`, `integer` or `map`
+- `description` (recommended) a short string that describes to the user what the variable is going to be usef for
+- `default` (optional) allows you to specify a default that is selected as the value when the user enters nothing into the prompt
+- `value` (optional) when set the user will not be prompted for a value when the template is being generated
 
 ##### Jsonnet support
 

data/lib/app_archetype.rb

@@ -7,8 +7,41 @@ require 'app_archetype/template_manager'
 require 'app_archetype/renderer'
 require 'app_archetype/generators'
 
+require 'app_archetype/cli/prompts'
+
 require 'app_archetype/version'
 
 # AppArchetype is the namespace for app_archetype
 module AppArchetype
+  def self.render(
+    name,
+    templates_dir,
+    destination_path: Dir.pwd,
+    overwrite: true,
+    variables: []
+  )
+    manifest_file = File.join(templates_dir, name, 'manifest.json')
+
+    manifest = AppArchetype::Template::Manifest.new_from_file(manifest_file)
+
+    template = manifest.template
+    template.load
+
+    variables.each { |var| manifest.variables.add(var) }
+
+    manifest.variables.all.each do |var|
+      value = AppArchetype::CLI::Prompts.variable_prompt_for(var)
+      var.set!(value)
+    end
+
+    plan = AppArchetype::Template::Plan.new(
+      template,
+      manifest.variables,
+      destination_path: destination_path,
+      overwrite: overwrite
+    )
+
+    plan.devise
+    plan.execute
+  end
 end

data/lib/app_archetype/template/variable.rb

@@ -16,7 +16,8 @@ module AppArchetype
       DEFAULT_VALUES = {
         'string' => '',
         'boolean' => false,
-        'integer' => 0
+        'integer' => 0,
+        'map' => {}
       }.freeze
 
       ##
@@ -55,13 +56,25 @@ module AppArchetype
         input != '0' && input.to_i != 0
       end
 
+      ##
+      # Map validation function. Ensures given input is a map
+      #
+      # @param [Object] input
+      #
+      # @return [Boolean]
+      #
+      MAP_VALIDATOR = lambda do |input|
+        input.is_a?(Hash)
+      end
+
       ##
       # Maps type to validation function
       #
       VALIDATORS = {
         'string' => STRING_VALIDATOR,
         'boolean' => BOOLEAN_VALIDATOR,
-        'integer' => INTEGER_VALIDATOR
+        'integer' => INTEGER_VALIDATOR,
+        'map' => MAP_VALIDATOR
       }.freeze
 
       ##
@@ -185,7 +198,7 @@ module AppArchetype
       ##
       # Returns true if the value input is valid.
       #
-      # @param [String] input
+      # @param [Object] input
       #
       # @return [Boolean]
       #

data/lib/app_archetype/version.rb

@@ -2,5 +2,5 @@ module AppArchetype
   ##
   # AppArchetype version
   #
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.2.6'.freeze
 end

data/spec/app_archetype/template/variable_spec.rb

@@ -72,6 +72,20 @@ RSpec.describe AppArchetype::Template::Variable do
     end
   end
 
+  describe '::MAP_VALIDATOR' do
+    it 'returns true when given hash' do
+      expect(
+        described_class::MAP_VALIDATOR.call({})
+      ).to be true
+    end
+
+    it 'returns false when given a non hash input' do
+      expect(
+        described_class::MAP_VALIDATOR.call('zyzz')
+      ).to be false
+    end
+  end
+
   describe '#set!' do
     context 'setting with a valid value' do
       before { subject.set!('a value') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_archetype
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.6
 platform: ruby
 authors:
 - Andrew Bigger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-format