terraspace 0.4.2 → 0.5.2

data/lib/terraspace/cli/new.rb

@@ -1,5 +1,9 @@
 class Terraspace::CLI
   class New < Terraspace::Command
+    long_desc Help.text("new/arg")
+    Arg.options.each { |args| option(*args) }
+    register(Arg, "arg", "arg NAME", "Generates new arg.")
+
     long_desc Help.text("new/git_hook")
     GitHook.cli_options.each { |args| option(*args) }
     register(GitHook, "git_hook", "git_hook", "Generates new git hook.")
@@ -8,33 +12,35 @@ class Terraspace::CLI
     Shim.cli_options.each { |args| option(*args) }
     register(Shim, "shim", "shim", "Generates terraspace shim.")
 
+    long_desc Help.text("new/helper")
+    Helper.options.each { |args| option(*args) }
+    register(Helper, "helper", "helper NAME", "Generates new helper.")
+
+    long_desc Help.text("new/hook")
+    Hook.options.each { |args| option(*args) }
+    register(Hook, "hook", "hook NAME", "Generates new hook.")
+
     long_desc Help.text("new/module")
     Module.base_options.each { |args| option(*args) }
     Module.component_options.each { |args| option(*args) }
     register(Module, "module", "module NAME", "Generates new module.")
 
-    long_desc Help.text("new/stack")
-    Stack.base_options.each { |args| option(*args) }
-    Stack.component_options.each { |args| option(*args) }
-    register(Stack, "stack", "stack NAME", "Generates new stack.")
-
     long_desc Help.text("new/project")
     Project.base_options.each { |args| option(*args) }
     Project.project_options.each { |args| option(*args) }
     register(Project, "project", "project NAME", "Generates new project.")
 
-    long_desc Help.text("new/project_test")
-    register(Test::Project, "project_test", "project_test NAME", "Generates new project test.")
-
-    long_desc Help.text("new/module_test")
-    register(Test::Module, "module_test", "module_test NAME", "Generates new module test.")
-
-    long_desc Help.text("new/bootstrap_test")
-    Test::Bootstrap.options.each { |args| option(*args) }
-    register(Test::Bootstrap, "bootstrap_test", "bootstrap_test", "Generates bootstrap test setup.")
-
     long_desc Help.text("new/plugin")
     Plugin.options.each { |args| option(*args) }
-    register(Plugin, "plugin", "plugin", "Generates plugin.")
+    register(Plugin, "plugin", "plugin NAME", "Generates plugin.")
+
+    long_desc Help.text("new/stack")
+    Stack.base_options.each { |args| option(*args) }
+    Stack.component_options.each { |args| option(*args) }
+    register(Stack, "stack", "stack NAME", "Generates new stack.")
+
+    long_desc Help.text("new/test")
+    Test.options.each { |args| option(*args) }
+    register(Test, "test", "test NAME", "Generates new test.")
   end
 end

data/lib/terraspace/cli/new/arg.rb

@@ -0,0 +1,62 @@
+class Terraspace::CLI::New
+  class Arg < Thor::Group
+    include Thor::Actions
+
+    argument :stack, required: false
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:name, default: "apply", desc: "command name"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/arg", __dir__)
+    end
+
+  private
+    def type
+      valid_types = %w[project stack module]
+      type = @options[:type]
+      valid_types.include?(type) ? type : "project" # fallback to project if user provides invalid type
+    end
+
+    def name
+      options[:name] ?  options[:name] : "apply"
+    end
+
+    def dest
+      map = {
+        project: "config/args",
+        stack:   "app/stacks/#{stack}/config/args",
+        module:  "app/modules/#{stack}/config/args",
+      }
+      map[type.to_sym]
+    end
+
+    def arg_path
+      "#{dest}/#{kind}.rb"
+    end
+
+  public
+
+    def check_stack_arg
+      return if type == "project"
+      return unless stack.nil?
+      # Else check for STACK argument for type module or stack
+      puts <<~EOL
+        Required STACK argument, either the module or stack name. Usage:
+
+            terraspace new arg STACK --type #{type}
+      EOL
+      exit 1
+    end
+
+    def create
+      directory ".", dest
+    end
+  end
+end

data/lib/terraspace/cli/new/helper.rb

@@ -1,22 +1,54 @@
 class Terraspace::CLI::New
