gemkeeper 0.6.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fffab47c1459590a6dd86cd4522ca533a54837516d50d15b377e1e5a1145c7
-  data.tar.gz: e52ee33dae0af8861b747400e284be4e4c847f28d297685490df29dfe0a1af6e
+  metadata.gz: bed56339bf29ed0dd82b9aec9c94a4a466b0d38364b3b3e5280d4d51b1101cf0
+  data.tar.gz: '09132dd1f425d64e0c423386583a29c9010b0f73fe016088428e5a3fe5dbe57c'
 SHA512:
-  metadata.gz: 78143e09b2661e66bbc08cd37c986f0363a4ae2d24d1fc4e81a39c57cd0e4b7281827e2b53631ff6e7762b2491fc2ed02cfacdc4579b6680d9620a63317e3367
-  data.tar.gz: 50dfb941e3611a175c81e3d0b99e33a41db486804f910fbd15a7c618c7d7bc794d7c5986426fde5b08b8467121d72c9134cbf813c3ffa02ee7470d54a9e52bc2
+  metadata.gz: 4e1178a59bda6fd8f299f1e16e68d828ae23b8176785dba7cff5c6c7f7d8776563e564fcadbb0746ea11bc8ce808a00be89de06836cf36dd49ecfbb52f401de4
+  data.tar.gz: 81e4e60ce2f0ced3d809448f4bbbada9a959bbc33215f27808c5eaf4a7987e56f6905259e26c93b1e09b177c503b5422702d7fb940f08855ae2e314c84146670

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.7.0] - 2026-05-28
+
+### Changed
+
+- `gemkeeper setup` and `gemkeeper manifest generate` no longer write `repo:` into generated `gemkeeper.yml` entries.
+  The repo URL is resolved from the manifest by gem name at sync time, making the manifest the single source of truth for name→repo mappings.
+  Re-running `setup` strips `repo:` from matched entries, promoting them to manifest-only.
+- `gemkeeper setup` now accepts only a `Gemfile.lock`, `Gemfile`, or directory as its source.
+  The path that imported an existing `gemkeeper.yml` into the manifest has been removed — it only made sense when configs carried `repo:`; populate the manifest with `gemkeeper manifest generate` or `setup` from a lockfile instead.
+
+### Added
+
+- `repo:` in `gemkeeper.yml` is now optional. When absent, `gemkeeper sync` resolves it from the manifest (`~/.config/gemkeeper/manifest.yml`) by gem name.
+  It remains a supported per-project override (escape hatch) for gems not in the manifest; `sync` warns when an explicit `repo:` diverges from the manifest and uses the `gemkeeper.yml` value.
+
 ## [0.6.7] - 2026-05-28
 
 ### Fixed
@@ -139,7 +154,8 @@
 
 - Initial release
 
-[Unreleased]: https://github.com/danhorst/gemkeeper/compare/v0.6.7...HEAD
+[Unreleased]: https://github.com/danhorst/gemkeeper/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/danhorst/gemkeeper/compare/0.6.7...0.7.0
 [0.6.7]: https://github.com/danhorst/gemkeeper/compare/0.6.6...0.6.7
 [0.6.6]: https://github.com/danhorst/gemkeeper/compare/0.6.5...0.6.6
 [0.6.5]: https://github.com/danhorst/gemkeeper/compare/0.6.4...0.6.5

data/README.md

@@ -70,15 +70,17 @@ Public gems are proxied from RubyGems.org automatically.
 
 ## Quick Start
 
