kettle-dev 2.4.5 → 2.5.0

data/lib/kettle/dev/release_secrets.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Kettle
+  module Dev
+    class Error < StandardError; end unless const_defined?(:Error, false)
+
+    module ReleaseSecrets
+      class Provider
+        def gem_signing_passphrase
+          nil
+        end
+
+        def rubygems_otp
+          nil
+        end
+      end
+
+      class OnePassword < Provider
+        PROVIDER_NAMES = %w[1password onepassword op].freeze
+        DEFAULTS = {
+          "item" => "Rubygems",
+          "gem_signing_passphrase_field" => "GEM-SIGN-PASSPHRASE",
+          "rubygems_otp_field" => "one-time password"
+        }.freeze
+
+        def self.configured?(name)
+          PROVIDER_NAMES.include?(name.to_s.downcase)
+        end
+
+        def initialize(config)
+          @config = DEFAULTS.merge(config || {})
+          @gem_signing_passphrase = nil
+          @gem_signing_passphrase_loaded = false
+        end
+
+        def gem_signing_passphrase
+          return @gem_signing_passphrase if @gem_signing_passphrase_loaded
+
+          return cached_gem_signing_passphrase if cached_gem_signing_passphrase?
+
+          reference = string_config("gem_signing_passphrase_reference")
+          value = if reference.empty?
+            item_field("gem_signing_passphrase_field")
+          else
+            read_reference(reference)
+          end
+
+          @gem_signing_passphrase = value
+          @gem_signing_passphrase_loaded = true
+          value
+        end
+
+        def rubygems_otp
+          reference = string_config("rubygems_otp_reference")
+          return read_reference(reference) unless reference.empty?
+
+          item = required_config("item")
+          argv = ["op", "item", "get", item, "--otp"]
+          account = string_config("account")
+          argv.concat(["--account", account]) unless account.empty?
+          run_op(argv, purpose: "RubyGems OTP")
+        end
+
+        private
+
+        attr_reader :config
+
+        def cached_gem_signing_passphrase?
+          %w[cached family kettle-family].include?(string_config("gem_signing_passphrase_source").downcase)
+        end
+
+        def cached_gem_signing_passphrase
+          value = ENV.fetch("KETTLE_RELEASE_GEM_SIGNING_PASSPHRASE", "").to_s
+          raise Kettle::Dev::Error, "cached gem signing passphrase was requested but KETTLE_RELEASE_GEM_SIGNING_PASSPHRASE is empty" if value.empty?
+
+          value
+        end
+
+        def item_field(field_key)
+          item = required_config("item")
+          field = required_config(field_key)
+          argv = ["op", "item", "get", item, "--fields", "label=#{field}", "--reveal"]
+          account = string_config("account")
+          argv.concat(["--account", account]) unless account.empty?
+          run_op(argv, purpose: field_key.tr("_", " "))
+        end
+
+        def read_reference(reference)
+          argv = ["op", "read", reference]
+          account = string_config("account")
+          argv.concat(["--account", account]) unless account.empty?
+          run_op(argv, purpose: "secret reference")
+        end
+
+        def run_op(argv, purpose:)
+          stdout, stderr, status = Open3.capture3(*argv)
+          return stdout.to_s.strip if status.success? && !stdout.to_s.strip.empty?
+
+          details = stderr.to_s.strip
+          details = "op exited #{status.exitstatus}" if details.empty?
+          raise Kettle::Dev::Error, "1Password #{purpose} lookup failed: #{details}"
+        rescue Errno::ENOENT
+          raise Kettle::Dev::Error, "1Password CLI executable `op` was not found"
+        end
+
+        def required_config(key)
+          value = string_config(key)
+          raise Kettle::Dev::Error, "1Password release secrets require #{key}" if value.empty?
+
+          value
+        end
+
+        def string_config(key)
+          config.fetch(key, "").to_s
+        end
+      end
+
+      class Factory
+        ENV_KEYS = {
+          "account" => "KETTLE_RELEASE_1PASSWORD_ACCOUNT",
+          "item" => "KETTLE_RELEASE_1PASSWORD_ITEM",
+          "gem_signing_passphrase_field" => "KETTLE_RELEASE_1PASSWORD_GEM_SIGNING_PASSPHRASE_FIELD",
+          "rubygems_otp_field" => "KETTLE_RELEASE_1PASSWORD_RUBYGEMS_OTP_FIELD",
+          "gem_signing_passphrase_reference" => "KETTLE_RELEASE_1PASSWORD_GEM_SIGNING_PASSPHRASE_REFERENCE",
+          "rubygems_otp_reference" => "KETTLE_RELEASE_1PASSWORD_RUBYGEMS_OTP_REFERENCE",
+          "gem_signing_passphrase_source" => "KETTLE_RELEASE_GEM_SIGNING_PASSPHRASE_SOURCE"
+        }.freeze
+
+        def self.build(provider_name: nil, config: nil)
+          configured = config || {}
+          name = if provider_name.to_s.empty?
+            configured.fetch("provider", ENV.fetch("KETTLE_RELEASE_SECRETS_PROVIDER", ""))
+          else
+            provider_name.to_s
+          end
+          return Provider.new if name.empty? || name == "interactive"
+          return OnePassword.new(env_config.merge(configured)) if OnePassword.configured?(name)
+
+          raise Kettle::Dev::Error, "unsupported release secrets provider #{name.inspect}"
+        end
+
+        def self.env_config
+          ENV_KEYS.each_with_object({}) do |(key, env_key), memo|
+            value = ENV.fetch(env_key, "").to_s
+            memo[key] = value unless value.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kettle/dev/reset_cli.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Kettle
+  module Dev
+    class ResetCLI
+      def initialize(argv = [], root: Kettle::Dev::CIHelpers.project_root)
+        @argv = Array(argv).dup
+        @root = root
+        @check = false
+      end
+
+      def run!
+        args = parse!
+        target = args.first.to_s
+        raise Error, "kettle-reset requires TARGET" if target.empty?
+        raise Error, "unexpected argument(s): #{args.drop(1).join(" ")}" if args.length > 1
+
+        if check
+          validate(target)
+        else
+          paths = resetter.lockfile_paths_for(target)
+          unless resetter.release_lockfiles_target?(target) || paths.any? { |path| resetter.normalization_needed?(path) }
+            puts "#{target} is already reset."
+            return 0
+          end
+          resetter.reset(target)
+          puts "Reset #{target}."
+        end
+        0
+      end
+
+      private
+
+      attr_reader :argv, :root, :check
+
+      def parse!
+        parser.parse!(argv)
+      rescue OptionParser::ParseError => error
+        raise Error, error.message
+      end
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = "Usage: kettle-reset [--check] TARGET"
+          opts.separator "Targets: Gemfile.lock, Appraisal.root.gemfile.lock, release-lockfiles"
+          opts.on("--check", "Validate TARGET without changing it") { @check = true }
+          opts.on("-h", "--help", "Show this help") do
+            puts opts
+            exit(0)
+          end
+        end
+      end
+
+      def validate(target)
+        paths = resetter.lockfile_paths_for(target)
+        diagnostics = paths.flat_map { |path| resetter.diagnostics(path) }
+        raise Error, validation_message(target, diagnostics) unless diagnostics.empty?
+
+        puts "#{target} is already reset."
+      end
+
+      def validation_message(target, diagnostics)
+        <<~MSG
+          #{target} is not reset:
+          #{diagnostics.map { |diagnostic| "  - #{diagnostic}" }.join("\n")}
+        MSG
+      end
+
+      def resetter
+        @resetter ||= Kettle::Dev::LockfileReset.new(root: root, command_runner: method(:run_cmd!))
+      end
+
+      def run_cmd!(command)
+        puts "$ #{command}"
+        system(command) || raise(Error, "Command failed: #{command}")
+      end
+    end
+  end
+end

