ruby-terraform 0.65.0.pre.12 → 1.0.0

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

@@ -5,7 +5,7 @@ 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

data/lib/ruby_terraform/options/definition.rb

@@ -16,9 +16,11 @@ module RubyTerraform
       :override_keys,
       :extra_keys,
       :separator,
+      :placement,
       :repeatable?
     )
-      def initialize(opts) # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
+      def initialize(opts)
         raise 'Missing name.' unless opts[:name]
 
         super(
@@ -27,6 +29,7 @@ module RubyTerraform
           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] || {}),
@@ -35,6 +38,7 @@ module RubyTerraform
               .merge(opts[:override_keys] || {})
         )
       end
+      # rubocop:enable Metrics/MethodLength
 
       def matches?(name)
         @name == Name.new(name)
@@ -95,7 +99,7 @@ module RubyTerraform
       end
 
       def build_option(value)
-        option_type.new(name, value, separator: separator)
+        option_type.new(name, value, separator: separator, placement: placement)
       end
 
       def build_value(value)

data/lib/ruby_terraform/options/definitions.rb

@@ -22,7 +22,7 @@ module RubyTerraform
         end,
 
         # string repeatable options
-        %w[-var-file -target -platform].map do |o|
+        %w[-var-file -target -platform -plugin-dir].map do |o|
           definition(
             name: o, option_type: :standard, value_type: :string,
             repeatable: true
@@ -56,6 +56,7 @@ module RubyTerraform
           -detailed-exitcode
           -diff
           -draw-cycles
+          -dry-run
           -force
           -force-copy
           -ignore-remote-version
@@ -73,14 +74,15 @@ module RubyTerraform
         %w[
           -backup
           -backup-out
-          -chdir
           -from-module
           -fs-mirror
+          -id
           -lock-timeout
+          -lockfile
           -module-depth
           -net-mirror
           -parallelism
-          -plugin-dir
+          -plan
           -provider
           -state
           -state-out
@@ -97,6 +99,13 @@ module RubyTerraform
         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

data/lib/ruby_terraform/options/{common.rb → global.rb}

@@ -2,7 +2,8 @@
 
 module RubyTerraform
   module Options
-    module Common
+    module Global
+      # @!visibility private
       def options
         %w[-chdir]
       end

data/lib/ruby_terraform/options/types.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'types/base'
 require_relative 'types/standard'
 require_relative 'types/flag'
 

data/lib/ruby_terraform/options/types/flag.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative '../values/boolean'
-
 module RubyTerraform
   module Options
     module Types
-      class Flag < Base
+      class Flag < ImmutableStruct.new(
+        :name,
+        :value
+      )
+        def initialize(name, value, **_opts)
+          super(name: name, value: value)
+        end
+
         def apply(builder)
           value.resolve ? builder.with_flag(name) : builder
         end

data/lib/ruby_terraform/options/types/standard.rb

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
-require 'json'
-
-require_relative 'base'
-
 module RubyTerraform
   module Options
     module Types
-      class Standard < Base
+      class Standard < ImmutableStruct.new(
+        :name,
+        :value,
+        :separator,
+        :placement
+      )
+        def initialize(name, value, **opts)
+          super(
+            name: name, value: value,
+            separator: opts[:separator],
+            placement: opts[:placement]
+          )
+        end
+
         def apply(builder)
-          builder.with_option(name, value.render, separator: separator)
+          builder.with_option(
+            name,
+            value.render,
+            separator: separator,
+            placement: placement
+          )
         end
       end
     end

data/lib/ruby_terraform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyTerraform
-  VERSION = '0.65.0.pre.12'
+  VERSION = '1.0.0'
 end

data/ruby_terraform.gemspec

@@ -38,8 +38,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'immutable-struct', '>= 2.4'
-  spec.add_dependency 'lino', '>= 2.5'
+  spec.add_dependency 'immutable-struct', '~> 2.4'
+  spec.add_dependency 'lino', '~> 2.7'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'faker', '~> 2.17'
@@ -56,4 +56,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0.5'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
   spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ruby-terraform
 version: !ruby/object:Gem::Version
-  version: 0.65.0.pre.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: immutable-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: lino
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Wraps the Terraform CLI so that Terraform can be invoked from a Ruby
   script or Rakefile.
 email:
@@ -269,7 +283,6 @@ files:
 - lib/ruby_terraform/commands.rb
 - lib/ruby_terraform/commands/apply.rb
 - lib/ruby_terraform/commands/base.rb
-- lib/ruby_terraform/commands/clean.rb
 - lib/ruby_terraform/commands/destroy.rb
 - lib/ruby_terraform/commands/force_unlock.rb
 - lib/ruby_terraform/commands/format.rb
@@ -286,7 +299,6 @@ files:
 - lib/ruby_terraform/commands/providers_mirror.rb
 - lib/ruby_terraform/commands/providers_schema.rb
 - lib/ruby_terraform/commands/refresh.rb
-- lib/ruby_terraform/commands/remote_config.rb
 - lib/ruby_terraform/commands/show.rb
 - lib/ruby_terraform/commands/state_list.rb
 - lib/ruby_terraform/commands/state_move.rb
@@ -306,13 +318,12 @@ files:
 - lib/ruby_terraform/errors.rb
 - lib/ruby_terraform/errors/execution_error.rb
 - lib/ruby_terraform/options.rb
-- lib/ruby_terraform/options/common.rb
 - lib/ruby_terraform/options/definition.rb
 - lib/ruby_terraform/options/definitions.rb
 - lib/ruby_terraform/options/factory.rb
+- lib/ruby_terraform/options/global.rb
 - lib/ruby_terraform/options/name.rb
 - lib/ruby_terraform/options/types.rb
-- lib/ruby_terraform/options/types/base.rb
 - lib/ruby_terraform/options/types/flag.rb
 - lib/ruby_terraform/options/types/standard.rb
 - lib/ruby_terraform/options/values.rb
@@ -339,9 +350,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: 

data/lib/ruby_terraform/commands/clean.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-module RubyTerraform
-  module Commands
-    class Clean
-      attr_reader :logger
-
-      def initialize(directory: nil, logger: nil)
-        @directory = directory || '.terraform'
-        @logger = logger || RubyTerraform.configuration.logger
-      end
-
-      def execute(parameters = {})
-        directory = parameters[:directory] || @directory
-        begin
-          logger.info "Cleaning terraform directory '#{directory}'."
-          FileUtils.rm_r(directory, secure: true)
-        rescue Errno::ENOENT => e
-          logger.error "Couldn't clean '#{directory}': #{e.message}"
-        end
-      end
-    end
-  end
-end

data/lib/ruby_terraform/commands/remote_config.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module RubyTerraform
-  module Commands
-    class RemoteConfig < Base
-      def subcommands
-        %w[remote config]
-      end
-
-      def options
-        %w[
-          -backend
-          -backend-config
-          -no-color
-        ]
-      end
-
-      def parameter_defaults(_parameters)
-        { backend_config: {} }
-      end
-    end
-  end
-end