app_archetype 1.2.3

data/Rakefile

@@ -0,0 +1,19 @@
+require 'private_gem/tasks'
+require 'bundler/gem_tasks'
+require 'bump/tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rubycritic/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+RubyCritic::RakeTask.new do |task|
+  task.paths = FileList['lib/**/*.rb'] - FileList['spec/**/*_spec.rb']
+  task.options = '--no-browser --path ./target/reports/critique'
+end
+
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop rubycritic yard]

data/app_archetype.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_archetype/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'app_archetype'
+  spec.version       = AppArchetype::VERSION
+  spec.authors       = ['Andrew Bigger']
+  spec.email         = ['andrew.bigger@gmail.com']
+  spec.summary       = 'Code project template renderer'
+  spec.homepage      = 'https://github.com/andrewbigger/app_archetype'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  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 'json-schema', '~> 2.8'
+  spec.add_dependency 'logger', '~> 1.4.2'
+  spec.add_dependency 'os', '~> 1.1'
+  spec.add_dependency 'ostruct', '~> 0.3'
+  spec.add_dependency 'ruby-handlebars', '~> 0.4'
+  spec.add_dependency 'thor', '~> 1.0'
+
+  spec.add_development_dependency 'bump', '~> 0.9'
+  spec.add_development_dependency 'private_gem', '~> 1.1'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.92'
+  spec.add_development_dependency 'rubycritic', '~> 4.5'
+  spec.add_development_dependency 'simplecov', '~> 0.19'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/bin/archetype

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'pry'
+require 'app_archetype/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  AppArchetype::CLI.start
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  exit 1
+end

data/lib/app_archetype.rb

@@ -0,0 +1,14 @@
+require 'core_ext/string'
+
+require 'app_archetype/logger'
+require 'app_archetype/template'
+
+require 'app_archetype/template_manager'
+require 'app_archetype/renderer'
+require 'app_archetype/generators'
+
+require 'app_archetype/version'
+
+# AppArchetype is the namespace for app_archetype
+module AppArchetype
+end

data/lib/app_archetype/cli.rb

