ruby-terraform 0.65.0.pre.2 → 0.65.0.pre.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dbba56077adf66c7e32da731ddb62cc90bfea3d2ba29ead63913edf3e1da5bd
-  data.tar.gz: 708c49c91c22e75dcc9262f3d7858d51015451ebfb56dd222bddcf37d95d0fdb
+  metadata.gz: 9addf5887a0f81258238fceea9f31f92f8653b4593c0684e3511723e5d7ee969
+  data.tar.gz: 660b6fb332e8b93e4ca3f7bb8dc1b48052a2116130273968d148d983b9ee0f4f
 SHA512:
-  metadata.gz: 12e0d2f034a80f3d3a3b08aaac13858ef88df3a7fcd16f41320c8aa79ea895cd11165ce8fe439568c46b906b85c54f6249a109899d50c1c4e1c4bd4a2b7356c4
-  data.tar.gz: a1e07bec999d28347645081e3d660c814f7e66a0d2c4f6079002a95e3ac021743904acc600a9a9f3965e8410b654c33381419110435cc0587cafad9acc93260a
+  metadata.gz: 444f51e2e53816404a78770d21873b060b2b117fe36a34516c1c1748db60d87ed10a1fa07bd75e0d7ff010617b1ce7ed3618ede7bc80263539be6454a703b962
+  data.tar.gz: cbb17a6a9b74be5a809b3d68058f383634482fdc3aa06151fc70b165195f230dd692da4b8494a20ffbe09bb7075acd15d9238b07a8a5dc53c3d4590990369000

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (0.65.0.pre.2)
-      lino (>= 1.5)
+    ruby-terraform (0.65.0.pre.7)
+      lino (>= 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -50,7 +50,7 @@ GEM
       concurrent-ruby (~> 1.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    lino (1.9.0)
+    lino (2.3.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
     listen (3.5.1)
@@ -101,7 +101,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -115,7 +115,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.0)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -157,18 +157,18 @@ DEPENDENCIES
   bundler (~> 2.0)
   faker (~> 2.17)
   gem-release (~> 2.1)
-  guard
-  guard-rspec
+  guard (~> 2.16)
+  guard-rspec (~> 4.7)
   rake (~> 13.0)
   rake_circle_ci (~> 0.9)
   rake_github (~> 0.5)
   rake_gpg (~> 0.12)
   rake_ssh (~> 0.4)
   rspec (~> 3.9)
-  rubocop
-  rubocop-rspec
+  rubocop (~> 1.12)
+  rubocop-rspec (~> 2.2)
   ruby-terraform!
-  simplecov
+  simplecov (~> 0.21)
 
 BUNDLED WITH
    2.2.15

data/README.md

@@ -467,7 +467,7 @@ RubyTerraform.workspace(operation: 'delete', workspace: 'staging')
 arguments:
 * `directory`: the directory containing terraform configuration, the default is
   the current path.
-* `operation`: `list`, `select`, `new` or `delete`. default `list`.
+* `operation`: `list`, `select`, `new` or `delete`. default `list`.
 * `workspace`: Workspace name.
 
 
@@ -551,15 +551,35 @@ interactive input from the terminal.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then,
-run `rake spec` to run the tests. You can also run `bin/console` for an
-interactive prompt that will allow you to experiment.
+To install dependencies and run the build, run the pre-commit build:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+```shell script
+./go
+```
+
+This runs all unit tests and other checks including coverage and code linting / 
+formatting.
+
+To run only the unit tests, including coverage:
+
+```shell script
+./go test:unit
+```
+
+To attempt to fix any code linting / formatting issues:
+
+```shell script
+./go library:fix
+```
+
+To check for code linting / formatting issues without fixing:
+
+```shell script
+./go library:check
+```
+
+You can also run `bin/console` for an interactive prompt that will allow you to 
+experiment.
 
 ### Managing CircleCI keys
 

data/Rakefile

@@ -5,10 +5,12 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task default: :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: [
+  #:'library:fix',
+  :'test:unit'
+]
 
 namespace :encryption do
   namespace :passphrase do
@@ -39,6 +41,20 @@ namespace :keys do
   end
 end
 
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
   namespace: :circle_ci,
   project_slug: 'github/infrablocks/ruby_terraform'

data/lib/ruby_terraform.rb

@@ -1,5 +1,6 @@
 require 'ruby_terraform/version'
 require 'ruby_terraform/errors'
+require 'ruby_terraform/options'
 require 'ruby_terraform/commands'
 require 'logger'
 
@@ -21,60 +22,25 @@ module RubyTerraform
   end
 
   module ClassMethods
-    def clean(opts = {})
-      Commands::Clean.new.execute(opts)
-    end
-
-    def init(opts = {})
-      Commands::Init.new.execute(opts)
-    end
-
-    def get(opts = {})
-      Commands::Get.new.execute(opts)
-    end
-
-    def validate(opts = {})
-      Commands::Validate.new.execute(opts)
-    end
-
-    def plan(opts = {})
-      Commands::Plan.new.execute(opts)
-    end
-
-    def apply(opts = {})
-      Commands::Apply.new.execute(opts)
-    end
-
-    def destroy(opts = {})
-      Commands::Destroy.new.execute(opts)
-    end
-
-    def remote_config(opts = {})
-      Commands::RemoteConfig.new.execute(opts)
-    end
-
-    def refresh(opts = {})
-      Commands::Refresh.new.execute(opts)
-    end
-
-    def output(opts = {})
-      Commands::Output.new.execute(opts)
-    end
-
-    def show(opts = {})
-      Commands::Show.new.execute(opts)
-    end
-
-    def workspace(opts = {})
-      Commands::Workspace.new.execute(opts)
-    end
-
-    def import(opts = {})
-      Commands::Import.new.execute(opts)
-    end
-
-    def format(opts = {})
-      Commands::Format.new.execute(opts)
+    {
+      apply: RubyTerraform::Commands::Apply,
+      clean: RubyTerraform::Commands::Clean,
+      destroy: RubyTerraform::Commands::Destroy,
+      format: RubyTerraform::Commands::Format,
+      get: RubyTerraform::Commands::Get,
+      import: RubyTerraform::Commands::Import,
+      init: RubyTerraform::Commands::Init,
+      output: RubyTerraform::Commands::Output,
+      plan: RubyTerraform::Commands::Plan,
+      refresh: RubyTerraform::Commands::Refresh,
+      remote_config: RubyTerraform::Commands::RemoteConfig,
+      show: RubyTerraform::Commands::Show,
+      validate: RubyTerraform::Commands::Validate,
+      workspace: RubyTerraform::Commands::Workspace
+    }.each do |method, command_class|
+      define_method(method) do |opts = {}|
+        command_class.new.execute(opts)
+      end
     end
   end
   extend ClassMethods

data/lib/ruby_terraform/commands/apply.rb

@@ -1,48 +1,39 @@
-require 'json'
 require_relative 'base'
 
 module RubyTerraform
   module Commands
     class Apply < Base
-      def configure_command(builder, opts)
-        directory = opts[:directory]
-        plan = opts[:plan]
-        vars = opts[:vars] || {}
-        var_file = opts[:var_file]
-        var_files = opts[:var_files] || []
-        target = opts[:target]
-        targets = opts[:targets] || []
-        state = opts[:state]
-        input = opts[:input]
-        auto_approve = opts[:auto_approve]
-        no_backup = opts[:no_backup]
-        backup = no_backup ? '-' : opts[:backup]
-        no_color = opts[:no_color]
+      def subcommands(_values)
+        %w[apply]
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def switches
+        %w[
+          -auto-approve
+          -backup
+          -input
+          -lock
+          -lock-timeout
+          -no-color
+          -state
+          -target
+          -var
+          -var-file
+        ]
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def arguments(values)
+        [values[:plan] || values[:directory]]
+      end
+
+      def option_default_values(_opts)
+        { vars: {}, var_files: [], targets: [] }
+      end
 
-        builder
-            .with_subcommand('apply') do |sub|
-              vars.each do |key, value|
-                var_value = value.is_a?(String) ? value : JSON.generate(value)
-                sub = sub.with_option(
-                    '-var', "'#{key}=#{var_value}'", separator: ' ')
-              end
-              sub = sub.with_option('-var-file', var_file) if var_file
-              var_files.each do |file|
-                sub = sub.with_option('-var-file', file)
-              end
-              sub = sub.with_option('-target', target) if target
-              targets.each do |file|
-                sub = sub.with_option('-target', file)
-              end
-              sub = sub.with_option('-state', state) if state
-              sub = sub.with_option('-input', input) if input
-              sub = sub.with_option('-auto-approve', auto_approve) unless
-                  auto_approve.nil?
-              sub = sub.with_option('-backup', backup) if backup
-              sub = sub.with_flag('-no-color') if no_color
-              sub
-            end
-            .with_argument(plan || directory)
+      def option_override_values(opts)
+        { backup: opts[:no_backup] ? '-' : opts[:backup] }
       end
     end
   end

data/lib/ruby_terraform/commands/base.rb

@@ -1,5 +1,7 @@
 require 'lino'
+
 require_relative '../errors'
+require_relative '../options/factory'
 
 module RubyTerraform
   module Commands
@@ -12,20 +14,12 @@ module RubyTerraform
         @stdin = stdin || RubyTerraform.configuration.stdin
         @stdout = stdout || RubyTerraform.configuration.stdout
         @stderr = stderr || RubyTerraform.configuration.stderr
+        initialize_command
       end
 
       def execute(opts = {})
-        builder = instantiate_builder
-
         do_before(opts)
-        command = configure_command(builder, opts).build
-        logger.debug("Running '#{command}'.")
-
-        command.execute(
-          stdin: stdin,
-          stdout: stdout,
-          stderr: stderr
-        )
+        build_and_execute_command(opts)
         do_after(opts)
       rescue Open4::SpawnError
         message = "Failed while running '#{command_name}'."
@@ -37,21 +31,70 @@ module RubyTerraform
 
       attr_reader :binary, :logger, :stdin, :stdout, :stderr
 
+      def build_and_execute_command(opts)
+        command = build_command(opts)
+        logger.debug("Running '#{command}'.")
+        command.execute(
+          stdin: stdin,
+          stdout: stdout,
+          stderr: stderr
+        )
+      end
+
       def command_name
         self.class.to_s.split('::')[-1].downcase
       end
 
-      def instantiate_builder
+      def do_before(_opts); end
+
+      def do_after(_opts); end
+
+      private
+
+      def initialize_command; end
+
+      def build_command(opts)
+        values = apply_option_defaults_and_overrides(opts)
+
         Lino::CommandLineBuilder
-          .for_command(binary)
+          .for_command(@binary)
+          .with_options_after_subcommands
           .with_option_separator('=')
+          .with_appliables(options(values))
+          .with_subcommands(subcommands(values))
+          .with_arguments(arguments(values))
+          .build
+      end
+
+      def apply_option_defaults_and_overrides(opts)
+        option_default_values(opts)
+          .merge(opts)
+          .merge(option_override_values(opts))
+      end
+
+      def option_default_values(_values)
+        {}
+      end
+
+      def option_override_values(_values)
+        {}
+      end
+
+      def subcommands(_values)
+        []
       end
 
-      def do_before(opts); end
+      def options(values)
+        RubyTerraform::Options::Factory.from(values, switches)
+      end
 
-      def configure_command(builder, opts); end
+      def switches
+        []
+      end
 
-      def do_after(opts); end
+      def arguments(_values)
+        []
+      end
     end
   end
 end

data/lib/ruby_terraform/commands/destroy.rb

@@ -3,44 +3,33 @@ require_relative 'base'
 module RubyTerraform
   module Commands
     class Destroy < Base
-      def configure_command(builder, opts)
-        directory = opts[:directory]
-        vars = opts[:vars] || {}
-        var_file = opts[:var_file]
-        var_files = opts[:var_files] || []
-        target = opts[:target]
-        targets = opts[:targets] || []
-        state = opts[:state]
-        force = opts[:force]
-        no_backup = opts[:no_backup]
-        backup = no_backup ? '-' : opts[:backup]
-        no_color = opts[:no_color]
-        auto_approve = opts[:auto_approve]
+      def switches
+        %w[
+          -auto-approve
+          -backup
+          -force
+          -no-color
+          -state
+          -target
+          -var
+          -var-file
+        ]
+      end
+
+      def subcommands(_values)
+        %w[destroy]
+      end
+
+      def arguments(values)
+        [values[:directory]]
+      end
+
+      def option_default_values(_opts)
+        { vars: {}, var_files: [], targets: [] }
+      end
 
-        builder
-            .with_subcommand('destroy') do |sub|
-              vars.each do |key, value|
-                var_value = value.is_a?(String) ? value : JSON.generate(value)
-                sub = sub.with_option(
-                    '-var', "'#{key}=#{var_value}'", separator: ' ')
-              end
-              sub = sub.with_option('-var-file', var_file) if var_file
-              var_files.each do |file|
-                sub = sub.with_option('-var-file', file)
-              end
-              sub = sub.with_option('-target', target) if target
-              targets.each do |target_name|
-                sub = sub.with_option('-target', target_name)
-              end
-              sub = sub.with_option('-state', state) if state
-              sub = sub.with_option('-auto-approve', auto_approve) unless
-                  auto_approve.nil?
-              sub = sub.with_option('-backup', backup) if backup
-              sub = sub.with_flag('-no-color') if no_color
-              sub = sub.with_flag('-force') if force
-              sub
-            end
-            .with_argument(directory)
+      def option_override_values(opts)
+        { backup: opts[:no_backup] ? '-' : opts[:backup] }
       end
     end
   end