-  module Helper
-    include Helper::PluginGem
+  class Helper < Thor::Group
+    include Thor::Actions
+
+    argument :stack
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:name, desc: "Helper name used for the filename. Defaults to the project, module or stack name"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/helper", __dir__)
+    end
 
   private
-    def build_gemfile(*list)
-      lines = []
-      list.each do |name|
-        lines << gem_line(name)
-      end
-      lines.join("\n")
+    def type
+      valid_types = %w[project stack module]
+      type = @options[:type]
+      valid_types.include?(type) ? type : "project" # fallback to project if user provides invalid type
     end
 
-    def gem_line(name)
-      if name == "terraspace"
-        %Q|gem "#{name}", '~> #{Terraspace::VERSION}'|
+    def helper_class
+      if type == "project"
+        "Terraspace::#{type.camelize}::#{name.camelize}Helper"
       else
-        %Q|gem "#{name}"|
+        "Terraspace::#{type.camelize}::#{stack.camelize}::#{name.camelize}Helper"
       end
     end
+
+    def name
+      options[:name] || stack
+    end
+
+    def dest
+      map = {
+        project: "config/helpers",
+        stack:   "app/stacks/#{stack}/config/helpers",
+        module:  "app/modules/#{stack}/config/helpers",
+      }
+      map[type.to_sym]
+    end
+
+  public
+
+    def create
+      directory ".", dest
+    end
   end
 end

data/lib/terraspace/cli/new/helpers.rb

@@ -0,0 +1,22 @@
+class Terraspace::CLI::New
+  module Helpers
+    include Helpers::PluginGem
+
+  private
+    def build_gemfile(*list)
+      lines = []
+      list.each do |name|
+        lines << gem_line(name)
+      end
+      lines.join("\n")
+    end
+
+    def gem_line(name)
+      if name == "terraspace"
+        %Q|gem "#{name}", '~> #{Terraspace::VERSION}'|
+      else
+        %Q|gem "#{name}"|
+      end
+    end
+  end
+end

data/lib/terraspace/cli/new/helpers/plugin_gem.rb

@@ -0,0 +1,25 @@
+module Terraspace::CLI::New::Helpers
+  module PluginGem
+  private
+    def plugin_gem_name
+      if @options[:plugin_gem]
+        @options[:plugin_gem]
+      else
+        plugin = @options[:plugin] || autodetect_provider
+        "terraspace_plugin_#{plugin}"
+      end
+    end
+
+    def autodetect_provider
+      providers = Terraspace::Plugin.meta.keys
+      if providers.size == 1
+        providers.first
+      else
+        precedence = %w[aws azurerm google]
+        precedence.find do |p|
+          providers.include?(p)
+        end
+      end
+    end
+  end
+end

data/lib/terraspace/cli/new/hook.rb

@@ -0,0 +1,70 @@
+class Terraspace::CLI::New
+  class Hook < Thor::Group
+    include Thor::Actions
+
+    argument :stack, required: false
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:kind, default: "terraform", desc: "terraform or terraspace"],
+        [:name, desc: "Command name. Defaults to apply for terraform kind and build for terraspace kind"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/hook", __dir__)
+    end
+
+  private
+    def kind
+      valid_kinds = %w[terraform terraspace]
+      kind = @options[:kind]
+      valid_kinds.include?(kind) ? kind : "terraform" # fallback to terraform if user provides invalid type
+    end
+
+    def type
+      valid_types = %w[project stack module]
+      type = @options[:type]
+      valid_types.include?(type) ? type : "project" # fallback to project if user provides invalid type
+    end
+
+    def name
+      return options[:name] if options[:name]
+      kind == "terraform" ? "apply" : "build"
+    end
+
+    def dest
+      map = {
+        project: "config/hooks",
+        stack:   "app/stacks/#{stack}/config/hooks",
+        module:  "app/modules/#{stack}/config/hooks",
+      }
+      map[type.to_sym]
+    end
+
+    def hook_path
+      "#{dest}/#{kind}.rb"
+    end
+
+  public
+
+    def check_stack_arg
+      return if type == "project"
+      return unless stack.nil?
+      # Else check for STACK argument for type module or stack
+      puts <<~EOL
+        Required STACK argument, either the module or stack name. Usage:
+
+            terraspace new hook STACK --type #{type}
+      EOL
+      exit 1
+    end
+
+    def create
+      directory ".", dest
+    end
+  end
+end

data/lib/terraspace/cli/new/module.rb

@@ -11,16 +11,5 @@ class Terraspace::CLI::New
       dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]
       directory ".", dest
     end
