app_archetype 1.2.8 → 1.3.0

data/lib/app_archetype/cli.rb

@@ -3,15 +3,181 @@ 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'
+    package_name 'AppArchetype'
 
-    class <<self
+    desc 'version', 'Print app archetype version to STDOUT'
+
+    ##
+    # Runs version command
+    #
+    def version
+      cmd = AppArchetype::Commands::PrintVersion.new(options)
+      cmd.run
+    end
+
+    map %w[--version -v] => :version
+
+    desc 'list', 'Prints a list of known templates to STDOUT'
+
+    ##
+    # Runs list templates command
+    #
+    def list
+      cmd = AppArchetype::Commands::ListTemplates.new(
+        manager,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'path', 'Prints template path to STDOUT'
+
+    ##
+    # Runs print path command
+    #
+    def path
+      cmd = AppArchetype::Commands::PrintPath.new(
+        template_dir,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'open', 'Opens template manifest file'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of manifest'
+    )
+
+    ##
+    # Runs open manifest command
+    #
+    def open
+      cmd = AppArchetype::Commands::OpenManifest.new(
+        manager,
+        editor,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'new', 'Creates a template in ARCHETYPE_TEMPLATE_DIR'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of template'
+    )
+
+    ##
+    # Runs new template commmand
+    #
+    def new
+      cmd = AppArchetype::Commands::NewTemplate.new(
+        template_dir,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'delete', 'Deletes a template in ARCHETYPE_TEMPLATE_DIR'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of template'
+    )
+
+    ##
+    # Runs delete template command
+    #
+    def delete
+      cmd = AppArchetype::Commands::DeleteTemplate.new(
+        manager,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'variables', 'Prints template variables'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of template'
+    )
+
+    ##
+    # Runs print template variables command
+    #
+    def variables
+      cmd = AppArchetype::Commands::PrintTemplateVariables.new(
+        manager,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'find', 'Finds a template in collection'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of template'
+    )
+
+    ##
+    # Runs find templates command
+    #
+    def find
+      cmd = AppArchetype::Commands::FindTemplates.new(
+        manager,
+        options
+      )
+      cmd.run
+    end
+
+    desc 'render', 'Renders project template'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of template'
+    )
+
+    method_option(
+      :out,
+      type: :string,
+      desc: 'Destination path for rendered template',
+      default: FileUtils.pwd
+    )
+
+    method_option(
+      :overwrite,
+      type: :boolean,
+      default: false,
+      desc: 'Option to overwrite any existing files'
+    )
+
+    ##
+    # Runs render template command
+    #
+    def render
+      cmd = AppArchetype::Commands::RenderTemplate.new(
+        manager,
+        options.out,
+        options
+      )
+      cmd.run
+    end
+
+    no_commands do
       ##
       # Retrieves template dir from environment and raises error
       # when TEMPLATE_DIR environment variable is not set.
@@ -45,7 +211,7 @@ module AppArchetype
 
         `which #{@editor}`
         if $?.exitstatus != 0
