gem_kit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34f2ba71222409206c90f3399be50f301388c0c0afdfff07558337696d246d08
-  data.tar.gz: bd16ae352402059e8852e1bcc5504e61b1961cbba172445837ba8e2a2c46bd31
+  metadata.gz: 4f7e45b6e07e8d99724e3bff85fdbc2d810a0fed2d4df6b31479f8df07741256
+  data.tar.gz: 96592d7cc445bc734f2c7645605360ee658e578916a5e3b957fb6984b528f5ab
 SHA512:
-  metadata.gz: e6bc7f8f8824e3e51f3b0e56df2d0832f698712c5b841e61f68803df7b30d920e29163fea4a5fe1aa78432e1a01b7b53ee54d92d48c37193af6d09678356d211
-  data.tar.gz: 2bc3b1f4b7f04f02d1fe6aa243ac18073b6d1db380d7e42a6999bf17c44e2f1638fb60fe3948dadd445e5163b3c47d7b24d472563d5ad7a0517886e911b9261c
+  metadata.gz: 15fea17b107de0fdb5c22e9c30c594689cb88b2fd91b0e47f1987694e82f5aa9725c168a113e0f020061c2cccddd81e83bc5d785d85fb90ea6e41e8df9525ce2
+  data.tar.gz: 491a1a5290db36b81ef45d51090ae0f8707c517283c72a268887e3b573344d5bce52ea3abc6b902d73341c0acca7237437586631b088cb84e10dd980d0d58f5a

data/README.md

@@ -1,50 +1,191 @@
 # gem_kit
 
-TODO: Write a description.
+Two gems, split along the line that matters: **what a library needs while it is
+running**, and **what its maintainer needs while releasing it**.
 
-## Install
+| Gem | Half | Depends on |
+| --- | --- | --- |
+| [`gem_kit`](gem_kit.gemspec) | `GemKit::Deprecate` — declare a deprecation | nothing beyond RubyGems |
+| [`gem_kit-release`](gem_kit-release.gemspec) | `gem kit …` — enforce it at release time | `gem_kit`, `thor` |
+
+A deprecation is a **dated promise**: it names its replacement *and* the version
+the old name stops existing in. The promise is declared at runtime and enforced
+at release time — which is exactly why these are two gems. A library that
+deprecates a name should not thereby acquire a release toolchain, and only the
+enforcing end needs one installed.
 
 ```ruby
-gem install gem_kit
+# Gemfile
+gem "gem_kit"                              # runtime: declaring
+gem "gem_kit-release", group: :development # release:  enforcing
 ```
 
-## Usage
+## Declaring — gem_kit
+
+A method:
 
