gem_kit-release 0.1.0 → 0.2.0

data/lib/gem_kit/release/templates/RELEASE.md.erb

@@ -3,13 +3,13 @@
 The whole process, in order:
 
 ```sh
-<%= test.ljust(30) %># 1. green suite
-gem kit bump minor            # 2. bump  (prints: now run gem kit changelog --write)
-gem kit changelog --write     # 3. write the entry
-gem kit changelog <VERSION>   # 4. check it
-git commit -am "Release ..."  # 5. commit the bump + changelog
-gem kit release               # 6. build and push
-gem kit tag --push            # 7. tag it
+<%= step(test)                             %># 1. green suite
+<%= step("gem kit bump#{gem_flag} minor")  %># 2. bump  (prints what to run next)
+<%= step("gem kit changelog#{gem_flag} --write") %># 3. write the entry
+<%= step("gem kit changelog#{gem_flag} <VERSION>") %># 4. check it
+<%= step(%(git commit -am "Release ..."))  %># 5. commit the bump + changelog
+<%= step("gem kit release#{gem_flag}")     %># 6. build and push
+<%= step("gem kit tag#{gem_flag} --push")  %># 7. tag it
 ```
 
 Steps 2 and 6 are gates: they refuse to proceed when something is missing.
@@ -18,7 +18,7 @@ Everything below is what they check and why.
 ## Versioning
 
 <%= name %> is [semver](https://semver.org/). The version lives in one place —
-`<%= version_file %>` — and is only ever changed by `gem kit bump`.
+`<%= version_file %>` — and is only ever changed by `gem kit bump<%= gem_flag %>`.
 
 | Segment | When | What it may contain |
 | --- | --- | --- |
@@ -29,7 +29,7 @@ Everything below is what they check and why.
 Two rules follow from this, and both are enforced in code:
 
 - **Removals only ever land in a major version.** A name promised to disappear
-  in <%= next_major %> disappears in <%= next_major %>.0.0, not in a patch.
+  in <%= next_major %> disappears in <%= next_major %>.0, not in a patch.
 - **Deprecating is a minor.** Adding a deprecation puts no obligation on the
   user *yet*, so it does not need a major — but it starts the clock. See
   [DEPRECATIONS.md](DEPRECATIONS.md).
@@ -45,7 +45,7 @@ A red suite is not a release candidate; nothing downstream checks this for you.
 ## 2. Bump
 
 ```sh
-gem kit bump <major|minor|patch>
+gem kit bump<%= gem_flag %> <major|minor|patch>
 ```
 
 Rewrites `<%= version_file %>` — by rendering its `.erb` template if there is
@@ -55,7 +55,7 @@ transition:
 ```
 <%= version %> -> ...
 
-now run: gem kit changelog --write
+now run: gem kit changelog<%= gem_flag %> --write
 ```
 
 **It refuses to bump onto a deprecation deadline.** If any registered
@@ -67,7 +67,7 @@ reported for information, not blocked on.
 ## 3. Changelog
 
 ```sh
-gem kit changelog --write
+gem kit changelog<%= gem_flag %> --write
 ```
 
 Hands the entry to the AI CLI named by `config.changelog_writer` (default:
@@ -100,8 +100,8 @@ of anything that shipped.
 ## 4. Lint the changelog
 
 ```sh
-gem kit changelog              # format only
-gem kit changelog <%= version %>       # format, plus "is this version ready?"
+gem kit changelog<%= gem_flag %>              # format only
+gem kit changelog<%= gem_flag %> <%= version %>       # format, plus "is this version ready?"
 ```
 
 Checks the title, that every heading is `## [Unreleased]` or
@@ -119,7 +119,7 @@ unwritten in git is the failure this process exists to prevent.
 ## 6. Release
 
 ```sh
-gem kit release           # or: gem kit release --dry-run, which is the CI check
+gem kit release<%= gem_flag %>           # or: gem kit release<%= gem_flag %> --dry-run, which is the CI check
 ```
 
 Two gates, both before `gem build` runs:
@@ -134,11 +134,11 @@ Then `gem build` and `gem push`. Requires RubyGems push credentials.
 ## 7. Tag
 
 ```sh
-gem kit tag --push
+gem kit tag<%= gem_flag %> --push
 ```
 
-Creates `v<%= version %>`, refusing if it already exists. The tag is also what
-the next `gem kit changelog --write` uses to find the commit range, so a missing
+Creates `<%= tag_prefix %><%= version %>`, refusing if it already exists. The tag is also what
+the next `gem kit changelog<%= gem_flag %> --write` uses to find the commit range, so a missing
 one makes the following release's changelog harder to write.
 
 ## When something goes wrong
@@ -148,10 +148,10 @@ it is genuinely dangerous, otherwise ship a patch. Yanking a version other
 people have already locked to breaks their builds.
 
 **Bumped but the release failed.** The bump is just a file. Fix the cause and
-re-run `gem kit release`; there is no need to un-bump.
+re-run `gem kit release<%= gem_flag %>`; there is no need to un-bump.
 
 **Changelog written for the wrong version.** Edit the heading and re-run
-`gem kit changelog <version>`. Nothing downstream caches it.
+`gem kit changelog<%= gem_flag %> <version>`. Nothing downstream caches it.
 
 ## See also
 

data/lib/gem_kit/release/version.rb

@@ -2,6 +2,6 @@
 
 module GemKit
   module Release
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/gem_kit/release.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../gem_kit"
 require_relative "release/version"
-require_relative "release/deprecate"
 require_relative "release/changelog"
 require_relative "release/project"
 require_relative "release/version_file"
@@ -38,13 +38,14 @@ module GemKit
       config
     end
 
-    # The project the tooling is running in.
-    def self.project(dir = Dir.pwd)
-      Project.detect(dir)
+    # The project the tooling is running in. `name` picks one out of a
+    # repository holding several gemspecs — this one, for instance.
+    def self.project(dir = Dir.pwd, name: nil)
+      Project.detect(dir, name: name)
     end
 
-    def self.gate(dir = Dir.pwd)
-      Gate.new(project(dir))
+    def self.gate(dir = Dir.pwd, name: nil)
+      Gate.new(project(dir, name: name))
     end
 
     # Reset configuration — for tests.
@@ -68,10 +69,21 @@ describe "gem_kit/release" do
     GemKit::Release.config.changelog.should.be.nil
   end
 
-  it "detects itself as a project" do
-    project = GemKit::Release.project(File.expand_path("../..", __dir__))
-    project.name.should == "gem_kit-release"
-    project.version.should == Gem::Version.new(GemKit::Release::VERSION)
-    project.require_path.should == "gem_kit/release"
+  it "detects a named gem out of this repository" do
+    root = File.expand_path("../..", __dir__)
+
+    release = GemKit::Release.project(root, name: "gem_kit-release")
+    release.name.should == "gem_kit-release"
+    release.version.should == Gem::Version.new(GemKit::Release::VERSION)
+    release.require_path.should == "gem_kit/release"
+
+    runtime = GemKit::Release.project(root, name: "gem_kit")
+    runtime.name.should == "gem_kit"
+    runtime.require_path.should == "gem_kit"
+  end
+
+  it "refuses to guess which gem in this repository is meant" do
+    lambda { GemKit::Release.project(File.expand_path("../..", __dir__)) }
+      .should.raise(GemKit::Release::Project::Ambiguous)
   end
 end

data/lib/rubygems/commands/kit_command.rb

@@ -60,7 +60,7 @@ module Gem
         # is installed, which keeps the command testable from the repo.
         require_relative "../../gem_kit/release/cli"
 
-        terminate_interaction(GemKit::Release::CLI.run(@argv || []))
+        terminate_interaction(GemKit::Release.run(@argv || []))
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_kit-release
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Kidd
@@ -10,38 +10,69 @@ cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-cli
+  name: gem_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 'A deprecation is a dated promise: it names its replacement and the version
-  the old name stops existing in. gem_kit-release makes that promise machine-checkable,
-  and refuses to release a version that breaks one or ships without a changelog entry.'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |
+  The maintainer's half of gem_kit: one RubyGems command, `gem kit`, with
+  subcommands for bumping the version, writing and linting the changelog,
+  listing outstanding deprecations, releasing and tagging.
+
+  It keeps the promises gem_kit records. `gem kit bump` refuses to move onto
+  a deprecation's removal version while the old name is still in the tree,
+  and `gem kit release` refuses to ship a version with an unkept promise or
+  no changelog entry of its own.
+
+  Everything is read from the .gemspec in the working directory, so the
+  normal case needs no configuration at all.
+email: nathanblenheimkidd@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/gem_kit/release.rb
 - lib/gem_kit/release/changelog.rb
 - lib/gem_kit/release/cli.rb
-- lib/gem_kit/release/cli/bump.rb
-- lib/gem_kit/release/cli/changelog.rb
-- lib/gem_kit/release/cli/command.rb
-- lib/gem_kit/release/cli/deprecations.rb
-- lib/gem_kit/release/cli/release.rb
-- lib/gem_kit/release/cli/setup.rb
-- lib/gem_kit/release/cli/tag.rb
-- lib/gem_kit/release/deprecate.rb
+- lib/gem_kit/release/commands/bump.rb
+- lib/gem_kit/release/commands/changelog.rb
+- lib/gem_kit/release/commands/command.rb
+- lib/gem_kit/release/commands/deprecations.rb
+- lib/gem_kit/release/commands/release.rb
+- lib/gem_kit/release/commands/tag.rb
 - lib/gem_kit/release/gate.rb
+- lib/gem_kit/release/generators/setup.rb
 - lib/gem_kit/release/project.rb
 - lib/gem_kit/release/templates/DEPRECATIONS.md.erb
 - lib/gem_kit/release/templates/RELEASE.md.erb
@@ -49,13 +80,13 @@ files:
 - lib/gem_kit/release/version_file.rb
 - lib/rubygems/commands/kit_command.rb
 - lib/rubygems_plugin.rb
-homepage: https://github.com/n-at-han-k/gem_kit-release
+homepage: https://github.com/n-at-han-k/gem_kit
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/n-at-han-k/gem_kit-release
-  changelog_uri: https://github.com/n-at-han-k/gem_kit-release/blob/main/CHANGELOG.md
-  bug_tracker_uri: https://github.com/n-at-han-k/gem_kit-release/issues
+  source_code_uri: https://github.com/n-at-han-k/gem_kit
+  changelog_uri: https://github.com/n-at-han-k/gem_kit/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/n-at-han-k/gem_kit/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/lib/gem_kit/release/cli/setup.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-require_relative "command"
-
-module GemKit
-  module Release
-    module CLI
-      # Copies the two documents that describe this toolchain into the project,
-      # rendered for its name and version.
-      #
-      # They are copies rather than links because a policy nobody can read in
-      # their own repo is a policy nobody follows, and because the examples are
-      # worth more when they use the project's real version numbers.
-      class Setup < Command
-        TEMPLATES = File.expand_path("../templates", __dir__)
-
-        DOCUMENTS = %w[DEPRECATIONS.md RELEASE.md].freeze
-
-        desc "Copy DEPRECATIONS.md and RELEASE.md into this project"
-
-        option :force, type: :boolean, default: false, desc: "Overwrite documents that already exist"
-
-        example [
-          "                   # write the documents that are missing",
-          "--force            # refresh them all, e.g. after a major version",
-        ]
-
-        def call(**options)
-          written, skipped = [], []
-
-          DOCUMENTS.each do |document|
-            destination = File.join(project.root, document)
-
-            if File.exist?(destination) && !options[:force]
-              skipped << document
-              next
-            end
-
-            File.write(destination, render_document(document))
-            written << document
-          end
-
-          written.each { |document| say("Wrote #{document}") }
-
-          unless skipped.empty?
-            say("Left alone (already present): #{skipped.join(", ")}")
-            say("Pass --force to overwrite.")
-          end
-
-          say("Link them from your README and AGENTS.md so they are found.") unless written.empty?
-        end
-
-        private
-
-          # Values the templates may use. Kept small and obvious — a template
-          # needing more than this is documenting the tool, not the project.
-          def render_document(document)
-            name         = project.name
-            version      = project.version.to_s
-            next_major   = project.next_major_version
-            changelog    = File.basename(project.changelog_path)
-            version_file = relative(project.version_file)
-            test         = project.test_command
-            today        = Time.now.strftime("%Y-%m-%d")
-
-            template = File.read(File.join(TEMPLATES, "#{document}.erb"))
-            ERB.new(template, trim_mode: "-").result(binding)
-          end
-      end
-    end
-  end
-end
-
-__END__
-
-describe "gem_kit/release/cli/setup" do
-  require_relative "../../../../spec/support/gem_kit_release_spec"
-  extend GemKitReleaseSpec
-
-  it "writes both documents into the project root" do
-    with_gem do |dir|
-      status, out, _err = invoke(["setup"], dir)
-
-      status.should == 0
-      out.should.match(/Wrote DEPRECATIONS\.md/)
-      out.should.match(/Wrote RELEASE\.md/)
-      File.exist?(File.join(dir, "DEPRECATIONS.md")).should.be.true
-      File.exist?(File.join(dir, "RELEASE.md")).should.be.true
-    end
-  end
-
-  it "renders them for this project's name and versions" do
-    with_gem(version: "4.1.0") do |dir|
-      invoke(["setup"], dir)
-
-      deprecations = File.read(File.join(dir, "DEPRECATIONS.md"))
-      deprecations.should.match(/A deprecation in demo is a \*\*dated promise\*\*/)
-      deprecations.should.match(/4\.1\.0, so the usual deadline is 5/)
-      deprecations.should.not.match(/<%=/)
-
-      release = File.read(File.join(dir, "RELEASE.md"))
-      release.should.match(/demo/)
-      release.should.not.match(/<%=/)
-    end
-  end
-
-  it "leaves existing documents alone and says so" do
-    with_gem do |dir|
-      File.write(File.join(dir, "RELEASE.md"), "mine\n")
-
-      status, out, _err = invoke(["setup"], dir)
-
-      status.should == 0
-      out.should.match(/Left alone \(already present\): RELEASE\.md/)
-      File.read(File.join(dir, "RELEASE.md")).should == "mine\n"
-    end
-  end
-
-  it "--force overwrites them" do
-    with_gem do |dir|
-      File.write(File.join(dir, "RELEASE.md"), "mine\n")
-
-      invoke(["setup", "--force"], dir).first.should == 0
-      File.read(File.join(dir, "RELEASE.md")).should.not == "mine\n"
-    end
-  end
-
-  it "is reachable by its alias" do
-    with_gem do |dir|
-      invoke(["init"], dir).first.should == 0
-      File.exist?(File.join(dir, "RELEASE.md")).should.be.true
-    end
-  end
-end