gem_kit-release 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbdaca4c93bb73c92daa2e585aa8f6dbcef18a7717a6f9c3549f943272b13947
-  data.tar.gz: 8d41aaa5cd762b8c6660d6cffbb669d1d17ce5a604ea578d1673681eb6c39809
+  metadata.gz: '028c5393e0908e49e47886256eb800f21382125f148bcd378bc6d2214fac27c2'
+  data.tar.gz: 85cd0ed8b03d81d4efcf0c63579b0046e273eb52eb36f9af36ab09fa8c972de8
 SHA512:
-  metadata.gz: e431cf45975cc92e084d02988ed88a68053bf538f386bf734a167a9e0a6914de609a8d22555ba4e238c41ff6ae932bbfa44e5933fd665f19b0c4468336d60e8b
-  data.tar.gz: 852b384995fbbd1ee34b28200cdcd472eddb6c3460e99101b70df56da4435b45be91fc6805959f21eb942bfc7287f883000e70e1566f684e518102727a29f1d1
+  metadata.gz: d5d1107714f5da3a524c06a40eac52b782c71d92a0ca90972c43c5e46c9bfd53bc6bd3cc6490bd3af43ed394eec825787ab30031b05bec192dcaa967b679bdd1
+  data.tar.gz: a890866fbb74226735ed5852d2b8fab0accf513cbe529b5ff505fbde0e0f7657f5d30e500088cbd602378fbf266c6f2277dbac8f7cb80c1cf4ce669fc39dba88

data/lib/gem_kit/release/cli.rb

@@ -38,6 +38,23 @@ module GemKit
     # Each command here is a thin front for a plain object under CLI::; the
     # work itself is in Gate, VersionFile, Changelog and Deprecate.
     class CLI < Thor
+      # The order the commands go in — printed above the command listing so
+      # nobody has to guess when to commit or when to write the changelog. The
+      # question the process is easy to get wrong on is exactly the one this
+      # answers: the changelog is written *after* the bump, then the two are
+      # committed together, and only then does release run.
+      WORKFLOW = <<~TXT
+        Release, in order:
+
+          1. bin/test                        # green suite
+          2. gem kit bump [SEGMENT]          # move the version, relock the Gemfile
+          3. gem kit changelog --write       # AI CLI drafts this version's entry
+          4. gem kit changelog [VERSION]     # lint the entry, confirm ready to release
+          5. git commit -am "Release ..."    # bump + lockfile + entry, one commit
+          6. gem kit release                 # gate, build, push, tag (also pushes the tag)
+          7. git push                        # publish the release commit
+      TXT
+
       class_option :gem, type: :string,
                          desc: "Which gem, in a repository holding more than one gemspec"
 
@@ -49,6 +66,15 @@ module GemKit
         "gem kit #{command.usage}"
       end
 
+      # Prepend the workflow to the top-level `gem kit` help. `gem kit help
+      # <command>` sets subcommand=true and lands here too; that page already
+      # has its own long_desc, so leave it alone.
+      def self.help(shell, subcommand = false)
+        shell.say(WORKFLOW) unless subcommand
+        shell.say unless subcommand
+        super
+      end
+
       # Short forms for the three typed most often.
       map "log"  => :changelog,
           "deps" => :deprecations,
@@ -210,6 +236,33 @@ describe "gem_kit/release/cli" do
     end
   end
 
+  # The order between `bump` and `release` — when to write the changelog and
+  # when to commit — is exactly the question the numbered list answers, so
+  # the top-level help has to print it.
+  it "prints the numbered workflow above the command listing" do
+    with_gem do |dir|
+      _status, out, _err = invoke([], dir)
+
+      out.should.match(/Release, in order:/)
+      out.should.match(/1\. bin\/test/)
+      out.should.match(/2\. gem kit bump/)
+      out.should.match(/5\. git commit/)
+      out.should.match(/6\. gem kit release/)
+      out.should.match(/7\. git push/)
+      # The workflow lands above "Commands:", not swallowed by it.
+      out.index("Release, in order:").should < out.index("Commands:")
+    end
+  end
+
+  # `gem kit help <command>` already has its own long_desc; the workflow
+  # belongs on the top-level page only.
+  it "does not repeat the workflow on a per-command help page" do
+    with_gem do |dir|
+      _status, out, _err = invoke(["help", "bump"], dir)
+      out.should.not.match(/Release, in order:/)
+    end
+  end
+
   it "names the commands `gem kit <command>`, not the running program" do
     with_gem do |dir|
       _status, out, _err = invoke([], dir)

data/lib/gem_kit/release/gate.rb

@@ -98,6 +98,9 @@ __END__
 
 describe "gem_kit/release/gate" do
   require "tmpdir"
+  # These specs ask the gate whether a temp directory is a repository, so the
+  # walk up out of Dir.tmpdir has to be stopped or the answer is the machine's.
+  require_relative "../../../spec/support/git_isolation"
 
   # A Project stub: the Gate only asks it for a changelog path and a version,
   # and to load the library (a no-op here — the specs drive the registry).