-```bash
-TODO: Write usage instructions.
+```ruby
+class Session
+  extend GemKit::Deprecate
+
+  def old_reset = new_reset
+  deprecate :old_reset, "Session#new_reset", "5.0"
+end
 ```
 
-## Development
+A renamed or moved constant — leave the old name as a subclass of the new one:
 
-After checking out the repo:
+```ruby
+class Completion < New::Completion
+  extend GemKit::Deprecate
+  superseded_by "New::Completion", "5.0"
+end
+```
 
-```bash
-bin/setup
-bin/test
+Both keep working, warn on use naming the caller, and register the deadline:
+
+```
+NOTE: Session#old_reset is deprecated; use Session#new_reset instead.
+It will be removed in 5.0
+Session#old_reset called from app.rb:12.
+```
+
+Use `:none` when there genuinely is no replacement. `Gem::Deprecate.skip_during`
+silences the warnings, so a suite can exercise the old path in quiet.
+
+## Enforcing — gem_kit-release
+
+Installing it registers one `gem` command. There is nothing to wire up — no
+Rakefile, no binstubs:
+
+```sh
+gem kit setup                 # write DEPRECATIONS.md and RELEASE.md into your project
+gem kit bump minor            # move the version
+gem kit changelog --write     # have an AI CLI write the entry
+gem kit changelog             # lint it
+gem kit deprecations          # what is still outstanding
+gem kit release --dry-run     # run the gates
+gem kit tag --push            # tag it
+```
+
+| Command | What it does |
+| --- | --- |
+| `gem kit setup` | Writes DEPRECATIONS.md and RELEASE.md, rendered for your gem's name and versions. A generator, so `--force`, `--skip` and `--pretend` all work. |
+| `gem kit bump <major\|minor\|patch>` | Rewrites the version file. Refuses to bump onto a deprecation deadline; `--force` overrides. |
+| `gem kit changelog [VERSION]` | Lints CHANGELOG.md. With a version, checks that version is ready to release. |
+| `gem kit changelog --write` | Hands the entry to the configured AI CLI. |
+| `gem kit deprecations [VERSION]` | Lists what is outstanding. With a version, fails if any come due — a CI gate. |
+| `gem kit release [--dry-run]` | Gates, then builds and pushes. |
+| `gem kit tag [--push]` | Tags `v<version>`, refusing if it exists. |
+
+Everything sits behind one `gem` command rather than six, so nothing here can
+collide with a command RubyGems ships now or adds later — `gem check`,
+`gem build`, `gem push` and `gem setup` all already exist.
+
+The command line is [Thor](https://github.com/rails/thor), so `gem kit` lists
+the commands and `gem kit help <command>` prints one command's arguments and
+options. `gem kit setup` is a `Thor::Group` generator — the same machinery
+behind `rails generate` — which is where its `create` / `identical` /
+`conflict` reporting and its `--force`, `--skip` and `--pretend` come from.
+
+Everything is read out of your `.gemspec`. Override only what cannot be
+inferred:
+
+```ruby
+GemKit::Release.configure do |config|
+  config.changelog        = "HISTORY.md"   # default: CHANGELOG.md
+  config.version_file     = "lib/x.rb"     # default: lib/<name>/version.rb
+  config.require_path     = "x"            # default: <name>, hyphens as slashes
+  config.test_command     = "bin/test"
+  config.changelog_writer = "claude"       # the CLI that writes the entry
+end
 ```
 
-### Versioning
+### In a repository with more than one gemspec
 
-Increment the version:
+Like this one. Every command takes `--gem`, and refuses to guess without it:
 
-```bash
-bin/increment-version patch  # 0.1.0 -> 0.1.1
-bin/increment-version minor  # 0.1.0 -> 0.2.0
-bin/increment-version major  # 0.1.0 -> 1.0.0
+```sh
+$ gem kit changelog
+2 gemspecs in /home/you/src/gem_kit (gem_kit-release, gem_kit); name one with --gem
+
+$ gem kit changelog --gem gem_kit
+CHANGELOG-gem_kit.md is clean.
 ```
 
-### Releasing
+Three things follow from a repository holding several gems, and `gem kit`
+arranges all three itself:
+
+| | One gem | Several |
+| --- | --- | --- |
+| Changelog | `CHANGELOG.md` | `CHANGELOG-<gem>.md` |
+| Release document | `RELEASE.md` | `RELEASE-<gem>.md` |
+| Tag | `v1.2.3` | `<gem>-v1.2.3` |
+
+The changelog has to be per-gem: the release gate asks whether the version
+being cut is the *topmost* released section, and two gems interleaved in one
+file means the older one never is — so the second gem could never be released.
+The tag has to be per-gem because `v1.2.3` says which version but not which
+gem, which is fine until two of them are at the same one. `DEPRECATIONS.md` is
+written once for the repository, because one deprecation policy governs
+everything in it.
+
+## Extending it
+
+`gem kit` takes commands from other gems. `GemKit::Release.plugin` is the seam:
 
-Build and push to rubygems.org (checks the remote version first):
+```ruby
+# lib/gem_kit/plugin.rb, in a gem of your own
+require "gem_kit/release/cli"
 
-```bash
-bin/release-gem
+GemKit::Release.plugin do
+  desc "lint", "Check this gem for the things gems get wrong"
+  def lint = GemKit::Plugin::Lint.new(options).call
+end
 ```
 
-## Contributing
+The block is evaluated on the Thor class, so the whole Thor DSL is in scope —
+`desc`, `long_desc`, `method_option`, `map`, and `register` for a `Thor::Group`
+generator. A command added this way is indistinguishable from a built-in one:
+it appears in `gem kit`, takes `--gem`, and gets a help page.
+
+Ship a `lib/rubygems_plugin.rb` that requires your file and RubyGems loads it on
+every `gem` invocation, the same way this gem is loaded. See
+[gem_kit-plugin](https://github.com/n-at-han-k/gem_kit-plugin) for a worked
+example.
+
+## Layout
 
-Bug reports and pull requests are welcome on GitHub.
+```
+lib/gem_kit.rb              gem_kit
+lib/gem_kit/deprecate.rb
+lib/gem_kit/release.rb      gem_kit-release
+lib/gem_kit/release/
+lib/rubygems_plugin.rb
+template/                   the gem template this repository used to be
+```
+
+One `Gemfile`, one `Gemfile.lock`, one `gemset.nix`, one `flake.nix` and one
+`lefthook.yml` cover both gems. The dependencies are listed in the Gemfile
+outright rather than through `gemspec`, which is the only sane answer when two
+gemspecs share one bundle — and, separately, what `bundlerEnv` needs, since it
+resolves against a store directory holding only a Gemfile and a lockfile.
+
+Each gemspec names its own files rather than globbing `lib/**/*.rb`, because a
+glob would put the whole release toolchain inside the runtime gem.
+
+## Template
+
+`template/` holds the gem template this repository started as: clone it, run
+`bin/01-rename-gem`, and you have a gem.
+
+## Development
+
+```sh
+direnv allow      # or: nix develop
+bin/test
+```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](LICENSE).
+MIT

data/lib/gem_kit/deprecate.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+require "rubygems/deprecate"
+
+module GemKit
+  # A deprecation is a dated promise: it names the replacement *and* the
+  # version the old name stops existing in. Built on Gem::Deprecate, which
+  # gets the message format and the skip_during escape hatch right, plus one
+  # addition — a registry, so the set of outstanding promises is data the
+  # release tooling can enforce rather than prose someone has to remember.
+  #
+  # Deprecate a method:
+  #
+  #   class Session
+  #     extend GemKit::Deprecate
+  #
+  #     def old_reset = new_reset
+  #     deprecate :old_reset, "Session#new_reset", "5.0"
+  #   end
+  #
+  # Deprecate a whole constant that has moved or been renamed — leave the old
+  # name in place as a subclass of the new one, then declare it:
+  #
+  #   class Completion < Brute::Completion::OpenRouter
+  #     extend GemKit::Deprecate
+  #     superseded_by "Brute::Completion::OpenRouter", "5.0"
+  #   end
+  #
+  # Both warn on use, naming the caller. Gem::Deprecate.skip_during silences
+  # them, so a test suite can exercise the old path in quiet.
+  module Deprecate
+    extend Gem::Deprecate
+
+    # One outstanding deprecation. `removed_in` is the deadline the release
+    # gate reads.
+    Entry = Struct.new(:name, :replacement, :removed_in, :declared_at, keyword_init: true) do
+      def to_s
+        "#{name} -> #{replacement == :none ? "(no replacement)" : replacement}"
+      end
+    end
+
+    class << self
+      # Every deprecation declared in the loaded library, in declaration order.
+      def registry
+        @registry ||= []
+      end
+
+      def register(name:, replacement:, removed_in:, declared_at: nil)
+        entry = Entry.new(
+          name:        name.to_s,
+          replacement: replacement,
+          removed_in:  Gem::Version.new(removed_in.to_s),
+          declared_at: declared_at || location(1),
+        )
+        registry << entry
+        entry
+      end
+
+      # The deprecations that come due at `version` — every deadline that has
+      # arrived or passed. Releasing `version` with any of these still in the
+      # tree breaks the promise the warning made.
+      def pending(version)
+        target = Gem::Version.new(version.to_s)
+        registry.select { |entry| entry.removed_in <= target }
+      end
+
+      # Deprecations still inside their grace period at `version`.
+      def upcoming(version)
+        target = Gem::Version.new(version.to_s)
+        registry.reject { |entry| entry.removed_in <= target }
+      end
+
+      # Single funnel for every warning: Gem::Deprecate.skip_during works
+      # across all of them, and specs have one place to listen.
+      def warn(message)
+        Kernel.warn(message) unless Gem::Deprecate.skip
+      end
+
+      # The Gem::Deprecate-shaped message. `origin` must be computed at the
+      # call site — one frame deeper and it names this file rather than the
+      # code that needs changing.
+      def message(target, replacement, removed_in, origin)
+        [
+          "NOTE: #{target} is deprecated",
+          replacement == :none ? " with no replacement" : "; use #{replacement} instead",
+          ". It will be removed in #{removed_in}",
+          "\n#{target} called from #{origin}.",
+        ].join
+      end
+
+      def location(depth)
+        caller_locations(depth + 1, 1)&.first&.then { |l| "#{l.path}:#{l.lineno}" }
+      end
+    end
+
+    # Deprecate one method. Mirrors Gem::Deprecate#rubygems_deprecate, but the
+    # deadline is explicit — a deprecation added late in a cycle usually wants
+    # the major after next, and guessing that is not the tool's business.
+    def deprecate(name, replacement, removed_in)
+      label = singleton_class? ? "#{attached_object}.#{name}" : "#{self}##{name}"
+      Deprecate.register(name: label, replacement: replacement, removed_in: removed_in,
+                         declared_at: Deprecate.location(1))
+
+      class_eval do
+        old = "_deprecated_#{name}"
+        alias_method old, name
+        define_method name do |*args, &block|
+          target = is_a?(Module) ? "#{self}.#{name}" : "#{self.class}##{name}"
+          origin = Gem.location_of_caller.join(":")
+          Deprecate.warn(Deprecate.message(target, replacement, removed_in, origin))
+          send(old, *args, &block)
+        end
+        ruby2_keywords name if respond_to?(:ruby2_keywords, true)
+      end
+    end
+
+    # Deprecate the constant this is called in — the renamed-or-moved case.
+    # Named `superseded_by` rather than `deprecate_constant` because Module
+    # already has a method by that name and shadowing it would be rude.
+    def superseded_by(replacement, removed_in)
+      Deprecate.register(name: name || to_s, replacement: replacement, removed_in: removed_in,
+                         declared_at: Deprecate.location(1))
+
+      return unless respond_to?(:new)
+
+      define_singleton_method(:new) do |*args, **options, &block|
+        origin = Gem.location_of_caller.join(":")
+        Deprecate.warn(Deprecate.message(name || to_s, replacement, removed_in, origin))
+        super(*args, **options, &block)
+      end
+    end
+  end
+end
+
+__END__
+
+describe "gem_kit/deprecate" do
+  Deprecate = GemKit::Deprecate unless defined?(Deprecate)
+
+  captured = []
+  # Capture what Deprecate.warn emits and keep the shared registry clean —
+  # these specs declare throwaway deprecations.
+  isolated = lambda do |&block|
+    saved    = Deprecate.registry.dup
+    original = Deprecate.method(:warn)
+    captured.clear
+    Deprecate.define_singleton_method(:warn) { |message| captured << message }
+    begin
+      block.call
+    ensure
+      Deprecate.define_singleton_method(:warn, original)
+      Deprecate.registry.replace(saved)
+    end
+  end
+
+  it "warns on a deprecated method, naming replacement, version and caller" do
+    isolated.call do
+      klass = Class.new do
+        extend Deprecate
+        def new_name = :result
+        def old_name = new_name
+        deprecate :old_name, "Thing#new_name", "9.0"
+      end
+
+      klass.new.old_name.should == :result   # still works
+      captured.size.should == 1
+      captured.first.should.match(/is deprecated/)
+      captured.first.should.match(/use Thing#new_name instead/)
+      captured.first.should.match(/removed in 9\.0/)
+      captured.first.should.match(/called from /)
+    end
+  end
+
+  it "names the caller, not the deprecation machinery" do
+    isolated.call do
+      klass = Class.new do
+        extend Deprecate
+        def old_name = :result
+        deprecate :old_name, "Thing#new_name", "9.0"
+      end
+
+      # These specs live in this file's __END__, so "the caller" is a line in
+      # deprecate.rb either way — pin the exact line to tell them apart.
+      klass.new.old_name; call_line = __LINE__
+      captured.first.should.match(/called from .*deprecate\.rb:#{call_line}\./)
+    end
+  end
+
+  it "labels a class-method deprecation by the class, not its singleton" do
+    isolated.call do
+      Class.new do
+        def self.to_s = "Demo"
+        def self.old_thing = :ok
+        class << self
+          extend Deprecate
+          deprecate :old_thing, "Other.new_thing", "9.0"
+        end
+      end
+
+      Deprecate.registry.last.name.should == "Demo.old_thing"
+    end
+  end
+
+  it "warns on a superseded constant but keeps it working" do
+    isolated.call do
+      modern = Class.new { def initialize(x); @x = x; end; attr_reader :x }
+      legacy = Class.new(modern) do
+        extend Deprecate
+        def self.name = "Old::Name"
+        superseded_by "New::Name", "9.0"
+      end
+
+      legacy.new(42).x.should == 42          # still works
+      captured.size.should == 1
+      captured.first.should.match(/Old::Name is deprecated; use New::Name instead/)
+    end
+  end
+
+  it "supports :none for a deprecation with no replacement" do
+    isolated.call do
+      klass = Class.new do
+        extend Deprecate
+        def gone = :ok
+        deprecate :gone, :none, "9.0"
+      end
+
+      klass.new.gone
+      captured.first.should.match(/with no replacement/)
+    end
+  end
+
+  it "registers each declaration with its deadline and source" do
+    isolated.call do
+      Class.new do
+        extend Deprecate
+        def gone = nil
+        deprecate :gone, "Other#kept", "9.0"
+      end
+
+      entry = Deprecate.registry.last
+      entry.replacement.should == "Other#kept"
+      entry.removed_in.should == Gem::Version.new("9.0")
+      entry.declared_at.should.match(/deprecate\.rb:\d+/)
+    end
+  end
+
+  it "splits the registry into pending and upcoming at a version" do
+    isolated.call do
+      Deprecate.registry.clear
+      Deprecate.register(name: "A", replacement: "A2", removed_in: "5.0")
+      Deprecate.register(name: "B", replacement: "B2", removed_in: "6.0")
+
+      Deprecate.pending("5.0.0").map(&:name).should == ["A"]
+      Deprecate.upcoming("5.0.0").map(&:name).should == ["B"]
+      Deprecate.pending("4.9.0").should.be.empty
+      Deprecate.pending("6.1.0").map(&:name).should == ["A", "B"]
+    end
+  end
+
+  it "stays quiet inside Gem::Deprecate.skip_during" do
+    saved = Deprecate.registry.dup
+    begin
+      klass = Class.new do
+        extend Deprecate
+        def quiet = :ok
+        deprecate :quiet, "Other#loud", "9.0"
+      end
+
+      warned   = []
+      original = Kernel.method(:warn)
+      Kernel.define_singleton_method(:warn) { |*args| warned << args.join }
+      begin
+        Gem::Deprecate.skip_during { klass.new.quiet.should == :ok }
+      ensure
+        Kernel.define_singleton_method(:warn, original)
+      end
+
+      warned.should.be.empty
+    ensure
+      Deprecate.registry.replace(saved)
+    end
+  end
+end

data/lib/gem_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemKit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/gem_kit.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
 require_relative "gem_kit/version"
+require_relative "gem_kit/deprecate"
 
+# The runtime half of the kit: what a library needs while it is *running*, as
+# opposed to what its maintainer needs while releasing it.
+#
+# Right now that is one thing — GemKit::Deprecate, the deprecation DSL. It has
+# no dependencies beyond RubyGems' own, deliberately: a library that deprecates
+# a name should not thereby acquire a release toolchain.
+#
+#   class Session
+#     extend GemKit::Deprecate
+#
+#     def old_reset = new_reset
+#     deprecate :old_reset, "Session#new_reset", "5.0"
+#   end
+#
+# The release half lives in the gem_kit-release gem, in this same repository:
+# `gem kit bump|changelog|deprecations|release|tag`. It reads the registry this
+# one populates, which is the whole point of the split — the promises are
+# declared at runtime and enforced at release time, and only the enforcing end
+# needs the tooling installed.
 module GemKit
 end

metadata

@@ -1,95 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: gem_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Nathan K
-bindir: exe
+- Nathan Kidd
+bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-description: 'Clone the repo and run bin/rename-gem and you have a gem.
+dependencies: []
+description: |
+  A deprecation is a dated promise: it names its replacement and the version
+  the old name stops existing in. GemKit::Deprecate declares that promise --
+  `deprecate` for a method, `superseded_by` for a renamed constant -- warns
+  on use naming the caller, and registers the deadline so it can be checked.
 
-  '
-email:
-- nathankidd@hey.com
-executables:
-- gem_kit
+  Built on Gem::Deprecate, so the message format and Gem::Deprecate.skip_during
+  work as they already do. No dependencies beyond RubyGems' own: a library
+  that deprecates a name should not thereby acquire a release toolchain.
+
+  The checking lives in the gem_kit-release gem, which reads this registry.
+email: nathanblenheimkidd@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".envrc"
-- ".gitignore"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/choose-license
-- bin/console
-- bin/increment-version
-- bin/release-gem
-- bin/rename-gem
-- bin/setup
-- bin/test
-- bin/update-spec
-- exe/gem_kit
-- flake.lock
-- flake.nix
-- gem_kit.gemspec
-- gem_kit.gemspec.erb
 - lib/gem_kit.rb
+- lib/gem_kit/deprecate.rb
 - lib/gem_kit/version.rb
-- lib/gem_kit/version.rb.erb
-homepage: https://github.com/n-at-han-k/gem-kit
+homepage: https://github.com/n-at-han-k/gem_kit
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/n-at-han-k/gem-kit
-  source_code_uri: https://github.com/n-at-han-k/gem-kit
-  documentation_uri: https://github.com/n-at-han-k/gem-kit
+  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:
@@ -98,7 +45,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,5 +54,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
-summary: Dynamic gem template
+summary: A deprecation DSL that makes a removal deadline enforceable
 test_files: []

data/.envrc

@@ -1 +0,0 @@
-use flake

data/.gitignore

@@ -1,7 +0,0 @@
-*.gem
-/.bundle/
-/coverage/
-/pkg/
-/tmp/
-/vendor/bundle
-Gemfile.lock

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test

data/bin/choose-license

@@ -1,35 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "json"
-require "net/http"
-require "uri"
-
-def fetch_json(url)
-  JSON.parse(Net::HTTP.get(URI(url)))
-end
-
-licenses = fetch_json("https://api.github.com/licenses")
-
-licenses.each_with_index { |l, i| puts "#{i + 1}. #{l['name']}" }
-
-print "\nPick a license: "
-choice = licenses[gets.to_i - 1]
-
-abort("Invalid choice") unless choice
-
-detail = fetch_json(choice["url"])
-
-license_path = File.expand_path("../LICENSE", __dir__)
-File.write(license_path, detail["body"])
-
-# Update the SPDX ID in the gemspec
-spdx_id = choice["spdx_id"]
-gemspec_path = Dir.glob(File.expand_path("../*.gemspec", __dir__)).first
-if gemspec_path
-  content = File.read(gemspec_path)
-  content.sub!(/spec\.license\s*=\s*"[^"]*"/, "spec.license = \"#{spdx_id}\"")
-  File.write(gemspec_path, content)
-end
-
-puts "Wrote #{spdx_id} license to LICENSE"

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "gem_kit"
-require "irb"
-
-IRB.start(__FILE__)

data/bin/increment-version

@@ -1,43 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "erb"
-require_relative "../lib/gem_kit/version"
-
-USAGE = <<~TEXT
-  Usage: bin/increment-version <major|minor|patch>
-TEXT
-
-segment = ARGV[0]
-
-unless %w[major minor patch].include?(segment)
-  warn USAGE
-  exit 1
-end
-
-current = GemKit::VERSION
-major, minor, patch = current.split(".").map(&:to_i)
-
-case segment
-when "major"
-  major += 1
-  minor = 0
-  patch = 0
-when "minor"
-  minor += 1
-  patch = 0
-when "patch"
-  patch += 1
-end
-
-version = "#{major}.#{minor}.#{patch}"
-
-template_path = File.expand_path("../lib/gem_kit/version.rb.erb", __dir__)
-output_path   = File.expand_path("../lib/gem_kit/version.rb", __dir__)
-
-template = ERB.new(File.read(template_path))
-result = template.result(binding)
-
-File.write(output_path, result)
-
-puts "#{current} -> #{version}"

data/bin/release-gem

@@ -1,32 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../lib/gem_kit/version"
-
-local_version = GemKit::VERSION
-gem_name = "gem_kit"
-gemspec = "gem_kit.gemspec"
-
-puts "Local version: #{local_version}"
-
-remote_output = `gem specification #{gem_name} version --remote 2>&1`
-
-if $?.success?
-  remote_version = remote_output[/version: (.+)/, 1]&.strip
-  puts "Remote version: #{remote_version}"
-
-  if Gem::Version.new(local_version) <= Gem::Version.new(remote_version)
-    abort "ERROR: Local version (#{local_version}) has not been incremented past remote (#{remote_version})"
-  end
-else
-  puts "Gem not yet published remotely, proceeding with first release"
-end
-
-puts "Building #{gemspec}..."
-system("gem build #{gemspec}") || abort("ERROR: gem build failed")
-
-gem_file = "#{gem_name}-#{local_version}.gem"
-puts "Pushing #{gem_file}..."
-system("gem push #{gem_file}") || abort("ERROR: gem push failed")
-
-puts "Released #{gem_name} #{local_version}"

data/bin/rename-gem

@@ -1,104 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "fileutils"
-
-current_name = "gem_kit"
-
-def to_camel(snake)
-  snake.split("_").map(&:capitalize).join
-end
-
-# Parse --from flag
-args = ARGV.dup
-if (idx = args.index("--from"))
-  current_name = args.delete_at(idx + 1)&.tr("-", "_")
-  args.delete_at(idx)
-  abort "ERROR: --from requires a gem name" unless current_name && !current_name.empty?
-end
-
-name = args[0]
-
-if name.nil? || name.empty?
-  print "Gem name (snake_case): "
-  name = $stdin.gets.chomp
-end
-
-abort "Usage: bin/rename-gem <gem_name> [--from <current_name>]" if name.empty?
-
-old_snake = current_name
-old_camel = to_camel(old_snake)
-
-snake = name.tr("-", "_")
-camel = to_camel(snake)
-
-if snake == old_snake
-  abort "Already named #{snake}, nothing to do"
-end
-
-root = File.expand_path("..", __dir__)
-
-# --- Rename files and directories ---
-
-renames = {
-  "lib/#{old_snake}"                    => "lib/#{snake}",
-  "lib/#{old_snake}.rb"                 => "lib/#{snake}.rb",
-  "lib/#{snake}/version.rb"             => "lib/#{snake}/version.rb",
-  "lib/#{snake}/version.rb.erb"         => "lib/#{snake}/version.rb.erb",
-  "#{old_snake}.gemspec"                => "#{snake}.gemspec",
-  "#{old_snake}.gemspec.erb"            => "#{snake}.gemspec.erb",
-  "exe/#{old_snake}"                    => "exe/#{snake}",
-  "test/#{old_snake}_test.rb"           => "test/#{snake}_test.rb",
-}
-
-# Rename directory first (lib/old_name -> lib/new_name)
-old_dir = File.join(root, "lib", old_snake)
-new_dir = File.join(root, "lib", snake)
-if File.directory?(old_dir)
-  FileUtils.mv(old_dir, new_dir)
-  puts "  mv lib/#{old_snake}/ -> lib/#{snake}/"
-end
-
-# Rename files
-renames.each do |old_rel, new_rel|
-  next if old_rel.start_with?("lib/#{old_snake}/") # directory already moved
-  next if old_rel == "lib/#{snake}/version.rb"      # already inside renamed dir
-
-  old_path = File.join(root, old_rel)
-  new_path = File.join(root, new_rel)
-  next unless File.exist?(old_path)
-  next if old_path == new_path
-
-  FileUtils.mv(old_path, new_path)
-  puts "  mv #{old_rel} -> #{new_rel}"
-end
-
-# --- Replace content in all files ---
-
-files = Dir.glob(File.join(root, "**/*"), File::FNM_DOTMATCH)
-  .reject { |f| File.directory?(f) }
-  .reject { |f| f.include?("/.git/") }
-
-files.each do |path|
-  content = File.read(path)
-  original = content.dup
-
-  content.gsub!(old_camel, camel)
-  content.gsub!(old_snake, snake)
-
-  if content != original
-    File.write(path, content)
-    puts "  updated #{path.sub("#{root}/", "")}"
-  end
-end
-
-# Update current_name in this script to reflect the new name
-script_path = File.join(root, "bin", "rename-gem")
-if File.exist?(script_path)
-  script = File.read(script_path)
-  script.sub!(/^current_name = ".*"$/, "current_name = \"#{snake}\"")
-  File.write(script_path, script)
-  puts "  updated bin/rename-gem (current_name = \"#{snake}\")"
-end
-
-puts "\nRenamed #{old_snake} -> #{snake} (#{old_camel} -> #{camel})"

data/bin/setup

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install

data/bin/test

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../test", __dir__)
-
-require "bundler/setup"
-
-Dir.chdir(File.expand_path("..", __dir__))
-
-if ARGV.empty?
-  Dir.glob("test/**/*_test.rb").sort.each { |f| require_relative "../#{f}" }
-else
-  ARGV.each { |f| require_relative "../#{f}" }
-end

data/bin/update-spec

@@ -1,49 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "erb"
-require_relative "../lib/gem_kit/version"
-
-gemspec_path = File.expand_path("../gem_kit.gemspec", __dir__)
-spec = Gem::Specification.load(gemspec_path)
-
-def prompt(label, default)
-  print "#{label} [#{default}] (y/N): "
-  return default unless $stdin.gets.chomp.downcase == "y"
-
-  print "#{label}: "
-  input = $stdin.gets.chomp
-  input.empty? ? default : input
-end
-
-def prompt_script(label, current, script)
-  print "#{label} [#{current}] (y/N): "
-  return unless $stdin.gets.chomp.downcase == "y"
-
-  system(File.expand_path(script, __dir__))
-end
-
-prompt_script("Gem name", spec.name, "rename-gem")
-authors      = prompt("Authors (comma-separated)", spec.authors.join(", ")).split(",").map(&:strip)
-emails       = prompt("Emails (comma-separated)", spec.email.join(", ")).split(",").map(&:strip)
-summary      = prompt("Summary", spec.summary)
-description  = prompt("Description", spec.description.strip)
-homepage     = prompt("Homepage", spec.homepage)
-prompt_script("License", spec.license, "choose-license")
-ruby_version = prompt("Minimum Ruby version", spec.required_ruby_version.to_s.delete(">= "))
-
-# Reload spec in case rename-gem or choose-license changed things
-gemspec_path = Dir.glob(File.expand_path("../*.gemspec", __dir__)).first
-spec = Gem::Specification.load(gemspec_path)
-gem_name = spec.name
-license = spec.license
-
-template_path = gemspec_path.sub(/\.gemspec$/, ".gemspec.erb")
-output_path   = gemspec_path
-
-template = ERB.new(File.read(template_path))
-result = template.result(binding)
-
-File.write(output_path, result)
-
-puts "Updated #{File.basename(gemspec_path)}"

data/exe/gem_kit

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../lib/gem_kit"
-
-puts "hello from gem_kit"

data/flake.lock

@@ -1,61 +0,0 @@
-{
-  "nodes": {
-    "nixpkgs": {
-      "locked": {
-        "lastModified": 1773821835,
-        "narHash": "sha256-TJ3lSQtW0E2JrznGVm8hOQGVpXjJyXY2guAxku2O9A4=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "b40629efe5d6ec48dd1efba650c797ddbd39ace0",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "root": {
-      "inputs": {
-        "nixpkgs": "nixpkgs",
-        "utils": "utils"
-      }
-    },
-    "systems": {
-      "locked": {
-        "lastModified": 1681028828,
-        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
-        "owner": "nix-systems",
-        "repo": "default",
-        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-systems",
-        "repo": "default",
-        "type": "github"
-      }
-    },
-    "utils": {
-      "inputs": {
-        "systems": "systems"
-      },
-      "locked": {
-        "lastModified": 1731533236,
-        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    }
-  },
-  "root": "root",
-  "version": 7
-}

data/flake.nix

@@ -1,37 +0,0 @@
-{
-  description = "Ruby gem flake";
-
-  inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
-    utils.url = "github:numtide/flake-utils";
-  };
-  outputs = { self, nixpkgs, utils }:
-    utils.lib.eachDefaultSystem (system:
-      let
-        pkgs = nixpkgs.legacyPackages.${system};
-        ruby = pkgs.ruby_3_4; # Specify version
-      in
-      {
-        devShells.default = pkgs.mkShell {
-          nativeBuildInputs = [
-            pkgs.pkg-config # native extension discovery
-          ];
-
-          buildInputs = [
-            ruby
-            pkgs.libyaml # psych gem
-            pkgs.openssl # openssl gem
-          ];
-
-          shellHook = ''
-            export GEM_HOME="$PWD/.gem"
-            export GEM_PATH="$GEM_HOME"
-            export PATH="$GEM_HOME/bin:$PATH"
-            export BUNDLE_PATH="$GEM_HOME"
-            export BUNDLE_BIN="$GEM_HOME/bin"
-          '';
-        };
-      }
-    );
-}
-

data/gem_kit.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/gem_kit/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "gem_kit"
-  spec.version = GemKit::VERSION
-  spec.authors = ["Nathan K"]
-  spec.email = ["nathankidd@hey.com"]
-
-  spec.summary = "Dynamic gem template"
-
-  spec.description = <<~DESC
-    Clone the repo and run bin/rename-gem and you have a gem.
-  DESC
-
-  spec.homepage = "https://github.com/n-at-han-k/gem-kit"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["documentation_uri"] = spec.homepage
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|data)/}) }
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rubocop", "~> 1.21"
-end

data/gem_kit.gemspec.erb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/gem_kit/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "<%= gem_name %>"
-  spec.version = GemKit::VERSION
-  spec.authors = [<%= authors.map { |a| %("#{a}") }.join(", ") %>]
-  spec.email = [<%= emails.map { |e| %("#{e}") }.join(", ") %>]
-
-  spec.summary = "<%= summary %>"
-
-  spec.description = <<~DESC
-    <%= description %>
-  DESC
-
-  spec.homepage = "<%= homepage %>"
-  spec.license = "<%= license %>"
-  spec.required_ruby_version = ">= <%= ruby_version %>"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["documentation_uri"] = spec.homepage
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|data)/}) }
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rubocop", "~> 1.21"
-end

data/lib/gem_kit/version.rb.erb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module GemKit
-  VERSION = "<%= version %>"
-end