releasetool 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983770392f1e8f1b9e2a4d1c7ca5fbf20d60a3c6927e9592dd2550d7b8b055e0
-  data.tar.gz: 33e70854792ca8494b51bb5db8df0fe5eecda6c4058d14448097fb4da4b5777e
+  metadata.gz: 1b46e141b87c5f056ab3af71cdf6a5157e6b559e51743a07383bc225676c9866
+  data.tar.gz: e9d0a785e91132404eee8aef1a96705834569d5933210dbae5e3a6cbe89f2360
 SHA512:
-  metadata.gz: 50dcc0d3b1855bbfcdabb39fe51acf733702215599e0d36a9f17b04e0a99dd2db610cd1aaaa4f0b050488f9e0abc606ad5077f4c3b003e80dd6a3d155c1ef3b0
-  data.tar.gz: 8dc72d2e9b6704f859d7812b39038b9e9c308d7e4c14975a9e1b8f4e2bf4ff62a69f0bc11a35c40ece91fe12f8cd77c50359750f5b615aac5a667b8c7de2c87b
+  metadata.gz: f0e80727a056d71917c33fb270685e16f7ec50e50a9aad75d0ae15c09380b993aec681fa340e45ecc126bda12a4a0778e807443dabba0e9f269b586f22cdc046
+  data.tar.gz: ad2a984cb079825de22f0efa986f6f4695e3df5f711c4eb8da5075ad726a2356eea050dff44d24efb48a78bf2d6069077a1126c4854a353b2ce2efa6d8cb4326

data/.rubocop.yml

@@ -0,0 +1,117 @@
+inherit_from: .rubocop_todo.yml
+
+#require:
+#  - rubocop-performance
+#  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  DefaultFormatter: fuubar
+  Exclude:
+    - 'tmp/**/*'
+  DisplayCopNames: true
+  NewCops: enable
+  CacheRootDirectory: tmp # ie. tmp/rubocop_cache
+  UseCache: true
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+# Don't like this, it's too annoying
+Layout/LineLength:
+  Max: 120
+  Enabled: false
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  Exclude:
+    - "spec/**/*" # https://github.com/rubocop/rubocop/issues/4222
+
+Lint/AssignmentInCondition:
+  AutoCorrect: false
+
+Lint/UnusedBlockArgument:
+  AutoCorrect:  false
+
+Lint/UnusedMethodArgument:
+  AutoCorrect:  false
+
+Metrics/AbcSize:
+  Enabled: false
+  # I don't think this is something we want to enforce (yet?)
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - "no_commands" # thor
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+  # No (not yet)
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+  # In theory this is good. In practice lots of false errors
+
+## I'm not very keen on this one
+#Performance/TimesMap:
+#  Enabled: false
+
+## I can't see the value of this
+#RSpec/DescribeClass:
+#  Enabled: false
+
+#RSpec/EmptyExampleGroup:
+#  # we need to fix manually - e.g. fill it in or delete it
+#  AutoCorrect: false
+#
+## prefer this
+#RSpec/ExpectChange:
+#  EnforcedStyle: block
+#
+## I can't see the value of this
+#RSpec/MultipleMemoizedHelpers:
+#  Enabled: false
+#
+## This is actually wrong and a mistake (`expect ... to receive ... and return ...` is good practice)
+#RSpec/StubbedMock:
+#  Enabled: false
+
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+  # Sounds good, but really?
+
+Style/DoubleNegation:
+  Enabled: false
+  # double negation is an ok way to enforce true / false when assigning
+
+Style/NumericLiterals:
+  Enabled: false
+  # This is a pain, most long numeric literals are things like ids or times as numbers
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SymbolProc:
+  Enabled: true
+  AllowMethodsWithArguments: true
+  AllowComments: true

data/.rubocop_todo.yml

@@ -0,0 +1,139 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 100`
+# on 2023-09-11 13:28:02 UTC using RuboCop version 1.56.3.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'spec/fixtures/example_with_releases/config/initializers/00-version.rb'
+
+# Offense count: 8
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'lib/tasks/release_thor.rb'
+
+# Offense count: 15
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/releasetool_spec.rb'
+    - 'spec/version_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never, either, consistent
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/releasetool.rb'
+    - 'lib/releasetool/util.rb'
+    - 'lib/tasks/release_thor.rb'
+    - 'spec/fixtures/example_with_releases/config/initializers/00-version.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/tasks/release_thor.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'releasetool.gemspec'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedCompactTypes.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantPercentQ:
+  Exclude:
+    - 'releasetool.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  Exclude:
+    - 'lib/releasetool/util.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SlicingWithRange:
+  Exclude:
+    - 'lib/releasetool/version.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'lib/releasetool/release.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish, EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'releasetool.gemspec'
+
+# Offense count: 34
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'bin/release'
+    - 'lib/releasetool/release.rb'
+    - 'lib/releasetool/util.rb'
+    - 'lib/tasks/release_thor.rb'
+    - 'releasetool.gemspec'
+    - 'spec/releasetool_spec.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/version_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiteralsInInterpolation:
+  Exclude:
+    - 'lib/tasks/release_thor.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/tasks/release_thor.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in releasetool.gemspec

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+```release help```
+
 ### List existing tags
 
 ```release list```
@@ -67,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 -
 ```
 
@@ -75,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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/release

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 $LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
 require File.expand_path('../lib/tasks/release_thor.rb', File.dirname(__FILE__))
 

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/release.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "releasetool/util"
+require "fileutils"
 
 module Releasetool
   class Release
@@ -6,6 +9,7 @@ module Releasetool
 
     def initialize(version, previous:)
       raise "Version must be a Releasetool::Version" unless version.is_a?(Releasetool::Version)
+
       if previous
         raise "Previous must be nil or a Releasetool::Version" unless version.is_a?(Releasetool::Version)
       end
@@ -18,10 +22,10 @@ module Releasetool
       commits = `git log #{@previous}..HEAD --pretty=format:"- %B"`
       notes = commits.gsub("\n\n", "\n")
       notes_file = "#{DIR}/#{@version}.md"
-      if File.exists?(notes_file)
-        puts "-"*80
+      if File.exist?(notes_file)
+        puts "-" * 80
         puts " File '#{notes_file}' already exists (appending)"
-        puts "-"*80
+        puts "-" * 80
         File.open(notes_file, 'a') do |f|
           f.puts("\n\nAPPENDED:\n\n")
           f.puts(notes)
@@ -33,22 +37,20 @@ module Releasetool
           f.puts(notes)
         end
         puts "written to #{notes_file}"
-        if edit
-          system("open #{notes_file}")
-        end
-      end
-      if File.exists?(VERSION_FILE)
-        from_version = @previous.to_s_without_v
-        to_version = @version.to_s_without_v
-        guarded_system("cat #{VERSION_FILE} | sed s/#{from_version}/#{to_version.gsub('.', '\.')}/ > #{VERSION_FILE}.tmp")
-        guarded_system("mv #{VERSION_FILE}.tmp #{VERSION_FILE}")
+        system("open #{notes_file}") if edit
       end
+      return unless File.exist?(Releasetool::Util.version_file)
+
+      from_version = @previous.to_s_without_v
+      to_version = @version.to_s_without_v
+      guarded_system("cat #{Releasetool::Util.version_file} | sed s/#{from_version}/#{to_version.gsub('.', '\.')}/ > #{Releasetool::Util.version_file}.tmp")
+      guarded_system("mv #{Releasetool::Util.version_file}.tmp #{Releasetool::Util.version_file}")
     end
 
     private
 
     def ensure_dir
-      Dir.mkdir(DIR) unless File.exists?(DIR)
+      FileUtils.mkdir_p(DIR)
     end
 
     def headers
@@ -62,20 +64,17 @@ module Releasetool
     def ensured_template_file
       ensure_dir
       template_file = "#{DIR}/#{TEMPLATE_FILE}"
