hoe 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 232664e1c18f9f6b79de0bab5fcf3688f2b8a4e15678b64ade007348e0a4ea79
-  data.tar.gz: 3e0f8ee572a3d43d264a9d73deadf9cdcc56fe1e8afe3debe9c584316f8bc0ce
+  metadata.gz: d748b707bbac7227b49c4cbb8f0a9bb86fca5bdb888b5777fe397e992c5f0ab6
+  data.tar.gz: 852ac4e7b19085650bf59100d204ecc2a7d17d199ad9dea5a18b03e932759839
 SHA512:
-  metadata.gz: c4c79031e28176a1975dca3b1631b0d31db90ee56abea92a37f7038095a9f102f4cdf36025917a93a8e9ad77ccbaf21178d324f53e6495f52be11c7a9599dcea
-  data.tar.gz: 8a5ceb14b19e6eb056f279c0b7240b4654b2fca73b8fc0ae35bd69a5b39240fe83e26c7e3f5ca527bdec61a0b15963c89c73a3336f15cd81d4c6dc6b3a38548d
+  metadata.gz: f306370fc2778a4cf015df82b93a61c13caf08eaaf867ab8e7a4d3ef5010df70d5e9d648769004b47889d7e55d6c63846d2e73dfe999b2409fb078c88411dcdd
+  data.tar.gz: f0bb47cc94f3bdf33cc68c9ceb07347219e443540f51abbac269acd6eefc39f333f48b4156acaad64307a83f510ee9921d4503c7c44a13e7dff4faed540b7860

data/History.rdoc

@@ -1,3 +1,21 @@
+=== 4.5.0 / 2025-12-24
+
+* 3 minor enhancements:
+
+  * Added Hoe::Git plugin, forked from jbarnette/hoe-git + halostatue/hoe-git2
+  * Bumped ruby version to 3.2+.
+  * Clarified dependency on rake to ~> 13.0.
+
+=== 4.4.0 / 2025-12-22
+
+* 1 minor enhancement:
+
+  * Added rdoc_options accessor to expose it so you can add more.
+
+* 1 bug fix:
+
+  * Updated File.read_utf to assume String encoding support. (wtn)
+
 === 4.3.0 / 2025-06-17
 
 * 4 bug fixes:

data/Manifest.txt

@@ -15,6 +15,7 @@ lib/hoe/flay.rb
 lib/hoe/flog.rb
 lib/hoe/gem_prelude_sucks.rb
 lib/hoe/gemcutter.rb
+lib/hoe/git.rb
 lib/hoe/inline.rb
 lib/hoe/newb.rb
 lib/hoe/package.rb

data/README.rdoc

@@ -167,6 +167,7 @@ Again, this must be done before the Hoe spec, or it won't be useful.
 * Hoe::Flog
 * Hoe::GemPreludeSucks
 * Hoe::Gemcutter
+* Hoe::Git
 * Hoe::Inline
 * Hoe::Newb
 * Hoe::Package

data/Rakefile

@@ -19,9 +19,9 @@ Hoe.spec "hoe" do
 
   pluggable!
   require_rubygems_version ">= 3.0"
-  require_ruby_version [">= 2.7", "< 4"]
+  require_ruby_version ">= 3.2"
 
-  dependency "rake", [">= 0.8", "< 15.0"] # FIX: to force it to exist pre-isolate
+  dependency "rake", "~> 13.0" # FIX: to force it to exist pre-isolate
 end
 
 task :plugins do

data/lib/hoe/git.rb

