Merge pull request #37 from blocknotes/feat/rbs

feat: RBS support

Author: blocknotes

.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")

lib/tiny_admin/actions/index.rb

@@ -58,12 +58,12 @@ def prepare_filters(fields)
         end
       end
 
-      def setup_pagination(page, pagination_component_class, total_count:)
+      def setup_pagination(page, pagination_component, total_count:)
         @pages = (total_count / pagination.to_f).ceil
-        return if pages <= 1 || !pagination_component_class
+        return if pages <= 1 || !pagination_component
 
         attributes = { current: current_page, pages: pages, query_string: query_string, total_count: total_count }
-        page.pagination_component = pagination_component_class.new
+        page.pagination_component = pagination_component.new
         page.pagination_component.update_attributes(attributes)
       end
     end

lib/tiny_admin/router.rb

@@ -53,37 +53,37 @@ def render_page(page)
       render(inline: page.call)
     end
 
-    def root_route(router)
+    def root_route(req)
       if TinyAdmin.settings.root[:redirect]
-        router.redirect route_for(TinyAdmin.settings.root[:redirect])
+        req.redirect route_for(TinyAdmin.settings.root[:redirect])
       else
         page_class = to_class(TinyAdmin.settings.root[:page])
         attributes = TinyAdmin.settings.root.slice(:content, :title, :widgets)
         render_page prepare_page(page_class, attributes: attributes, params: request.params)
       end
     end
 
-    def setup_page_route(router, slug, page_data)
-      router.get slug do
+    def setup_page_route(req, slug, page_data)
+      req.get slug do
         attributes = page_data.slice(:content, :title, :widgets)
         render_page prepare_page(page_data[:class], slug: slug, attributes: attributes, params: request.params)
       end
     end
 
-    def setup_resource_routes(router, slug, options:)
-      router.on slug do
-        setup_collection_routes(router, slug, options: options)
-        setup_member_routes(router, slug, options: options)
+    def setup_resource_routes(req, slug, options:)
+      req.on slug do
+        setup_collection_routes(req, slug, options: options)
+        setup_member_routes(req, slug, options: options)
       end
     end
 
-    def setup_collection_routes(router, slug, options:)
+    def setup_collection_routes(req, slug, options:)
       repository = options[:repository].new(options[:model])
       action_options = options[:index] || {}
 
       # Custom actions
       custom_actions = setup_custom_actions(
-        router,
+        req,
         options[:collection_actions],
         options: action_options,
         repository: repository,
@@ -92,12 +92,12 @@ def setup_collection_routes(router, slug, options:)
 
       # Index
       if options[:only].include?(:index) || options[:only].include?('index')
-        router.is do
+        req.is do
           context = Context.new(
             actions: custom_actions,
             repository: repository,
             request: request,
-            router: router,
+            router: req,
             slug: slug
           )
           index_action = TinyAdmin::Actions::Index.new
@@ -106,14 +106,14 @@ def setup_collection_routes(router, slug, options:)
       end
     end
 
-    def setup_member_routes(router, slug, options:)
+    def setup_member_routes(req, slug, options:)
       repository = options[:repository].new(options[:model])
       action_options = (options[:show] || {}).merge(record_not_found_page: TinyAdmin.settings.record_not_found)
 
-      router.on String do |reference|
+      req.on String do |reference|
         # Custom actions
         custom_actions = setup_custom_actions(
-          router,
+          req,
           options[:member_actions],
           options: action_options,
           repository: repository,
@@ -123,13 +123,13 @@ def setup_member_routes(router, slug, options:)
 
         # Show
         if options[:only].include?(:show) || options[:only].include?('show')
-          router.is do
+          req.is do
             context = Context.new(
               actions: custom_actions,
               reference: reference,
               repository: repository,
               request: request,
-              router: router,
+              router: req,
               slug: slug
             )
             show_action = TinyAdmin::Actions::Show.new
@@ -139,18 +139,18 @@ def setup_member_routes(router, slug, options:)
       end
     end
 
-    def setup_custom_actions(router, custom_actions, options:, repository:, slug:, reference: nil)
+    def setup_custom_actions(req, custom_actions = nil, options:, repository:, slug:, reference: nil)
       (custom_actions || []).each_with_object({}) do |custom_action, result|
         action_slug, action = custom_action.first
         action_class = to_class(action)
 
-        router.get action_slug.to_s do
+        req.get action_slug.to_s do
           context = Context.new(
             actions: {},
             reference: reference,
             repository: repository,
             request: request,
-            router: router,
+            router: req,
             slug: slug
           )
           custom_action = action_class.new

lib/tiny_admin/views/actions/index.rb

@@ -4,7 +4,14 @@ module TinyAdmin
   module Views
     module Actions
       class Index < DefaultLayout
-        attr_accessor :actions, :fields, :filters, :links, :pagination_component, :prepare_record, :records, :slug
+        attr_accessor :actions,
+                      :fields,
+                      :filters,
+                      :links,
+                      :pagination_component,
+                      :prepare_record,
+                      :records,
+                      :slug
 
         def template
           super do

lib/tiny_admin/views/actions/show.rb

@@ -4,7 +4,12 @@ module TinyAdmin
   module Views
     module Actions
       class Show < DefaultLayout
-        attr_accessor :actions, :fields, :prepare_record, :record, :reference, :slug
+        attr_accessor :actions,
+                      :fields,
+                      :prepare_record,
+                      :record,
+                      :reference,
+                      :slug
 
         def template
           super do

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