dependabot-terraform 0.145.4 → 0.146.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6cf1e8836cea7995d0aef09994f802d1998c32ef12bb7d226f130bb53edf138
-  data.tar.gz: e5ca05e600f6d2f0882447122cfa35fcad661afd9eb974be345d60dc9f2558cb
+  metadata.gz: 4e420475dee8741febcbdbb02fbffc509cf328bc767ba0f3126dc384403cf8d3
+  data.tar.gz: 728d0bcf47d8891d39ea7de8c6e4794f2866492aae8328cce43f1d72156abd7e
 SHA512:
-  metadata.gz: 992d918f528309caafe5b983cd48db2427fe729d9f8bd4c3d25ca06a92bf898454b29669285b01069df21a995dbe5a31d584e9a86afd761d1dffdbbb6b06fb78
-  data.tar.gz: 39ef0856f66834d0c6a0a04ef8936c07f63706f1b665ddbec9c5c7db05b44370869e9acec2d77dcb56c77401e1473260d13a08fc4f2889f5aac8eac237247999
+  metadata.gz: b9ae9da9838932d029c73c2d9ede6cf13f0405440f590bb74ad2e7bcaf37394e2ce2c4ba8d8d8746699f8fe238f0c06c4756f5d3a919817b91132ee3e816efcd
+  data.tar.gz: a530a3b1fba4dae111238e23d67e89f3794fb812ebf658f3a357cf7b588bcb9637c582f55619aee83f87f75fca4b7302efc172363008cf6833154d848be575f4

data/lib/dependabot/terraform/requirements_updater.rb

@@ -10,9 +10,45 @@ require "dependabot/terraform/requirement"
 
 module Dependabot
   module Terraform
+    # Takes an array of `requirements` hashes for a dependency at the old
+    # version and a new version, and generates a set of new `requirements`
+    # hashes at the new version.
+    #
+    # A requirements hash is a basic description of a dependency at a certain
+    # version constraint, and it includes the data that is needed to update the
+    # manifest (i.e. the `.tf` file) with the new version.
+    #
+    # A requirements hash looks like this for a registry hosted requirement:
+    # ```ruby
+    # {
+    #   requirement: "~> 0.2.1",
+    #   groups: [],
+    #   file: "main.tf",
+    #   source: {
+    #     type: "registry",
+    #     registry_hostname: "registry.terraform.io",
+    #     module_identifier: "hashicorp/consul/aws"
+    #   }
+    # }
+    #
+    # And like this for a git requirement:
+    # ```ruby
+    # {
+    #   requirement: nil,
+    #   groups: [],
+    #   file: "main.tf",
+    #   source: {
+    #     type: "git",
+    #     url: "https://github.com/cloudposse/terraform-null-label.git",
+    #     branch: nil,
+    #     ref: nil
+    #   }
+    # }
     class RequirementsUpdater
-      def initialize(requirements:, latest_version:,
-                     tag_for_latest_version:)
+      # @param requirements [Hash{Symbol => String, Array, Hash}]
+      # @param latest_version [Dependabot::Terraform::Version]
+      # @param tag_for_latest_version [String, NilClass]
+      def initialize(requirements:, latest_version:, tag_for_latest_version:)
         @requirements = requirements
         @tag_for_latest_version = tag_for_latest_version
 
@@ -22,6 +58,11 @@ module Dependabot
         @latest_version = version_class.new(latest_version)
       end
 
+      # @return requirements [Hash{Symbol => String, Array, Hash}]
+      #   * requirement [String, NilClass] the updated version constraint
+      #   * groups [Array] no-op for terraform
+      #   * file [String] the file that specified this dependency
+      #   * source [Hash{Symbol => String}] The updated git or registry source details
       def updated_requirements
         return requirements unless latest_version
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-terraform
 version: !ruby/object:Gem::Version
-  version: 0.145.4
+  version: 0.146.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dependabot-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.145.4
+        version: 0.146.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.145.4
+        version: 0.146.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement