build: refactor Rakefile by splitting tasks into separate files

jcouball · jcouball · commit bd69f9b6a482 · 2025-11-11T10:07:29.000-08:00
The monolithic 79-line Rakefile has been refactored into a clean
15-line loader that dynamically imports task definitions from the
tasks/ directory.

Changes:
- Created tasks/ directory with 5 focused rake files:
  - tasks/test.rake - test execution tasks
  - tasks/rubocop.rake - RuboCop linting tasks
  - tasks/yard.rake - YARD documentation tasks
  - tasks/gem_tasks.rake - gem building and release tasks
  - tasks/test_gem.rake - gem sanity check task

- Main Rakefile now:
  - Loads all .rake files from tasks/ directory
  - Dynamically builds default task list based on available tasks
  - Simplified from 79 lines to 15 lines

- Moved platform-specific logic (JRuby/TruffleRuby check) into
  yard.rake where it belongs

- Maintained all original functionality and default task behavior:
  - Default tasks: test, rubocop, yard, yardstick:coverage, build
  - yardstick remains commented out of defaults (too many warnings)

This refactoring improves maintainability and separation of concerns
while preserving all existing rake task functionality.
diff --git a/Rakefile b/Rakefile
@@ -1,79 +1,18 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'English'
+require 'rake/clean'
 
-require 'git/version'
+# Load all .rake files from tasks and its subdirectories.
+Dir.glob('tasks/**/*.rake').each { |r| load r }
 
 default_tasks = []
-
-desc 'Run Unit Tests'
-task :test do
-  sh 'ruby bin/test'
-
-  # You can run individual test files (or multiple files) from the command
-  # line with:
-  #
-  # $ bin/test test_archive.rb
-  #
-  # $ bin/test test_archive.rb test_object.rb
-end
-default_tasks << :test
-
-# Rubocop
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-default_tasks << :rubocop
-
-# YARD
-
-unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
-  #
-  # YARD documentation for this project can NOT be built with JRuby.
-  # This project uses the redcarpet gem which can not be installed on JRuby.
-  #
-  require 'yard'
-  YARD::Rake::YardocTask.new
-  CLEAN << '.yardoc'
-  CLEAN << 'doc'
-  default_tasks << :yard
-
-  require 'yardstick/rake/verify'
-  Yardstick::Rake::Verify.new(:'yardstick:coverage') do |t|
-    t.threshold = 50
-    t.require_exact_threshold = false
-  end
-  default_tasks << :'yardstick:coverage'
-
-  desc 'Run yardstick to check yard docs'
-  task :yardstick do
-    sh "yardstick 'lib/**/*.rb'"
-  end
-  # Do not include yardstick as a default task for now since there are too many
-  # warnings.  Will work to get the warnings down before re-enabling it.
-  #
-  # default_tasks << :yardstick
-end
-
-default_tasks << :build
+default_tasks << :test if Rake::Task.task_defined?(:test)
+default_tasks << :rubocop if Rake::Task.task_defined?(:rubocop)
+default_tasks << :yard if Rake::Task.task_defined?(:yard)
+default_tasks << :'yardstick:coverage' if Rake::Task.task_defined?(:'yardstick:coverage')
+# Do not include yardstick as a default task for now since there are too many
+# warnings. Will work to get the warnings down before re-enabling it.
+# default_tasks << :yardstick if Rake::Task.task_defined?(:yardstick)
+default_tasks << :build if Rake::Task.task_defined?(:build)
 
 task default: default_tasks
-
-desc 'Build and install the git gem and run a sanity check'
-task 'test:gem': :install do
-  output = `ruby -e "require 'git'; g = Git.open('.'); puts g.log.size"`.chomp
-  raise 'Gem test failed' unless $CHILD_STATUS.success?
-  raise 'Expected gem test to return an integer' unless output =~ /^\d+$/
-
-  puts 'Gem Test Succeeded'
-end
-
-# Make it so that calling `rake release` just calls `rake release:rubygem_push` to
-# avoid creating and pushing a new tag.
-
-Rake::Task['release'].clear
-desc 'Customized release task to avoid creating a new tag'
-task release: 'release:rubygem_push'
diff --git a/tasks/gem_tasks.rake b/tasks/gem_tasks.rake
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+# Make it so that calling `rake release` just calls `rake release:rubygem_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
diff --git a/tasks/rubocop.rake b/tasks/rubocop.rake
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
diff --git a/tasks/test.rake b/tasks/test.rake
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+desc 'Run Unit Tests'
+task :test do
+  sh 'ruby bin/test'
+
+  # You can run individual test files (or multiple files) from the command
+  # line with:
+  #
+  # $ bin/test test_archive.rb
+  #
+  # $ bin/test test_archive.rb test_object.rb
+end
diff --git a/tasks/test_gem.rake b/tasks/test_gem.rake
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'English'
+
+desc 'Build and install the git gem and run a sanity check'
+task 'test:gem': :install do
+  output = `ruby -e "require 'git'; g = Git.open('.'); puts g.log.size"`.chomp
+  raise 'Gem test failed' unless $CHILD_STATUS.success?
+  raise 'Expected gem test to return an integer' unless output =~ /^\d+$/
+
+  puts 'Gem Test Succeeded'
+end
diff --git a/tasks/yard.rake b/tasks/yard.rake
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# YARD documentation for this project can NOT be built with JRuby or TruffleRuby.
+# This project uses the redcarpet gem which can not be installed on JRuby.
+#
+unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  require 'yardstick/rake/verify'
+  Yardstick::Rake::Verify.new(:'yardstick:coverage') do |t|
+    t.threshold = 50
+    t.require_exact_threshold = false
+  end
+
+  desc 'Run yardstick to check yard docs'
+  task :yardstick do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+end
