terraspace-bundler 0.1.0

data/lib/terraspace_bundler/cli/base.rb

@@ -0,0 +1,9 @@
+class TerraspaceBundler::CLI
+  class Base
+    include TB::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+  end
+end

data/lib/terraspace_bundler/cli/bundle.rb

@@ -0,0 +1,27 @@
+class TerraspaceBundler::CLI
+  class Bundle < TerraspaceBundler::Command
+    terrafile_option = Proc.new {
+      option :terrafile, default: "Terrafile", desc: "Terrafile to use"
+    }
+
+    desc "install", "install"
+    long_desc Help.text("bundle/install")
+    terrafile_option.call
+    def install
+      Install.new(options).run
+    end
+
+    desc "update", "update"
+    long_desc Help.text("bundle/install")
+    terrafile_option.call
+    def update(mod=nil)
+      Update.new(options.merge(mod: mod)).run
+    end
+
+    desc "clean", "clean"
+    long_desc Help.text("bundle/clean")
+    def clean
+      Clean.new(options).run
+    end
+  end
+end

data/lib/terraspace_bundler/cli/clean.rb

@@ -0,0 +1,11 @@
+class TerraspaceBundler::CLI
+  class Clean < Base
+    include TB::Mod::TmpPaths
+    include TB::Logging
+
+    def run
+      FileUtils.rm_rf(tmp_root)
+      logger.info "Removed #{tmp_root}"
+    end
+  end
+end

data/lib/terraspace_bundler/cli/help.rb

@@ -0,0 +1,9 @@
+module TerraspaceBundler::CLI::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/terraspace_bundler/cli/help/bundle/install.md

@@ -0,0 +1,3 @@
+## Examples
+
+    terraspace-bundler bundle install

data/lib/terraspace_bundler/cli/help/completion.md

@@ -0,0 +1,20 @@
+## Examples
+
+    terraspace-bundler completion
+
+Prints words for TAB auto-completion.
+
+    terraspace-bundler completion
+    terraspace-bundler completion hello
+    terraspace-bundler completion hello name
+
+To enable, TAB auto-completion add the following to your profile:
+
+    eval $(terraspace-bundler completion_script)
+
+Auto-completion example usage:
+
+    terraspace-bundler [TAB]
+    terraspace-bundler hello [TAB]
+    terraspace-bundler hello name [TAB]
+    terraspace-bundler hello name --[TAB]

data/lib/terraspace_bundler/cli/help/completion_script.md

@@ -0,0 +1,3 @@
+To use, add the following to your `~/.bashrc` or `~/.profile`
+
+    eval $(terraspace-bundler completion_script)

data/lib/terraspace_bundler/cli/install.rb

@@ -0,0 +1,7 @@
+class TerraspaceBundler::CLI
+  class Install < Base
+    def run
+      TB::Installer.new(@options).run
+    end
+  end
+end

data/lib/terraspace_bundler/cli/update.rb

@@ -0,0 +1,7 @@
+class TerraspaceBundler::CLI
+  class Update < Base
+    def run
+      TB::Updater.new(@options).run
+    end
+  end
+end

data/lib/terraspace_bundler/command.rb

@@ -0,0 +1,89 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module TerraspaceBundler
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   terraspace-bundler command help
+        #   terraspace-bundler command -h
+        #   terraspace-bundler command --help
+        #   terraspace-bundler command -D
+        #
+        # as well thor's normal way:
+        #
+        #   terraspace-bundler help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   terraspace-bundler version
+        #   terraspace-bundler --version
+        #   terraspace-bundler -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/terraspace-bundler-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        ""
+      end
+
+      # https://github.com/erikhuda/thor/issues/244
+      # Deprecation warning: Thor exit with status 0 on errors. To keep this behavior, you must define `exit_on_failure?` in `Lono::CLI`
+      # You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION.
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/terraspace_bundler/completer.rb