@@ -0,0 +1,186 @@
+class Hoe # :nodoc:
+
+  ##
+  # This module is a Hoe plugin. You can set its attributes in your
+  # Rakefile Hoe spec, like this:
+  #
+  #    Hoe.plugin :git
+  #
+  #    Hoe.spec "myproj" do
+  #      self.git_release_tag_prefix  = "REL_"
+  #      self.git_remotes            << "myremote"
+  #    end
+  #
+  #
+  # === Tasks
+  #
+  # git:changelog:: Print the current changelog.
+  # git:manifest::  Update the manifest with Git's file list.
+  # git:tag::       Create and push a tag.
+
+  module Git
+
+    ##
+    # What do you want at the front of your release tags?
+    # [default: <tt>"v"</tt>]
+
+    attr_accessor :git_release_tag_prefix
+
+    ##
+    # Which remotes do you want to push tags, etc. to?
+    # [default: <tt>%w[ origin ]</tt>]
+
+    attr_accessor :git_remotes
+
+    attr_accessor :git_changes # :nodoc:
+
+    def initialize_git # :nodoc:
+      self.git_release_tag_prefix = "v"
+      self.git_remotes            = %w[ origin ]
+    end
+
+    def define_git_tasks # :nodoc:
+      return unless File.exist? ".git"
+
+      desc "Print the current changelog."
+      task "git:changelog" do
+        tag   = ENV["FROM"] || git_tags.last
+        range = [tag, "HEAD"].compact.join ".."
+
+        changes = `git log #{range} --format="tformat:%B|||%aN|||%aE|||"`
+          .split("|||")
+          .each_slice(3)
+          .map { |msg, author, email|
+            msg.lines(chomp: true).reject(&:empty?)
+          }
+          .flatten
+
+        next if changes.empty?
+
+        self.git_changes = Hash.new { |h, k| h[k] = [] }
+
+        codes = {
+          "!" => :major,
+          "+" => :minor,
+          "*" => :minor,
+          "-" => :bug,
+          "?" => :unknown,
+        }
+
+        codes_re = Regexp.escape codes.keys.join
+
+        changes.each do |change|
+          if change =~ /^\s*([#{codes_re}])\s*(.*)/ then
+            code, line = codes[$1], $2
+          else
+            code, line = codes["?"], change.chomp
+          end
+
+          git_changes[code] << line
+        end
+
+        now = Time.new.strftime "%Y-%m-%d"
+
+        puts "=== #{ENV["VERSION"] || "NEXT"} / #{now}"
+        puts
+        changelog_section :major
+        changelog_section :minor
+        changelog_section :bug
+        changelog_section :unknown
+        puts
+      end
+
+      desc "Update the manifest with Git's file list. Use Hoe's excludes."
+      task "git:manifest" do
+        with_config do |config, _|
+          files = `git ls-files`
+            .lines(chomp:true)
+            .grep_v(config["exclude"])
+
+          File.write "Manifest.txt", files.sort.join("\n")
+        end
+      end
+
+      desc "Create and push a TAG " +
+           "(default #{git_release_tag_prefix}#{version})."
+
+      task "git:tag" do
+        tag = ENV["TAG"]
+        ver = ENV["VERSION"] || version
+        pre = ENV["PRERELEASE"] || ENV["PRE"]
+        ver += ".#{pre}" if pre
+        tag ||= "#{git_release_tag_prefix}#{ver}"
+
+        git_tag_and_push tag
+      end
+
+      task "git:tags" do
+        p git_tags
+      end
+
+      task :release_sanity do
+        unless ENV["DIRTY"] or `git status --porcelain`.empty?
+          abort "Won't release: Dirty index or untracked files present!"
+        end
+      end
+
+      task :release_to => "git:tag"
+    end
+
+    ##
+    # Generate a tag and push it to all remotes.
+
+    def git_tag_and_push tag
+      msg = "Tagging #{tag}."
+
+      flags = " -s" unless `git config --get user.signingkey`.empty?
+
+      sh %Q(git tag#{flags} -f #{tag} -m "#{msg}")
+      git_remotes.each { |remote| sh "git push -f #{remote} tag #{tag}" }
+    end
+
+    ##
+    # Return all git tags massaged down to readable versions.
+
+    def git_tags
+      flags  = %w[--date-order
+                  --reverse
+                  --simplify-by-decoration
+                  --pretty=format:%H].join " "
+      shas = `git log #{flags}`.lines(chomp: true)
+
+      `git name-rev --tags #{shas.join " "}`
+        .lines
+        .map { |s| s[/tags\/(#{git_release_tag_prefix}.+)/, 1] }
+        .compact
+        .map { |s| s.sub(/\^0$/, "") } # v1.2.3^0 -> v1.2.3 (why?)
+        .grep(%r{^#{git_release_tag_prefix}}) # TODO: remove?
+    end
+
+    ##
+    # Generate and print a changelog section based on the +code+.
+
+    def changelog_section code
+      name = +{
+        :major   => "major enhancement",
+        :minor   => "minor enhancement",
+        :bug     => "bug fix",
+        :unknown => "unknown",
+      }[code]
+
+      changes = git_changes[code]
+      count = changes.size
+      name += "s" if count > 1
+      name.sub!(/fixs/, "fixes")
+
+      return if count < 1
+
+      puts "* #{count} #{name}:"
+      puts
+      changes.sort.each do |line|
+        puts "  * #{line}"
+      end
+      puts
+    end
+  end
+end

data/lib/hoe.rb

@@ -87,7 +87,7 @@ class Hoe
   include Rake::DSL if defined?(Rake::DSL)
 
   # duh
-  VERSION = "4.3.0"
+  VERSION = "4.5.0"
 
   @@plugins = [:clean, :debug, :deps, :flay, :flog, :newb, :package,
                :publish, :gemcutter, :signing, :test]
@@ -181,6 +181,11 @@ class Hoe
 
   attr_accessor :extra_dev_deps
 
+  ##
+  # Optional: rdoc arguments to be used when generating rdoc.
+
+  attr_accessor :rdoc_options
+
   ##
   # Optional: Extra files you want to add to RDoc.
   #
@@ -544,7 +549,7 @@ class Hoe
       s.bindir               = bindir || "bin"
       s.executables          = s.files.grep(/^#{s.bindir}/) { |f| File.basename(f) }
       s.require_paths        = dirs unless dirs.empty?
-      s.rdoc_options         = ["--main", readme_file]
+      s.rdoc_options         = rdoc_options
       s.post_install_message = post_install_message
       s.metadata             = (urls.keys & URLS_TO_META_MAP.keys).map { |name|
         [URLS_TO_META_MAP[name], urls[name]]
@@ -663,6 +668,9 @@ class Hoe
     self.history_file ||= Dir.glob("History.{rdoc,txt,md}").first || "History.txt"
     self.readme_file  ||= Dir.glob("README.{rdoc,txt,md}").first || "README.txt"
 
+    # delayed to set readme_file first
+    self.rdoc_options = ["--main", readme_file]
+
     abort "Hoe.new {...} removed. Switch to Hoe.spec." if block_given?
   end
 
@@ -953,15 +961,8 @@ end
 class File # :nodoc:
   # Like File::read, but strips out a BOM marker if it exists.
   def self.read_utf path
-    r19 = "<3".respond_to? :encoding
-    opt = r19 ? "r:bom|utf-8" : "rb"
-
-    open path, opt do |f|
-      if r19 then
-        f.read
-      else
-        f.read.sub %r%\A\xEF\xBB\xBF%, ""
-      end
+    open path, "r:bom|utf-8" do |f|
+      f.read
     end
   end
 end

data/test/test_hoe.rb

@@ -192,10 +192,7 @@ class TestHoe < Minitest::Test
 
       content = File.read_utf io.path
       assert_equal "BOM", content
-
-      if content.respond_to? :encoding then
-        assert_equal Encoding::UTF_8, content.encoding
-      end
+      assert_equal Encoding::UTF_8, content.encoding
     end
   end
 

data/test/test_hoe_test.rb

@@ -28,11 +28,9 @@ class TestHoeTest < Minitest::Test
 
   MT_EXPECTED = %W[-I#{mt_path} -w
                    -e '%srequire "test/test_hoe_test.rb"'
-                   --].join(" ") + " "
+                   -- %s].join(" ")
 
   def test_make_test_cmd_for_minitest
-    skip "Using TESTOPTS... skipping" if ENV["TESTOPTS"]
-
     framework = %(require "minitest/autorun"; )
 
     @tester = Minitest::TestTask.create :testtest do |t|
@@ -40,12 +38,12 @@ class TestHoeTest < Minitest::Test
       t.test_globs = ["test/test_hoe_test.rb"]
     end
 
-    assert_equal MT_EXPECTED % [framework].join("; "), @tester.make_test_cmd
+    fw = [framework].join("; ")
+    env = ENV["A"]
+    assert_equal MT_EXPECTED % [fw, env], @tester.make_test_cmd
   end
 
   def test_make_test_cmd_for_minitest_prelude
-    skip "Using TESTOPTS... skipping" if ENV["TESTOPTS"]
-
     prelude = %(require "other/file")
     framework = %(require "minitest/autorun"; )
 
@@ -55,6 +53,8 @@ class TestHoeTest < Minitest::Test
       t.test_globs = ["test/test_hoe_test.rb"]
     end
 
-    assert_equal MT_EXPECTED % [prelude, framework].join("; "), @tester.make_test_cmd
+    prelude = [prelude, framework].join("; ")
+    env = ENV["A"]
+    assert_equal MT_EXPECTED % [prelude, env], @tester.make_test_cmd
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -34,22 +34,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +116,7 @@ files:
 - lib/hoe/flog.rb
 - lib/hoe/gem_prelude_sucks.rb
 - lib/hoe/gemcutter.rb
+- lib/hoe/git.rb
 - lib/hoe/inline.rb
 - lib/hoe/newb.rb
 - lib/hoe/package.rb
@@ -163,17 +158,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '3.0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Hoe is a rake/rubygems helper for project Rakefiles
 test_files: []