-      create_template_file(template_file) unless File.exists?(template_file)
+      create_template_file(template_file) unless File.exist?(template_file)
       template_file
     end
 
     def create_template_file(template_file)
-      File.open(template_file, "w") do |f|
-        f.write <<~FILEEND
+      File.write(template_file, <<~FILEEND)
         $VERSION Release Notes
-        
+
         *Changes since $PREVIOUS*
 
-        FILEEND
-      end
+      FILEEND
     end
-
   end
 end

data/lib/releasetool/util.rb

@@ -1,13 +1,22 @@
+# frozen_string_literal: true
+
+require 'English'
+require "releasetool/configuration"
+
 module Releasetool
   module Util
-
     DIR = "release_notes"
-    VERSION_FILE = ENV['RELEASETOOL_VERSION_FILE'] || "config/initializers/00-version.rb" #rails out of box
     TEMPLATE_FILE = "__TEMPLATE__.md" # relative to DIR
     RELEASE_MARKER_FILE = ".RELEASE_NEW_VERSION" # should be a config var
 
+    def self.version_file
+      # rails out of box
+      ENV['RELEASETOOL_VERSION_FILE'] || "config/initializers/00-version.rb"
+    end
+
     def stored_version
       fail Thor::Error.new("No stored version... did you forget to do release start?") unless File.exist?(RELEASE_MARKER_FILE)
+
       File.read(RELEASE_MARKER_FILE).strip
     end
 
@@ -19,5 +28,18 @@ module Releasetool
       puts command
       system(command) or raise Thor::Error.new("Couldn't '#{command}'")
     end
+
+    def guarded_capture(command)
+      puts command
+      output = `#{command}`
+      raise Thor::Error.new("Couldn't '#{command}'") unless $CHILD_STATUS
+
+      output
+    end
+
+    # @return [Releasetool::Configuration]
+    def config
+      @config ||= Releasetool::Configuration.new
+    end
   end
 end

data/lib/releasetool/version.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Releasetool
   class Version
     attr_reader :ident
+
     def initialize(ident)
       raise "Not a valid version identifier: #{ident.inspect}" unless ident.is_a?(String)
+
       @ident = ident
     end
 
@@ -43,9 +47,11 @@ module Releasetool
     end
 
     private
-    def incremented(v)
-      raise "Can't work out next version from #{self}" unless v.to_i.to_s == v
-      v.to_i + 1
+
+    def incremented(number)
+      raise "Can't work out next version from #{self}" unless number.to_i.to_s == number
+
+      number.to_i + 1
     end
 
     def segments

data/lib/releasetool.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "releasetool/release"
 
 module Releasetool
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/tasks/release_thor.rb

@@ -1,11 +1,23 @@
+# frozen_string_literal: true
+
 require 'thor'
+require "releasetool"
 require "releasetool/release"
 require "releasetool/util"
 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
@@ -38,7 +50,7 @@ class Release < Thor
   # ========================
 
   method_option :since, type: :string, desc: "since commit_ref (or will use most recent tag)", required: false,
-    aliases: 's'
+                        aliases: 's'
   method_option :edit, type: :boolean, desc: "edit", required: false, aliases: 'e'
   method_option :minor, type: :boolean, desc: "minor version", required: false, default: false
 
@@ -46,15 +58,13 @@ class Release < Thor
     Start a release by doing a prepare, and storing the target release in #{RELEASE_MARKER_FILE}.
   END
 
-  def start(specified_version=nil)
-    if File.exists?(RELEASE_MARKER_FILE)
-      raise Thor::Error.new("Can't start when already started on a version. release abort or release finish")
-    end
-    version = next_version(specified_version)
-    File.open(RELEASE_MARKER_FILE, 'w') do |f|
-      f.write(version)
-    end
+  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 = 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]'
@@ -63,11 +73,14 @@ class Release < Thor
       If no version given, it will use the version stored by release start
   END
 
-  def commit(version=nil)
+  # 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
     guarded_system("git add #{DIR}")
