gem_kit-release 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c85c52c48c2f4ef893784a7e3f5cd6f1dd35fbf6e74e46de4eef4bc7c205821
-  data.tar.gz: 994048430d10430d4d3f47ca3a57a214200459a75205685adc921cc63e6d58cf
+  metadata.gz: dbdaca4c93bb73c92daa2e585aa8f6dbcef18a7717a6f9c3549f943272b13947
+  data.tar.gz: 8d41aaa5cd762b8c6660d6cffbb669d1d17ce5a604ea578d1673681eb6c39809
 SHA512:
-  metadata.gz: 58349a775e00a64b0e023f6cd53016527bcc3ed440c9143ef53321da8dd03a8e5b2009ad90cf8d8d84827e7158f639943a544cf15446095c59b0407bc00dabe6
-  data.tar.gz: 5014510b87f87df7047b62f288182586fae3278133fd92d1f50a24f93b6294ed986e92a67c3fb3da15c9bb86c47b8d1ef6231b886edcd4d422df7885aba7cdc6
+  metadata.gz: e431cf45975cc92e084d02988ed88a68053bf538f386bf734a167a9e0a6914de609a8d22555ba4e238c41ff6ae932bbfa44e5933fd665f19b0c4468336d60e8b
+  data.tar.gz: 852b384995fbbd1ee34b28200cdcd472eddb6c3460e99101b70df56da4435b45be91fc6805959f21eb942bfc7287f883000e70e1566f684e518102727a29f1d1

data/lib/gem_kit/release/commands/bump.rb

@@ -35,6 +35,8 @@ module GemKit
           version_file.write(target)
           say("#{current} -> #{target}")
 
+          relock(target)
+
           upcoming = gate.upcoming_deprecations(target)
           unless upcoming.empty?
             say("#{upcoming.size} deprecation(s) still outstanding (none due in #{target}).")
@@ -45,6 +47,35 @@ module GemKit
           say
           say("#{RED}now run: gem kit changelog --write#{RESET}")
         end
+
+        private
+
+          # A Gemfile that says `gemspec` or `path: "."` records this gem's own
+          # version in Gemfile.lock, so a bump that only rewrites the version
+          # file leaves the two disagreeing — and bundler refuses outright
+          # under frozen mode, which is what bundlerEnv sets. Relock, so the
+          # bump is one coherent change rather than a trap for the next
+          # command anyone runs.
+          #
+          # `bundle lock` rather than `bundle install`: nothing needs
+          # installing, only the lockfile needs to agree.
+          def relock(target)
+            return unless project.self_locked?
+
+            say("Relocking #{File.basename(project.lockfile_path)}…")
+
+            ok = Dir.chdir(project.root) do
+              # BUNDLE_FROZEN is exactly what stops this, and inheriting it
+              # from an ambient devshell would defeat the point.
+              system({"BUNDLE_FROZEN" => "false", "BUNDLE_GEMFILE" => nil},
+                     "bundle", "lock", out: File::NULL, err: File::NULL)
+            end
+
+            return if ok
+
+            say("#{RED}could not relock — run `bundle lock` before committing " \
+                "#{target}#{RESET}")
+          end
       end
     end
   end
@@ -95,6 +126,44 @@ describe "gem_kit/release/commands/bump" do
     end
   end
 
+  # The version lives in two files when a gem is in its own bundle, and a bump
+  # that moves one of them leaves bundler refusing to do anything.
+  it "relocks a lockfile that records this gem's own version" do
+    with_gem do |dir|
+      File.write(File.join(dir, "Gemfile"), %(source "https://rubygems.org"\ngemspec\n))
+      File.write(File.join(dir, "Gemfile.lock"), <<~LOCK)
+        PATH
+          remote: .
+          specs:
+            demo (1.2.3)
+
+        GEM
+          remote: https://rubygems.org/
+
+        PLATFORMS
+          ruby
+
+        DEPENDENCIES
+          demo!
+
+        BUNDLED WITH
+           2.7.2
+      LOCK
+
+      _status, out, _err = invoke(["bump", "minor"], dir)
+
+      out.should.match(/Relocking Gemfile\.lock/)
+      File.read(File.join(dir, "Gemfile.lock")).should.match(/demo \(1\.3\.0\)/)
+    end
+  end
+
+  it "says nothing about a lockfile that does not record this gem" do
+    with_gem do |dir|
+      _status, out, _err = invoke(["bump", "minor"], dir)
+      out.should.not.match(/Relocking/)
+    end
+  end
+
   it "mentions deprecations outstanding but not yet due" do
     with_gem do |dir|
       _status, out, _err = invoke(["bump", "minor"], dir, deprecations: [["Old", "New", "9.0"]])

data/lib/gem_kit/release/project.rb

@@ -105,6 +105,21 @@ module GemKit
         multi_gem? ? "CHANGELOG-#{name}.md" : "CHANGELOG.md"
       end
 
+      def lockfile_path
+        File.join(root, "Gemfile.lock")
+      end
+
+      # A Gemfile that says `gemspec` or `path: "."` puts this gem in its own
+      # bundle, and the lockfile then records this gem's version. Bumping
+      # without relocking leaves the two disagreeing — which bundler reports as
+      # "the gemspecs for path gems changed", and refuses outright under
+      # frozen mode, as bundlerEnv sets.
+      def self_locked?
+        return false unless File.exist?(lockfile_path)
+
+        File.read(lockfile_path).match?(/^\s{4}#{Regexp.escape(name)} \(\d/)
+      end
+
       # `v1.2.3` says which version but not which gem, which is fine until a
       # repository holds two of them at the same version.
       def tag_prefix
@@ -252,6 +267,38 @@ describe "gem_kit/release/project" do
     end
   end
 
+  # A gem whose own Gemfile pulls it in has its version written in the lockfile
+  # as well as the version file, and both have to move together.
+  it "knows whether the lockfile records this gem's own version" do
+    with_project.call do |dir|
+      GemKit::Release::Project.detect(dir).self_locked?.should.be.false
+
+      File.write(File.join(dir, "Gemfile.lock"), <<~LOCK)
+        PATH
+          remote: .
+          specs:
+            demo (1.2.3)
+
+        GEM
+          remote: https://rubygems.org/
+      LOCK
+      GemKit::Release::Project.detect(dir).self_locked?.should.be.true
+    end
+  end
+
+  it "does not mistake another gem's line in the lockfile for its own" do
+    with_project.call do |dir|
+      File.write(File.join(dir, "Gemfile.lock"), <<~LOCK)
+        GEM
+          remote: https://rubygems.org/
+          specs:
+            other-demo (1.0.0)
+            demo-helper (2.0.0)
+      LOCK
+      GemKit::Release::Project.detect(dir).self_locked?.should.be.false
+    end
+  end
+
   it "finds an ERB version template when the project generates its version file" do
     with_project.call do |dir|
       GemKit::Release::Project.detect(dir).version_template.should.be.nil

data/lib/gem_kit/release/version.rb

@@ -2,6 +2,6 @@
 
 module GemKit
   module Release
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_kit-release
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nathan Kidd