@@ -0,0 +1,159 @@
+=begin
+Code Explanation:
+
+There are 3 types of things to auto-complete:
+
+  1. command: the command itself
+  2. parameters: command parameters.
+  3. options: command options
+
+Here's an example:
+
+  mycli hello name --from me
+
+  * command: hello
+  * parameters: name
+  * option: --from
+
+When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
+
+## Arity
+
+For example, say you had a method for a CLI command with the following form:
+
+  ufo scale service count --cluster development
+
+It's equivalent ruby method:
+
+  scale(service, count) = has an arity of 2
+
+So typing:
+
+  ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.
+
+So the completion should only show options, something like this:
+
+  --noop --verbose --cluster
+
+## Splat Arguments
+
+When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
+
+   ship(service) = 1
+   scale(service, count) = 2
+   ships(*services) = -1
+   foo(example, *rest) = -2
+
+Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
+
+Here are some test cases, hit TAB after typing the command:
+
+  terraspace-bundler completion
+  terraspace-bundler completion hello
+  terraspace-bundler completion hello name
+  terraspace-bundler completion hello name --
+  terraspace-bundler completion hello name --noop
+
+  terraspace-bundler completion
+  terraspace-bundler completion sub:goodbye
+  terraspace-bundler completion sub:goodbye name
+
+## Subcommands and Thor::Group Registered Commands
+
+Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.
+
+  * regular command: ufo ship
+  * subcommand: ufo docker
+  * Thor::Group command: ufo init
+
+Auto-completion accounts for each of these type of commands.
+=end
+module TerraspaceBundler
+  class Completer
+    def initialize(command_class, *params)
+      @params = params
+      @current_command = @params[0]
+      @command_class = command_class # CLI initiall
+    end
+
+    def run
+      if subcommand?(@current_command)
+        subcommand_class = @command_class.subcommand_classes[@current_command]
+        @params.shift # destructive
+        Completer.new(subcommand_class, *@params).run # recursively use subcommand
+        return
+      end
+
+      # full command has been found!
+      unless found?(@current_command)
+        puts all_commands
+        return
+      end
+
+      # will only get to here if command aws found (above)
+      arity = @command_class.instance_method(@current_command).arity.abs
+      if @params.size > arity or thor_group_command?
+        puts options_completion
+      else
+        puts params_completion
+      end
+    end
+
+    def subcommand?(command)
+      @command_class.subcommands.include?(command)
+    end
+
+    # hacky way to detect that command is a registered Thor::Group command
+    def thor_group_command?
+      command_params(raw=true) == [[:rest, :args]]
+    end
+
+    def found?(command)
+      public_methods = @command_class.public_instance_methods(false)
+      command && public_methods.include?(command.to_sym)
+    end
+
+    # all top-level commands
+    def all_commands
+      commands = @command_class.all_commands.reject do |k,v|
+        v.is_a?(Thor::HiddenCommand)
+      end
+      commands.keys
+    end
+
+    def command_params(raw=false)
+      params = @command_class.instance_method(@current_command).parameters
+      # Example:
+      # >> Sub.instance_method(:goodbye).parameters
+      # => [[:req, :name]]
+      # >>
+      raw ? params : params.map!(&:last)
+    end
+
+    def params_completion
+      offset = @params.size - 1
+      offset_params = command_params[offset..-1]
+      command_params[offset..-1].first
+    end
+
+    def options_completion
+      used = ARGV.select { |a| a.include?('--') } # so we can remove used options
+
+      method_options = @command_class.all_commands[@current_command].options.keys
+      class_options = @command_class.class_options.keys
+
+      all_options = method_options + class_options + ['help']
+
+      all_options.map! { |o| "--#{o.to_s.gsub('_','-')}" }
+      filtered_options = all_options - used
+      filtered_options.uniq
+    end
+
+    # Useful for debugging. Using puts messes up completion.
+    def log(msg)
+      File.open("/tmp/complete.log", "a") do |file|
+        file.puts(msg)
+      end
+    end
+  end
+end

data/lib/terraspace_bundler/completer/script.rb

@@ -0,0 +1,6 @@
+class TerraspaceBundler::Completer::Script
+  def self.generate
+    bash_script = File.expand_path("script.sh", File.dirname(__FILE__))
+    puts "source #{bash_script}"
+  end
+end

data/lib/terraspace_bundler/completer/script.sh

@@ -0,0 +1,10 @@
+_terraspace-bundler() {
+  COMPREPLY=()
+  local word="${COMP_WORDS[COMP_CWORD]}"
+  local words=("${COMP_WORDS[@]}")
+  unset words[0]
+  local completion=$(terraspace-bundler completion ${words[@]})
+  COMPREPLY=( $(compgen -W "$completion" -- "$word") )
+}
+
+complete -F _terraspace-bundler terraspace-bundler

data/lib/terraspace_bundler/config.rb

@@ -0,0 +1,15 @@
+module TerraspaceBundler
+  class Config
+    extend Memoist
+    include Singleton
+
+    def config
+      config = ActiveSupport::OrderedOptions.new
+      config.export_path = "vendor/modules"
+      config.terrafile = "Terrafile"
+      config.lockfile = "#{config.terrafile}.lock"
+      config
+    end
+    memoize :config
+  end
+end

data/lib/terraspace_bundler/core.rb

@@ -0,0 +1,21 @@
+module TerraspaceBundler
+  module Core
+    extend Memoist
+
+    @@logger = nil
+    def logger
+      return @@logger if @@logger
+      @@logger = Logger.new($stdout)
+      @@logger.level = ENV['TB_LOG_LEVEL'] || 'info'
+      @@logger
+    end
+
+    def logger=(v)
+      @@logger = v
+    end
+
+    def config
+      Config.instance.config
+    end
+  end
+end

data/lib/terraspace_bundler/dsl.rb

@@ -0,0 +1,18 @@
+module TerraspaceBundler
+  class Dsl
+    include DslEvaluator
+    include Syntax
+
+    class_attribute :meta
+    self.meta = {global: {}, mods: []}
+
+    def run
+      evaluate_file(TB.config.terrafile)
+      self.class.meta
+    end
+
+    def meta
+      self.class.meta
+    end
+  end
+end

data/lib/terraspace_bundler/dsl/syntax.rb

@@ -0,0 +1,20 @@
+class TerraspaceBundler::Dsl
+  module Syntax
+    def org(url)
+      global[:org] = url
+    end
+    alias_method :user, :org
+
+    def export_path(path)
+      global[:export_path] = path
+    end
+
+    def mod(*args, **options)
+      meta[:mods] << {args: args, options: options}
+    end
+
+    def global
+      meta[:global]
+    end
+  end
+end