rest_framework 1.0.2 → 1.2.0

data/lib/rest_framework/paginators/page_number_paginator.rb

@@ -13,22 +13,21 @@ class RESTFramework::Paginators::PageNumberPaginator < RESTFramework::Paginators
   end
 
   def _page_size
-    page_size = 1
+    page_size = nil
 
-    # Get from context, if allowed.
+    # Get from query param, if allowed.
     if param = @controller.class.page_size_query_param
-      if page_size = @controller.params[param].presence
-        page_size = page_size.to_i
+      if raw = @controller.params[param].presence
+        parsed = raw.to_i
+        page_size = parsed if parsed > 0
       end
     end
 
-    # Otherwise, get from config.
-    if !page_size && @controller.class.page_size
-      page_size = @controller.class.page_size.to_i
-    end
+    # Fall back to the configured page size.
+    page_size ||= @controller.class.page_size&.to_i || 1
 
     # Ensure we don't exceed the max page size.
-    max_page_size = @controller.class.max_page_size&.to_i
+    max_page_size = @controller.class.max_page_size
     if max_page_size && page_size > max_page_size
       page_size = max_page_size
     end
@@ -46,7 +45,7 @@ class RESTFramework::Paginators::PageNumberPaginator < RESTFramework::Paginators
         page_number = 1
       else
         page_number = page_number.to_i
-        if page_number.zero?
+        if page_number < 1
           page_number = 1
         end
       end
@@ -61,7 +60,7 @@ class RESTFramework::Paginators::PageNumberPaginator < RESTFramework::Paginators
   # Wrap the serialized page with appropriate metadata.
   def get_paginated_response(serialized_page)
     page_query_param = @controller.class.page_query_param
-    base_params = @controller.params.to_unsafe_h
+    base_params = @controller.request.query_parameters.symbolize_keys
     next_url = if @page_number < @total_pages
       @controller.url_for({ **base_params, page_query_param => @page_number + 1 })
     end

data/lib/rest_framework/routers.rb

@@ -31,7 +31,7 @@ module ActionDispatch::Routing
 
           begin
             controller = mod.const_get(name_reverse)
-          rescue
+          rescue NameError
             reraise = true
           end
 
@@ -109,16 +109,25 @@ module ActionDispatch::Routing
             next unless controller_class.method_defined?(action)
 
             [ methods ].flatten.each do |m|
-              public_send(m, "", action: action) if self.respond_to?(m)
+              # Anchor the route since Rails 8.1 OPTIONS routes are non-anchored by default, which
+              # causes parent OPTIONS routes to greedily intercept sub-path requests.
+              public_send(m, "", action: action, anchor: true) if self.respond_to?(m)
             end
           end
 
-          # Route bulk actions, if configured.
-          RESTFramework::RRF_BUILTIN_BULK_ACTIONS.each do |action, methods|
-            next unless controller_class.method_defined?(action)
-
-            [ methods ].flatten.each do |m|
-              public_send(m, "", action: action) if self.respond_to?(m)
+          # Route bulk actions, if configured. These require a model and are gated by the `bulk`
+          # attribute, and may be individually excluded via `excluded_actions`.
+          if controller_class.model && controller_class.bulk
+            bulk_exclude = controller_class.excluded_actions&.to_set || Set.new
+            RESTFramework::RRF_BUILTIN_BULK_ACTIONS.each do |action, methods|
+              next unless controller_class.method_defined?(action)
+              next if bulk_exclude.include?(action)
+
+              [ methods ].flatten.each do |m|
+                # Anchor the route since Rails 8.1 OPTIONS routes are non-anchored by default, which
+                # causes parent OPTIONS routes to greedily intercept sub-path requests.
+                public_send(m, "", action: action, anchor: true) if self.respond_to?(m)
+              end
             end
           end
         end
@@ -179,7 +188,9 @@ module ActionDispatch::Routing
             next unless controller_class.method_defined?(action)
 
             [ methods ].flatten.each do |m|
-              public_send(m, "", action: action) if self.respond_to?(m)
+              # Anchor the route since Rails 8.1 OPTIONS routes are non-anchored by default, which
+              # causes parent OPTIONS routes to greedily intercept sub-path requests.
+              public_send(m, "", action: action, anchor: true) if self.respond_to?(m)
             end
           end
         end

data/lib/rest_framework/serializers/native_serializer.rb

@@ -28,10 +28,12 @@ class RESTFramework::Serializers::NativeSerializer < RESTFramework::Serializers:
     # Determine model either explicitly, or by inspecting @object or @controller.
     @model = model
     @model ||= @object.class if @object.is_a?(ActiveRecord::Base)
-    @model ||= @object[0].class if
-      @many && @object.is_a?(Enumerable) && @object.is_a?(ActiveRecord::Base)
+    @model ||= @object.klass if @many && @object.is_a?(ActiveRecord::Relation)
+    @model ||= @object.first.class if @many &&
+      @object.is_a?(Enumerable) &&
+      @object.first.is_a?(ActiveRecord::Base)
 
-    @model ||= @controller.class.get_model if @controller
+    @model ||= @controller.class.model if @controller
   end
 
   def action

