dependabot-devcontainers 0.242.1 → 0.243.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7b4145added088e88f5e297ef2aee20585963983b81ef47920d892f93e95a72
-  data.tar.gz: 54b7c39594846193d16c0730b0dcd6b3d366de01b7a48dfe898ad2088ff1f8e7
+  metadata.gz: 6d7528b485992d8e78ec3e0569772f6c7514074c1c861a639fe7228089c1d291
+  data.tar.gz: 4ebec7698561a2a2813cb119aedf3527cc06d06690a38c1e5f6940f019cfaa4c
 SHA512:
-  metadata.gz: 122db965c8552bcc23314f20808760065a97de250ed016c8343ae432e075298b2cbfbe3a493d551882051dbe31dd1b5f9da1c91323924ae2e4e761862dd16b48
-  data.tar.gz: f494802e9204bf03d253bc699671135dd4cbc7bc3c412ffdee356da305b21e5476ac79e22dcc1efc2959856516bedd8409deeafbcdc50f84483125791ccb86c6
+  metadata.gz: 8795cda17d2b9b87ebb02da515390994a42d33e31263f89eabc2d28c52d3a6579af104f516416fe8c15c8051da7481a403f6ca39452870d08421b23806a8ef73
+  data.tar.gz: d3a5f5db65fa19ff0f1f73142c632a93c3916e4e75d631127153c08db40f97eef8342de64af2f8c49d984905d682c7d5ce73270d436fd5b5b4278ab16161fa9f

data/lib/dependabot/devcontainers/file_fetcher.rb

@@ -1,6 +1,7 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
 require "dependabot/file_fetchers"
 require "dependabot/file_fetchers/base"
 require "dependabot/devcontainers/utils"
@@ -8,16 +9,21 @@ require "dependabot/devcontainers/utils"
 module Dependabot
   module Devcontainers
     class FileFetcher < Dependabot::FileFetchers::Base
+      extend T::Sig
+
+      sig { override.params(filenames: T::Array[String]).returns(T::Boolean) }
       def self.required_files_in?(filenames)
         # There's several other places a devcontainer.json can be checked into
         # See: https://containers.dev/implementors/spec/#devcontainerjson
         filenames.any? { |f| f.end_with?("devcontainer.json") }
       end
 
+      sig { override.returns(String) }
       def self.required_files_message
         "Repo must contain a dev container configuration file."
       end
 
+      sig { override.returns(T::Array[Dependabot::DependencyFile]) }
       def fetch_files
         fetched_files = []
         fetched_files += root_files
@@ -34,16 +40,19 @@ module Dependabot
 
       private
 
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
       def root_files
         fetch_config_and_lockfile_from(".")
       end
 
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
       def scoped_files
         return [] unless devcontainer_directory
 
         fetch_config_and_lockfile_from(".devcontainer")
       end
 
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
       def custom_directory_files
         return [] unless devcontainer_directory
 
@@ -52,16 +61,21 @@ module Dependabot
         end
       end
 
+      sig { returns(T::Array[T.untyped]) }
       def custom_directories
         repo_contents(dir: ".devcontainer").select { |f| f.type == "dir" && f.name != ".devcontainer" }
       end
 
+      sig { returns(T.untyped) }
       def devcontainer_directory
-        return @devcontainer_directory if defined?(@devcontainer_directory)
-
-        @devcontainer_directory = repo_contents.find { |f| f.type == "dir" && f.name == ".devcontainer" }
+        @devcontainer_directory ||=
+          T.let(
+            repo_contents.find { |f| f.type == "dir" && f.name == ".devcontainer" },
+            T.untyped
+          )
       end
 
+      sig { params(directory: String).returns(T::Array[Dependabot::DependencyFile]) }
       def fetch_config_and_lockfile_from(directory)
         files = []
 

data/lib/dependabot/devcontainers/file_parser/feature_dependency_parser.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "dependabot/devcontainers/requirement"
@@ -6,18 +6,30 @@ require "dependabot/file_parsers/base"
 require "dependabot/shared_helpers"
 require "dependabot/dependency"
 require "json"
+require "sorbet-runtime"
 require "uri"
 
 module Dependabot
   module Devcontainers
     class FileParser < Dependabot::FileParsers::Base
       class FeatureDependencyParser
+        extend T::Sig
+
+        sig do
+          params(
+            config_dependency_file: Dependabot::DependencyFile,
+            repo_contents_path: T.nilable(String),
+            credentials: T::Array[Dependabot::Credential]
+          )
+            .void
+        end
         def initialize(config_dependency_file:, repo_contents_path:, credentials:)
           @config_dependency_file = config_dependency_file
           @repo_contents_path = repo_contents_path
           @credentials = credentials
         end
 
