hoe-git2 1.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7aac80c05332e9faf7b61b526e7d3dbce4f8e2f04e4851bf42fa25719ed07c8
+  data.tar.gz: 783d51ff0f977cbd7cb93150225c8e0b0bbd9615c5b48afb958590795bb77c21
+SHA512:
+  metadata.gz: 45447bf8aa1a2a1bd4aa8d469fa04a3f9c5e3c22dde457ecb2d275ddb45459ea048a75df109b091ecd00880bded2f8daf9e401e9e427bcc81e4abb444c5aa4d3
+  data.tar.gz: 70c54520d3c71db1eff92c26bb6a09cf32eb448d6b3bae0bb5b538413ea0dbc4378fe42a2c3737f0f1efbd9e10ba902ecab2f7d80a221853d8b02e106a62d659

data/CHANGELOG.rdoc

@@ -0,0 +1,92 @@
+=== 1.7.0 / 2022-07-18
+
+* 2 minor enhancements:
+
+  * Incorporated the porcelain change for jbarnette/hoe-git#14, resolving
+    jbarnette/hoe-git#13. Thanks to @ghost for the original contribution.
+
+  * Improved in-git and git-svn detection to use git porcelain instead of
+    strict directory detection.
+
+* This is sort of a re-birthday! Since jbarnette/hoe-git has been archived,
+  I've forked the repository and released this plug-in as +hoe-git2+. I've
+  also chosen to reformat this to my preferred style. I have released this
+  using the same versioning as +hoe-git+ because this is very much a
+  continuation of the original code.
+
+=== 1.6.0 / 2014-02-05
+
+* 1 minor enhancement:
+
+  * Added signed tag support to hoe-git
+
+=== 1.5.0 / 2012-03-22
+
+* 1 minor enhancement:
+
+  * Added prerelease support.  Use `rake release VERSION=1.0 PRE=rc.1` to
+    create a prerelease gem.
+
+* 1 bug fix:
+
+  * The git:tag task is now a dependency of release_to instead of release to
+    ensure it runs before post_release tasks
+
+
+=== 1.4.1 / 2011-10-04
+
+* 1 minor enhancement:
+
+  * Added git:tags.
+
+* 2 bug fixes:
+
+  * Fixed name-rev to use --tags. Version diff?
+  * Newer versions of git are tacking on a "^0" to tag names for some stupid reason.
+
+=== 1.4.0 / 2011-05-16
+
+* 2 minor enhancements:
+
+  * Exported all the other git functions so that other rake tasks can benefit.
+  * Updated git:changelog to support annotated commit messages.
+
+* 1 bug fix:
+
+  * Fix shell escaping on Windows. [Gordon Thiesfeld]
+
+=== 1.3.0 / 2009-07-27
+
+* Add a git:manifest task. [Phil Hagelb0rg]
+* Clean up git:changelog a bit.
+* Add the doofus Hoe plugin.
+* Update README w/better docs.
+
+=== 1.2.0 / 2009-07-01
+
+* Add git-svn support for git:tag and git:changelog.
+
+=== 1.1.3 / 2009-06-27
+
+* Changelog should use author, not committer.
+
+=== 1.1.2 / 2009-06-26
+
+* Doc cleanups.
+* Veto releases when the index is dirty.
+
+=== 1.1.1 / 2009-06-23
+
+* Use git_release_tag_prefix more consistently, handle unreleased case.
+* Make the README a bit better.
+
+=== 1.1.0 / 2009-06-23
+
+* Allow configurable release tag prefixes.
+* Add git:changelog to make release notes easier.
+* Make the git:tag task respect a TAG env var.
+* Minor cleanups.
+
+=== 1.0.0 / 2009-06-23
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,5 @@
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/hoe/git2.rb

data/README.rdoc