data/lib/rest_framework/utils.rb

@@ -42,17 +42,27 @@ module RESTFramework::Utils
   end
 
   def self.get_skipped_builtin_actions(controller_class, singular)
-    (
-      (
-        RESTFramework::BUILTIN_ACTIONS.keys - (singular ? [ :index ] : [])
-      ) + RESTFramework::BUILTIN_MEMBER_ACTIONS.keys
-    ).reject do |action|
-      controller_class.method_defined?(action)
+    candidates = (
+      RESTFramework::BUILTIN_ACTIONS.keys - (singular ? [ :index ] : [])
+    ) + RESTFramework::BUILTIN_MEMBER_ACTIONS.keys
+
+    return candidates unless controller_class.model
+
+    exclude = controller_class.excluded_actions&.to_set || Set.new
+    candidates.reject do |action|
+      controller_class.method_defined?(action) && !exclude.include?(action)
     end
   end
 
   # Get the first route pattern which matches the given request.
   def self.get_request_route(application_routes, request)
+    # Prefer the route already resolved by the router to avoid an expensive `recognize` call. This
+    # is also required for Rails 8.1+ where OPTIONS routes are non-anchored, causing `path_info` to
+    # be modified during dispatch, which makes `recognize` fail from inside the controller action.
+    if route = request.env["action_dispatch.route"]
+      return route
+    end
+
     application_routes.router.recognize(request) { |route, _| return route }
   end
 
@@ -241,4 +251,12 @@ module RESTFramework::Utils
 
     s
   end
+
+  # Used for deprecated mixins that rely on model being determined from the controller name.
+  def self.get_model(controller_class)
+    begin
+      controller_class.name.demodulize.chomp("Controller").singularize.constantize
+    rescue NameError
+    end
+  end
 end

data/lib/rest_framework.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RESTFramework
-  BUILTIN_FORM_ACTIONS = %i[new edit].freeze
+  BUILTIN_FORM_ACTIONS = [ :new, :edit ].freeze
   BUILTIN_ACTIONS = {
     index: :get,
     new: :get,
@@ -144,6 +144,7 @@ module RESTFramework
       password
       password_confirmation
     ].freeze
+    DEFAULT_INFLECT_ACRONYMS = [ "ID", "IDs", "REST", "API", "APIs" ].freeze
 
     # Permits use of `render(api: obj)` syntax over `render_api(obj)`; `true` by default.
     attr_accessor :register_api_renderer
@@ -168,9 +169,6 @@ module RESTFramework
     # Whether the backtrace should be shown in rescued errors.
     attr_accessor :show_backtrace
 
-    # Disable `rescue_from` on the controller mixins.
-    attr_accessor :disable_rescue_from
-
     # The default label fields to use when generating labels for `has_many` associations.
     attr_accessor :label_fields
 
@@ -181,6 +179,9 @@ module RESTFramework
     attr_accessor :read_only_fields
     attr_accessor :write_only_fields
 
+    # List of acronyms to be inflected in controller titles and field labels.
+    attr_accessor :inflect_acronyms
+
     # Option to use vendored assets (requires sprockets or propshaft) rather than linking to
     # external assets (the default).
     attr_accessor :use_vendored_assets
@@ -188,6 +189,7 @@ module RESTFramework
     def initialize
       self.register_api_renderer = true
       self.auto_finalize = true
+      self.freeze_config = true
 
       self.show_backtrace = Rails.env.development?
 
@@ -195,6 +197,7 @@ module RESTFramework
       self.search_columns = DEFAULT_SEARCH_COLUMNS
       self.read_only_fields = DEFAULT_READ_ONLY_FIELDS
       self.write_only_fields = DEFAULT_WRITE_ONLY_FIELDS
+      self.inflect_acronyms = DEFAULT_INFLECT_ACRONYMS
     end
   end
 
@@ -209,15 +212,20 @@ module RESTFramework
   def self.features
     @features ||= {}
   end
+
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("2.0", "REST Framework")
+  end
 end
 
 require_relative "rest_framework/engine"
 require_relative "rest_framework/errors"
 require_relative "rest_framework/filters"
-require_relative "rest_framework/generators"
 require_relative "rest_framework/mixins"
 require_relative "rest_framework/paginators"
 require_relative "rest_framework/routers"
 require_relative "rest_framework/serializers"
 require_relative "rest_framework/utils"
 require_relative "rest_framework/version"
+
+require_relative "rest_framework/controller"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-13 00:00:00.000000000 Z
+date: 2026-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,19 +54,18 @@ files:
 - app/views/rest_framework/routes_and_forms/_routes.html.erb
 - app/views/rest_framework/routes_and_forms/routes/_route.html.erb
 - lib/rest_framework.rb
+- lib/rest_framework/controller.rb
+- lib/rest_framework/controller/bulk.rb
+- lib/rest_framework/controller/crud.rb
+- lib/rest_framework/controller/openapi.rb
 - lib/rest_framework/engine.rb
 - lib/rest_framework/errors.rb
-- lib/rest_framework/errors/base_error.rb
-- lib/rest_framework/errors/nil_passed_to_render_api_error.rb
-- lib/rest_framework/errors/unknown_model_error.rb
 - lib/rest_framework/filters.rb
 - lib/rest_framework/filters/base_filter.rb
 - lib/rest_framework/filters/ordering_filter.rb
 - lib/rest_framework/filters/query_filter.rb
 - lib/rest_framework/filters/ransack_filter.rb
 - lib/rest_framework/filters/search_filter.rb
-- lib/rest_framework/generators.rb
-- lib/rest_framework/generators/controller_generator.rb
 - lib/rest_framework/mixins.rb
 - lib/rest_framework/mixins/base_controller_mixin.rb
 - lib/rest_framework/mixins/bulk_model_controller_mixin.rb

data/lib/rest_framework/errors/base_error.rb

@@ -1,5 +0,0 @@
-class RESTFramework::Errors::BaseError < StandardError
-end
-
-# Alias for convenience.
-RESTFramework::BaseError = RESTFramework::Errors::BaseError

data/lib/rest_framework/errors/nil_passed_to_render_api_error.rb

@@ -1,14 +0,0 @@
-class RESTFramework::Errors::NilPassedToRenderAPIError < RESTFramework::Errors::BaseError
-  def message
-    <<~MSG.split("\n").join(" ")
-      Payload of `nil` was passed to `render_api`; this is unsupported. If you want a blank
-      response, pass `''` (an empty string) as the payload. If this was the result of a `find_by`
-      (or similar Active Record method) not finding a record, you should use the bang version (e.g.,
-      `find_by!`) to raise `ActiveRecord::RecordNotFound`, which the REST controller will catch and
-      return an appropriate error response.
-    MSG
-  end
-end
-
-# Alias for convenience.
-RESTFramework::NilPassedToRenderAPIError = RESTFramework::Errors::NilPassedToRenderAPIError

data/lib/rest_framework/errors/unknown_model_error.rb

@@ -1,18 +0,0 @@
-class RESTFramework::Errors::UnknownModelError < RESTFramework::Errors::BaseError
-  def initialize(controller_class)
-    super()
-    @controller_class = controller_class
-  end
-
-  def message
-    <<~MSG.split("\n").join(" ")
-      The model class for `#{@controller_class}` could not be determined. Any controller that
-      includes `RESTFramework::BaseModelControllerMixin` (directly or indirectly) must either set
-      the `model` attribute on the controller, or the model must be deducible from the controller
-      name (e.g., `UsersController` could resolve to the `User` model).
-    MSG
-  end
-end
-
-# Alias for convenience.
-RESTFramework::UnknownModelError = RESTFramework::Errors::UnknownModelError

data/lib/rest_framework/generators/controller_generator.rb

@@ -1,64 +0,0 @@
-require "rails/generators"
-
-# Most projects don't have the inflection "REST" as an acronym, so this is a helper class to prevent
-# this generator from being namespaced as `"r_e_s_t_framework"`.
-# :nocov:
-class RESTFrameworkCustomGeneratorControllerNamespace < String
-  def camelize
-    "RESTFramework"
-  end
-end
-# :nocov:
-
-class RESTFramework::Generators::ControllerGenerator < Rails::Generators::Base
-  PATH_REGEX = %r{^[a-z0-9][a-z0-9_/]+$}
-
-  desc <<~END
-    Description:
-      Generates a new REST Framework controller.
-
-      Specify the controller as a path, including the module, if needed, like:
-      'parent_module/controller_name'.
-
-    Example:
-      `rails generate rest_framework:controller user_api/groups`
-
-      Generates a controller at `app/controllers/user_api/groups_controller.rb` named
-      `UserApi::GroupsController`.
-  END
-
-  argument :path, type: :string
-  class_option(
-    :parent_class, type: :string, default: "ApplicationController", desc: "Inheritance parent"
-  )
-  class_option(
-    :include_base,
-    type: :boolean,
-    default: false,
-    desc: "Include `BaseControllerMixin`, not `ModelControllerMixin`",
-  )
-
-  # Some projects may not have the inflection "REST" as an acronym, which changes this generator to
-  # be namespaced in `r_e_s_t_framework`, which is weird.
-  def self.namespace
-    RESTFrameworkCustomGeneratorControllerNamespace.new("rest_framework:controller")
-  end
-
-  def create_rest_controller_file
-    unless PATH_REGEX.match?(self.path)
-      raise StandardError, "Path isn't valid."
-    end
-
-    # Remove '_controller' from end of path, if it exists.
-    cleaned_path = self.path.delete_suffix("_controller")
-
-    content = <<~END
-      class #{cleaned_path.camelize}Controller < #{options[:parent_class]}
-        include RESTFramework::#{
-          options[:include_base] ? "BaseControllerMixin" : "ModelControllerMixin"
-        }
-      end
-    END
-    create_file("app/controllers/#{cleaned_path}_controller.rb", content)
-  end
-end

data/lib/rest_framework/generators.rb

@@ -1,4 +0,0 @@
-module RESTFramework::Generators
-end
-
-require_relative "generators/controller_generator"