Code review consensus from Tobi+Sandi: the empty-block call
'Opencode::Instrumentation.instrument(name, payload) { }' at fire-
and-forget call sites in opencode-rails is API smell. Tobi: 'two
named verbs are clearer than one verb with a vestigial block.'
Sandi: 'a method with a block parameter that's optional but expected
empty in some call sites is doing two things.'
Two emission shapes now:
.instrument(name, payload) { ... } # block; duration measured
.notify(name, payload) # fire-and-forget; no block
Both flow through the same adapter. The adapter still always
receives a block argument (some adapters key on it, e.g. AS::
Notifications.instrument requires a block) — .notify passes an
empty {}. Adapter return value is ignored for .notify (it returns
nil); .instrument continues to pass through the block's return.
Three new tests in smoke_test.rb:
- no-op when no adapter set
- forwards to adapter + verifies block presence + verifies that
.notify returns nil (not the adapter's return)
- works without a block at the call site
Also: switched gemspec metadata URLs from Gitea to GitHub. The gem
will eventually publish from github.com/ajaynomics/opencode-ruby —
the metadata now reflects that. (No actual GitHub remote push yet;
that's the user's manual step.)
15 tests pass, 32 assertions, 0 failures.
46 lines
2.0 KiB
Ruby
46 lines
2.0 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative "lib/opencode/version"
|
|
|
|
Gem::Specification.new do |spec|
|
|
spec.name = "opencode-ruby"
|
|
spec.version = Opencode::VERSION
|
|
spec.authors = ["Ajay Krishnan"]
|
|
spec.email = ["ajay@krishnan.ca"]
|
|
|
|
spec.summary = "Idiomatic Ruby client for OpenCode (HTTP + SSE)."
|
|
spec.description = <<~DESC
|
|
Hand-rolled, opinionated Ruby SDK for OpenCode's REST + SSE API.
|
|
Block-form streaming, value-object responses, automatic SSE
|
|
reconnection. Complement to opencode_client (auto-generated from
|
|
OpenAPI) — pick this one if you want a small Ruby-idiomatic surface;
|
|
pick opencode_client if you want every endpoint with generated types.
|
|
DESC
|
|
spec.homepage = "https://github.com/ajaynomics/opencode-ruby"
|
|
spec.license = "MIT"
|
|
spec.required_ruby_version = ">= 3.2.0"
|
|
|
|
spec.metadata["homepage_uri"] = spec.homepage
|
|
spec.metadata["source_code_uri"] = spec.homepage
|
|
spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
|
|
spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
|
|
|
|
spec.files = Dir.glob("lib/**/*.rb") +
|
|
Dir.glob("examples/**/*.rb") +
|
|
%w[README.md LICENSE CHANGELOG.md opencode-ruby.gemspec]
|
|
spec.require_paths = ["lib"]
|
|
|
|
# The only runtime dependency is ActiveSupport (NOT Rails). ActiveSupport
|
|
# is a standalone gem providing the `present?`/`blank?`/`presence`/
|
|
# `truncate`/`duplicable?` helpers used in this gem's code. It does NOT
|
|
# pull in ActiveRecord, ActionView, ActionController, Turbo, or any other
|
|
# Rails-only piece. Most Ruby apps in the wild already have ActiveSupport
|
|
# transitively via another gem; in the rare case yours doesn't, ~250 LOC
|
|
# of core_ext is added when this gem installs.
|
|
spec.add_runtime_dependency "activesupport", ">= 6.1", "< 9.0"
|
|
|
|
spec.add_development_dependency "minitest", "~> 5.20"
|
|
spec.add_development_dependency "rake", "~> 13.0"
|
|
spec.add_development_dependency "webmock", "~> 3.20"
|
|
end
|