-
-    def create_test
-      args = component_args(name, @options[:project_name])
-      Test::Module.start(args)
-    end
-
-    def run_generator_hook_script
-      script = ENV['TS_GENERATOR_MODULE']
-      return unless script
-      run_script(script, "app/modules/#{name}")
-    end
   end
 end

data/lib/terraspace/cli/new/plugin.rb

@@ -1,16 +1,16 @@
 class Terraspace::CLI::New
   class Plugin < Sequence
-    include Helper
+    include Helpers
+
+    argument :name
 
     def self.options
       [
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
       ]
     end
     options.each { |args| class_option(*args) }
 
-    argument :name
-
     def create_plugin
       puts "=> Creating new plugin: #{name}"
       core_template_source("plugin")

data/lib/terraspace/cli/new/plugin/helper.rb

@@ -1,5 +1,5 @@
 class Terraspace::CLI::New::Plugin
-  module Helper
+  module Helpers
   private
     # helper
     def camel_name

data/lib/terraspace/cli/new/project.rb

@@ -4,16 +4,23 @@ class Terraspace::CLI::New
       [
         [:bundle, type: :boolean, default: true, desc: "Runs bundle install on the project"],
         [:config, type: :boolean, default: true, desc: "Whether or not to generate config files."],
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
-        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."]
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:quiet, type: :boolean, desc: "Quiet output."],
+        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."],
       ]
     end
 
     base_options.each { |args| class_option(*args) }
     project_options.each { |args| class_option(*args) }
 
+  private
+    def log(msg)
+      logger.info(msg) unless @options[:quiet]
+    end
+
+  public
     def creating_messaging
-      puts "=> Creating new project called #{name}."
+      log "=> Creating new project called #{name}."
     end
 
     def create_base
@@ -60,15 +67,17 @@ class Terraspace::CLI::New
 
     def bundle_install
       return if @options[:bundle] == false
-      puts "=> Installing dependencies with: bundle install"
+      log "=> Installing dependencies with: bundle install"
       Bundler.with_unbundled_env do
-        system("BUNDLE_IGNORE_CONFIG=1 bundle install", chdir: name)
+        bundle = "BUNDLE_IGNORE_CONFIG=1 bundle install"
+        bundle << " > /dev/null 2>&1" if @options[:quiet]
+        system(bundle, chdir: name)
       end
     end
 
     def welcome_message_examples
       return unless options[:examples]
-      puts <<~EOL
+      log <<~EOL
         #{"="*64}
         Congrats! You have successfully created a terraspace project.
         Check out the created files. Adjust to the examples and then deploy with:
@@ -83,7 +92,7 @@ class Terraspace::CLI::New
 
     def welcome_message_no_examples
       return if options[:examples]
-      puts <<~EOL
+      log <<~EOL
         #{"="*64}
         Congrats! You have successfully created a terraspace project.
         Check out the created files.

data/lib/terraspace/cli/new/sequence.rb

@@ -3,12 +3,13 @@ require 'thor'
 class Terraspace::CLI::New
   class Sequence < Thor::Group
     include Thor::Actions
-    include Helper
+    include Terraspace::Util::Logging
+    include Helpers
 
     def self.base_options
       [
         [:examples, type: :boolean, default: false, desc: "Also generate examples"],
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
         [:lang, default: "hcl", desc: "Language to use: HCL/ERB or Ruby DSL"],
         [:plugin, aliases: %w[p], default: "aws", desc: "Cloud Plugin. Supports: aws, google"],
         [:test, type: :boolean, desc: "Whether or not to generate tests"],
@@ -47,13 +48,5 @@ class Terraspace::CLI::New
       source = Source::Plugin.new(self, @options)
       source.set_source_paths(template, type)
     end
-
-    # A generator script hook to allow for further customizations
-    # The dest folder like app/modules/demo is provided as a first argument to the command.
-    def run_script(script, dest)
-      command = "#{script} #{dest}"
-      puts "Running: #{command}" unless ENV['TS_GENERATOR_MUTE']
-      system(command)
-    end
   end
 end

data/lib/terraspace/cli/new/source/core.rb

@@ -1,6 +1,6 @@
 module Terraspace::CLI::New::Source
   class Core
-    include Terraspace::CLI::New::Helper::PluginGem
+    include Terraspace::CLI::New::Helpers::PluginGem
     include Terraspace::Util
 
     def initialize(sequence, options)