app_archetype 1.2.3 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a10af9366de2e0735df447d87d1cbe3660601702b038fffff206a7489687c70
-  data.tar.gz: 4708824cee9cb49c3731038b1f13dc88b61ecb732a1de7fe45d1a483a0e66120
+  metadata.gz: 69596e80065838a6a6ee3e106cf923c0a5cde9c3ab021ad453cec86693b7a54e
+  data.tar.gz: 0c2efba5fa04672d651f85ee96c1758d5a1b2af04dc8229684f6a510208bcc46
 SHA512:
-  metadata.gz: 0bd5e63c6bdcdf49aa85266c2b63d09d5994113d192349051740829b3ce47d3727f7ee9455459aca5dec39b240d3d734df0c247dc8a8dfd4d6e3c0149d8cca07
-  data.tar.gz: a80ecdeaeb2e2ca8e2e91e6dbfbaaf78762cdd6eb8b3b3e94961696c3e3722f06170185b2404807a694db22e7be9e0737a44b886039b05a74077f307cf808612
+  metadata.gz: 6bdf46483034b8a0655597c181a2710a8d426f10b27aef0f9ae3d49598f3457e5f9231aab1c853dfbd17fefa2ceb2cb2a80e251a146a25abac3bb72e5ae789e0
+  data.tar.gz: 5925cafc17983ad94872e22a430a858b5f53feb1ebef9a4b1b00f1c6a337816b7331d0cc51f06c5d9bba74f57b1884378cc869cb283ceac46272970039ad10ca

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    app_archetype (1.2.3)
+    app_archetype (1.2.8)
       cli-format (~> 0.2)
       highline (~> 2.0)
       json (~> 2.3)
       json-schema (~> 2.8)
-      jsonnet (~> 0.3.0)
+      jsonnet (~> 0.4.0)
       logger (~> 1.4.2)
       os (~> 1.1)
       ostruct (~> 0.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)
@@ -60,7 +60,7 @@ GEM
     json (2.5.1)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    jsonnet (0.3.0)
+    jsonnet (0.4.0)
       mini_portile2 (>= 2.2.0)
     kwalify (0.7.2)
     launchy (2.5.0)
@@ -70,7 +70,7 @@ GEM
     mini_portile2 (2.6.1)
     minitest (5.14.4)
     os (1.1.1)
-    ostruct (0.3.3)
+    ostruct (0.4.0)
     parallel (1.19.2)
     parser (2.7.1.5)
       ast (~> 2.4.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
 
@@ -133,6 +161,10 @@ You can list the templates in your template directory at any time by running the
 archetype list
 ```
 
+## Contributing
+
+See CONTRIBUTING.md for more information
+
 ## Licence
 
 This gem is covered by the terms of the MIT licence. See LICENCE for more information

data/app_archetype.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'cli-format', '~> 0.2'
   spec.add_dependency 'highline', '~> 2.0'
   spec.add_dependency 'json', '~> 2.3'
-  spec.add_dependency 'jsonnet', '~> 0.3.0'
+  spec.add_dependency 'jsonnet', '~> 0.4.0'
   spec.add_dependency 'json-schema', '~> 2.8'
   spec.add_dependency 'logger', '~> 1.4.2'
   spec.add_dependency 'os', '~> 1.1'

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/cli.rb

@@ -8,7 +8,7 @@ require 'app_archetype/cli/prompts'
 
 module AppArchetype
   # Command line interface helpers and actions
-  class CLI < Thor
+  class CLI < ::Thor
     package_name 'Archetype'
 
     class <<self

data/lib/app_archetype/cli/presenters.rb

@@ -1,7 +1,7 @@
 require 'cli-format'
 
 module AppArchetype
-  class CLI < Thor
+  class CLI < ::Thor
     # CLI output presenters
     module Presenters
       ##

data/lib/app_archetype/cli/prompts.rb

@@ -1,7 +1,7 @@
 require 'highline'
 
 module AppArchetype
-  class CLI < Thor
+  class CLI < ::Thor
     # CLI output presenters
     module Prompts
       ##

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/template/variable_manager.rb

@@ -34,6 +34,15 @@ module AppArchetype
         @data.detect { |var| var.name == name }
       end
 
+      ##
+      # Adds a variable to the set
+      #
+      # @param [AppArchetype::Template::Variable] var
+      #
+      def add(var)
+        @data << var
+      end
+
       ##
       # Creates a hash representation of variables.
       #

data/lib/app_archetype/version.rb

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

data/spec/app_archetype/template/variable_manager_spec.rb

@@ -58,6 +58,19 @@ RSpec.describe AppArchetype::Template::VariableManager do
     end
   end
 
+  describe '#add' do
+    let(:new_var) { double(AppArchetype::Template::Variable) }
+
+    before do
+      subject.add(new_var)
+    end
+
+    it 'adds variable to set' do
+      expect(subject.instance_variable_get(:@data).include?(new_var))
+        .to be true
+    end
+  end
+
   describe '#to_h' do
     let(:instance_helpers) { double }
     let(:random_result) { 'random-string-25-chars-long' }

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.3
+  version: 1.2.8
 platform: ruby
 authors:
 - Andrew Bigger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-format
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement