app_archetype 1.2.8 → 1.4.2

data/lib/app_archetype/commands/render_template.rb

@@ -0,0 +1,178 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Prompts user for variable values and renders template to disk
+    class RenderTemplate
+      def initialize(manager, destination_path, options = Hashie::Mash.new)
+        @manager = manager
+        @destination_path = destination_path
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Renders a template with instructions described
+      # in the manifest.
+      #
+      # First it looks to the options to determine the
+      # name of the manifest. If one is not provided
+      # then the user will be prompted to choose a manifest
+      # from the list.
+      #
+      # The manager will then attempt to find the manifest.
+      # if one is not found then a RuntimeError will be raised.
+      #
+      # Once the manifest is loaded the template will be loaded
+      # into memory.
+      #
+      # Then the variables specified in the manifest are
+      # resolved. This involves the command prompting
+      # for values.
+      #
+      # A plan can then be constructed with the template and
+      # variables, this plan is then devised and executed.
+      #
+      # When the render is successful a success message
+      # is sent to STDOUT to confirm the operation was
+      # successful.
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.select('Please choose manifest', @manager.manifest_names)
+
+        manifest = @manager.find_by_name(name)
+
+        unless manifest
+          puts "✖ No template with name `#{name}` found."
+          return
+        end
+
+        template = manifest.template
+        template.load
+
+        resolve_variables(manifest)
+        render_template(
+          manifest,
+          template,
+          overwrite: @options.overwrite
+        )
+
+        puts("✔ Rendered #{name} to #{@destination_path}")
+      end
+
+      ##
+      # Prompts user for values for each variable
+      # specified in the given manifest. And then
+      # sets the value of those variables to the
+      # answers to the prompts.
+      #
+      # @param[AppArchetype::Template::Manifest] manifest
+      #
+      def resolve_variables(manifest)
+        manifest.variables.all.each do |var|
+          value = variable_prompt_for(var)
+          var.set!(value)
+        end
+      end
+
+      ##
+      # Builds plan to render template and executes
+      # it - essentially rendering the template to
+      # the output location
+      #
+      # @param [AppArchetype::Template::Manifest] manifest
+      # @param [AppArchetype::Template] template
+      # @param [Boolean] overwrite
+      #
+      def render_template(
+        manifest,
+        template,
+        overwrite: false
+      )
+        plan = AppArchetype::Template::Plan.new(
+          template,
+          manifest.variables,
+          destination_path: @destination_path,
+          overwrite: overwrite
+        )
+
+        plan.devise
+        plan.execute
+      end
+
+      ##
+      # Resolver for a given variable
+      #
+      # First, it will set the value if the value is set in
+      # the manifest.
+      #
+      # Otherwise it will call a function that prompts
+      # a user for input depending on type.
+      #
+      # By default it will call the string variable prompt
+      #
+      # @param [AppArchetype::Template::Variable] var
+      #
+      # @return [Object]
+      #
+      def variable_prompt_for(var)
+        return var.value if var.value?
+        return boolean_variable_prompt_for(var) if var.type == 'boolean'
+        return integer_variable_prompt_for(var) if var.type == 'integer'
+
+        string_variable_prompt_for(var)
+      end
+
+      ##
+      # Prompts and then asks for boolean input for
+      # a boolean variable
+      #
+      # @param [AppArchetype::Template::Variable] var
+      #
+      # @return [Boolean]
+      #
+      def boolean_variable_prompt_for(var)
+        puts "• #{var.name} (#{var.description})"
+
+        @prompt.yes?(
+          "Enter value for `#{var.name}` variable:",
+          default: var.default
+        )
+      end
+
+      ##
+      # Prompts and then asks for integer input for
+      # a integer variable
+      #
+      # @param [AppArchetype::Template::Variable] var
+      #
+      # @return [Integer]
+      #
+      def integer_variable_prompt_for(var)
+        puts "• #{var.name} (#{var.description})"
+
+        @prompt.ask("Enter value for `#{var.name}` variable:",
+                    convert: :int,
+                    default: var.default)
+      end
+
+      ##
+      # Prompts and then asks for string input for
+      # a string variable
+      #
+      # @param [AppArchetype::Template::Variable] var
+      #
+      # @return [String]
+      #
+      def string_variable_prompt_for(var)
+        puts "• #{var.name} (#{var.description})"
+
+        @prompt.ask(
+          "Enter value for `#{var.name}` variable:",
+          default: var.default
+        )
+      end
+    end
+  end
+end

data/lib/app_archetype/commands.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+
+ARCHETYPE_CLI_COMMANDS = File.join(__dir__, 'commands', '*.rb')
+
+Dir[ARCHETYPE_CLI_COMMANDS].sort.each do |file|
+  require file
+end
+
+module AppArchetype
+  # Module for CLI command classes
+  module Commands
+  end
+end

data/lib/app_archetype/generators.rb

@@ -25,7 +25,8 @@ module AppArchetype
             'version' => AppArchetype::VERSION
           }
         },
-        'variables' => DEFAULT_VARS
+        'variables' => DEFAULT_VARS,
+        'next_steps' => []
       }
     end
 
@@ -48,7 +49,7 @@ module AppArchetype
       MD
     end
 
-    class <<self
+    class << self
       ##
       # Render empty template renders a manifest and template folder at
       # the given path.
@@ -60,7 +61,7 @@ module AppArchetype
       # @param [String] path
       #
       def render_empty_template(name, path)
-        template_path = File.join(path, name)
+        template_path = File.join(path, 'template')
         manifest_path = File.join(path, 'manifest.json')
         readme_path = File.join(path, 'README.md')
 

data/lib/app_archetype/template/manifest.rb

@@ -38,11 +38,14 @@ module AppArchetype
           },
           variables: {
             type: 'object'
+          },
+          next_steps: {
+            type: 'array'
           }
         }
       }.freeze
 
-      class <<self
+      class << self
         ##
         # Creates a [AppArchetype::Template] from a manifest json so long as the
         # manifest is compatible with this version of AppArchetype.
@@ -130,6 +133,19 @@ module AppArchetype
         @data.metadata
       end
 
+      ##
+      # Next steps getter
+      #
+      # @return [String]
+      #
+      def next_steps
+        steps = @data.next_steps
+
+        return [] unless steps
+
+        steps
+      end
+
       ##
       # Parent path of the manifest (working directory)
       #

data/lib/app_archetype/template_manager.rb

@@ -27,12 +27,10 @@ module AppArchetype
       Dir.glob(
         File.join(@template_dir, '**', 'manifest.json*')
       ).each do |manifest|
-        begin
-          @manifests << AppArchetype::Template::Manifest.new_from_file(manifest)
-        rescue StandardError
-          puts "WARN: `#{manifest}` is invalid, skipping"
-          next
-        end
+        @manifests << AppArchetype::Template::Manifest.new_from_file(manifest)
+      rescue StandardError
+        puts "WARN: `#{manifest}` is invalid, skipping"
+        next
       end
     end
 
@@ -109,5 +107,14 @@ module AppArchetype
 
       results.first
     end
+
+    ##
+    # Returns a list of manifest names from loaded templates
+    #
+    # @return [Array]
+    #
+    def manifest_names
+      @manifests.map(&:name)
+    end
   end
 end

data/lib/app_archetype/version.rb

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

data/lib/app_archetype.rb

@@ -7,41 +7,58 @@ require 'app_archetype/template_manager'
 require 'app_archetype/renderer'
 require 'app_archetype/generators'
 
-require 'app_archetype/cli/prompts'
-
 require 'app_archetype/version'
+require_relative './app_archetype/commands'
 
 # AppArchetype is the namespace for app_archetype
 module AppArchetype
-  def self.render(
-    name,
-    templates_dir,
-    destination_path: Dir.pwd,
-    overwrite: true,
-    variables: []
+  ##
+  # Self contained template render method
+  #
+  # Takes collection directory and template name to
+  # load a new manager and find the desired template
+  #
+  # Then executes a render template command with the
+  # found template
+  #
+  # Returns the manifest rendered. Target can optionally
+  # be set to overwrite
+  #
+  # This method is to be used for self contained rendering#
+  # scripts.
+  #
+  # @param [String] collection_dir
+  # @param [String] template_name
+  # @param [String] destination_path
+  # @param [Boolean] overwrite
+  #
+  # @return [AppArchetype::Template::Manifest]
+  #
+  def self.render_template(
+    collection_dir: ENV.fetch('ARCHETYPE_TEMPLATE_DIR'),
+    template_name: '',
+    destination_path: '',
+    overwrite: false
   )
-    manifest_file = File.join(templates_dir, name, 'manifest.json')
+    manager = AppArchetype::TemplateManager.new(collection_dir)
+    manager.load
 
-    manifest = AppArchetype::Template::Manifest.new_from_file(manifest_file)
+    manifest = manager.find_by_name(template_name)
 
     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,
+    options = Hashie::Mash.new(
+      name: template_name,
       overwrite: overwrite
     )
 
-    plan.devise
-    plan.execute
+    command = AppArchetype::Commands::RenderTemplate.new(
+      manager, destination_path, options
+    )
+
+    command.run
+
+    manifest
   end
 end

data/lib/core_ext/string.rb

@@ -7,8 +7,9 @@ class String
   #
   # @return [String]
   #
-  def snake_case
-    helper.snake_case(self)
+  def snake_case(str = nil)
+    str ||= self
+    helper.snake_case(str)
   end
 
   ##
@@ -16,8 +17,9 @@ class String
   #
   # @return [String]
   #
-  def dash_case
-    helper.dash_case(self)
+  def dash_case(str = nil)
+    str ||= self
+    helper.dash_case(str)
   end
 
   ##
@@ -25,8 +27,9 @@ class String
   #
   # @return [String]
   #
-  def camel_case
-    helper.camel_case(self)
+  def camel_case(str = nil)
+    str ||= self
+    helper.camel_case(str)
   end
 
   ##
@@ -34,8 +37,9 @@ class String
   #
   # @return [String]
   #
-  def pluralize
-    helper.pluralize(self)
+  def pluralize(str = nil)
+    str ||= self
+    helper.pluralize(str)
   end
 
   ##
@@ -43,8 +47,9 @@ class String
   #
   # @return [String]
   #
-  def singularize
-    helper.singularize(self)
+  def singularize(str = nil)
+    str ||= self
+    helper.singularize(str)
   end
 
   ##
@@ -52,8 +57,9 @@ class String
   #
   # @return [String]
   #
-  def randomize(size = 5)
-    helper.randomize(self, size.to_s)
+  def randomize(size = 5, str = nil)
+    str ||= self
+    helper.randomize(str, size.to_s)
   end
 
   private

data/scripts/create_new_command

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/app_archetype'
+
+puts 'CREATE NEW COMMAND'
+
+manifest = AppArchetype.render_template(
+  collection_dir: File.join(__dir__, 'generators'),
+  template_name: 'command',
+  destination_path: File.expand_path(File.join(__dir__, '..'))
+)
+
+command_name = manifest.variables.get('command_name').value
+
+next_steps = <<~TEXT
+  ✔ Command created
+
+  TODO:
+
+  Add the following to cli.rb within AppArchetype::CLI:
+
+  ```
+  desc '#{command_name.snake_case}', 'TODO: description'
+
+  def #{command_name.snake_case}
+    cmd =  AppArchetype::Commands::#{command_name.camel_case}.new(options)
+    cmd.run
+  end
+  ```
+TEXT
+
+puts next_steps

data/scripts/generators/command/manifest.json

@@ -0,0 +1,15 @@
+{
+  "name": "command",
+  "version": "1.0.0",
+  "metadata": {
+    "app_archetype": {
+      "version": "1.2.7"
+    }
+  },
+  "variables": {
+    "command_name": {
+      "type": "string",
+      "description": "Name of command (i.e. create_new_thing)"
+    }
+  }
+}

data/scripts/generators/command/template/lib/app_archetype/commands/{{command_name.snake_case}}.rb.hbs

@@ -0,0 +1,17 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    class {{command_name.camel_case}}
+      def initialize(manager, options)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      def run
+        puts('✔ {{command_name.snake_case}} complete')
+      end
+    end
+  end
+end