ruby-terraform 1.6.0.pre.5 → 1.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d7192a520d734b246ea0384e49ac60341ed2169ddad8dd63bd0f8c281b5715
-  data.tar.gz: 5ca820f3ee95ce07d2d8d5f1e13edf284e53eabd7137732d20234eee4b3f30d7
+  metadata.gz: 680283afcf36ed8fa426c1223836e60e576efcad33524e459ba287e22cf803a2
+  data.tar.gz: 15513e05d5002247601634b071794d6b2f04cbc91d1f147d7100d92210c1df9d
 SHA512:
-  metadata.gz: 565db2201a431fa3b53e75162c965717fb6b76f935404f75f521ae374c44bc651e7c5c428a2ac6b87993df5a2668922a7b17d55069194e00ec52aba2bb520cf6
-  data.tar.gz: efc862a5c9a2385a7f28f53d71baa6a6b4aa7bc50ae7bbfe7e5de289af95ccb9d8966d4636176c5ecfbcefcd46c75feb0eb4e9b2056a2979abbcf0a0459ba806
+  metadata.gz: 19cddfe7e77d1601eccab259866df3c16cb15b3d98ca2e5b4852b253e5e5303b27141a8c8ce204aba7a13ad2fef452e1eb61cca9a85f4bd53c7a1c9e2724def4
+  data.tar.gz: d8bd7161d5343e1696d3386e58b84aec9d51e4bb2b93f88c1e51df998b7adf44f00e03b3fba47b0484701280ab4b963ab239a12055a1d2e59ef73b509b2b34c2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (1.6.0.pre.5)
+    ruby-terraform (1.7.0.pre.1)
       immutable-struct (~> 2.4)
       lino (~> 3.0)
 
@@ -177,4 +177,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.16
+   2.3.17

data/lib/ruby_terraform/models/change.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+require_relative './objects'
+
+module RubyTerraform
+  module Models
+    class Change
+      include ValueEquality
+
+      def initialize(content)
+        @content = content
+      end
+
+      def actions
+        @content[:actions].map do |action|
+          {
+            'no-op' => :no_op,
+            'create' => :create,
+            'read' => :read,
+            'update' => :update,
+            'delete' => :delete
+          }[action]
+        end
+      end
+
+      def before
+        @content[:before]
+      end
+
+      def before_sensitive
+        @content[:before_sensitive]
+      end
+
+      def before_object
+        Objects.box(before, sensitive: before_sensitive)
+      end
+
+      def after
+        @content[:after]
+      end
+
+      def after_unknown
+        @content[:after_unknown]
+      end
+
+      def after_sensitive
+        @content[:after_sensitive]
+      end
+
+      def after_object
+        Objects.box(
+          after,
+          unknown: after_unknown,
+          sensitive: after_sensitive
+        )
+      end
+
+      def no_op?
+        actions == [:no_op]
+      end
+
+      def create?
+        actions == [:create]
+      end
+
+      def read?
+        actions == [:read]
+      end
+
+      def update?
+        actions == [:update]
+      end
+
+      def replace_delete_before_create?
+        actions == %i[delete create]
+      end
+
+      def replace_create_before_delete?
+        actions == %i[create delete]
+      end
+
+      def replace?
+        replace_delete_before_create? || replace_create_before_delete?
+      end
+
+      def delete?
+        actions == [:delete]
+      end
+
+      def inspect
+        @content.inspect
+      end
+
+      def to_h
+        @content
+      end
+
+      def state
+        [@content]
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models/known_value.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+
+module RubyTerraform
+  module Models
+    class KnownValue
+      include ValueEquality
+
+      def initialize(value, sensitive: false)
+        @value = value
+        @sensitive = sensitive
+      end
+
+      attr_reader :value
+
+      def known?
+        true
+      end
+
+      def sensitive?
+        @sensitive
+      end
+
+      def state
+        [@value, @sensitive]
+      end
+
+      def inspect
+        sensitive = sensitive? ? 'sensitive' : 'non-sensitive'
+        "#{@value.inspect} (known, #{sensitive})"
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models/list.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+
+module RubyTerraform
+  module Models
+    class List
+      extend Forwardable
+
+      include Enumerable
+      include ValueEquality
+
+      def_delegators(
+        :@value,
+        :to_a, :to_h, :to_ary,
+        :[], :[]=, :at, :fetch, :first, :last,
+        :concat, :union, :difference, :intersection, :intersect?,
+        :<<, :push, :append, :pop, :shift, :unshift, :insert,
+        :each, :each_index, :reverse_each, :length, :size, :empty?,
+        :find_index, :index, :rindex, :join,
+        :reverse, :reverse!, :rotate, :rotate!, :sort, :sort!, :sort_by!,
+        :collect, :collect!, :map, :map!, :select, :select!, :filter, :filter!,
+        :keep_if, :values_at, :delete, :delete_at, :delete_if,
+        :reject, :reject!, :zip, :transpose, :replace, :clear, :fill, :include?,
+        :<=>, :slice, :slice!, :assoc, :rassoc, :+, :*, :-, :&, :|, :max, :min,
+        :minmax, :uniq, :uniq!, :compact, :compact!, :flatten, :flatten!,
+        :count, :cycle,
+        :permutation, :combination,
+        :repeated_permutation, :repeated_combination,
+        :product, :take, :take_while, :drop, :drop_while,
+        :bsearch, :bsearch_index, :any?, :all?, :none?, :one?, :dig, :sum,
+        :deconstruct, :append, :prepend, :shuffle!, :shuffle, :sample, :pack
+      )
+
+      def initialize(value, sensitive: false)
+        @value = value
+        @sensitive = sensitive
+      end
+
+      attr_reader :value
+
+      def sensitive?
+        @sensitive
+      end
+
+      def state
+        [@value, @sensitive]
+      end
+
+      def inspect
+        sensitive = sensitive? ? 'sensitive' : 'non-sensitive'
+        "#{value.inspect} (#{sensitive})"
+      end
+      alias to_s inspect
+    end
+  end
+end

