rubygems-tasks 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be886af586a0508f6dbe548247677067920db2f38b4590c4cd54f3b96b0449ee
-  data.tar.gz: 7d3c7deb140448cfebfba8ebbf184eccfe4bc167823f2088192c5e4f0f69acc3
+  metadata.gz: 4c796aef54b6d54c6c4afcf50f0588ee2204a5fae8527cee9c4a53f1881bf32d
+  data.tar.gz: 275002c2d14b8d6198c23cafb9a348742117fb32addcec9bb9ce879a18d57161
 SHA512:
-  metadata.gz: a5906ece048555085e8ec9b5959f262c3d642ee28d8001f8f42221ce53a1c76e39ce41a5e18cdafae1c8ed67fa1ef97b009a28f66b0223c117efba4d78e44f7c
-  data.tar.gz: '038f3abd105da7c5705632c4e65dc3d268567da424bb5e74411b667b93a940a3ff563a801e2ddee32959d7514e4ba821b39e8db0797fce7819814cd8498b2b9a'
+  metadata.gz: 322f40592b51da34f2d6c651214b84b8d5a2e97d49bf9e4b30a1c8a808a2e50698058544e65ff5904edee1ffd13fbc639e211d0132dc12610c9732a117349fa7
+  data.tar.gz: b8ecbb198b85d8163ea41c591b8c00efab9ad3c007946316743c35918c166078c5d4a20ee8df3da4496027dd2cd5e3aaa22f79998e21df5250b5a5d7bd240cb8

data/.github/workflows/ruby.yml

@@ -9,9 +9,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.0
-          - 3.1
-          - 3.2
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
+          - '3.5'
+          - '4.0'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}

data/ChangeLog.md