@@ -0,0 +1,204 @@
+require 'logger'
+require 'thor'
+require 'highline'
+
+require 'app_archetype'
+require 'app_archetype/cli/presenters'
+require 'app_archetype/cli/prompts'
+
+module AppArchetype
+  # Command line interface helpers and actions
+  class CLI < Thor
+    package_name 'Archetype'
+
+    class <<self
+      ##
+      # Retrieves template dir from environment and raises error
+      # when TEMPLATE_DIR environment variable is not set.
+      #
+      # @return [String]
+      #
+      def template_dir
+        @template_dir = ENV['ARCHETYPE_TEMPLATE_DIR']
+
+        unless @template_dir
+          raise 'ARCHETYPE_TEMPLATE_DIR environment variable not set'
+        end
+
+        return @template_dir if File.exist?(@template_dir)
+
+        raise "ARCHETYPE_TEMPLATE_DIR #{@template_dir} does not exist"
+      end
+
+      ##
+      # Editor retrieves the chosen editor command to open text files
+      # and raises error when ARCHETYPE_EDITOR is not set.
+      #
+      # If we detect that the which command fails then we warn the user that
+      # something appears awry
+      #
+      # @return [String]
+      #
+      def editor
+        @editor = ENV['ARCHETYPE_EDITOR']
+        raise 'ARCHETYPE_EDITOR environment variable not set' unless @editor
+
+        `which #{@editor}`
+        if $?.exitstatus != 0
+          CLI.print_warning(
+            "WARN: Configured editor #{@editor} is not installed correctly "\
+            'please check your configuration'
+          )
+        end
+
+        @editor
+      end
+
+      ##
+      # Template manager creates and loads a template manager
+      #
+      # @return [AppArchetype::TemplateManager]
+      #
+      def manager
+        @manager ||= AppArchetype::TemplateManager.new(template_dir)
+        @manager.load
+
+        @manager
+      end
+    end
+
+    include AppArchetype::Logger
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'version', 'Prints archetype gem version'
+    def version
+      print_message(AppArchetype::VERSION)
+    end
+    map %w[--version -v] => :version
+
+    desc 'list', 'Lists known templates in ARCHETYPE_TEMPLATE_DIR'
+    def list
+      print_message(
+        Presenters.manifest_list(
+          CLI.manager.manifests
+        )
+      )
+    end
+
+    desc 'path', 'Prints configured ARCHETYPE_TEMPLATE_DIR'
+    def path
+      print_message(
+        CLI.template_dir
+      )
+    end
+
+    desc 'open', 'Opens template manifest'
+    def open(name)
+      editor = CLI.editor
+      manifest = CLI.manager.find_by_name(name)
+
+      pid = Process.spawn("#{editor} #{manifest.path}")
+      Process.waitpid(pid)
+    end
+
+    desc 'new', 'Creates a template in ARCHETYPE_TEMPLATE_DIR'
+    def new(rel)
+      raise 'template rel not provided' unless rel
+
+      dest = File.join(CLI.template_dir, rel)
+      FileUtils.mkdir_p(dest)
+
+      name = File.basename(rel)
+      AppArchetype::Generators.render_empty_template(name, dest)
+
+      print_message("Template `#{name}` created at #{dest}")
+    end
+
+    desc 'delete', 'Deletes a template in ARCHETYPE_TEMPLATE_DIR'
+    def delete(name)
+      manifest = CLI.manager.find_by_name(name)
+      raise 'Cannot find template' unless manifest
+
+      proceed = Prompts.delete_template(manifest)
+
+      return unless proceed
+
+      FileUtils.rm_rf(manifest.parent_path)
+      print_message("Template `#{manifest.name}` has been removed")
+    end
+
+    desc 'validate', 'Runs a schema validation on given template'
+    def validate(name)
+      manifest = CLI.manager.find_by_name(name)
+      raise 'Cannot find template' unless manifest
+
+      result = manifest.validate
+
+      print_message("VALIDATION RESULTS FOR `#{name}`")
+      if result.any?
+        print_message(
+          Presenters.validation_result(result)
+        )
+
+        raise "Manifest `#{name}` is not valid"
+      end
+
+      print_message("Manifest `#{name}` is valid") if result.empty?
+    end
+
+    desc 'variables', 'Prints template variables'
+    def variables(search_term)
+      result = CLI.manager.find_by_name(search_term)
+      return print_message("Manifest `#{search_term}` not found") unless result
+
+      print_message("VARIABLES FOR `#{search_term}`")
+      print_message(
+        Presenters.variable_list(result.variables.all)
+      )
+    end
+
+    desc 'find', 'Finds a template in collection by name'
+    def find(search_term)
+      result = CLI.manager.find_by_name(search_term)
+      return print_message("Manifest `#{search_term}` not found") unless result
+
+      print_message("SEARCH RESULTS FOR `#{search_term}`")
+      print_message(
+        Presenters.manifest_list([result])
+      )
+    end
+
+    desc 'render', 'Renders project template'
+    method_option(
+      :overwrite,
+      type: :boolean,
+      default: false,
+      desc: 'Option to overwrite any existing files'
+    )
+    def render(manifest_name)
+      manifest = CLI.manager.find_by_name(manifest_name)
+
+      raise "Unable to find manifest `#{manifest_name}`" unless manifest
+
+      template = manifest.template
+      template.load
+
+      manifest.variables.all.each do |var|
+        value = Prompts.variable_prompt_for(var)
+        var.set!(value)
+      end
+
+      plan = AppArchetype::Template::Plan.new(
+        template,
+        manifest.variables,
+        destination_path: FileUtils.pwd,
+        overwrite: options.overwrite
+      )
+      plan.devise
+      plan.execute
+    end
+  end
+end

data/lib/app_archetype/cli/presenters.rb

@@ -0,0 +1,106 @@
+require 'cli-format'
+
+module AppArchetype
+  class CLI < Thor
+    # CLI output presenters
+    module Presenters
+      ##
+      # Output table header
+      #
+      RESULT_HEADER = %w[NAME VERSION].freeze
+
+      ##
+      # Variable table header
+      #
+      VARIABLE_HEADER = %w[NAME DESCRIPTION DEFAULT].freeze
+
+      ##
+      # Validation result table header
+      #
+      VALIDATION_HEADER = %w[ERROR].freeze
+
+      class <<self
+        ##
+        # Creates a presenter for given data
+        #
+        # Accepts header row data and has configurable format.
+        #
+        # Header must be array of string
+        #
+        # Data is array of arrays where the inner array is a row.
+        #
+        # Format by default is a table, although can be 'csv'
+        # or 'json'.
+        #
+        # @param header [Array]
+        # @param data [Array]
+        # @param format [String]
+        #
+        # @return [CliFormat::Presenter]
+        #
+        def table(header: [], data: [], format: 'table')
+          has_header = header.any?
+          opts = { header: has_header, format: format }
+
+          presenter = CliFormat::Presenter.new(opts)
+          presenter.header = header if has_header
+
+          data.each { |row| presenter.rows << row }
+
+          presenter
+        end
+
+        ##
+        # Builds a table of manifest information
+        #
+        # @param [Array] manifests
+        #
+        def manifest_list(manifests)
+          table(
+            header: RESULT_HEADER,
+            data: manifests.map do |manifest|
+              [
+                manifest.name,
+                manifest.version
+              ]
+            end
+          ).show
+        end
+
+        ##
+        # Builds a table of variable information
+        #
+        # @param [Array] variables
+        #
+        def variable_list(variables)
+          table(
+            header: VARIABLE_HEADER,
+            data: variables.map do |variable|
+              [
+                variable.name,
+                variable.description,
+                variable.default
+              ]
+            end
+          ).show
+        end
+
+        ##
+        # Builds a table for manifest validation results
+        #
+        # @param [Array] results
+        #
+        def validation_result(results)
+          table(
+            header: VALIDATION_HEADER,
+            data: results.map do |result|
+              [
+                result
+              ]
+            end
+          ).show
+        end
+      end
+    end
+  end
+end