data/lib/kettle/dev/{gem_coop_versions.rb → ruby_gems_versions.rb}

@@ -8,10 +8,10 @@ require "uri"
 
 module Kettle
   module Dev
-    module GemCoopVersions
+    module RubyGemsVersions
       CACHE_BUST_TTL_SECONDS = 15 * 60
-      ENV_REFRESH = "KETTLE_GEM_COOP_REFRESH"
-      ENV_MARKER_PATH = "KETTLE_GEM_COOP_CACHE_BUST_PATH"
+      ENV_REFRESH = "KETTLE_RUBYGEMS_REFRESH"
+      ENV_MARKER_PATH = "KETTLE_RUBYGEMS_CACHE_BUST_PATH"
 
       class << self
         def fetch(gem_name, version_hint: nil, refresh: false)
@@ -43,7 +43,7 @@ module Kettle
           FileUtils.mkdir_p(File.dirname(path))
           File.write(path, JSON.pretty_generate(data) << "\n")
         rescue => error
-          warn("[kettle-dev] could not update gem.coop cache-bust marker: #{error.class}: #{error.message}") if Kettle::Dev::DEBUGGING
+          warn("[kettle-dev] could not update RubyGems.org cache-bust marker: #{error.class}: #{error.message}") if Kettle::Dev::DEBUGGING
         end
 
         def marker_path
@@ -52,13 +52,13 @@ module Kettle
 
           state_home = ENV["XDG_STATE_HOME"]
           state_home = File.join(Dir.home, ".local", "state") if state_home.to_s.empty?
-          File.join(state_home, "kettle-dev", "gem-coop-cache-bust.json")
+          File.join(state_home, "kettle-dev", "rubygems-cache-bust.json")
         end
 
         private
 
         def versions_uri(gem_name, cache_bust:)
-          uri = URI("https://gem.coop/api/v1/versions/#{gem_name}.json")
+          uri = URI("https://rubygems.org/api/v1/versions/#{gem_name}.json")
           uri.query = "_kettle_cache_bust=#{Time.now.to_i}" if cache_bust
           uri
         end

data/lib/kettle/dev/version.rb

@@ -2,9 +2,12 @@
 
 module Kettle
   module Dev
+    # Version namespace for this gem.
     module Version
-      VERSION = "2.4.5"
+      # Current gem version.
+      VERSION = "2.5.0"
     end
+    # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location
   end
 end

data/lib/kettle/dev.rb

@@ -34,15 +34,19 @@ module Kettle
     autoload :CommitMsg, "kettle/dev/commit_msg"
     autoload :DvcsCLI, "kettle/dev/dvcs_cli"
     autoload :ExitAdapter, "kettle/dev/exit_adapter"
-    autoload :GemCoopVersions, "kettle/dev/gem_coop_versions"
+    autoload :RubyGemsVersions, "kettle/dev/ruby_gems_versions"
     autoload :GemSpecReader, "kettle/dev/gem_spec_reader"
     autoload :GitAdapter, "kettle/dev/git_adapter"
     autoload :GitCommitFooter, "kettle/dev/git_commit_footer"
     autoload :GhaShaPinsCLI, "kettle/dev/gha_sha_pins_cli"
     autoload :InputAdapter, "kettle/dev/input_adapter"
+    autoload :InteractiveReleaseCommand, "kettle/dev/interactive_release_command"
+    autoload :LockfileReset, "kettle/dev/lockfile_reset"
     autoload :ReadmeBackers, "kettle/dev/readme_backers"
     autoload :OpenCollectiveConfig, "kettle/dev/open_collective_config"
     autoload :ReleaseCLI, "kettle/dev/release_cli"
+    autoload :ReleaseSecrets, "kettle/dev/release_secrets"
+    autoload :ResetCLI, "kettle/dev/reset_cli"
     autoload :PreReleaseCLI, "kettle/dev/pre_release_cli"
     autoload :Version, "kettle/dev/version"
     autoload :VersionBump, "kettle/dev/version_bump"
