releasetool 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a125cee11cd4ea5f8f7e0d11f1483c6d97e0d5b8e95f66a86641ac84e27ca1d
-  data.tar.gz: 45b0ec021a7e0067655a7c87d334b45687df6a2a4b21920b0b895c770a9045d6
+  metadata.gz: 1b46e141b87c5f056ab3af71cdf6a5157e6b559e51743a07383bc225676c9866
+  data.tar.gz: e9d0a785e91132404eee8aef1a96705834569d5933210dbae5e3a6cbe89f2360
 SHA512:
-  metadata.gz: 0c4147c03ebf447fd56092d1348aa95fa5eb808d007ac9a39ce82344724fa5b09921a88628524b379408d4b40a64a0709f7f1aec8f4f4183ea63f37286f38868
-  data.tar.gz: a8c6d7e67bde87c0935175e12b75bc400dd0f425cafb8d2d7a318f0ba7ebfad28ba599cce13d65a01d4e74f69b6aab6f4015616021577640035fd8daa32d00df
+  metadata.gz: f0e80727a056d71917c33fb270685e16f7ec50e50a9aad75d0ae15c09380b993aec681fa340e45ecc126bda12a4a0778e807443dabba0e9f269b586f22cdc046
+  data.tar.gz: ad2a984cb079825de22f0efa986f6f4695e3df5f711c4eb8da5075ad726a2356eea050dff44d24efb48a78bf2d6069077a1126c4854a353b2ce2efa6d8cb4326

data/README.md

