feat: RBS support

Author: Mattia Roccoberton

.github/workflows/specs.yml

@@ -32,4 +32,7 @@ jobs:
         run: cd spec/dummy_rails && bundle exec rails db:migrate
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        env:
+          RUBYOPT: '-rbundler/setup -rrbs/test/setup'
+          RBS_TEST_TARGET: 'TinyAdmin::*'
+        run: bin/rspec --profile

Gemfile

@@ -13,6 +13,8 @@ group :development, :test do
   gem 'warden'
   gem 'webrick'
 
+  gem 'rbs'
+
   # Testing
   gem 'capybara'
   gem 'capybara-screenshot'

Makefile

@@ -0,0 +1,8 @@
+lint:
+	bin/rubocop
+
+test:
+	bin/rspec
+
+test_rbs:
+	RUBYOPT='-rbundler/setup -rrbs/test/setup' RBS_TEST_TARGET='TinyAdmin::*' bin/rspec

bin/rbs

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rbs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rbs", "rbs")

sig/tiny_admin.rbs

@@ -0,0 +1,11 @@
+module TinyAdmin
+  VERSION: String
+
+  def configure: () { (Settings) -> untyped } -> untyped
+
+  def configure_from_file: (String) -> void
+
+  def route_for: (String, reference: String?, action: String?, query: String?) -> String
+
+  def settings: -> Settings
+end

sig/tiny_admin/actions/basic_action.rbs

@@ -0,0 +1,7 @@
+module TinyAdmin
+  module Actions
+    class BasicAction
+      def attribute_options: (Array[untyped]?) -> Hash[untyped, untyped]?
+    end
+  end
+end

sig/tiny_admin/actions/index.rbs

@@ -0,0 +1,26 @@
+module TinyAdmin
+  module Actions
+    class Index
+      attr_reader context: untyped
+      attr_reader current_page: Integer
+      attr_reader fields_options: untyped
+      attr_reader links: untyped
+      attr_reader options: untyped
+      attr_reader pagination: Integer
+      attr_reader pages: untyped
+      attr_reader params: untyped
+      attr_reader query_string: String
+      attr_reader repository: untyped
+
+      def call: (app: BasicApp, context: Context, options: Hash[Symbol, untyped]) -> void
+
+      private
+
+      def evaluate_options: (Hash[Symbol, untyped]) -> void
+
+      def prepare_filters: (Hash[untyped, untyped]) -> void
+
+      def setup_pagination: (untyped, untyped, total_count: Integer) -> void
+    end
+  end
+end

sig/tiny_admin/actions/show.rbs

@@ -0,0 +1,7 @@
+module TinyAdmin
+  module Actions
+    class Show
+      def call: (app: BasicApp, context: Context, options: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

sig/tiny_admin/authentication.rbs

@@ -0,0 +1,7 @@
+module TinyAdmin
+  class Authentication
+    private
+
+    def render_login: (?notices: Array[String]?, ?warnings: Array[String]?, ?errors: Array[String]?) -> void
+  end
+end

sig/tiny_admin/basic_app.rbs

@@ -0,0 +1,5 @@
+module TinyAdmin
+  class BasicApp
+    def self.authentication_plugin: () -> void
+  end
+end