data/lib/gem_kit/release/project.rb

@@ -129,7 +129,10 @@ module GemKit
       # lib/gem_kit/release/version.rb for "gem_kit-release", lib/brute/version.rb
       # for "brute" — the convention every `bundle gem` project follows.
       def version_file
-        File.expand_path(config.version_file || File.join("lib", *name.split("-"), "version.rb"), root)
+        File.expand_path(
+          config.version_file || File.join("lib", *library_segments, "version.rb"),
+          root,
+        )
       end
 
       # An ERB template beside the version file, if the project generates it.
@@ -141,7 +144,35 @@ module GemKit
       # What to require so that deprecation declarations register themselves.
       # "gem_kit-release" -> "gem_kit/release".
       def require_path
-        config.require_path || name.tr("-", "/")
+        config.require_path || library_segments.join("/")
+      end
+
+      # Where the library sits under lib/, as path segments.
+      #
+      # `bundle gem gem_kit-release` NESTS, treating the hyphen as a directory
+      # separator: lib/gem_kit/release.rb, module GemKit::Release. That is the
+      # common case and the one assumed here first.
+      #
+      # But a hyphenated name whose library is a SINGLE module does not nest.
+      # `ag-ui` is lib/ag_ui.rb holding `module AgUi` — hyphen as underscore —
+      # and the nested form names lib/ag/ui.rb, a file that was never there.
+      #
+      # A third belongs to bindings. `oo7-rb` and `sqlite3-ruby` are a library
+      # name wearing a suffix that says which language binds it, and the library
+      # underneath drops it: lib/oo7.rb holding `module Oo7`, with
+      # lib/oo7/version.rb beside it. Often the suffix is only there because
+      # RubyGems would not give up the bare name. The nested form names
+      # lib/oo7/rb.rb and the flat one lib/oo7_rb.rb, neither of which was ever
+      # there, so without this a binding gem cannot be bumped at all.
+      #
+      # All three are conventional and the name alone cannot tell them apart, so
+      # ask the tree: whichever exists is what this project is.
+      #
+      # When none exists the nested form wins, because that is what
+      # `bundle gem` would have produced and a project with no library yet is
+      # about to become one.
+      def library_segments
+        layouts.find { |segments| exists_under_lib?(segments) } || nested_layout
       end
 
       # Load the library, so Deprecate's registry reflects this project.
@@ -158,6 +189,40 @@ module GemKit
       def test_command = config.test_command || "bin/test"
 
       def changelog_writer = config.changelog_writer || "claude"
+
+      private
+
+        # The suffixes a binding gem wears, which its library drops.
+        BINDING_SUFFIXES = %w[rb ruby].freeze
+
+        # What a hyphenated name could mean, most conventional first. A name with
+        # no hyphen in it has exactly one meaning and the list says so.
+        def layouts
+          [nested_layout, flat_layout, *binding_layout].uniq
+        end
+
+        def nested_layout = name.split("-")
+
+        def flat_layout = [name.tr("-", "_")]
+
+        # [["oo7"]] for "oo7-rb"; nothing for a name wearing no binding suffix,
+        # and nothing for one that is only the suffix.
+        def binding_layout
+          nested_layout.then do |segments|
+            if segments.length > 1 && BINDING_SUFFIXES.include?(segments.last)
+              [segments[0..-2]]
+            else
+              []
+            end
+          end
+        end
+
+        # A layout is present if the entry file is there, or the directory it
+        # would hold — a gem is free to ship lib/foo/ without lib/foo.rb.
+        def exists_under_lib?(segments)
+          base = File.join(root, "lib", *segments)
+          File.exist?("#{base}.rb") || File.directory?(base)
+        end
     end
   end
 end
@@ -167,16 +232,29 @@ __END__
 describe "gem_kit/release/project" do
   require "tmpdir"
 
-  # A throwaway gem laid out the conventional way.
-  with_project = lambda do |name: "demo", version: "1.2.3", &block|
+  # A throwaway gem. `layout:` picks between the three conventions a hyphenated
+  # name can follow: :nested is `bundle gem`'s lib/gem_kit/release, :flat is a
+  # single-module gem's lib/ag_ui, and :binding is a bindings gem's lib/oo7 for
+  # a gem called oo7-rb.
+  with_project = lambda do |name: "demo", version: "1.2.3", layout: :nested, &block|
     Dir.mktmpdir do |dir|
-      path = name.split("-")
+      case layout
+      when :flat then path = [name.tr("-", "_")]
+      when :binding then path = name.split("-")[0..-2]
+      else path = name.split("-")
+      end
       FileUtils.mkdir_p(File.join(dir, "lib", *path))