data/lib/ruby_terraform/models/map.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+
+module RubyTerraform
+  module Models
+    class Map
+      extend Forwardable
+
+      include Enumerable
+      include ValueEquality
+
+      def_delegators(
+        :@value,
+        :rehash, :to_hash, :to_h, :to_a, :to_proc,
+        :[], :fetch, :[]=, :store, :default, :default=,
+        :default_proc, :default_proc=, :key, :size, :length, :empty?,
+        :each_value, :each_key, :each_pair, :each,
+        :transform_keys, :transform_keys!,
+        :transform_values, :transform_values!,
+        :keys, :values, :values_at, :fetch_values,
+        :shift, :delete, :delete_if, :keep_if,
+        :select, :select!, :filter, :filter!, :reject, :reject!,
+        :slice, :except, :clear, :invert, :update, :replace,
+        :merge!, :merge, :assoc, :rassoc, :flatten, :compact, :compact!,
+        :include?, :member?, :has_key?, :has_value?, :key?, :value?,
+        :compare_by_identity, :compare_by_identity?, :any?, :dig,
+        :<=, :<, :>=, :>, :deconstruct_keys
+      )
+
+      def initialize(value, sensitive: false)
+        @value = value
+        @sensitive = sensitive
+      end
+
+      attr_reader :value
+
+      def sensitive?
+        @sensitive
+      end
+
+      def state
+        [@value, @sensitive]
+      end
+
+      def inspect
+        sensitive = sensitive? ? 'sensitive' : 'non-sensitive'
+        "#{value.inspect} (#{sensitive})"
+      end
+
+      alias to_s inspect
+    end
+  end
+end