data/lib/app_archetype/cli/prompts.rb

@@ -0,0 +1,152 @@
+require 'highline'
+
+module AppArchetype
+  class CLI < Thor
+    # CLI output presenters
+    module Prompts
+      ##
+      # Variable prompt question. Asked when evaluating template
+      # variables
+      #
+      # @param [AppArchetype::Template::Variable] variable
+      #
+      # @return [Proc]
+      #
+      VAR_PROMPT_MESSAGE = lambda do |variable|
+        "\nEnter value for `#{variable.name}` variable\n\n"\
+        "DESCRIPTION: #{variable.description}\n"\
+        "TYPE: #{variable.type}\n"\
+        "DEFAULT: #{variable.default}"
+      end
+
+      class <<self
+        ##
+        # Prompt returns a TTY prompt object for asking the user
+        # questions.
+        #
+        # @return [HighLine]
+        def prompt
+          HighLine.new
+        end
+
+        ##
+        # A yes/no prompt for asking the user a yes or no question.
+        #
+        # @return [Boolean]
+        #
+        def yes?(message)
+          prompt.ask("#{message} [Y/n]", String) { |input| input.strip == 'Y' }
+        end
+
+        ##
+        # Prompt for requesting user input.
+        #
+        # A default can be provided in the event the user does not
+        # provide an answer.
+        #
+        # Validator also performs type conversion by default it is
+        # a string
+        #
+        # @param message [String]
+        # @param default [Object]
+        # @param validator [Object|Lambda]
+        #
+        # @return [Object]
+        #
+        def ask(message, validator: String, default: nil)
+          resp = prompt.ask(message, validator)
+          return default if !default.nil? && resp.to_s.empty?
+
+          resp
+        end
+
+        ##
+        # Y/N prompt to ensure user is sure they wish to delete
+        # the selected template
+        #
+        # @param [AppArchetype::Template::Manifest] manifest
+        #
+        # @return [Boolean]
+        def delete_template(manifest)
+          yes?(
+            "Are you sure you want to delete `#{manifest.name}`?"
+          )
+        end
+
+        ##
+        # Returns a variable prompt based on the type of variable
+        # required. Once prompt has been executed, the response is
+        # returned to the caller.
+        #
+        # When the value is set in the manifest, the set value is
+        # returned without a prompt.
+        #
+        # For boolean and integer variables, the relevant prompt
+        # function is called.
+        #
+        # By default the string variable prompt will be used.
+        #
+        # @param [AppArchetype::Template::Variable] var
+        #
+        # @return [Object]
+        #
+        def variable_prompt_for(var)
+          return var.value if var.value?
+          return boolean_variable_prompt(var) if var.type == 'boolean'
+          return integer_variable_prompt(var) if var.type == 'integer'
+
+          string_variable_prompt(var)
+        end
+
+        ##
+        # Prompt for boolean variable. This quizzes the user as to
+        # whether they want the variable set or not. The response
+        # is returned to the caller.
+        #
+        # @param [AppArchetype::Template::Variable] variable
+        #
+        # @return [Boolean]
+        #
+        def boolean_variable_prompt(variable)
+          yes?(
+            VAR_PROMPT_MESSAGE.call(variable)
+          )
+        end
+
+        ##
+        # Prompt for integer. This quizzes the user for their
+        # choice and then attempts to convert it to an integer.
+        #
+        # In the event a non integer value is entered, a
+        # RuntimeError is thrown.
+        #
+        # @param [AppArchetype::Template::Variable] variable
+        #
+        # @return [Integer]
+        #
+        def integer_variable_prompt(variable)
+          ask(
+            VAR_PROMPT_MESSAGE.call(variable),
+            default: variable.default,
+            validator: Integer
+          )
+        end
+
+        ##
+        # Prompt for a string. Asks user for input and returns
+        # it.
+        #
+        # @param [AppArchetype::Template::Variable] variable
+        #
+        # @return [String]
+        #
+        def string_variable_prompt(variable)
+          ask(
+            VAR_PROMPT_MESSAGE.call(variable),
+            default: variable.default
+          )
+        end
+      end
+    end
+  end
+end