-    guarded_system("git add #{VERSION_FILE}") if File.exists?(VERSION_FILE)
-    guarded_system("git commit #{DIR} #{File.exists?(VERSION_FILE) ? VERSION_FILE : ''} -e -m\"#{DEFAULT_COMMIT_MESSAGE}\"")
+    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
@@ -75,9 +88,10 @@ class Release < Thor
       If no version given, it will use the version stored by release start
   END
 
-  def tag(version=nil)
+  def tag(version = nil)
     version ||= stored_version
-    guarded_system("git tag -a #{version}")
+    last_useful_commit = guarded_capture("git log head^^..head^  --pretty=format:%s").strip.split("\n").first.strip
+    guarded_system("git tag -a #{version} -e -m \"#{last_useful_commit}\"")
   end
 
   desc "push (NEW_VERSION)", <<-END
@@ -85,7 +99,7 @@ class Release < Thor
       If no version given, it will use the version stored by release start.
   END
 
-  def push(version=nil)
+  def push(version = nil)
     version ||= stored_version
     guarded_system("git push")
     guarded_system("git push origin #{version}")
@@ -100,10 +114,16 @@ class Release < Thor
     remove_stored_version
   end
 
+  map %w[--version -v] => :__print_version
+
+  desc "--version, -v", "print the version"
+  def __print_version
+    say "Releasetool v#{Releasetool::VERSION}"
+  end
+
   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.4.0.md

@@ -0,0 +1,7 @@
+v0.4.0 Release Notes
+
+*Changes since v0.3.0*
+
+* `release commit` now doesn't require you to edit message by default. If you want to edit use `release commit --edit`
+* `release tag` now gives you the previous log message as the default tag message (useful in case of release a single-issue/commit)
+* `release --version` to print version

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/releasetool.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'releasetool'
 
@@ -15,12 +16,14 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_dependency 'thor', '>= 0.18'
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop", "1.56.3"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -1,40 +1,46 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'fileutils'
-require File.expand_path('../../lib/tasks/release_thor', __FILE__)
+require File.expand_path('../lib/tasks/release_thor', __dir__)
 
-describe Releasetool do
+RSpec.describe Releasetool do
   it 'should have a version number' do
     expect(Releasetool::VERSION).not_to be_nil
   end
 end
 
-describe Release, quietly: true do
+RSpec.describe Release, quietly: false do
   subject { Release.new }
-  TMPDIR = File.expand_path('../../tmp/testing', __FILE__)
-  ROOT_DIR = File.expand_path('../..', __FILE__)
+
+  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 {
-    FileUtils.rmtree(TMPDIR)
-    FileUtils.mkdir_p(TMPDIR)
-    FileUtils.chdir(TMPDIR)
+    Releasetool.send(:remove_const, :Hooks) if defined?(Releasetool::Hooks)
+    FileUtils.rmtree(tmpdir)
+    FileUtils.mkdir_p(tmpdir)
+    FileUtils.chdir(tmpdir)
     system('tar -xf ../../spec/fixtures/example_with_releases.tar')
   }
   after {
-    FileUtils.chdir(ROOT_DIR)
+    FileUtils.chdir(root_dir)
   }
   it "should respond to list" do
     subject.list
   end
 
-  let(:mock_target){ instance_double(Releasetool::Release)}
-  let(:v_0_0_1) {Releasetool::Version.new("v0.0.1")}
-  let(:v_0_0_2) {Releasetool::Version.new("v0.0.2")}
-  let(:v_0_0_3) {Releasetool::Version.new("v0.0.3")}
-  let(:v_0_1_0) {Releasetool::Version.new("v0.1.0")}
-  let(:v_1_0_0) {Releasetool::Version.new("v1.0.0")}
+  let(:mock_target) { instance_double(Releasetool::Release) }
+  let(:v_0_0_1) { Releasetool::Version.new("v0.0.1") }
+  let(:v_0_0_2) { Releasetool::Version.new("v0.0.2") }
+  let(:v_0_0_3) { Releasetool::Version.new("v0.0.3") }
+  let(:v_0_1_0) { Releasetool::Version.new("v0.1.0") }
+  let(:v_1_0_0) { Releasetool::Version.new("v1.0.0") }
 