@@ -0,0 +1,95 @@
+= Hoe Loves Git
+
+* home :: http://github.com/halostatue/hoe-git
+* docs :: http://docs.seattlerb.org/hoe-git
+
+== Description
+
+A set of Hoe plugins for tighter Git integration. Provides tasks to automate release tagging and pushing and changelog
+generation. I expect it'll learn a few more tricks in the future.
+
+This is an evolution of +hoe-git+ by John Barnette, which has been archived at <http://github.com/jbarnette/hoe-git>.
+
+== Examples
+
+    # in your Rakefile
+    Hoe.plugin :git2
+
+If this plugin cannot see that it is in a `.git` directory, it'll silently deactivate itself.
+
+=== Autogenerating the Changelog
+
+    $ rake git:changelog
+
+This takes all the commit messages since your last release and formats
+'em into a nice RDoc fragment. If you specify <tt>VERSION</tt>, it'll
+be used in the changelog fragment. If you specify <tt>FROM</tt>, it'll
+be used as a starting point for the changelog instead of your last
+tagged release.
+
+The rdoc is automatically formatted into sections by using "annotated
+commit messages" by using a simple format for multi-line commit messages:
+
+    ! major change description.
+    + minor change description.
+    - bug fix description.
+    un-logged description (for minor stuff like re-formatting).
+
+=== Generating the Manifest
+
+    $ rake git:manifest
+
+This will regenerate <tt>Manifest.txt</tt> using <tt>git
+ls-files</tt>. It respects Hoe's manifest sort order and excludes.
+
+=== Tagging and Sanity Checking a Release
+
+    $ rake release VERSION=1.0.0
+
+In addition to the normal RubyForge release process, this will create
+and push a <tt>v1.0.0</tt> tag. It'll also abort the release if your
+index is dirty, or if there are untracked files present.
+
+=== git-svn
+
+The <tt>git:changelog</tt> and <tt>git:tag</tt> tasks understand
+<tt>git-svn</tt> repositories, and will adjust their behavior
+accordingly.
+
+== Dependencies
+
+Hoe and Git, obviously. I wouldn't be surprised if things don't quite
+work for git < 2.37.
+
+== Installation
+
+    $ gem install hoe-git2
+
+== TODO
+
+* Release tags are sorted lexicographically right now, which won't
+  work for long.
+
+== License
+
+Copyright 2009 John Barnette (jbarnette@rubyforge.org)
+Copyright 2022 Austin Ziegler (halostatue@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift "lib"
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :doofus
+Hoe.plugin :gemspec2
+Hoe.plugin :git2
+
+Hoe.spec "hoe-git2" do
+  developer "John Barnette", "jbarnette@rubyforge.org"
+  developer "Austin Ziegler", "halostatue@gmail.com"
+
+  self.extra_rdoc_files = FileList["*.rdoc"]
+  self.history_file = "CHANGELOG.rdoc"
+  self.readme_file = "README.rdoc"
+
+  license "MIT"
+
+  extra_dev_deps << ["hoe-doofus", "~> 1.0"]
+  extra_dev_deps << ["hoe-gemspec2", "~> 1.1"]
+  extra_dev_deps << ["standard", "~> 1.0"]
+end

data/lib/hoe/git2.rb

@@ -0,0 +1,205 @@
+require "shellwords"
+
+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 Git2
+    # Duh.
+    VERSION = "1.7.0"
+
+    # 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
+
+    def initialize_git2 # :nodoc:
+      self.git_release_tag_prefix = "v"
+      self.git_remotes = %w[origin]
+    end
+
+    def define_git2_tasks # :nodoc:
+      return unless __run_git("rev-parse", "--is-inside-work-tree") == "true"
+
+      desc "Print the current changelog."
+      task "git:changelog" do
+        tag = ENV["FROM"] || git_tags.last
+        range = [tag, "HEAD"].compact.join("..")
+        now = Time.new.strftime("%Y-%m-%d")
+
+        changes =
+          __run_git("log", range, "--format=tformat:%B|||%aN|||%aE|||")
+            .split("|||")
+            .each_slice(3)
+            .map do |msg, _author, _email|
+            msg.split("\n").reject(&:empty?)
+          end
+
+        changes = changes.flatten
+
+        next if changes.empty?
+
+        $changes = Hash.new { |h, k| h[k] = [] } # standard:disable Style/GlobalVars
+
+        codes = {
+          "!" => :major,
+          "+" => :minor,
+          "*" => :minor,
+          "-" => :bug,
+          "?" => :unknown
+        }
+
+        codes_re = Regexp.escape codes.keys.join
+
+        changes.each do |change|
+          if change =~ /^\s*([#{codes_re}])\s*(.*)/
+            code, line = codes[$1], $2
+          else
+            code, line = codes["?"], change.chomp
+          end
+
+          $changes[code] << line # standard:disable Style/GlobalVars
+        end
+
+        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 = __run_git("ls-files").split($/)
+          files.reject! { |f| f =~ config["exclude"] }
+
+          File.open "Manifest.txt", "w" do |f|
+            f.puts files.sort.join("\n")
+          end
+        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 __run_git("status", "--porcelain").empty?
+          abort "Won't release: Dirty index or untracked files present!"
+        end
+      end
+
+      task release_to: "git:tag"
+    end
+
+    def __git(command, *params)
+      "git #{command.shellescape} #{params.compact.shelljoin}"
+    end
+
+    def __run_git(command, *params)
+      `#{__git(command, *params)}`.strip.chomp
+    end
+
+    def git_svn?
+      File.exist?(File.join(__run_git("rev-parse", "--show-toplevel"), ".git/svn"))
+    end
+
+    def git_tag_and_push tag
+      msg = "Tagging #{tag}."
+
+      if git_svn?
+        sh __git("svn", "tag", tag, "-m", msg)
+      else
+        flags =
+          if __run_git("config", "--get", "user.signingkey").empty?
+            nil
+          else
+            "-s"
+          end
+
+        sh __git("tag", flags, "-f", tag, "-m", msg)
+        git_remotes.each { |remote| sh __git("push", "-f", remote, "tag", tag) }
+      end
+    end
+
+    def git_tags
+      if git_svn?
+        source = __run_git("config", "svn-remote.svn.tags")
+
+        unless source =~ %r{refs/remotes/(.*)/\*$}
+          abort "Can't discover git-svn tag scheme from #{source}"
+        end
+
+        prefix = $1
+
+        __run_git("branch", "-r")
+          .split($/)
+          .collect { |t| t.strip }
+          .select { |t| t =~ %r{^#{prefix}/#{git_release_tag_prefix}} }
+      else
+        flags = %w[--date-order --simplify-by-decoration --pretty=format:%H]
+        hashes = __run_git("log", *flags).split($/).reverse
+        names = __run_git("name-rev", "--tags", *hashes).split($/)
+        names = names.map { |s| s[/tags\/(v.+)/, 1] }.compact
+        names = names.map { |s| s.sub(/\^0$/, "") }
+        names.select { |t| t =~ %r{^#{git_release_tag_prefix}} }
+      end
+    end
+
+    def changelog_section(code)
+      name = {
+        major: "major enhancement",
+        minor: "minor enhancement",
+        bug: "bug fix",
+        unknown: "unknown"
+      }[code]
+
+      changes = $changes[code] # standard:disable Style/GlobalVars
+      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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: hoe-git2
+version: !ruby/object:Gem::Version
+  version: 1.7.0
+platform: ruby
+authors:
+- John Barnette
+- Austin Ziegler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe-doofus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: |-
+  A set of Hoe plugins for tighter Git integration. Provides tasks to automate release tagging and pushing and changelog
+  generation. I expect it'll learn a few more tricks in the future.
+
+  This is an evolution of +hoe-git+ by John Barnette, which has been archived at <http://github.com/jbarnette/hoe-git>.
+email:
+- jbarnette@rubyforge.org
+- halostatue@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/hoe/git2.rb
+homepage: http://github.com/halostatue/hoe-git
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/halostatue/hoe-git
+  documentation_uri: http://docs.seattlerb.org/hoe-git
+post_install_message:
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A set of Hoe plugins for tighter Git integration
+test_files: []