🔨 Galtzo FLOSS Rakefile v1.0.0

Author: Aboling0

Rakefile

@@ -1,5 +1,36 @@
 # frozen_string_literal: true
 
+# Galtzo FLOSS Rakefile v1.0 - 2025-08-12
+#
+# MIT License (see License.txt)
+#
+# Copyright (c) 2025 Peter H. Boling (galtzo.com)
+#
+# Expected to work in any project that uses Bundler.
+# Sets up tasks for rspec, minitest, rubocop, reek, yard, and stone_checksums.
+# rake build                            # Build my_gem-1.0.0.gem into the pkg directory
+# rake build:checksum                   # Generate SHA512 checksum of my_gem-1.0.0.gem into the checksums directory
+# rake build:generate_checksums         # Generate both SHA256 & SHA512 checksums into the checksums directory, and git commit them
+# rake bundle:audit:check               # Checks the Gemfile.lock for insecure dependencies
+# rake bundle:audit:update              # Updates the bundler-audit vulnerability database
+# rake clean                            # Remove any temporary products
+# rake clobber                          # Remove any generated files
+# rake coverage                         # Run specs w/ coverage and open results in browser
+# rake install                          # Build and install my_gem-1.0.0.gem into system gems
+# rake install:local                    # Build and install my_gem-1.0.0.gem into system gems without network access
+# rake reek                             # Check for code smells
+# rake reek:update                      # Run reek and store the output into the REEK file
+# rake release[remote]                  # Create tag v1.0.0 and build and push my_gem-1.0.0.gem to rubygems.org
+# rake rubocop                          # alias rubocop task to rubocop_gradual
+# rake rubocop_gradual                  # Run RuboCop Gradual
+# rake rubocop_gradual:autocorrect      # Run RuboCop Gradual with autocorrect (only when it's safe)
+# rake rubocop_gradual:autocorrect_all  # Run RuboCop Gradual with autocorrect (safe and unsafe)
+# rake rubocop_gradual:check            # Run RuboCop Gradual to check the lock file
+# rake rubocop_gradual:force_update     # Run RuboCop Gradual to force update the lock file
+# rake spec                             # Run RSpec code examples
+# rake test                             # Run tests / run spec task with test task
+# rake yard                             # Generate YARD Documentation
+
 require "bundler/gem_tasks"
 
 defaults = []
@@ -39,6 +70,7 @@ rescue LoadError
   end
 end
 
+# Setup RSpec
 begin
   require "rspec/core/rake_task"
 
@@ -52,6 +84,20 @@ rescue LoadError
   end
 end
 
+# Setup MiniTest
+begin
+  require "rake/testtask"
+
+  Rake::TestTask.new(:test) do |t|
+    t.test_files = FileList["tests/**/test_*.rb"]
+  end
+rescue LoadError
+  desc("test task stub")
+  task(:test) do
+    warn("NOTE: minitest isn't installed, or is disabled for #{RUBY_VERSION} in the current environment")
+  end
+end
+
 desc "run spec task with test task"
 task test: :spec
 
@@ -69,6 +115,40 @@ rescue LoadError
   end
 end
 
+# Setup Reek
+begin
+  require "reek/rake/task"
+
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = "{lib,spec,tests}/**/*.rb"
+  end
+
+  # Store current Reek output into REEK file
+  require "open3"
+  desc("Run reek and store the output into the REEK file")
+  task("reek:update") do
+    # Run via Bundler if available to ensure the right gem version is used
+    cmd = [Gem.bindir ? File.join(Gem.bindir, "bundle") : "bundle", "exec", "reek"]
+
+    output, status = Open3.capture2e(*cmd)
+
+    File.write("REEK", output)
+
+    # Mirror the failure semantics of the standard reek task
+    unless status.success?
+      abort("reek:update failed (reek reported smells). Output written to REEK")
+    end
+  end
+  defaults << "reek:update" unless is_ci
+rescue LoadError
+  desc("(stub) reek is unavailable")
+  task(:reek) do
+    warn("NOTE: reek isn't installed, or is disabled for #{RUBY_VERSION} in the current environment")
+  end
+end
+
 # Setup Yard
 begin
   require "yard"
@@ -82,6 +162,7 @@ begin
       "*.cff",
       "*.md",
       "*.txt",
+      "REEK",
     ]
   end
   defaults << "yard"
@@ -92,23 +173,6 @@ rescue LoadError
   end
 end
 
-# Setup Reek
-begin
-  require "reek/rake/task"
-
-  Reek::Rake::Task.new do |t|
-    t.fail_on_error = true
-    t.verbose = false
-    t.source_files = "{lib,spec}/**/*.rb"
-  end
-  defaults << "reek" unless is_ci
-rescue LoadError
-  desc("(stub) reek is unavailable")
-  task(:reek) do
-    warn("NOTE: reek isn't installed, or is disabled for #{RUBY_VERSION} in the current environment")
-  end
-end
-
 ### RELEASE TASKS
 # Setup stone_checksums
 begin