636e494068
## Motivation and Context The documentation site under `docs/` had no development command: previewing a change meant hand-assembling a Jekyll environment, since the site only builds for real when a release publishes it through `bin/generate-gh-pages.sh` and the GitHub Pages runtime. `rake docs:preview` now builds and serves the site at http://localhost:4000 (override with `PORT`), with watch-based rebuilds on edit. The preview dependencies live in their own `docs/Gemfile` rather than the gem's Gemfile: `github-pages` mirrors the runtime that builds the released site (jekyll-remote-theme, jekyll-redirect-from, and the Jekyll version Pages actually runs), which keeps the preview faithful but is far too heavy to impose on the gem itself. The task subshells into that bundle with `Bundler.with_unbundled_env`, the same delegation shape the conformance tasks use for npx. Two support pieces keep the pinned toolchain running on current Ruby. `docs/_preview/taint_shim.rb` restores the taint API as no-ops: Liquid 4.0.3 calls `obj.tainted?` on every variable render, ahead of its own lax-mode check (`liquid/variable.rb:124`), so on Ruby 3.2 and later, where the taint API was removed, the first layout render dies with NoMethodError, while on Ruby 3.1 and earlier the methods still exist as deprecated no-ops and the shim is inert. The shim is loaded only into the preview process via RUBYOPT. The former default gems the pinned Jekyll expects are listed in the docs Gemfile. The task also regenerates `docs/_data/versions.yml` from the version tags, mirroring what `bin/generate-gh-pages.sh` produces at deploy time, so the nav footer shows the released-gem version line exactly as it does on the published site. Build products and the generated data file are ignored. ## How Has This Been Tested? By running the task on a spare port and verifying the served pages, the footer's version line, and that a SIGINT stops it cleanly with exit 0; `git status` stays clean while it runs (all build products ignored). Verified on both Ruby 3.1.5 (shim inert) and Ruby 4.0.6, where a shimless build reproduces the NoMethodError and the task runs green with the shim. RuboCop and the full suite are green. ## Breaking Changes None. The task and its Gemfile are development-only additions; the gem and its dependencies are untouched.
95 lines
3 KiB
Ruby
95 lines
3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "bundler/gem_tasks"
|
|
require "rake/testtask"
|
|
|
|
Rake::TestTask.new(:test) do |t|
|
|
t.ruby_opts = ["-W0", "-W:deprecated"]
|
|
t.libs << "test"
|
|
t.libs << "lib"
|
|
t.test_files = FileList["test/**/*_test.rb"]
|
|
end
|
|
|
|
require "rubocop/rake_task"
|
|
|
|
RuboCop::RakeTask.new
|
|
|
|
task default: [:rubocop, :test, :conformance]
|
|
|
|
desc "Run MCP conformance tests (PORT, SCENARIO, SPEC_VERSION, VERBOSE)"
|
|
task :conformance do |t|
|
|
next unless npx_available?(t.name)
|
|
|
|
require_relative "conformance/server_runner"
|
|
require_relative "conformance/client_runner"
|
|
|
|
options = {}
|
|
options[:port] = Integer(ENV["PORT"]) if ENV["PORT"]
|
|
options[:scenario] = ENV["SCENARIO"] if ENV["SCENARIO"]
|
|
options[:spec_version] = ENV["SPEC_VERSION"] if ENV["SPEC_VERSION"]
|
|
options[:verbose] = true if ENV["VERBOSE"]
|
|
|
|
Conformance::ServerRunner.new(**options).run
|
|
Conformance::ClientRunner.new(**options.reject { |key, _value| key == :port }).run
|
|
end
|
|
|
|
desc "List available conformance scenarios"
|
|
task :conformance_list do |t|
|
|
next unless npx_available?(t.name)
|
|
|
|
system("npx", "--yes", "@modelcontextprotocol/conformance", "list", "--server")
|
|
system("npx", "--yes", "@modelcontextprotocol/conformance", "list", "--client")
|
|
end
|
|
|
|
desc "Start the conformance server (PORT)"
|
|
task :conformance_server do
|
|
require_relative "conformance/server"
|
|
|
|
options = {}
|
|
options[:port] = Integer(ENV["PORT"]) if ENV["PORT"]
|
|
|
|
Conformance::Server.new(**options).start
|
|
end
|
|
|
|
namespace :docs do
|
|
desc "Serve the documentation site locally at http://localhost:4000 (PORT)"
|
|
task :preview do
|
|
docs_dir = File.expand_path("docs", __dir__)
|
|
generate_docs_versions_data(docs_dir)
|
|
|
|
env = {
|
|
"BUNDLE_GEMFILE" => File.join(docs_dir, "Gemfile"),
|
|
"RUBYOPT" => "-r#{File.join(docs_dir, "_preview", "taint_shim.rb")}",
|
|
}
|
|
port = ENV.fetch("PORT", "4000")
|
|
|
|
Bundler.with_unbundled_env do
|
|
system(env, "bundle", "install", "--quiet", chdir: docs_dir, exception: true)
|
|
system(env, "bundle", "exec", "jekyll", "serve", "--port", port, chdir: docs_dir, exception: true)
|
|
rescue Interrupt
|
|
# Ctrl-C is the way to stop the preview, not an error.
|
|
end
|
|
end
|
|
end
|
|
|
|
# Mirrors bin/generate-gh-pages.sh: the released site receives `_data/versions.yml` from
|
|
# the version tags at deploy time, and the preview generates the same data so the nav footer
|
|
# shows the released-gem version line.
|
|
def generate_docs_versions_data(docs_dir)
|
|
versions = %x(git tag --list).split("\n").filter_map { |tag|
|
|
tag[/\A[^0-9]*(\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?)\z/, 1]
|
|
}.sort_by { |version|
|
|
Gem::Version.new(version)
|
|
}.reverse
|
|
return if versions.empty?
|
|
|
|
mkdir_p(File.join(docs_dir, "_data"))
|
|
File.write(File.join(docs_dir, "_data", "versions.yml"), versions.map { |version| "- #{version}\n" }.join)
|
|
end
|
|
|
|
def npx_available?(task_name)
|
|
return true if system("which", "npx", out: File::NULL, err: File::NULL)
|
|
|
|
warn("Skipping #{task_name}: npx is not installed. Install Node.js to run this task: https://nodejs.org/")
|
|
false
|
|
end
|