+        sig { returns(T::Array[Dependabot::Dependency]) }
         def parse
           SharedHelpers.in_a_temporary_repo_directory(base_dir, repo_contents_path) do
             SharedHelpers.with_git_configured(credentials: credentials) do
@@ -28,19 +40,23 @@ module Dependabot
 
         private
 
+        sig { returns(String) }
         def base_dir
           File.dirname(config_dependency_file.path)
         end
 
+        sig { returns(String) }
         def config_name
           File.basename(config_dependency_file.path)
         end
 
+        sig { returns(T.nilable(String)) }
         def config_contents
           config_dependency_file.content
         end
 
         # https://github.com/devcontainers/cli/blob/9444540283b236298c28f397dea879e7ec222ca1/src/spec-node/devContainersSpecCLI.ts#L1072
+        sig { returns(T::Hash[String, T.untyped]) }
         def evaluate_with_cli
           raise "config_name must be a string" unless config_name.is_a?(String) && !config_name.empty?
 
@@ -55,6 +71,7 @@ module Dependabot
           JSON.parse(json)
         end
 
+        sig { params(json: T::Hash[String, T.untyped]).returns(T::Array[Dependabot::Dependency]) }
         def parse_cli_json(json)
           dependencies = []
 
@@ -90,7 +107,14 @@ module Dependabot
           dependencies
         end
 
-        attr_reader :config_dependency_file, :repo_contents_path, :credentials
+        sig { returns(Dependabot::DependencyFile) }
+        attr_reader :config_dependency_file
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :repo_contents_path
+
+        sig { returns(T::Array[Dependabot::Credential]) }
+        attr_reader :credentials
       end
     end
   end

data/lib/dependabot/devcontainers/file_parser.rb

@@ -1,6 +1,8 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/file_parsers"
 require "dependabot/file_parsers/base"
 require "dependabot/devcontainers/version"
@@ -9,8 +11,11 @@ require "dependabot/devcontainers/file_parser/feature_dependency_parser"
 module Dependabot
   module Devcontainers
     class FileParser < Dependabot::FileParsers::Base
+      extend T::Sig
+
       require "dependabot/file_parsers/base/dependency_set"
 
+      sig { override.returns(T::Array[Dependabot::Dependency]) }
       def parse
         dependency_set = DependencySet.new
 
@@ -25,12 +30,14 @@ module Dependabot
 
       private
 
+      sig { override.void }
       def check_required_files
         return if config_dependency_files.any?
 
         raise "No dev container configuration!"
       end
 
+      sig { params(config_dependency_file: Dependabot::DependencyFile).returns(T::Array[Dependabot::Dependency]) }
       def parse_features(config_dependency_file)
         FeatureDependencyParser.new(
           config_dependency_file: config_dependency_file,
@@ -39,10 +46,14 @@ module Dependabot
         ).parse
       end
 
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
       def config_dependency_files
-        @config_dependency_files ||= dependency_files.select do |f|
-          f.name.end_with?("devcontainer.json")
-        end
+        @config_dependency_files ||= T.let(
+          dependency_files.select do |f|
+            f.name.end_with?("devcontainer.json")
+          end,
+          T.nilable(T::Array[Dependabot::DependencyFile])
+        )
       end
     end
   end

data/lib/dependabot/devcontainers/file_updater/config_updater.rb

@@ -1,15 +1,31 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/file_updaters/base"
 require "dependabot/shared_helpers"
 require "dependabot/logger"
 require "dependabot/devcontainers/utils"
+require "dependabot/devcontainers/version"
 
 module Dependabot
   module Devcontainers
     class FileUpdater < Dependabot::FileUpdaters::Base
       class ConfigUpdater
+        extend T::Sig
+
+        sig do
+          params(
+            feature: String,
+            requirement: T.any(String, Dependabot::Devcontainers::Version),
+            version: String,
+            manifest: Dependabot::DependencyFile,
+            repo_contents_path: String,
+            credentials: T::Array[Dependabot::Credential]
+          )
+            .void
+        end
         def initialize(feature:, requirement:, version:, manifest:, repo_contents_path:, credentials:)
           @feature = feature
           @requirement = requirement
@@ -19,6 +35,7 @@ module Dependabot
           @credentials = credentials
         end
 
+        sig { returns(T::Array[String]) }
         def update
           SharedHelpers.in_a_temporary_repo_directory(base_dir, repo_contents_path) do
             SharedHelpers.with_git_configured(credentials: credentials) do