-1. Create a configuration file at `~/.config/gemkeeper/config.yml`:
+1. Ensure your org manifest is present at `~/.config/gemkeeper/manifest.yml` (see [Workstation Setup](#workstation-setup)), then create a project `gemkeeper.yml`:
 
 ```yaml
 port: 9292
 gems:
-  - repo: https://github.com/company/internal-gem
+  - name: internal-gem
     version: latest
 ```
 
+The repo URL for `internal-gem` is resolved from the manifest at sync time.
+
 2. Start the server:
 
 ```bash
@@ -127,18 +129,21 @@ pid_file: ./cache/gemkeeper.pid
 
 # List of gems to manage
 gems:
-  # HTTPS is recommended — works without SSH key setup (alternative: git@github.com:company/gem-one.git)
-  - repo: https://github.com/company/gem-one
+  # Preferred form: name only. The repo URL is resolved from the manifest at sync time.
+  - name: gem-one
     version: latest    # Use the latest commit on main/master; cached by resolved gemspec version
 
-  - repo: https://github.com/company/gem-two
+  - name: gem-two
     version: v1.2.3    # Use a specific tag; both v-prefixed and bare semver accepted
 
-  - repo: https://github.com/company/gem-two
+  - name: gem-two
     version: from_lockfile    # Read version from the nearest Gemfile.lock
 
-  - repo: https://github.com/company/ruby-gem-three
-    name: gem-three    # Override the gem name (strips "ruby-" prefix by default)
+  # repo: is optional — a per-project override for gems not in the manifest (HTTPS recommended,
+  # works without SSH key setup; alternative: git@github.com:company/gem-three.git). When both are
+  # present, repo: wins and sync warns if it diverges from the manifest.
+  - name: gem-three
+    repo: https://github.com/company/ruby-gem-three
 ```
 
 ## CLI Commands
@@ -169,9 +174,6 @@ gemkeeper server status
 # Generate gemkeeper.yml from a Gemfile.lock and org manifest
 gemkeeper setup path/to/Gemfile.lock
 
-# Use an existing gemkeeper.yml as input (updates manifest, optionally installs as global config)
-gemkeeper setup path/to/gemkeeper.yml
-
 # Use a custom manifest path
 gemkeeper setup path/to/Gemfile.lock --manifest ~/.config/myorg/manifest.yml
 
@@ -195,7 +197,8 @@ It sets `repos_path` and `gems_path` as absolute paths under the corresponding `
 ### Manifest Management
 
 The manifest (`~/.config/gemkeeper/manifest.yml`) is the global name→repo lookup table shared across projects.
-`manifest generate` builds or updates it; `setup` reads it.
+`manifest generate` builds or updates it; `setup` reads it, and `sync` resolves each gem's repo URL from it.
+Because `gemkeeper.yml` entries omit `repo:`, the manifest must be present before `sync`; run `gemkeeper manifest validate --resolve` first to confirm every gem maps to a reachable repo.
 
 ```bash
 # Build or update the manifest from a Gemfile.lock

data/lib/gemkeeper/cli/commands/setup.rb

@@ -6,11 +6,10 @@ module Gemkeeper
       class Setup < Dry::CLI::Command
         include CLI::LockfileResolution
 
-        desc "Generate gemkeeper.yml from a Gemfile.lock or existing gemkeeper.yml"
+        desc "Generate gemkeeper.yml from a Gemfile.lock"
 
         argument :source_path, type: :string, required: false,
-                               desc: "Gemfile.lock, Gemfile, directory, or gemkeeper.yml " \
-                                     "(default: nearest Gemfile.lock)"
+                               desc: "Gemfile.lock, Gemfile, or directory (default: nearest Gemfile.lock)"
         option :manifest, type: :string,
                           desc: "Path to gem manifest (default: ~/.config/gemkeeper/manifest.yml)"
         option :config, type: :string, desc: "Path to write gemkeeper.yml (default: ./gemkeeper.yml)"
@@ -25,12 +24,9 @@ module Gemkeeper
           validate_options!(options)
           output_path = resolve_output_path(options)
           resolved = resolve_source_path(source_path)
+          not_a_lockfile!(resolved) unless lockfile?(resolved)
 
-          if lockfile?(resolved)
-            setup_from_lockfile(resolved, output_path, options)
-          else
-            setup_from_config(resolved, output_path, options)
-          end
+          setup_from_lockfile(resolved, output_path, options)
         rescue UnresolvableGemError, ManifestConflictError => error
           warn "Error: #{error.message}"
           exit 1
@@ -61,36 +57,10 @@ module Gemkeeper
           BundlerMirrorConfigurator.new(resolved, port:, global: options[:global]).configure
         end
 
-        def setup_from_config(source_path, output_path, options)
-          source = YAML.safe_load_file(source_path, permitted_classes: [], symbolize_names: false) || {}
-          manifest = load_manifest(options)
-          update_manifest_from_config(source, manifest, options)
-          install_global_config(source, output_path) if options[:global]
-        end
-
-        def update_manifest_from_config(source, manifest, options)
-          (source["gems"] || []).each do |entry|
-            repo = entry["repo"].to_s
-            next if repo.empty?
-
-            name = File.basename(repo, ".git").sub(/^ruby-/, "")
-            manifest.add_mapping(name:, repo:)
-          end
-          manifest.save(manifest_path(options))
-        end
-
-        def install_global_config(source, output_path)
-          existing = File.exist?(output_path) ? (YAML.safe_load_file(output_path) || {}) : {}
-          merged = existing.merge(source.except("gems")).merge("gems" => merge_gem_lists(existing, source))
-          File.write(output_path, merged.to_yaml)
-          puts "Wrote #{output_path}"
-        end
-
-        def merge_gem_lists(existing, source)
-          existing_gems = existing["gems"] || []
-          source_gems = source["gems"] || []
-          existing_repos = existing_gems.to_set { |g| g["repo"] }
-          existing_gems + source_gems.reject { |g| existing_repos.include?(g["repo"]) }
+        def not_a_lockfile!(path)
+          warn "Error: setup builds from a Gemfile.lock, Gemfile, or directory — got #{path}. " \
+               "To populate the manifest, run 'gemkeeper manifest generate'."
+          exit 1
         end
 
         def load_manifest(options)

data/lib/gemkeeper/cli/commands/sync.rb

@@ -12,7 +12,7 @@ module Gemkeeper
         def call(gem_name: nil, **options)
           config = Configuration.load(options[:config])
           gems_to_sync = select_gems(config, gem_name)
-          syncer = GemSyncer.new(config, GemUploader.new(config.geminabox_url))
+          syncer = GemSyncer.new(config, GemUploader.new(config.geminabox_url), manifest: ManifestReader.load)
           counts, failures = run_sync(gems_to_sync, syncer)
           report_results(counts, failures, gems_to_sync.size)
         end

data/lib/gemkeeper/config_generator.rb

@@ -22,7 +22,7 @@ module Gemkeeper
     def matched_gems
       matched = @manifest.gems.filter_map do |gem_entry|
         name = gem_entry[:name]
-        { name:, repo: gem_entry[:repo] } if @lockfile_versions.key?(name)
+        { name: } if @lockfile_versions.key?(name)
       end
       warn_unmatched
       matched
@@ -47,7 +47,7 @@ module Gemkeeper
 
     def build_fresh(matched, global_output_path: nil)
       repos_path, gems_path = data_paths_for(global_output_path)
-      gem_entries = matched.map { |g| { "name" => g[:name], "repo" => g[:repo], "version" => "from_lockfile" } }
+      gem_entries = matched.map { |g| { "name" => g[:name], "version" => "from_lockfile" } }
       { "port" => Configuration::DEFAULT_PORT, "repos_path" => repos_path,
         "gems_path" => gems_path, "gems" => gem_entries }
     end
@@ -62,7 +62,7 @@ module Gemkeeper
     def merge(existing, matched)
       existing_gems = existing["gems"] || []
       new_by_name = matched.to_h do |g|
-        [g[:name], { "name" => g[:name], "repo" => g[:repo], "version" => "from_lockfile" }]
+        [g[:name], { "name" => g[:name], "version" => "from_lockfile" }]
       end
 
       updated = existing_gems.map do |entry|

data/lib/gemkeeper/configuration.rb

@@ -127,9 +127,11 @@ module Gemkeeper
       attr_reader :repo, :version, :name
 
       def initialize(config)
-        @repo = config[:repo] or raise InvalidConfigError, "Gem definition missing 'repo'"
-        @version = config[:version] || "latest"
+        @repo = config[:repo]
         @name = config[:name] || extract_name_from_repo
+        raise InvalidConfigError, "Gem definition needs a 'name' or 'repo'" unless @name
+
+        @version = config[:version] || "latest"
         validate_version!
       end
 
@@ -153,6 +155,8 @@ module Gemkeeper
       end
 
       def extract_name_from_repo
+        return nil unless @repo
+
         File.basename(@repo, ".git").sub(/^ruby-/, "")
       end
     end

data/lib/gemkeeper/gem_syncer.rb

@@ -11,12 +11,14 @@ module Gemkeeper
       /fatal: credential/i
     ].freeze
 
-    def initialize(config, uploader)
+    def initialize(config, uploader, manifest:)
       @config = config
       @uploader = uploader
+      @manifest = manifest
     end
 
     def sync(gem_def)
+      repo_url = resolve_repo(gem_def)
       version = resolve_version(gem_def)
       name = gem_def.name
       gems_path = @config.gems_path
@@ -25,13 +27,13 @@ module Gemkeeper
 
       puts "Syncing #{name} @ #{version}..."
       local_path = File.join(@config.repos_path, name)
-      repo = fetch_repo(gem_def.repo, local_path)
+      repo = fetch_repo(repo_url, local_path)
 
       Output.step("Checking out #{version}...")
       repo.checkout_version(version)
 
       if gem_def.latest?
-        version = latest_version!(repo, name, gems_path, gem_def.repo)
+        version = latest_version!(repo, name, gems_path, repo_url)
         return :skipped unless version
       end
 
@@ -41,6 +43,33 @@ module Gemkeeper
 
     private
 
+    # Explicit repo: in gemkeeper.yml wins, but warns on divergence from the manifest.
+    # Otherwise the repo is resolved from the manifest by gem name.
+    def resolve_repo(gem_def)
+      manifest_repo = @manifest.repo_for(gem_def.name)
+      return manifest_repo || missing_repo!(gem_def.name) unless gem_def.repo
+
+      warn_if_divergent(gem_def.name, gem_def.repo, manifest_repo)
+      gem_def.repo
+    end
+
+    def missing_repo!(name)
+      unless File.exist?(@manifest.path)
+        raise InvalidConfigError,
+              "No manifest found at #{@manifest.path} — run 'gemkeeper manifest generate' to create one"
+      end
+
+      raise InvalidConfigError,
+            "No repo configured for #{name.inspect} — add it to the manifest with 'gemkeeper manifest generate'"
+    end
+
+    def warn_if_divergent(name, config_repo, manifest_repo)
+      return unless manifest_repo && manifest_repo != config_repo
+
+      warn "Warning: repo for #{name} in gemkeeper.yml (#{config_repo}) " \
+           "differs from manifest (#{manifest_repo}) — using gemkeeper.yml"
+    end
+
     def resolve_version(gem_def)
       return gem_def.version unless gem_def.from_lockfile?
 

data/lib/gemkeeper/manifest_reader.rb

@@ -5,7 +5,7 @@ module Gemkeeper
   class ManifestReader
     DEFAULT_PATH = File.expand_path("~/.config/gemkeeper/manifest.yml")
 
-    attr_reader :gems, :source_url
+    attr_reader :gems, :source_url, :path
 
     def self.load(path = DEFAULT_PATH)
       new(path)

data/lib/gemkeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gemkeeper
-  VERSION = "0.6.7"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemkeeper
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.0
 platform: ruby
 authors:
 - Dan Brubaker Horst