@@ -181,6 +185,10 @@ module Kettle
         defaults.include?(task_name.to_s)
       end
 
+      def skip_test_tasks?
+        ENV_TRUE_RE.match?(ENV.fetch("KETTLE_DEV_SKIP_TESTS", ""))
+      end
+
       private
 
       ### LINTING TASKS
@@ -204,6 +212,8 @@ module Kettle
       # Set up kettle-soup-cover
       # @return [void]
       def coverage_tasks
+        return if skip_test_tasks?
+
         # Lazy loaded because it won't be installed for Ruby < 2.7
         require "kettle-soup-cover"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-dev
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.5.0
 platform: ruby
 authors:
 - Peter H. Boling
@@ -207,6 +207,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: anonymous_loader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: appraisal2
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +256,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -246,7 +266,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: stone_checksums
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +276,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -266,7 +286,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: gitmoji-regex
   requirement: !ruby/object:Gem::Requirement
@@ -276,7 +296,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -286,7 +306,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.0.6
 description: "\U0001F372 Kettle::Dev is a meta tool from kettle-dev to streamline
   development and testing. Acts as a shim dependency, pulling in many other dependencies,
   to give you OOTB productivity with a RubyGem, or Ruby app project. Configures a
@@ -307,6 +327,7 @@ executables:
 - kettle-pre-release
 - kettle-readme-backers
 - kettle-release
+- kettle-reset
 extensions: []
 extra_rdoc_files: []
 files:
@@ -325,6 +346,7 @@ files:
 - exe/kettle-pre-release
 - exe/kettle-readme-backers
 - exe/kettle-release
+- exe/kettle-reset
 - lib/kettle-dev.rb
 - lib/kettle/dev.rb
 - lib/kettle/dev/bump_cli.rb
@@ -337,12 +359,13 @@ files:
 - lib/kettle/dev/dvcs_cli.rb
 - lib/kettle/dev/executable_version.rb
 - lib/kettle/dev/exit_adapter.rb
-- lib/kettle/dev/gem_coop_versions.rb
 - lib/kettle/dev/gem_spec_reader.rb
 - lib/kettle/dev/gha_sha_pins_cli.rb
 - lib/kettle/dev/git_adapter.rb
 - lib/kettle/dev/git_commit_footer.rb
 - lib/kettle/dev/input_adapter.rb
+- lib/kettle/dev/interactive_release_command.rb
+- lib/kettle/dev/lockfile_reset.rb
 - lib/kettle/dev/open_collective_config.rb
 - lib/kettle/dev/pre_release_cli.rb
 - lib/kettle/dev/rakelib/appraisal.rake
@@ -356,6 +379,9 @@ files:
 - lib/kettle/dev/rakelib/yard.rake
 - lib/kettle/dev/readme_backers.rb
 - lib/kettle/dev/release_cli.rb
+- lib/kettle/dev/release_secrets.rb
+- lib/kettle/dev/reset_cli.rb
+- lib/kettle/dev/ruby_gems_versions.rb
 - lib/kettle/dev/tasks.rb
 - lib/kettle/dev/tasks/ci_task.rb
 - lib/kettle/dev/version.rb
@@ -369,10 +395,10 @@ licenses:
 - AGPL-3.0-only
 metadata:
   homepage_uri: https://kettle-dev.galtzo.com
-  source_code_uri: https://github.com/kettle-dev/kettle-dev/tree/v2.4.5
-  changelog_uri: https://github.com/kettle-dev/kettle-dev/blob/v2.4.5/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-dev/tree/v2.5.0
+  changelog_uri: https://github.com/kettle-dev/kettle-dev/blob/v2.5.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-dev/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/2.4.5
+  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/2.5.0
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-dev/kettle-dev/wiki
   news_uri: https://www.railsbling.com/tags/kettle-dev