-          CLI.print_warning(
+          puts(
             "WARN: Configured editor #{@editor} is not installed correctly "\
             'please check your configuration'
           )
@@ -66,139 +232,5 @@ module AppArchetype
         @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/commands/delete_template.rb

@@ -0,0 +1,58 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Deletes template from collection
+    class DeleteTemplate
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Deletes a manifest from template dir
+      #
+      # First it looks in options for the name of the
+      # manifest to delete. If this is not set then the user
+      # is presented a list of manifests to choose from.
+      #
+      # When the manifest specified does not exist
+      # a runtime error will be raised
+      #
+      # The user will then be prompted with a yes/no prompt
+      # to confirm they wish to delete the selected manifest.
+      #
+      # If the answer to this is no, the command will stop
+      #
+      # Otherwise, the template and manifest will be removed
+      # from the template dir
+      #
+      # A success message will be presented to confirm to the
+      # user that the operation was successful.
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.select(
+          'Please choose template for deletion',
+          @manager.manifest_names
+        )
+
+        manifest = @manager.find_by_name(name)
+
+        unless manifest
+          puts "✖ No template with name `#{name}` found."
+          return
+        end
+
+        ok_to_proceed = @prompt.yes?("Are you sure you want to delete #{name}?")
+
+        return unless ok_to_proceed
+
+        FileUtils.rm_rf(manifest.parent_path)
+
+        puts("✔ Template `#{name}` has been removed")
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/find_templates.rb

@@ -0,0 +1,66 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Finds template by name in collection
+    class FindTemplates
+      ##
+      # Output table header
+      #
+      RESULT_HEADER = %w[NAME VERSION].freeze
+
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Finds a template by name from the collection
+      #
+      # First it looks for a name option, if this is not
+      # set then the user is prompted for the template name.
+      #
+      # Then the template manager runs a search to find a
+      # manifest with a fully or partially matching name
+      #
+      # If there are found results they will be rendered
+      # to STDOUT in a table.
+      #
+      # When there are no results found then a message
+      # confirming this will be printed to STDOUT.
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.ask('Please enter a template name')
+
+        manifests = @manager.search_by_name(name)
+
+        if manifests.any?
+          puts manifest_list_table(manifests).render&.strip
+        else
+          puts "✖ No manifests with name `#{name}` found."
+        end
+      end
+
+      private
+
+      ##
+      # Builds a table of manifest information
+      #
+      # @param [Array] manifests
+      #
+      def manifest_list_table(manifests)
+        TTY::Table.new(
+          header: RESULT_HEADER,
+          rows: manifests.map do |manifest|
+            [
+              manifest.name,
+              manifest.version
+            ]
+          end
+        )
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/list_templates.rb

@@ -0,0 +1,49 @@
+require 'tty-prompt'
+require 'tty-table'
+
+module AppArchetype
+  module Commands
+    # Lists known templates for user
+    class ListTemplates
+      ##
+      # Output table header
+      #
+      RESULT_HEADER = %w[NAME VERSION].freeze
+
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Lists all known and valid manifests
+      #
+      # This renders a manifest list table
+      #
+      # Note: any invalid manifests will be excluded
+      # from this list.
+      #
+      def run
+        puts(manifest_list_table.render.strip)
+      end
+
+      private
+
+      ##
+      # Builds a table of manifest information
+      #
+      def manifest_list_table
+        TTY::Table.new(
+          header: RESULT_HEADER,
+          rows: @manager.manifests.map do |manifest|
+            [
+              manifest.name,
+              manifest.version
+            ]
+          end
+        )
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/new_template.rb

@@ -0,0 +1,42 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Creates new blank template for a user
+    class NewTemplate
+      def initialize(template_dir, options = Hashie::Mash.new)
+        @template_dir = template_dir
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Renders a new empty template and manifest
+      #
+      # First it looks to the name option for a relative
+      # path from the template dir
+      #
+      # If this is not provided then the user is prompted
+      # for input.
+      #
+      # Once we have a name, the destination folder is created
+      # and the generator renders an empty template there.
+      #
+      # If the operation is successful then a success message
+      # is printed to STDOUT confirming this.
+      #
+      def run
+        rel = @options.name
+        rel ||= @prompt.ask('Please enter a name for the new template')
+
+        dest = File.join(@template_dir, rel)
+        FileUtils.mkdir_p(dest)
+
+        name = File.basename(rel)
+        AppArchetype::Generators.render_empty_template(name, dest)
+
+        puts("✔ Template `#{name}` created at #{dest}")
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/open_manifest.rb

@@ -0,0 +1,48 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Opens manifest in configured editor
+    class OpenManifest
+      def initialize(manager, editor, options = Hashie::Mash.new)
+        @manager = manager
+        @editor = editor
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Opens a manifest in the chosen editor program
+      #
+      # First it looks to the options for the manifest
+      # name. If this is not provided the user will be
+      # given a list to select from.
+      #
+      # The manager then attempts to find the manifest
+      # by name. If it cannot be found, a RuntimeError
+      # is raised and the command stops.
+      #
+      # Otherwise a new editor subprocess is started
+      # with the manifest path given as an arg.
+      #
+      # This process will wait until the conclusion of
+      # the editor process. It's recommended that the
+      # editor be a command line editor like `vi`
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.select('Please choose manifest', @manager.manifest_names)
+
+        manifest = @manager.find_by_name(name)
+
+        unless manifest
+          puts "✖ No manifests with name `#{name}` found."
+          return
+        end
+
+        pid = Process.spawn("#{@editor} #{manifest.path}")
+        Process.waitpid(pid)
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/print_path.rb

@@ -0,0 +1,20 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Prints templates path to STDOUT
+    class PrintPath
+      def initialize(template_dir, options = Hashie::Mash.new)
+        @template_dir = template_dir
+        @options = options
+      end
+
+      ##
+      # Prints template directory to STDOUT
+      #
+      def run
+        puts(@template_dir)
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/print_template_variables.rb

@@ -0,0 +1,67 @@
+require 'tty-prompt'
+require 'tty-table'
+
+module AppArchetype
+  module Commands
+    # Summarizes and prints variables from template manifest
+    class PrintTemplateVariables
+      ##
+      # Variable table header
+      #
+      VARIABLE_HEADER = %w[NAME DESCRIPTION DEFAULT].freeze
+
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Prints manifest variables, descriptions and defaults
+      #
+      # First it looks to the options for the manifest name.
+      # If one is not provided then the user will be prompted
+      # to choose a manifest from the list of known manifests.
+      #
+      # If the manifest cannot be found a RuntimeError will be
+      # raised.
+      #
+      # Once the manifest is found, an info table is rendered
+      # with the variable names, descriptions and any defined
+      # defaults.
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.select('Please choose manifest', @manager.manifest_names)
+
+        manifest = @manager.find_by_name(name)
+
+        if manifest
+          puts variable_table_for(manifest).render&.strip
+        else
+          puts "✖ No manifests with name `#{name}` found."
+        end
+      end
+
+      private
+
+      ##
+      # Builds a table of template variables
+      #
+      # @param [Manifest] manifest
+      #
+      def variable_table_for(manifest)
+        TTY::Table.new(
+          header: VARIABLE_HEADER,
+          rows: manifest.variables.all.map do |variable|
+            [
+              variable.name,
+              variable.description,
+              variable.default
+            ]
+          end
+        )
+      end
+    end
+  end
+end

data/lib/app_archetype/commands/print_version.rb

@@ -0,0 +1,19 @@
+require 'tty-prompt'
+
+module AppArchetype
+  module Commands
+    # Prints gem version to STDOUT
+    class PrintVersion
+      def initialize(options = Hashie::Mash.new)
+        @options = options
+      end
+
+      ##
+      # Prints gem version
+      #
+      def run
+        puts(AppArchetype::VERSION)
+      end
+    end
+  end
+end