-  context "start" do
+  describe "start" do
     context "with a since" do
-      subject { Release.new([], {since: 'v0.0.2'}, {}) }
+      subject { Release.new([], { since: 'v0.0.2' }, {}) }
       it "it should do a prepare and store a file" do
         expect(Releasetool::Release).to receive(:new).with(v_0_0_3, previous: v_0_0_2).and_return(mock_target)
         expect(mock_target).to receive(:prepare)
@@ -44,14 +50,14 @@ describe Release, quietly: true do
         allow(Releasetool::Release).to receive(:new).with(v_0_0_3, previous: v_0_0_2).and_return(mock_target)
         allow(mock_target).to receive(:prepare)
         expect { subject.start('v0.0.3') }.to change {
-              File.exist?(File.join(TMPDIR, '.RELEASE_NEW_VERSION'))
-            }
-        expect(File.read(File.join(TMPDIR, '.RELEASE_NEW_VERSION')).to_s).to eq('v0.0.3')
+          File.exist?(File.join(tmpdir, '.RELEASE_NEW_VERSION'))
+        }
+        expect(File.read(File.join(tmpdir, '.RELEASE_NEW_VERSION')).to_s).to eq('v0.0.3')
       end
 
       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
+        FileUtils.touch(File.join(tmpdir, '.RELEASE_NEW_VERSION'))
+        expect { subject.start('v0.0.3') }.to raise_error(/Can't start when already started on a version/)
       end
     end
 
@@ -72,7 +78,7 @@ describe Release, quietly: true do
     end
 
     context "without a new version but with --minor modifier" do
-      subject { Release.new([], {minor: true}, {}) }
+      subject { Release.new([], { minor: true }, {}) }
 
       it "it should use next minor level" do
         expect(Releasetool::Release).to receive(:new).with(v_0_1_0, previous: v_0_0_1).and_return(mock_target)
@@ -82,7 +88,7 @@ describe Release, quietly: true do
     end
 
     context "without a new version but with --major modifier" do
-      subject { Release.new([], {major: true}, {}) }
+      subject { Release.new([], { major: true }, {}) }
 
       it "it should use next minor level" do
         expect(Releasetool::Release).to receive(:new).with(v_1_0_0, previous: v_0_0_1).and_return(mock_target)
@@ -90,11 +96,89 @@ 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
+    before {
+      allow(ENV).to receive(:[]).with('RELEASETOOL_VERSION_FILE').and_return(nil) # in case it is defined...
+      expect(subject).to receive(:guarded_system).with("git add release_notes")
+      expect(subject).to receive(:guarded_system).with("git add config/initializers/00-version.rb")
+    }
+    context "with no args" do
+      it "outputs without -e" do
+        expect(subject).to receive(:guarded_system).with("git commit release_notes config/initializers/00-version.rb  -m\"#{Release::DEFAULT_COMMIT_MESSAGE}\"")
+        subject.commit('v0.0.3')
+      end
+    end
+
+    context "with --edit" do
+      subject { Release.new([], { edit: true }, {}) }
+      it "outputs with e" do
+        expect(subject).to receive(:guarded_system).with("git commit release_notes config/initializers/00-version.rb -e -m\"#{Release::DEFAULT_COMMIT_MESSAGE}\"")
+        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
     it "outputs latest version" do
-      expect{subject.latest}.to output("v0.0.1\n").to_stdout
+      expect { subject.latest }.to output("v0.0.1\n").to_stdout
     end
   end
 
@@ -110,7 +194,6 @@ describe Release, quietly: true do
     end
   end
 
-
   # describe 'CLI' do
   #   it "should work with source and no target" do
   #     puts "CLI"
@@ -137,5 +220,4 @@ describe Release, quietly: true do
   #         }.strip).not_to eq('')
   #   end
   # end
-
 end

data/spec/spec_helper.rb

@@ -1,17 +1,17 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'releasetool'
 
 RSpec.configure do |config|
   config.around quietly: true do |example|
-    RSpec.configure do |config|
-      original_stderr = $stderr
-      original_stdout = $stdout
-      # Redirect stderr and stdout
-      $stderr = File.open(File::NULL, "w")
-      $stdout = File.open(File::NULL, "w")
-      example.run
-      $stderr = original_stderr
-      $stdout = original_stdout
-    end
+    original_stderr = $stderr
+    original_stdout = $stdout
+    # Redirect stderr and stdout
+    $stderr = File.open(File::NULL, "w")
+    $stdout = File.open(File::NULL, "w")
+    example.run
+    $stderr = original_stderr
+    $stdout = original_stdout
   end
 end

data/spec/version_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require "releasetool/version"
@@ -21,9 +23,9 @@ describe Releasetool::Version do
   end
 
   describe "next_patch" do
-    let(:v_0_0_1) {Releasetool::Version.new("v0.0.1")}
-    let(:v_0_0_2) {Releasetool::Version.new("v0.0.2")}
-    let(:v_0_0_3) {Releasetool::Version.new("v0.0.3")}
+    let(:v_0_0_1) { Releasetool::Version.new("v0.0.1") }
+    let(:v_0_0_2) { Releasetool::Version.new("v0.0.2") }
+    let(:v_0_0_3) { Releasetool::Version.new("v0.0.3") }
 
     it "is next" do
       expect(v_0_0_1.next_patch).to eq(v_0_0_2)
@@ -34,9 +36,9 @@ describe Releasetool::Version do
   end
 
   describe "next_minor" do
-    let(:v_0_0_1) {Releasetool::Version.new("v0.0.1")}
-    let(:v_0_1_0) {Releasetool::Version.new("v0.1.0")}
-    let(:v_0_2_0) {Releasetool::Version.new("v0.2.0")}
+    let(:v_0_0_1) { Releasetool::Version.new("v0.0.1") }
+    let(:v_0_1_0) { Releasetool::Version.new("v0.1.0") }
+    let(:v_0_2_0) { Releasetool::Version.new("v0.2.0") }
 
     it "is next" do
       expect(v_0_0_1.next_minor).to eq(v_0_1_0)
@@ -47,9 +49,9 @@ describe Releasetool::Version do
   end
 
   describe "next_major" do
-    let(:v_0_1_1) {Releasetool::Version.new("v0.1.1")}
-    let(:v_1_0_0) {Releasetool::Version.new("v1.0.0")}
-    let(:v_2_0_0) {Releasetool::Version.new("v2.0.0")}
+    let(:v_0_1_1) { Releasetool::Version.new("v0.1.1") }
+    let(:v_1_0_0) { Releasetool::Version.new("v1.0.0") }
+    let(:v_2_0_0) { Releasetool::Version.new("v2.0.0") }
 
     it "is next" do
       expect(v_0_1_1.next_major).to eq(v_1_0_0)
@@ -60,11 +62,8 @@ describe Releasetool::Version do
   end
 
   describe "==" do
-    let(:v_0_0_2) {Releasetool::Version.new("v0.0.2")}
+    let(:v_0_0_2) { Releasetool::Version.new("v0.0.2") }
 
-    it "is self same" do
-      expect(v_0_0_2 == v_0_0_2).to be_truthy
-    end
     it "is same if other is a version of same" do
       expect(v_0_0_2 == Releasetool::Version.new("v0.0.2")).to be_truthy
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasetool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Diggins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.56.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.56.3
 description: Some release-related functions, initially just release notes management
   and creation
 email:
@@ -76,12 +90,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - 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
@@ -94,15 +112,20 @@ files:
 - release_notes/v0.1.1.md
 - 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
 homepage: ''
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -111,19 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Release management tools
-test_files:
-- spec/fixtures/example_with_releases.tar
-- spec/releasetool_spec.rb
-- spec/spec_helper.rb
-- spec/version_spec.rb
+test_files: []