@@ -34,18 +51,28 @@ module Dependabot
 
         private
 
+        sig { returns(String) }
         def base_dir
           File.dirname(manifest.path)
         end
 
+        sig { returns(String) }
         def manifest_name
           File.basename(manifest.path)
         end
 
+        sig { returns(String) }
         def lockfile_name
           Utils.expected_lockfile_name(manifest_name)
         end
 
+        sig do
+          params(
+            target_requirement: T.any(String, Dependabot::Devcontainers::Version),
+            target_version: String
+          )
+            .void
+        end
         def update_manifests(target_requirement:, target_version:)
           # First force target version to upgrade lockfile.
           run_devcontainer_upgrade(target_version)
@@ -55,10 +82,12 @@ module Dependabot
           force_target_requirement(lockfile_name, from: target_version, to: target_requirement)
         end
 
+        sig { params(file_name: String, from: String, to: T.any(String, Dependabot::Devcontainers::Version)).void }
         def force_target_requirement(file_name, from:, to:)
           File.write(file_name, File.read(file_name).gsub("#{feature}:#{from}", "#{feature}:#{to}"))
         end
 
+        sig { params(target_version: String).void }
         def run_devcontainer_upgrade(target_version)
           cmd = "devcontainer upgrade " \
                 "--workspace-folder . " \
@@ -71,7 +100,23 @@ module Dependabot
           SharedHelpers.run_shell_command(cmd, stderr_to_stdout: false)
         end
 
-        attr_reader :feature, :requirement, :version, :manifest, :repo_contents_path, :credentials
+        sig { returns(String) }
+        attr_reader :feature
+
+        sig { returns(T.any(String, Dependabot::Devcontainers::Version)) }
+        attr_reader :requirement
+
+        sig { returns(String) }
+        attr_reader :version
+
+        sig { returns(Dependabot::DependencyFile) }
+        attr_reader :manifest
+
+        sig { returns(String) }
+        attr_reader :repo_contents_path
+
+        sig { returns(T::Array[Dependabot::Credential]) }
+        attr_reader :credentials
       end
     end
   end

data/lib/dependabot/devcontainers/file_updater.rb

@@ -1,6 +1,8 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/file_updaters"
 require "dependabot/file_updaters/base"
 require "dependabot/devcontainers/file_updater/config_updater"
@@ -8,6 +10,9 @@ require "dependabot/devcontainers/file_updater/config_updater"
 module Dependabot
   module Devcontainers
     class FileUpdater < Dependabot::FileUpdaters::Base
+      extend T::Sig
+
+      sig { override.returns(T::Array[Regexp]) }
       def self.updated_files_regex
         [
           /^\.?devcontainer\.json$/,
@@ -15,6 +20,7 @@ module Dependabot
         ]
       end
 
+      sig { override.returns(T::Array[Dependabot::DependencyFile]) }
       def updated_dependency_files
         updated_files = []
 
@@ -24,7 +30,7 @@ module Dependabot
 
           config_contents, lockfile_contents = update(manifest, requirement)
 
-          updated_files << updated_file(file: manifest, content: config_contents) if file_changed?(manifest)
+          updated_files << updated_file(file: manifest, content: T.must(config_contents)) if file_changed?(manifest)
 
           lockfile = lockfile_for(manifest)
 
@@ -36,23 +42,30 @@ module Dependabot
 
       private
 
+      sig { returns(Dependabot::Dependency) }
       def dependency
         # TODO: Handle one dependency at a time
-        dependencies.first
+        T.must(dependencies.first)
       end
 
+      sig { override.void }
       def check_required_files
         return if dependency_files.any?
 
         raise "No dev container configuration!"
       end
 
+      sig { returns(T::Array[Dependabot::DependencyFile]) }
       def manifests
-        @manifests ||= dependency_files.select do |f|
-          f.name.end_with?("devcontainer.json")
-        end
+        @manifests ||= T.let(
+          dependency_files.select do |f|
+            f.name.end_with?("devcontainer.json")
+          end,
+          T.nilable(T::Array[Dependabot::DependencyFile])
+        )
       end
 
+      sig { params(manifest: Dependabot::DependencyFile).returns(T.nilable(Dependabot::DependencyFile)) }
       def lockfile_for(manifest)
         lockfile_name = lockfile_name_for(manifest)
 
@@ -61,6 +74,7 @@ module Dependabot
         end
       end
 
