Add RBS signature and testing (#25)

* Add RBS signature and testing

* Automated annotation

Author: ksss

.github/workflows/sig.yml

@@ -0,0 +1,20 @@
+name: sig
+
+on: [push, pull_request]
+
+jobs:
+  sig:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+      - name: Install dependencies
+        run: |
+          bundle config set with 'sig'
+          bundle install
+      - name: Run RBS test, annotate and confirm
+        run: bundle exec rake rbs:{test,annotate,confirm}

.github/workflows/test.yml

@@ -27,6 +27,8 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
-      run: bundle install
+      run: |
+        bundle config set without 'sig'
+        bundle install
     - name: Run test
       run: rake test

Gemfile

@@ -2,3 +2,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "test-unit"
+
+group :sig do
+  gem "rbs"
+  gem "rdoc", "<= 6.11"
+end

Rakefile

@@ -7,4 +7,25 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+namespace :rbs do
+  task :test do
+    sh "ruby -I lib test_sig/test_base64.rb"
+  end
+
+  task :annotate do
+    require "tmpdir"
+    require "pathname"
+
+    Dir.mktmpdir do |tmpdir|
+      system("rdoc --ri --output #{tmpdir}/doc --root=. lib")
+      system("rbs annotate --no-system --no-gems --no-site --no-home -d #{tmpdir}/doc sig")
+    end
+  end
+
+  task :confirm do
+    puts "Testing if RBS docs are updated with respect to RDoc"
+    sh "git diff --exit-code sig/"
+  end
+end
+
 task :default => :test

base64.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = spec.homepage + "/releases"
 
-  spec.files         = ["README.md", "BSDL", "COPYING", "LEGAL", "lib/base64.rb"]
+  spec.files         = ["README.md", "BSDL", "COPYING", "LEGAL", "lib/base64.rb", "sig/base64.rbs"]
   spec.bindir        = "exe"
   spec.executables   = []
   spec.require_paths = ["lib"]