-      File.write(File.join(dir, "lib", *path, "version.rb"), <<~RUBY)
-        module #{path.map { |p| p.split("_").map(&:capitalize).join }.join("::")}
-          VERSION = "#{version}"
-        end
-      RUBY
+
+      # Nested blocks rather than `module A::B`, which is only valid once A
+      # exists -- and a throwaway gem's outermost constant never does. The one
+      # hyphenated name that got away with it was gem_kit-release, because this
+      # process has GemKit defined already.
+      constants = path.map { |segment| segment.split("_").map(&:capitalize).join }
+      lines = constants.each_with_index.map { |constant, depth| "#{"  " * depth}module #{constant}" }
+      lines << "#{"  " * constants.length}VERSION = #{version.inspect}"
+      lines.concat(Array.new(constants.length) { |depth| "#{"  " * (constants.length - 1 - depth)}end" })
+
+      File.write(File.join(dir, "lib", *path, "version.rb"), "#{lines.join("\n")}\n")
       File.write(File.join(dir, "#{name}.gemspec"), <<~RUBY)
         require_relative "lib/#{path.join("/")}/version"
         Gem::Specification.new do |spec|
@@ -218,6 +296,86 @@ describe "gem_kit/release/project" do
     end
   end
 
+  # A hyphenated name whose library is one module: lib/ag_ui.rb, not
+  # lib/ag/ui.rb. Deriving the path from the name alone named a file that was
+  # never there, so `gem kit bump` could not find the version and deprecations
+  # went undetected.
+  it "reads an underscored single-module layout off the tree" do
+    with_project.call(name: "ag-ui", layout: :flat) do |dir|
+      project = GemKit::Release::Project.detect(dir)
+      project.require_path.should == "ag_ui"
+      project.version_file.should == File.join(dir, "lib/ag_ui/version.rb")
+    end
+  end
+
+  # A bindings gem drops the suffix: oo7-rb is lib/oo7.rb and lib/oo7/version.rb,
+  # which neither of the other two layouts names. Found the hard way -- the gem
+  # was called oo7-rb only because RubyGems holds `oo7` for something else, and
+  # `gem kit bump` then wrote to lib/oo7/rb/version.rb, a path nothing had.
+  it "reads a bindings layout, whose library drops the suffix, off the tree" do
+    with_project.call(name: "oo7-rb", layout: :binding) do |dir|
+      project = GemKit::Release::Project.detect(dir)
+      project.require_path.should == "oo7"
+      project.version_file.should == File.join(dir, "lib/oo7/version.rb")
+    end
+  end
+
+  it "reads a -ruby suffix the same way" do
+    with_project.call(name: "sqlite3-ruby", layout: :binding) do |dir|
+      project = GemKit::Release::Project.detect(dir)
+      project.version_file.should == File.join(dir, "lib/sqlite3/version.rb")
+    end
+  end
+
+  # The suffix is only dropped when the tree says so. A gem that genuinely nests
+  # under a segment called "rb" keeps it.
+  it "keeps a nested layout that really does end in rb" do
+    with_project.call(name: "thing-rb", layout: :nested) do |dir|
+      project = GemKit::Release::Project.detect(dir)
+      project.require_path.should == "thing/rb"
+      project.version_file.should == File.join(dir, "lib/thing/rb/version.rb")
+    end
+  end
+
+  # "release" is not a binding suffix, so a name ending in something else is
+  # untouched by any of this.
+  it "leaves a hyphenated name that wears no binding suffix alone" do
+    with_project.call(name: "gem_kit-release", layout: :nested) do |dir|
+      project = GemKit::Release::Project.detect(dir)
+      project.require_path.should == "gem_kit/release"
+    end
+  end
+
+  # Nesting stays the default: it is what `bundle gem` produces, so it is what
+  # a project with no library yet is about to become.
+  it "falls back to the nested layout when neither is on disk" do
+    Dir.mktmpdir do |dir|
+      File.write(File.join(dir, "ag-ui.gemspec"), <<~RUBY)
+        Gem::Specification.new do |spec|
+          spec.name = "ag-ui"
+          spec.version = "0.1.0"
+          spec.authors = ["x"]
+          spec.summary = "x"
+          spec.files = []
+        end
+      RUBY
+      GemKit::Release::Project.detect(dir).require_path.should == "ag/ui"
+    end
+  end
+
+  # An explicit setting still wins over anything read off the tree.
+  it "prefers a configured require path and version file" do
+    with_project.call(name: "ag-ui", layout: :flat) do |dir|
+      config = GemKit::Release::Project::Config.new(
+        require_path: "somewhere/else",
+        version_file: "lib/custom.rb",
+      )
+      project = GemKit::Release::Project.detect(dir, config: config)
+      project.require_path.should == "somewhere/else"
+      project.version_file.should == File.join(dir, "lib/custom.rb")
+    end
+  end
+
   it "defaults the changelog to CHANGELOG.md in the project root" do
     with_project.call do |dir|
       project = GemKit::Release::Project.detect(dir)

data/lib/gem_kit/release/version.rb

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

metadata

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