@@ -1,3 +1,18 @@
+### 0.3.0 / 2025-11-28
+
+* Added support for Ruby 3.5 and 4.0.
+* Fixed `ostruct` warnings by refactoring code to use plain-Ruby classes
+  instead of `OpenStruct`.
+* {Gem::Tasks::Build} is now a class that can be initialized and will
+  define all `build:` sub-tasks.
+* {Gem::Tasks::SCM} is now a class that can be initialized and will define
+  all `scm:` sub-tasks.
+* {Gem::Tasks::Sign} is now a class that can be initialized and will define
+  all `sign:` sub-tasks.
+* {Gem::Tasks::Push#initialize} now accepts the `key:` keyword argument.
+* Switched to keyword arguments.
+* Added `frozen_string_literal: true` to all files.
+
 ### 0.2.6 / 2023-09-07
 
 * Fixed `rake install` so that it runs `gem install -q pkg/...` outside of the

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 group :development do
   gem 'rake'
   gem 'rspec',          '~> 3.0'
+  gem 'redcarpet',      platform: :mri
   gem 'kramdown'
   gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2020 Hal Brodigan
+Copyright (c) 2011-2025 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,125 +4,158 @@
 [![Code Climate](https://codeclimate.com/github/postmodern/rubygems-tasks.svg)](https://codeclimate.com/github/postmodern/rubygems-tasks)
 
 * [Source](https://github.com/postmodern/rubygems-tasks)
-* [Issues](https://github.com/postmodern/rubygems-tasks/issues)
-* [Email](mailto:postmodern.mod3 at gmail.com)
+* [Forum](https://github.com/postmodern/rubygems-tasks/discussions) |
+  [Issues](https://github.com/postmodern/rubygems-tasks/issues)
+* [Documentation](https://rubydoc.info/gems/rubygems-tasks)
 
 ## Description
 
-rubygems-tasks provides agnostic and unobtrusive Rake tasks for building,
-installing and releasing Ruby Gems.
+rubygems-tasks provides [Rake] tasks for building and releasing Ruby Gems.
+rubygems-tasks can be added to any Ruby project that has a `Rakefile` and a
+`.gemspec` file.
 
-    require 'rubygems/tasks'
-    Gem::Tasks.new
+## Features
 
-## Philosophy
+* Provides [Rake] tasks to build, install, or release gem packages to
+  [rubygems.org].
+* Supports pushing gem packages to internal [gem servers].
+* Additionally supports creating `.tar.gz` of `.zip` source archives.
+* Loads all project metadata from the `.gemspec` file.
+* Supports Ruby projects with multiple `.gemspec` files.
+* Supports [Git], [Mercurial], [SubVersion], or even no SCM at all.
+* Enforces important safety checks:
+  * Checks for uncommitted changes before building a gem.
+  * Pushes all commits and tags before pushing a gem.
+* Provides additional enhanced security features:
+  * Supports optionally creating PGP signed [Git] or [Mercurial] tags.
+  * Supports optionally generating checksums or PGP signatures of the `.gem`
+    package.
 
-The Rake tasks which you use to manage a Ruby project should not be coupled
-to the project generator which you used to create the project.
-Project generators have nothing to do with the Rake tasks used to build,
-install and release a Ruby project.
+## Requirements
 
-Recently, many Ruby Developers began creating Ruby projects by hand,
-building/releasing RubyGems using `gem build` / `gem push`. Sometimes this
-resulted in RubyGems being released with uncommitted changes, or the developer
-forgetting to tag the release. Ruby Developers should have access to
-**agnostic** and **unobtrusive** Rake tasks, to **automate** the release
-process.
+* [ruby] >= 2.0.0
+* [rake] >= 10.0.0
+* [irb] ~> 1.0
 
-This is what rubygems-tasks seeks to provide.
+## Install
 
-## Features
+1. Add the following to the `Gemfile`:
 
-* Provides tasks to build, install and push gems to [rubygems.org].
-  * Loads all project metadata from the `.gemspec` file.
-  * Supports loading multiple `.gemspec` files.
-  * Supports pushing gems to alternate [gem server]s.
-* Supports optionally building `.tar.gz` and `.zip` archives.
-  * `build:tar`
-  * `build:zip`
-* Supports [Git], [Mercurial] and [SubVersion] Source-Code-Managers
-  (SCMs).
-  * Supports creating PGP signed Git/Mercurial tags.
-* Provides optional `sign` tasks for package integrity:
-  * `sign:checksum`
-  * `sign:pgp`
-* Provides a `console` task, for jumping right into your code.
-* Defines task aliases for users coming from [Jeweler] or [Hoe].
-* ANSI coloured messages!
-
-## Anti-Features
-
-* **Does not** parse project metadata from the README or the ChangeLog.
-* **Does not** generate or modify code.
-* **Does not** automatically commit changes.
-* **Does not** inject dependencies into gems.
-* **Zero** dependencies.
+```ruby
+gem 'rubygems-tasks', '~> 0.3', require: false
+```
 
-## Requirements
+2. Add the following to the `Rakefile`:
 
-* [ruby] >= 2.0.0
-* [rake]
+```ruby
+require 'rubygems/tasks'
+Gem::Tasks.new
+```
 
-## Install
+## Synopsis
 
-    $ gem install rubygems-tasks
+```
+rake build    # Builds all packages
+rake console  # Spawns an Interactive Ruby Console
+rake install  # Installs all built gem packages
+rake release  # Performs a release
+```
+
+Perform a test build of the project and write all build artifacts to the
+`pkg/` directory:
+
+```
+$ rake build
+```
+
+Jump into IRB with the Ruby library preloaded:
+
+```
+$ rake console
+irb(main):001>
+```
+
+Build and install the Ruby gem locally:
+
+```
+$ rake install
+```
+
+Build, tag, and release a new version:
+
+```
+$ rake release
+```
 
 ## Examples
 
-Specifying an alternate Ruby Console to run:
+Default configuration:
 
-    Gem::Tasks.new do |tasks|
-      tasks.console.command = 'pry'
-    end
+```ruby
+require 'rubygems/tasks'
+Gem::Tasks.new
+```
 
-Enable pushing gems to an in-house [gem server]:
+Change the Ruby REPL for the `console` [Rake] task:
 
-    Gem::Tasks.new do |tasks|
-      tasks.push.host = 'gems.company.com'
-    end
+```ruby
+Gem::Tasks.new do |tasks|
+  tasks.console.command = 'pry'
+end
+```
 
-Disable the `push` task:
+Enable pushing gems to an internal [gem server] instead of [rubygems.org]:
 
-    Gem::Tasks.new(push: false)
+```ruby
+Gem::Tasks.new do |tasks|
+  tasks.push.host = 'gems.company.internal'
+end
+```
 
-Enable building `.tar.gz` and `.zip` archives:
+Disable the `push` [Rake] task:
 
-    Gem::Tasks.new(build: {tar: true, zip: true})
+```ruby
+Gem::Tasks.new(push: false)
+```
 
-Enable Checksums and PGP signatures for built packages:
+Enable building `.tar.gz` and `.zip` source archives, in addition to the `.gem`
+package:
 
-    Gem::Tasks.new(sign: {checksum: true, pgp: true})
+```ruby
+Gem::Tasks.new(build: {tar: true, zip: true})
+```
 
-Selectively defining tasks:
+Enable generating checksums and PGP signatures for built packages:
 
-    Gem::Tasks::Build::Tar.new
-    Gem::Tasks::SCM::Status.new
-    Gem::Tasks::SCM::Tag.new(format: 'REL-%s')
-    Gem::Tasks::Sign::Checksum.new
-    Gem::Tasks::Console.new
+```ruby
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
+```
 
-## Synopsis
+Selectively defining specific [Rake] tasks:
 
-    rake build    # Builds all packages
-    rake console  # Spawns an Interactive Ruby Console
-    rake install  # Installs all built gem packages
-    rake release  # Performs a release
+```ruby
+Gem::Tasks::Build::Tar.new
+Gem::Tasks::SCM::Status.new
+Gem::Tasks::SCM::Tag.new(format: 'REL-%s')
+Gem::Tasks::Sign::Checksum.new
+Gem::Tasks::Console.new
+```
 
 ## Copyright
 
-Copyright (c) 2011-2020 Hal Brodigan
+Copyright (c) 2011-2025 Hal Brodigan
 
 See {file:LICENSE.txt} for details.
 
-[Git]: http://git-scm.com/
-[Mercurial]: http://mercurial.selenic.com/
-[SubVersion]: http://subversion.tigris.org/
+[Git]: https://git-scm.com/
+[Mercurial]: https://www.mercurial-scm.org/
+[SubVersion]: https://subversion.apache.org/
 
-[Jeweler]: https://github.com/technicalpickles/jeweler#readme
-[Hoe]: https://github.com/seattlerb/hoe#readme
+[Rake]: https://github.com/ruby/rake#readme
 
 [rubygems.org]: https://rubygems.org/
 [gem server]: https://github.com/rubygems/rubygems.org#readme
 
 [ruby]: https://www.ruby-lang.org/
 [rake]: https://rubygems.org/gems/rake
+[irb]: https://rubygems.org/gems/irb

data/gemspec.yml

@@ -1,8 +1,10 @@
 name: rubygems-tasks
-version: 0.2.6
-summary: Rake tasks for managing and releasing Ruby Gems.
+version: 0.3.0
+summary: Rake tasks for building and releasing Ruby Gems.
 description: |
-  Agnostic and unobtrusive Rake tasks for managing and releasing Ruby Gems.
+  rubygems-tasks provides agnostic and unobtrusive Rake tasks for building and
+  releasing Ruby Gems. rubygems-tasks can be used in any existing Ruby project
+  that has a .gemspec file.
 
 authors: Postmodern
 license: MIT
@@ -23,4 +25,4 @@ dependencies:
   irb: ~> 1.0
 
 development_dependencies:
-  bundler: ~> 2.0
+  bundler: ">= 2.0.0"

data/lib/rubygems/tasks/build/gem.rb

@@ -1,4 +1,6 @@
-require 'rubygems/tasks/build/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 if Gem::VERSION > '2.' then require 'rubygems/package'
 else                        require 'rubygems/builder'
@@ -6,7 +8,7 @@ end
 
 module Gem
   class Tasks
-    module Build
+    class Build
       #
       # The `build:gem` task.
       #
@@ -15,10 +17,7 @@ module Gem
         #
         # Initializes the `build:gem` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?

data/lib/rubygems/tasks/build/tar.rb

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/build/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
-    module Build
+    class Build
       #
       # The `build:tar` task.
       #
@@ -11,10 +13,7 @@ module Gem
         #
         # Initializes the `build:tar` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?

data/lib/rubygems/tasks/build/task.rb

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative '../task'
 
 module Gem
   class Tasks
-    module Build
+    class Build
       class Task < Tasks::Task
 
         #

data/lib/rubygems/tasks/build/zip.rb

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/build/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
-    module Build
+    class Build
       #
       # The `build:zip` task.
       #
@@ -11,10 +13,7 @@ module Gem
         #
         # Initializes the `build:zip` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?

data/lib/rubygems/tasks/build.rb

@@ -1,3 +1,61 @@
-require 'rubygems/tasks/build/tar'
-require 'rubygems/tasks/build/gem'
-require 'rubygems/tasks/build/zip'
+# frozen_string_literal: true
+
+require_relative 'build/tar'
+require_relative 'build/gem'
+require_relative 'build/zip'
+
+module Gem
+  class Tasks
+    #
+    # Collection of all `build:*` tasks.
+    #
+    # * {Build::Gem build:gem}
+    # * {Build::Tar build:tar}
+    # * {Build::Zip build:zip}
+    #
+    class Build
+
+      # The {Gem build:gem} task.
+      #
+      # @return [Gem, nil]
+      #
+      # @since 0.3.0
+      attr_reader :gem
+
+      # The {Tar build:tar} task.
+      #
+      # @return [Tar, nil]
+      #
+      # @since 0.3.0
+      attr_reader :tar
+
+      # The {Zip build:zip} task.
+      #
+      # @return [Zip, nil]
+      #
+      # @since 0.3.0
+      attr_reader :zip
+
+      #
+      # Initializes the `build:` tasks.
+      #
+      # @param [Boolean] gem
+      #   Enables or disables the {Build::Gem build:gem} task.
+      #
+      # @param [Boolean] tar
+      #   Enables or disables the {Build::Tar build:tar} task.
+      #
+      # @param [Boolean] zip
+      #   Enables or disables the {Build::Zip build:zip} task.
+      #
+      # @since 0.3.0
+      #
+      def initialize(gem: true, tar: nil, zip: nil)
+        @gem = Gem.new if gem
+        @tar = Tar.new if tar
+        @zip = Zip.new if zip
+      end
+
+    end
+  end
+end

data/lib/rubygems/tasks/console.rb

@@ -1,4 +1,6 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
@@ -14,28 +16,29 @@ module Gem
       DEFAULT_COMMAND = (ENV['RUBYCONSOLE'] || DEFAULT_CONSOLE)
 
       # The Ruby Console command
+      #
+      # @return [String]
       attr_accessor :command
 
       # Additional options for the Ruby Console
+      #
+      # @return [Array<String>]
       attr_accessor :options
 
       #
       # Initializes the `console` task.
       #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [String] :command (DEFAULT_COMMAND)
+      # @param [String] command
       #   The Ruby Console command to run.
       #
-      # @option options [Array] :options
+      # @param [Array<String>] options
       #   Additional options for the Ruby Console.
       #
-      def initialize(options={})
+      def initialize(command: DEFAULT_COMMAND, options: [])
         super()
 
-        @command = options.fetch(:command,DEFAULT_COMMAND)
-        @options = Array(options[:options])
+        @command = command
+        @options = options
 
         yield self if block_given?
         define

data/lib/rubygems/tasks/install.rb

@@ -1,4 +1,6 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
@@ -10,10 +12,7 @@ module Gem
       #
       # Initializes the `install` task.
       #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      def initialize(options={})
+      def initialize
         super()
 
         yield self if block_given?

data/lib/rubygems/tasks/printing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gem
   class Tasks
     #

data/lib/rubygems/tasks/project.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Gem
   class Tasks
     #
-    # @api semipublic
+    # @api private
     #
     class Project
 

data/lib/rubygems/tasks/push.rb

@@ -1,4 +1,6 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
@@ -8,21 +10,31 @@ module Gem
     class Push < Task
 
       # The rubygems host to push gems to.
+      #
+      # @return [String, nil]
       attr_accessor :host
 
+      # The rubygems API key.
       #
-      # Initializes the `push` task.
+      # @return [String, nil]
       #
-      # @param [Hash] options
-      #   Additional options.
+      # @since 0.3.0
+      attr_accessor :key
+
       #
-      # @option options [String] :host
+      # Initializes the `push` task.
+      #
+      # @param [String, nil] host
       #   The rubygems host to push gems to.
       #
-      def initialize(options={})
+      # @param [String, nil] key
+      #   An optional rubygems API key.
+      #
+      def initialize(host: nil, key: nil)
         super()
 
-        @host = options[:host]
+        @host = host
+        @key  = key
 
         yield self if block_given?
         define
@@ -69,6 +81,7 @@ module Gem
       #
       def push(path)
         arguments = ['gem', 'push', path]
+        arguments.push('--key',   @key) if @key
         arguments.push('--host', @host) if @host
 
         return run(*arguments)

data/lib/rubygems/tasks/release.rb

@@ -1,4 +1,6 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
@@ -10,10 +12,7 @@ module Gem
       #
       # Initializes the `release` task.
       #
-      # @param [Hash] options
-      #   Additional options for the `release` task.
-      #
-      def initialize(options={})
+      def initialize
         super()
 
         yield self if block_given?

data/lib/rubygems/tasks/scm/push.rb

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative '../task'
 
 module Gem
   class Tasks
-    module SCM
+    class SCM
       #
       # The `scm:push` task.
       #
@@ -11,10 +13,7 @@ module Gem
         #
         # Initializes the `scm:push` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?