ruby-terraform 0.65.0.pre.11 → 1.0.0.pre.1

data/lib/ruby_terraform/commands/workspace_select.rb

@@ -1,23 +1,39 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
+    # Wraps the +terraform workspace select+ command which selects a workspace.
+    #
+    # For options accepted on construction, see {#initialize}.
+    #
+    # When executing an instance of {WorkspaceSelect} via {#execute}, the
+    # following options are supported:
+    #
+    # * +:name+: the name of the workspace to select; required.
+    # * +:directory+: the path to a directory containing terraform configuration
+    #   (deprecated in terraform 0.14, removed in terraform 0.15, use +:chdir+
+    #   instead).
+    # * +:chdir+: the path of a working directory to switch to before executing
+    #   the given subcommand.
+    #
+    # @example BasicInvocation
+    #   RubyTerraform::Commands::WorkspaceSelect.new.execute(
+    #     name: 'example')
+    #
     class WorkspaceSelect < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
+      # @!visibility private
       def subcommands
         %w[workspace select]
       end
 
+      # @!visibility private
       def arguments(parameters)
-        [parameters[:workspace], parameters[:directory]]
-      end
-
-      def parameter_defaults(_parameters)
-        { directory: nil }
+        [parameters[:name], parameters[:directory]]
       end
     end
   end

data/lib/ruby_terraform/commands/workspace_show.rb

@@ -1,13 +1,28 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
+    # Wraps the +terraform workspace show+ command which shows the name of the
+    # current workspace.
+    #
+    # For options accepted on construction, see {#initialize}.
+    #
+    # When executing an instance of {WorkspaceSelect} via {#execute}, the
+    # following options are supported:
+    #
+    # * +:chdir+: the path of a working directory to switch to before executing
+    #   the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform::Commands::WorkspaceShow.new.execute
+    #
     class WorkspaceShow < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
+      # @!visibility private
       def subcommands
         %w[workspace show]
       end

data/lib/ruby_terraform/options.rb

@@ -1,8 +1,30 @@
 # frozen_string_literal: true
 
 require_relative 'options/name'
-require_relative 'options/types/flag'
-require_relative 'options/types/boolean'
-require_relative 'options/types/standard'
+require_relative 'options/types'
+require_relative 'options/values'
+require_relative 'options/definition'
 require_relative 'options/factory'
-require_relative 'options/common'
+require_relative 'options/global'
+
+module RubyTerraform
+  module Options
+    def self.name(name)
+      Name.new(name)
+    end
+
+    def self.definition(opts)
+      Definition.new(opts)
+    end
+
+    def self.types
+      Types
+    end
+
+    def self.values
+      Values
+    end
+  end
+end
+
+require_relative 'options/definitions'

data/lib/ruby_terraform/options/definition.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'immutable-struct'
+
+require_relative 'name'
+require_relative 'types'
+require_relative 'values'
+
+module RubyTerraform
+  module Options
+    # rubocop:disable Metrics/ClassLength
+    class Definition < ImmutableStruct.new(
+      :name,
+      :option_type,
+      :value_type,
+      :override_keys,
+      :extra_keys,
+      :separator,
+      :placement,
+      :repeatable?
+    )
+      # rubocop:disable Metrics/MethodLength
+      def initialize(opts)
+        raise 'Missing name.' unless opts[:name]
+
+        super(
+          name: Name.new(opts[:name]),
+          option_type: Types.resolve(opts[:option_type]) || Types::Standard,
+          value_type: Values.resolve(opts[:value_type]) || Values::String,
+          repeatable: opts[:repeatable] || false,
+          separator: opts[:separator],
+          placement: opts[:placement],
+          extra_keys:
+            { singular: [], plural: [] }
+              .merge(opts[:extra_keys] || {}),
+          override_keys:
+            { singular: nil, plural: nil }
+              .merge(opts[:override_keys] || {})
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def matches?(name)
+        @name == Name.new(name)
+      end
+
+      def build(parameters)
+        build_singular_options(parameters) + build_plural_options(parameters)
+      end
+
+      private
+
+      def resolved_singular_key
+        if override_keys[:singular] == false
+          nil
+        else
+          override_keys[:singular] || name.as_singular_key
+        end
+      end
+
+      def all_singular_keys
+        ([resolved_singular_key] + extra_keys[:singular]).compact
+      end
+
+      def resolved_plural_key
+        if override_keys[:plural] == false
+          nil
+        else
+          override_keys[:plural] || name.as_plural_key
+        end
+      end
+
+      def all_plural_keys
+        ([resolved_plural_key] + extra_keys[:plural]).compact
+      end
+
+      def too_many_values?(values)
+        !repeatable? && values.length > 1
+      end
+
+      def values(parameters, keys)
+        keys.map { |k| parameters[k] }.compact
+      end
+
+      def needs_plural?(value)
+        repeatable? && !value.nil?
+      end
+
+      def only_singular?(value)
+        !needs_plural?(value)
+      end
+
+      def key_valued?(value)
+        value.respond_to?(:keys)
+      end
+
+      def multi_valued?(value)
+        value.respond_to?(:each)
+      end
+
+      def build_option(value)
+        option_type.new(name, value, separator: separator, placement: placement)
+      end
+
+      def build_value(value)
+        value_type.new(value)
+      end
+
+      def build_key_value(key, value)
+        Values::KeyValue.new(key, build_value(value))
+      end
+
+      def build_singular(value)
+        build_single_option(value)
+      end
+
+      def build_singulars(values)
+        values.map { |p| build_singular(p) }.flatten
+      end
+
+      def build_singular_options(parameters)
+        keys = all_singular_keys
+        values = values(parameters, keys)
+
+        if too_many_values?(values)
+          raise "Multiple values provided for '#{name}' " \
+                "(with keys #{keys}) and option not repeatable."
+        end
+
+        build_singulars(values)
+      end
+
+      def build_plural(value)
+        if only_singular?(value)
+          build_no_options
+        elsif key_valued?(value)
+          build_key_value_options(value)
+        elsif multi_valued?(value)
+          build_multiple_options(value)
+        else
+          build_single_option(value)
+        end
+      end
+
+      def build_plurals(values)
+        values.map { |p| build_plural(p) }.flatten
+      end
+
+      def build_plural_options(parameters)
+        keys = all_plural_keys
+        values = values(parameters, keys)
+
+        build_plurals(values)
+      end
+
+      def build_key_value_options(value)
+        value.map { |k, v| build_option(build_key_value(k, v)) }
+      end
+
+      def build_multiple_options(value)
+        value.map { |v| build_option(build_value(v)) }
+      end
+
+      def build_single_option(value)
+        [build_option(build_value(value))]
+      end
+
+      def build_no_options
+        []
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/ruby_terraform/options/definitions.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RubyTerraform
+  module Options
+    DEFINITIONS =
+      [
+        # complex repeatable options with space separator
+        %w[-var].map do |o|
+          definition(
+            name: o, option_type: :standard, value_type: :complex,
+            repeatable: true, separator: ' '
+          )
+        end,
+
+        # complex repeatable options with default separator
+        %w[-backend-config].map do |o|
+          definition(
+            name: o, option_type: :standard, value_type: :complex,
+            repeatable: true,
+            override_keys: { singular: false, plural: :backend_config }
+          )
+        end,
+
+        # string repeatable options
+        %w[-var-file -target -platform -plugin-dir].map do |o|
+          definition(
+            name: o, option_type: :standard, value_type: :string,
+            repeatable: true
+          )
+        end,
+
+        # boolean options
+        %w[
+          -auto-approve
+          -backend
+          -get
+          -get-plugins
+          -input
+          -list
+          -lock
+          -refresh
+          -upgrade
+          -verify-plugins
+          -write
+        ].map do |o|
+          definition(name: o, option_type: :standard, value_type: :boolean)
+        end,
+
+        # flag options
+        %w[
+          -allow-missing
+          -allow-missing-config
+          -check
+          -compact-warnings
+          -destroy
+          -detailed-exitcode
+          -diff
+          -draw-cycles
+          -dry-run
+          -force
+          -force-copy
+          -ignore-remote-version
+          -json
+          -no-color
+          -raw
+          -reconfigure
+          -recursive
+          -update
+        ].map do |o|
+          definition(name: o, option_type: :flag, value_type: :boolean)
+        end,
+
+        # string options
+        %w[
+          -backup
+          -backup-out
+          -from-module
+          -fs-mirror
+          -id
+          -lock-timeout
+          -lockfile
+          -module-depth
+          -net-mirror
+          -parallelism
+          -plan
+          -provider
+          -state
+          -state-out
+          -type
+        ].map do |o|
+          definition(name: o, option_type: :standard, value_type: :string)
+        end,
+
+        # string options with extra keys
+        definition(
+          name: '-config', option_type: :standard, value_type: :string,
+          extra_keys: { singular: %i[directory] }
+        ),
+        definition(
+          name: '-out', option_type: :standard, value_type: :string,
+          extra_keys: { singular: %i[plan] }
+        ),
+
+        # global options
+        definition(
+          name: '-chdir', option_type: :standard, value_type: :string,
+          placement: :after_command,
+          extra_keys: { singular: %i[working_directory] }
+        )
+      ].flatten.freeze
+  end
+end

data/lib/ruby_terraform/options/factory.rb

@@ -1,118 +1,26 @@
 # frozen_string_literal: true
 
 require_relative 'name'
-require_relative 'types/boolean'
-require_relative 'types/flag'
-require_relative 'types/standard'
 
 module RubyTerraform
   module Options
     class Factory
-      PLURAL_OPTIONS =
-        Set.new(
-          %w[
-            -var
-            -target
-            -var-file
-            -platform
-          ]
-        ).freeze
-
-      BOOLEAN_OPTIONS =
-        Set.new(
-          %w[
-            -auto-approve
-            -backend
-            -get
-            -get-plugins
-            -input
-            -list
-            -lock
-            -refresh
-            -upgrade
-            -verify-plugins
-            -write
-          ]
-        ).freeze
-
-      FLAG_OPTIONS =
-        Set.new(
-          %w[
-            -allow-missing
-            -allow-missing-config
-            -check
-            -compact-warnings
-            -destroy
-            -detailed-exitcode
-            -diff
-            -draw-cycles
-            -force
-            -force-copy
-            -ignore-remote-version
-            -json
-            -no-color
-            -raw
-            -reconfigure
-            -recursive
-            -update
-          ]
-        ).freeze
-
-      OVERRIDE_OPTIONS =
-        {
-          config: :directory,
-          out: :plan
-        }.freeze
-
-      def self.from(names, parameters)
-        new(names, parameters).from
-      end
-
-      private_class_method :new
-
-      def initialize(names, parameters)
-        @names = names.map { |name| Name.new(name) }
-        @parameters = parameters
+      def initialize(definitions)
+        @definitions = definitions
       end
 
-      def from
-        names.each_with_object([]) do |name, options|
-          options.append(*options_from_name(name))
-        end
+      def resolve(names, parameters)
+        names
+          .map { |name| Name.new(name) }
+          .inject([]) do |options, name|
+            options + resolve_name(name, parameters)
+          end
       end
 
       private
 
-      attr_reader :names, :parameters
-
-      def options_from_name(name)
-        return plural_options(name) if PLURAL_OPTIONS.include?(name)
-        return boolean_option(name) if BOOLEAN_OPTIONS.include?(name)
-        return flag_option(name) if FLAG_OPTIONS.include?(name)
-        return override_option(name) if OVERRIDE_OPTIONS.key?(name.as_key)
-
-        standard_option(name, name.as_key)
-      end
-
-      def boolean_option(name)
-        [Types::Boolean.new(name.to_s, parameters[name.as_key])]
-      end
-
-      def flag_option(name)
-        [Types::Flag.new(name.to_s, parameters[name.as_key])]
-      end
-
-      def standard_option(name, hash_key)
-        [Types::Standard.new(name.to_s, parameters[hash_key])]
-      end
-
-      def override_option(name)
-        standard_option(name, OVERRIDE_OPTIONS[name.as_key])
-      end
-
-      def plural_options(name)
-        standard_option(name.to_s, name.as_key) +
-          standard_option(name.to_s, name.as_plural_key)
+      def resolve_name(name, parameters)
+        @definitions.find { |d| d.matches?(name) }.build(parameters)
       end
     end
   end