+      sig { params(manifest: Dependabot::DependencyFile).returns(String) }
       def lockfile_name_for(manifest)
         basename = File.basename(manifest.name)
         lockfile_name = Utils.expected_lockfile_name(basename)
@@ -68,13 +82,20 @@ module Dependabot
         manifest.name.delete_suffix(basename).concat(lockfile_name)
       end
 
+      sig do
+        params(
+          manifest: Dependabot::DependencyFile,
+          requirement: T::Hash[Symbol, T.untyped]
+        )
+          .returns(T::Array[String])
+      end
       def update(manifest, requirement)
         ConfigUpdater.new(
           feature: dependency.name,
           requirement: requirement[:requirement],
-          version: dependency.version,
+          version: T.must(dependency.version),
           manifest: manifest,
-          repo_contents_path: repo_contents_path,
+          repo_contents_path: T.must(repo_contents_path),
           credentials: credentials
         ).update
       end

data/lib/dependabot/devcontainers/metadata_finder.rb

@@ -1,14 +1,19 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/metadata_finders"
 require "dependabot/metadata_finders/base"
 
 module Dependabot
   module Devcontainers
     class MetadataFinder < Dependabot::MetadataFinders::Base
+      extend T::Sig
+
       private
 
+      sig { override.returns(T.nilable(Dependabot::Source)) }
       def look_up_source
         # TODO: Make upstream changes to dev container CLI to point to docs.
         #       Specifically, 'devcontainers features info' can be augmented to expose documentationUrl

data/lib/dependabot/devcontainers/requirement.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
 require "sorbet-runtime"
@@ -14,17 +14,18 @@ module Dependabot
       # For consistency with other languages, we define a requirements array.
       # Devcontainers don't have an `OR` separator for requirements, so it
       # always contains a single element.
-      sig { override.params(requirement_string: T.nilable(String)).returns(T::Array[Requirement]) }
+      sig { override.params(requirement_string: T.nilable(String)).returns(T::Array[Dependabot::Requirement]) }
       def self.requirements_array(requirement_string)
         [new(requirement_string)]
       end
 
       # Patches Gem::Requirement to make it accept requirement strings like
       # "~> 4.2.5, >= 4.2.5.1" without first needing to split them.
+      sig { params(requirements: T.nilable(String)).void }
       def initialize(*requirements)
         requirements = requirements.flatten.flat_map do |req_string|
-          req_string.split(",").map(&:strip)
-        end
+          req_string&.split(",")&.map(&:strip)
+        end.compact
 
         super(requirements)
       end

data/lib/dependabot/devcontainers/update_checker.rb

@@ -1,6 +1,8 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/update_checkers"
 require "dependabot/update_checkers/base"
 require "dependabot/devcontainers/version"
@@ -10,14 +12,19 @@ require "dependabot/devcontainers/requirement"
 module Dependabot
   module Devcontainers
     class UpdateChecker < Dependabot::UpdateCheckers::Base
+      extend T::Sig
+
+      sig { returns(T.nilable(Gem::Version)) }
       def latest_version
-        @latest_version ||= fetch_latest_version
+        @latest_version ||= T.let(fetch_latest_version, T.nilable(Gem::Version))
       end
 
+      sig { returns(T.nilable(Gem::Version)) }
       def latest_resolvable_version
         latest_version # TODO
       end
 
+      sig { override.returns(T::Array[T::Hash[Symbol, T.untyped]]) }
       def updated_requirements
         dependency.requirements.map do |requirement|
           required_version = version_class.new(requirement[:requirement])
@@ -32,41 +39,61 @@ module Dependabot
         end
       end
 
+      sig { override.returns(T.nilable(Dependabot::Version)) }
       def latest_resolvable_version_with_no_unlock
         raise NotImplementedError
       end
 
       private
 
+      sig { returns(T::Array[Dependabot::Devcontainers::Version]) }
       def viable_candidates
-        @viable_candidates ||= fetch_viable_candidates
+        @viable_candidates ||= T.let(
+          fetch_viable_candidates,
+          T.nilable(T::Array[Dependabot::Devcontainers::Version])
+        )
       end
 
+      sig { returns(T::Array[Dependabot::Devcontainers::Version]) }
       def fetch_viable_candidates
         candidates = comparable_versions_from_registry
         candidates = filter_ignored(candidates)
         candidates.sort
       end
 
+      sig { returns(Dependabot::Devcontainers::Version) }
       def fetch_latest_version
         return current_version unless viable_candidates.any?
 
-        viable_candidates.last
+        T.must(viable_candidates.last)
       end
 