data/lib/ruby_terraform/models/objects.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative './values'
+
+module RubyTerraform
+  module Models
+    # rubocop:disable Metrics/ModuleLength
+    module Objects
+      class << self
+        # rubocop:disable Style/RedundantAssignment
+        def box(object, unknown: {}, sensitive: {})
+          boxed_unknown =
+            box_unknown(unknown, sensitive: sensitive)
+          boxed_object =
+            box_known(object, sensitive: sensitive, initial: boxed_unknown)
+
+          boxed_object
+        end
+        # rubocop:enable Style/RedundantAssignment
+
+        def paths(object, current = [], accumulator = [])
+          normalised = normalise(object)
+          if normalised.is_a?(Enumerable)
+            normalised.inject(accumulator) do |a, e|
+              paths(e[0], current + [e[1]], a)
+            end
+          else
+            accumulator + [current]
+          end
+        end
+
+        def known_values(paths, object: {}, sensitive: {})
+          paths.map do |path|
+            resolved = try_dig(object, path)
+            resolved_sensitive = try_dig(sensitive, path) == true
+
+            Values.known(resolved, sensitive: resolved_sensitive)
+          end
+        end
+
+        def unknown_values(paths, unknown: {}, sensitive: {})
+          paths.map do |path|
+            resolved = try_dig(unknown, path)
+            resolved_sensitive = try_dig(sensitive, path) == true
+
+            resolved ? Values.unknown(sensitive: resolved_sensitive) : nil
+          end
+        end
+
+        private
+
+        def box_unknown(unknown, sensitive: {}, initial: Values.empty_map)
+          unknown_paths = paths(unknown)
+          unknown_values = unknown_values(
+            unknown_paths,
+            unknown: unknown, sensitive: sensitive
+          )
+
+          object(
+            unknown_paths, unknown_values,
+            sensitive: sensitive, initial: initial
+          )
+        end
+
+        def box_known(object, sensitive: {}, initial: Values.empty_map)
+          object_paths = paths(object)
+          object_values = known_values(
+            object_paths,
+            object: object, sensitive: sensitive
+          )
+
+          object(
+            object_paths, object_values,
+            sensitive: sensitive, initial: initial
+          )
+        end
+
+        def object(paths, values, sensitive: {}, initial: Values.empty_map)
+          paths
+            .zip(values)
+            .each_with_object(initial) do |path_value, object|
+            path, value = path_value
+            update_in(object, path, value, sensitive: sensitive)
+          end
+        end
+
+        def update_in(object, path, value, sensitive: {})
+          path.inject([[], path.drop(1)]) do |context, step|
+            seen, remaining = context
+            pointer = [seen, step, remaining]
+
+            update_object_for_step(object, pointer, value, sensitive: sensitive)
+            update_context_for_step(pointer)
+          end
+          object
+        end
+
+        def update_object_for_step(object, pointer, value, sensitive: {})
+          seen, step, remaining = pointer
+
+          parent = try_dig(object, seen, default: object)
+          upcoming = remaining.first
+
+          resolved_sensitive = try_dig(sensitive, seen + [step]) == true
+          resolved = if remaining.empty?
+                       value
+                     else
+                       empty_by_type(upcoming, sensitive: resolved_sensitive)
+                     end
+
+          parent[step] ||= resolved
+        end
+
+        def update_context_for_step(pointer)
+          seen, step, remaining = pointer
+          [seen + [step], remaining.drop(1)]
+        end
+
+        def try_dig(object, path, default: nil)
+          return default if path.empty?
+
+          result = object.dig(*path)
+          result.nil? ? default : result
+        rescue NoMethodError, TypeError
+          default
+        end
+
+        def empty_by_type(value, sensitive: false)
+          if value.is_a?(Numeric)
+            Values.empty_list(sensitive: sensitive)
+          else
+            Values.empty_map(sensitive: sensitive)
+          end
+        end
+
+        def normalise(object)
+          case object
+          when Array then object.each_with_index.to_a
+          when Hash then object.to_a.map { |e| [e[1], e[0]] }
+          else object
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/ModuleLength
+  end
+end