@@ -69,6 +69,7 @@ It will ask for a one-line summary of the release (full details are in the relea
 
 The tests work on a known-good repo stored in `spec/fixtures/example_with_releases.tar`. To recreate this:
 ```
+mkdir -p spec/fixtures/example_with_releases
 cd spec/fixtures/example_with_releases && tar -xvf ../example_with_releases.tar  && cd -
 ```
 
@@ -77,11 +78,20 @@ then you can tweak it and save it back with:
 cd spec/fixtures/example_with_releases && tar -cvf ../example_with_releases.tar . && cd -
 ```
 
+ditto for other one with config
+
+cd spec/fixtures/example_with_releases && tar -cvf ../example_with_releases.tar . && cd -
+
 ## Configuration
 
 If you want it to automatically update the version number in a string then set the environment variable
  `RELEASETOOL_VERSION_FILE`, eg. `export RELEASETOOL_VERSION_FILE=./lib/releasetool.rb`. By default this is configured to config/initializers/00-version.rb (useful for rails projects).
 
+If you want to run something after `release start` or after `release commit` then generate a hooks file:
+
+    release init
+
+which will generate a file at `config/releasetool/hooks.rb` which you can adjust.
 
 ## Contributing
 

data/lib/releasetool/base_hooks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "releasetool/util"
+
+module Releasetool
+  class BaseHooks
+    # @param config [Releasetool::Configuration]
+    def initialize(config)
+      @config = config
+    end
+
+    def after_prepare(version)
+      # noop
+    end
+
+    def after_commit(version)
+      # noop
+    end
+  end
+end

data/lib/releasetool/configuration.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "releasetool/util"
+require "pathname"
+
+module Releasetool
+  class Configuration
+    def after_start_hook(version)
+      return nil unless hooks.respond_to?(:after_start)
+
+      hooks.after_start(version)
+    end
+
+    def after_commit_hook(version)
+      return nil unless hooks.respond_to?(:after_commit)
+
+      hooks.after_commit(version)
+    end
+
+    def generate
+      FileUtils.mkdir_p(config_dir)
+      if File.exist?(hooks_file)
+        say "File #{hooks_file.inspect} already exists"
+        return
+      end
+
+      File.write(hooks_file, default_hooks)
+    end
+
+    private
+
+    def config_dir
+      Pathname.new("./config/releasetool")
+    end
+
+    def hooks
+      @hooks ||= new_hooks
+    end
+
+    def new_hooks
+      return nil unless File.exist?(hooks_file)
+
+      load hooks_file # we use load so we can test it 🙁
+      return nil unless defined?(Releasetool::Hooks)
+
+      Releasetool::Hooks.new(self)
+    end
+
+    def hooks_file
+      config_dir / "hooks.rb"
+    end
+
+    def default_hooks
+      <<~HOOKS
+        # frozen_string_literal: true
+
+        require "releasetool/util"
+        require "releasetool/base_hooks"
+
+        module Releasetool
+          class Hooks < Releasetool::BaseHooks
+            include Releasetool::Util
+
+            # def after_start(version)
+            #   puts "after_start has been called"
+            # end
+
+            # def after_commit(version)
+            #   puts "after_commit has been called"
+            # end
+          end
+        end
+      HOOKS
+    end
+  end
+end

data/lib/releasetool/util.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'English'
+require "releasetool/configuration"
 
 module Releasetool
   module Util
@@ -35,5 +36,10 @@ module Releasetool
 
       output
     end
+
+    # @return [Releasetool::Configuration]
+    def config
+      @config ||= Releasetool::Configuration.new
+    end
   end
 end

data/lib/releasetool.rb

@@ -3,5 +3,5 @@
 require "releasetool/release"
 
 module Releasetool
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/tasks/release_thor.rb

@@ -8,6 +8,16 @@ require "releasetool/version"
 
 class Release < Thor
   include Releasetool::Util
+  desc "init", <<-END
+    generate optional config directory and optional hooks file
+  END
+
+  def init
+    config.generate
+  end
+
+  # ========================
+
   desc "list", <<-END
     show a list of tags ordered by date (just a git listing).
   END
@@ -51,9 +61,10 @@ class Release < Thor
   def start(specified_version = nil)
     raise Thor::Error.new("Can't start when already started on a version. release abort or release finish") if File.exist?(RELEASE_MARKER_FILE)
 
-    version = next_version(specified_version)
+    version = specified_version ? Releasetool::Version.new(specified_version) : next_version
     File.write(RELEASE_MARKER_FILE, version)
     Releasetool::Release.new(version, previous: previous_version).prepare(edit: options[:edit])
+    config.after_start_hook(version)
   end
 
   DEFAULT_COMMIT_MESSAGE = 'preparing for release [CI SKIP]'
@@ -65,10 +76,11 @@ class Release < Thor
   # should take release commit --edit which allows you to edit, or --no-edit (default) which allows you to just skip
   method_option :edit, type: :boolean, desc: "edit", aliases: 'e', default: false
   def commit(version = nil)
-    version || stored_version
+    version ||= stored_version
     guarded_system("git add #{DIR}")
     guarded_system("git add #{Releasetool::Util.version_file}") if File.exist?(Releasetool::Util.version_file)
     guarded_system("git commit #{DIR} #{File.exist?(Releasetool::Util.version_file) ? Releasetool::Util.version_file : ''} #{options[:edit] ? '-e' : nil} -m\"#{DEFAULT_COMMIT_MESSAGE}\"")
+    config.after_commit_hook(version)
   end
 
   desc "tag (NEW_VERSION)", <<-END
@@ -111,9 +123,7 @@ class Release < Thor
 
   protected
 
-  def next_version(specified)
-    return Releasetool::Version.new(specified) if specified
-
+  def next_version
     if options[:major]
       previous_version.next_major
     elsif options[:minor]

data/release_notes/v0.5.0.md

@@ -0,0 +1,5 @@
+v0.5.0 Release Notes
+
+*Changes since v0.4.0*
+
+- allow local configuration of after_start and after_commit (#12)

data/spec/fixtures/empty_file.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# deliberately empty

data/spec/fixtures/hooks_example.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "releasetool/util"
+require "releasetool/base_hooks"
+
+module Releasetool
+  class Hooks < Releasetool::BaseHooks
+    include Releasetool::Util
+
+    def after_start(version)
+      puts "after_start(#{version}) has been called"
+    end
+
+    def after_commit(version)
+      puts "after_commit(#{version}) has been called"
+    end
+  end
+end

data/spec/releasetool_spec.rb

@@ -10,11 +10,15 @@ RSpec.describe Releasetool do
   end
 end
 
-RSpec.describe Release, quietly: true do
+RSpec.describe Release, quietly: false do
   subject { Release.new }
+
   let(:tmpdir) { File.expand_path('../tmp/testing', __dir__) }
   let(:root_dir) { File.expand_path('..', __dir__) }
+  let(:hooks_example_rb) { File.expand_path('./fixtures/hooks_example.rb', __dir__) }
+  let(:empty_file) { File.expand_path('./fixtures/empty_file.rb', __dir__) }
   before {
+    Releasetool.send(:remove_const, :Hooks) if defined?(Releasetool::Hooks)
     FileUtils.rmtree(tmpdir)
     FileUtils.mkdir_p(tmpdir)
     FileUtils.chdir(tmpdir)
@@ -53,7 +57,7 @@ RSpec.describe Release, quietly: true do
 
       it "with existing release-version file, it should freak out" do
         FileUtils.touch(File.join(tmpdir, '.RELEASE_NEW_VERSION'))
-        expect { subject.start('v0.0.3') }.to raise_error
+        expect { subject.start('v0.0.3') }.to raise_error(/Can't start when already started on a version/)
       end
     end
 
@@ -92,6 +96,31 @@ RSpec.describe Release, quietly: true do
         subject.start
       end
     end
+
+    context "with config and..." do
+      context "with empty hooks" do
+        before do
+          FileUtils.mkdir_p("#{tmpdir}/config/releasetool")
+          FileUtils.cp(empty_file, "#{tmpdir}/config/releasetool/hooks.rb")
+        end
+        it "should still work" do
+          expect(Releasetool::Release).to receive(:new).with(v_0_0_2, previous: v_0_0_1).and_return(mock_target)
+          expect(mock_target).to receive(:prepare)
+          expected = "after_start(v0.0.2) has been called"
+          expect { subject.start }.not_to output(/#{Regexp.escape(expected)}/).to_stdout
+        end
+      end
+      context "with hook" do
+        before do
+          FileUtils.mkdir_p("#{tmpdir}/config/releasetool")
+          FileUtils.cp(hooks_example_rb, "#{tmpdir}/config/releasetool/hooks.rb")
+        end
+        it "should output hook" do
+          expected = "after_start(v0.0.2) has been called"
+          expect { subject.start }.to output(/#{Regexp.escape(expected)}/).to_stdout
+        end
+      end
+    end
   end
 
   describe "commit" do
@@ -114,6 +143,37 @@ RSpec.describe Release, quietly: true do
         subject.commit('v0.0.3')
       end
     end
+
+    context "with generated config and hook" do
+      it "should generate and still work" do
+        subject.init
+        expected = "after_commit(v0.0.3) has been called"
+        expect(subject).to receive(:guarded_system).with("git commit release_notes config/initializers/00-version.rb  -m\"#{Release::DEFAULT_COMMIT_MESSAGE}\"")
+        expect { subject.commit('v0.0.3') }.not_to output(/#{Regexp.escape(expected)}/).to_stdout
+      end
+    end
+
+    context "with config and hook" do
+      before do
+        FileUtils.mkdir_p("#{tmpdir}/config/releasetool")
+        FileUtils.cp(hooks_example_rb, "#{tmpdir}/config/releasetool/hooks.rb")
+      end
+      it "should output hook" do
+        expect(subject).to receive(:guarded_system).with("git commit release_notes config/initializers/00-version.rb  -m\"#{Release::DEFAULT_COMMIT_MESSAGE}\"")
+        expected = "after_commit(v0.0.3) has been called"
+        expect { subject.commit('v0.0.3') }.to output(/#{Regexp.escape(expected)}/).to_stdout
+      end
+    end
+  end
+
+  describe "init" do
+    it "should generate " do
+      expect(Dir.exist?("#{tmpdir}/config/releasetool")).to be_falsey
+      expect(File.exist?("#{tmpdir}/config/releasetool/hooks.rb")).to be_falsey
+      subject.init
+      expect(Dir.exist?("#{tmpdir}/config/releasetool")).to be_truthy
+      expect(File.exist?("#{tmpdir}/config/releasetool/hooks.rb")).to be_truthy
+    end
   end
 
   describe "latest" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasetool
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Diggins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -98,6 +98,8 @@ files:
 - Rakefile
 - bin/release
 - lib/releasetool.rb
+- lib/releasetool/base_hooks.rb
+- lib/releasetool/configuration.rb
 - lib/releasetool/release.rb
 - lib/releasetool/util.rb
 - lib/releasetool/version.rb
@@ -111,8 +113,11 @@ files:
 - release_notes/v0.2.0.md
 - release_notes/v0.3.0.md
 - release_notes/v0.4.0.md
+- release_notes/v0.5.0.md
 - releasetool.gemspec
+- spec/fixtures/empty_file.rb
 - spec/fixtures/example_with_releases.tar
+- spec/fixtures/hooks_example.rb
 - spec/releasetool_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
@@ -136,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Release management tools