Add RBS & Steep

.github/workflows/test.yml → .github/workflows/ci.yml

@@ -1,10 +1,10 @@
-name: Test
+name: CI
 
 on:
   push:
 
 jobs:
-  rspec:
+  test:
     runs-on: ubuntu-latest
 
     strategy:
@@ -23,3 +23,17 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rake test
+
+  steep:
+    name: Type check (Steep)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4.4'
+          bundler-cache: true
+
+      - run: bundle exec steep check

Steepfile

@@ -0,0 +1,5 @@
+target :lib do
+  signature "sig"
+
+  check "lib"
+end

lib/predicateable.rb

@@ -13,7 +13,8 @@ def predicate(name, values, prefix: false, strict: false)
         method = prefix ? "#{name}_#{value}?" : "#{value}?"
 
         define_method(method) do
-          actual = send(name)
+          # @type self: Object
+          actual = public_send(name)
 
           if strict
             actual == value

predicateable.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.22"
+  spec.add_development_dependency "rbs",   "~> 3.9"
+  spec.add_development_dependency "steep", "~> 1.10"
 end

sig/predicateable.rbs

@@ -1,4 +1,12 @@
 module Predicateable
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  def self.included: (Module base) -> void
+
+  module ClassMethods : Module
+    def predicate: (
+      Symbol | String name,
+      Array[Symbol | String] values,
+      ?prefix: bool,
+      ?strict: bool
+    ) -> Array[Symbol | String]
+  end
 end

sig/predicateable/version.rbs

@@ -0,0 +1,3 @@
+module Predicateable
+  VERSION: String
+end