data/lib/ruby_terraform/models/plan.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'resource_change'
+
+module RubyTerraform
+  module Models
+    class Plan
+      def initialize(content)
+        @content = content
+      end
+
+      def format_version
+        @content[:format_version]
+      end
+
+      def terraform_version
+        @content[:terraform_version]
+      end
+
+      def variables
+        @content[:variables]
+      end
+
+      def variable_values
+        variables.transform_values { |value| value[:value] }
+      end
+
+      def resource_changes
+        @content[:resource_changes].map do |resource_change|
+          ResourceChange.new(resource_change)
+        end
+      end
+
+      def resource_changes_matching(definition)
+        resource_changes.filter do |resource_change|
+          definition.all? do |method, value|
+            resource_change.send(method) == value
+          end
+        end
+      end
+
+      def inspect
+        @content.inspect
+      end
+
+      def to_h
+        @content
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models/resource_change.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+require_relative 'change'
+
+module RubyTerraform
+  module Models
+    class ResourceChange
+      include ValueEquality
+      def initialize(content)
+        @content = content
+      end
+
+      def address
+        @content[:address]
+      end
+
+      def module_address
+        @content[:module_address]
+      end
+
+      def mode
+        @content[:mode]
+      end
+
+      def type
+        @content[:type]
+      end
+
+      def name
+        @content[:name]
+      end
+
+      def index
+        @content[:index]
+      end
+
+      def provider_name
+        @content[:provider_name]
+      end
+
+      def change
+        Change.new(@content[:change])
+      end
+
+      def no_op?
+        change.no_op?
+      end
+
+      def create?
+        change.create?
+      end
+
+      def read?
+        change.read?
+      end
+
+      def update?
+        change.update?
+      end
+
+      def replace_delete_before_create?
+        change.replace_delete_before_create?
+      end
+
+      def replace_create_before_delete?
+        change.replace_create_before_delete?
+      end
+
+      def replace?
+        change.replace?
+      end
+
+      def delete?
+        change.delete?
+      end
+
+      def inspect
+        @content.inspect
+      end
+
+      def to_h
+        @content
+      end
+
+      def state
+        [@content]
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models/unknown_value.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../value_equality'
+
+module RubyTerraform
+  module Models
+    class UnknownValue
+      include ValueEquality
+
+      def initialize(sensitive: false)
+        @sensitive = sensitive
+      end
+
+      def known?
+        false
+      end
+
+      def sensitive?
+        @sensitive
+      end
+
+      def state
+        [@sensitive]
+      end
+
+      def inspect
+        sensitive = sensitive? ? 'sensitive' : 'non-sensitive'
+        "? (unknown, #{sensitive})"
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models/values.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './list'
+require_relative './map'
+require_relative './known_value'
+require_relative './unknown_value'
+
+module RubyTerraform
+  module Models
+    module Values
+      class << self
+        def known(value, sensitive: false)
+          KnownValue.new(value, sensitive: sensitive)
+        end
+
+        def unknown(sensitive: false)
+          UnknownValue.new(sensitive: sensitive)
+        end
+
+        def list(value, sensitive: false)
+          List.new(value, sensitive: sensitive)
+        end
+
+        def empty_list(sensitive: false)
+          list([], sensitive: sensitive)
+        end
+
+        def map(value, sensitive: false)
+          Map.new(value, sensitive: sensitive)
+        end
+
+        def empty_map(sensitive: false)
+          map({}, sensitive: sensitive)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_terraform/models.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'models/plan'
+require_relative 'models/objects'
+require_relative 'models/values'

data/lib/ruby_terraform/value_equality.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyTerraform
+  module ValueEquality
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+
+    alias eql? ==
+
+    def hash
+      [self.class, state].hash
+    end
+  end
+end

data/lib/ruby_terraform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyTerraform
-  VERSION = '1.6.0.pre.5'
+  VERSION = '1.7.0.pre.1'
 end

data/lib/ruby_terraform.rb

@@ -4,6 +4,7 @@ require 'ruby_terraform/version'
 require 'ruby_terraform/errors'
 require 'ruby_terraform/options'
 require 'ruby_terraform/commands'
+require 'ruby_terraform/models'
 require 'logger'
 
 module RubyTerraform

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-terraform
 version: !ruby/object:Gem::Version
-  version: 1.6.0.pre.5
+  version: 1.7.0.pre.1
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: immutable-struct
@@ -317,6 +317,16 @@ files:
 - lib/ruby_terraform/commands/workspace_show.rb
 - lib/ruby_terraform/errors.rb
 - lib/ruby_terraform/errors/execution_error.rb
+- lib/ruby_terraform/models.rb
+- lib/ruby_terraform/models/change.rb
+- lib/ruby_terraform/models/known_value.rb
+- lib/ruby_terraform/models/list.rb
+- lib/ruby_terraform/models/map.rb
+- lib/ruby_terraform/models/objects.rb
+- lib/ruby_terraform/models/plan.rb
+- lib/ruby_terraform/models/resource_change.rb
+- lib/ruby_terraform/models/unknown_value.rb
+- lib/ruby_terraform/models/values.rb
 - lib/ruby_terraform/options.rb
 - lib/ruby_terraform/options/definition.rb
 - lib/ruby_terraform/options/definitions.rb
@@ -333,6 +343,7 @@ files:
 - lib/ruby_terraform/options/values/key_value.rb
 - lib/ruby_terraform/options/values/string.rb
 - lib/ruby_terraform/output.rb
+- lib/ruby_terraform/value_equality.rb
 - lib/ruby_terraform/version.rb
 - ruby_terraform.gemspec
 homepage: https://github.com/infrablocks/ruby_terraform