+      sig do
+        params(
+          versions: T::Array[Dependabot::Devcontainers::Version],
+          required_version: Dependabot::Devcontainers::Version
+        )
+          .returns(T::Array[Dependabot::Devcontainers::Version])
+      end
       def remove_precision_changes(versions, required_version)
         versions.select do |version|
           version.same_precision?(required_version)
         end
       end
 
+      sig do
+        params(
+          versions: T::Array[Dependabot::Devcontainers::Version]
+        )
+          .returns(T::Array[Dependabot::Devcontainers::Version])
+      end
       def filter_ignored(versions)
         filtered =
           versions.reject do |version|
             ignore_requirements.any? { |r| version.satisfies?(r) }
           end
 
-        if @raise_on_ignored &&
+        if raise_on_ignored &&
            filter_lower_versions(filtered).empty? &&
            filter_lower_versions(versions).any?
           raise AllVersionsIgnored
@@ -75,16 +102,19 @@ module Dependabot
         filtered
       end
 
+      sig { returns(T::Array[Dependabot::Devcontainers::Version]) }
       def comparable_versions_from_registry
         tags_from_registry.filter_map do |tag|
           version_class.correct?(tag) && version_class.new(tag)
         end
       end
 
+      sig { returns(T::Array[String]) }
       def tags_from_registry
-        @tags_from_registry ||= fetch_tags_from_registry
+        @tags_from_registry ||= T.let(fetch_tags_from_registry, T.nilable(T::Array[String]))
       end
 
+      sig { returns(T::Array[String]) }
       def fetch_tags_from_registry
         cmd = "devcontainer features info tags #{dependency.name} --output-format json"
 
@@ -95,16 +125,19 @@ module Dependabot
         JSON.parse(output).fetch("publishedTags")
       end
 
+      sig { params(versions: T::Array[Gem::Version]).returns(T::Array[Gem::Version]) }
       def filter_lower_versions(versions)
         versions.select do |version|
           version > current_version
         end
       end
 
+      sig { override.returns(T::Boolean) }
       def latest_version_resolvable_with_full_unlock?
         false # TODO
       end
 
+      sig { override.returns(T::Array[Dependabot::Dependency]) }
       def updated_dependencies_after_full_unlock
         raise NotImplementedError
       end

data/lib/dependabot/devcontainers/utils.rb

@@ -1,17 +1,24 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 module Dependabot
   module Devcontainers
     module Utils
+      extend T::Sig
+
+      sig { params(directory: String).returns(String) }
       def self.expected_config_basename(directory)
         root_directory?(directory) ? ".devcontainer.json" : "devcontainer.json"
       end
 
+      sig { params(directory: String).returns(T::Boolean) }
       def self.root_directory?(directory)
         Pathname.new(directory).cleanpath.to_path == Pathname.new(".").cleanpath.to_path
       end
 
+      sig { params(config_file_name: String).returns(String) }
       def self.expected_lockfile_name(config_file_name)
         if config_file_name.start_with?(".")
           ".devcontainer-lock.json"

data/lib/dependabot/devcontainers/version.rb

@@ -1,20 +1,27 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+require "sorbet-runtime"
+
 require "dependabot/version"
 require "dependabot/utils"
 
 module Dependabot
   module Devcontainers
     class Version < Dependabot::Version
+      extend T::Sig
+
+      sig { params(other: Dependabot::Devcontainers::Version).returns(T::Boolean) }
       def same_precision?(other)
         precision == other.precision
       end
 
+      sig { params(requirement: Dependabot::Requirement).returns(T::Boolean) }
       def satisfies?(requirement)
         requirement.satisfied_by?(self)
       end
 
+      sig { params(other: BasicObject).returns(T.nilable(Integer)) }
       def <=>(other)
         if self == other
           precision <=> other.precision
@@ -25,6 +32,7 @@ module Dependabot
 
       protected
 
+      sig { returns(Integer) }
       def precision
         segments.size
       end

data/lib/dependabot/devcontainers.rb

@@ -18,6 +18,3 @@ Dependabot::PullRequestCreator::Labeler
 require "dependabot/dependency"
 Dependabot::Dependency
   .register_production_check("devcontainers", ->(_) { true })
-
-require "dependabot/utils"
-Dependabot::Utils.register_always_clone("devcontainers")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-devcontainers
 version: !ruby/object:Gem::Version
-  version: 0.242.1
+  version: 0.243.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-02-13 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.242.1
+        version: 0.243.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.242.1
+        version: 0.243.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +243,7 @@ licenses:
 - Nonstandard
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.242.1
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.243.0
 post_install_message: 
 rdoc_options: []
 require_paths: