rest_framework 1.2.0 → 2.0.0.beta1

data/lib/rest_framework/version.rb

@@ -22,11 +22,14 @@ module RESTFramework
       UNKNOWN
     end
 
-    def self.stamp_version
-      # Only stamp the version if it's not unknown.
-      if RESTFramework::VERSION != UNKNOWN
-        File.write(VERSION_FILEPATH, RESTFramework::VERSION)
+    def self.stamp_version(version = nil)
+      # Stamp the given version into the VERSION file, deriving it from git when none is provided.
+      # Returns the stamped version so callers don't rely on the (require-time) `VERSION` constant.
+      version ||= self.get_version
+      if version != UNKNOWN
+        File.write(VERSION_FILEPATH, version)
       end
+      version
     end
 
     def self.unstamp_version
@@ -34,5 +37,5 @@ module RESTFramework
     end
   end
 
-  VERSION = Version.get_version
+  VERSION = Version.get_version(skip_git: true)
 end

data/lib/rest_framework.rb

@@ -1,26 +1,6 @@
 # frozen_string_literal: true
 
 module RESTFramework
-  BUILTIN_FORM_ACTIONS = [ :new, :edit ].freeze
-  BUILTIN_ACTIONS = {
-    index: :get,
-    new: :get,
-    create: :post,
-  }.freeze
-  BUILTIN_MEMBER_ACTIONS = {
-    show: :get,
-    edit: :get,
-    update: [ :put, :patch ].freeze,
-    destroy: :delete,
-  }.freeze
-  RRF_BUILTIN_ACTIONS = {
-    options: :options,
-  }.freeze
-  RRF_BUILTIN_BULK_ACTIONS = {
-    update_all: [ :put, :patch ].freeze,
-    destroy_all: :delete,
-  }.freeze
-
   # Storage for extra routes and associated metadata.
   EXTRA_ACTION_ROUTES = Set.new
   ROUTE_METADATA = {}
@@ -47,6 +27,7 @@ module RESTFramework
     # Bootstrap Icons
     "bootstrap-icons.min.css" => {
       url: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css",
+      sri: "sha384-XGjxtQfXaH2tnPFa9x+ruJTuLE3Aa6LhHSWRr1XeTyhezb4abCG4ccI5AkVDxqC+",
       inline_fonts: true,
     },
 
@@ -74,19 +55,23 @@ module RESTFramework
       extra_tag_attrs: { class: "rrf-light-mode" },
     },
 
-    # NeatJSON
+    # NeatJSON. The package publishes no minified build; jsdelivr's `neatjson.min.js` is synthesized
+    # on the fly (so its bytes/SRI aren't stable), so we pin the published `neatjson.js` instead.
     "neatjson.min.js" => {
-      url: "https://cdn.jsdelivr.net/npm/neatjson@0.10.6/javascript/neatjson.min.js",
+      url: "https://cdn.jsdelivr.net/npm/neatjson@0.10.6/javascript/neatjson.js",
+      sri: "sha384-7yRMvyGBuBnnlsgFwUDx7wY7Y/kXt7Irg5xppXVAI0yp3R0870lWaXNP/JE2rbFA",
       exclude_from_docs: true,
     },
 
     # Trix
     "trix.min.css" => {
       url: "https://unpkg.com/trix@2.0.8/dist/trix.css",
+      sri: "sha384-Cgg84c/W0Q5VrTzc4ITmV88Ocx4Pn1YlTXPvSTJjX6+lxJRLYrZ4chaighxlqOY1",
       exclude_from_docs: true,
     },
     "trix.min.js" => {
       url: "https://unpkg.com/trix@2.0.8/dist/trix.umd.min.js",
+      sri: "sha384-Ki3zDe3whjAHK/GOksrYLGCU8m0SkmiJQ4Kqm3jQlM3YCl2hFBf17s9bzjVYmXWX",
       exclude_from_docs: true,
     },
   }.map { |name, cfg|
@@ -149,19 +134,6 @@ module RESTFramework
     # Permits use of `render(api: obj)` syntax over `render_api(obj)`; `true` by default.
     attr_accessor :register_api_renderer
 
-    # Run `rrf_finalize` on controllers automatically using a `TracePoint` hook. This is `true` by
-    # default, and can be disabled for performance, and must be global because we have to determine
-    # this before any controller-specific configuration is set. If this is set to `false`, then you
-    # must manually call `rrf_finalize` after any configuration on each controller that needs to
-    # participate in:
-    #  - Model delegation, for the helper methods to be defined dynamically.
-    #  - Websockets, for `::Channel` class to be defined dynamically.
-    #  - Controller configuration freezing.
-    attr_accessor :auto_finalize
-
-    # Freeze configuration attributes during finalization to prevent accidental mutation.
-    attr_accessor :freeze_config
-
     # Specify reverse association tables that are typically very large, and therefore should not be
     # added to fields by default.
     attr_accessor :large_reverse_association_tables
@@ -188,8 +160,6 @@ module RESTFramework
 
     def initialize
       self.register_api_renderer = true
-      self.auto_finalize = true
-      self.freeze_config = true
 
       self.show_backtrace = Rails.env.development?
 
@@ -221,7 +191,6 @@ end
 require_relative "rest_framework/engine"
 require_relative "rest_framework/errors"
 require_relative "rest_framework/filters"
-require_relative "rest_framework/mixins"
 require_relative "rest_framework/paginators"
 require_relative "rest_framework/routers"
 require_relative "rest_framework/serializers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-22 00:00:00.000000000 Z
+date: 2026-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,6 +55,7 @@ files:
 - app/views/rest_framework/routes_and_forms/routes/_route.html.erb
 - lib/rest_framework.rb
 - lib/rest_framework/controller.rb
+- lib/rest_framework/controller/actions.rb
 - lib/rest_framework/controller/bulk.rb
 - lib/rest_framework/controller/crud.rb
 - lib/rest_framework/controller/openapi.rb
@@ -66,10 +67,6 @@ files:
 - lib/rest_framework/filters/query_filter.rb
 - lib/rest_framework/filters/ransack_filter.rb
 - lib/rest_framework/filters/search_filter.rb
-- lib/rest_framework/mixins.rb
-- lib/rest_framework/mixins/base_controller_mixin.rb
-- lib/rest_framework/mixins/bulk_model_controller_mixin.rb
-- lib/rest_framework/mixins/model_controller_mixin.rb
 - lib/rest_framework/paginators.rb
 - lib/rest_framework/paginators/base_paginator.rb
 - lib/rest_framework/paginators/page_number_paginator.rb
@@ -101,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key:

data/lib/rest_framework/mixins/base_controller_mixin.rb

@@ -1,12 +0,0 @@
-module RESTFramework::Mixins::BaseControllerMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "BaseControllerMixin is deprecated; use RESTFramework::Controller instead.",
-    )
-
-    base.include(RESTFramework::Controller)
-  end
-end
-
-# Alias for convenience.
-RESTFramework::BaseControllerMixin = RESTFramework::Mixins::BaseControllerMixin

data/lib/rest_framework/mixins/bulk_model_controller_mixin.rb

@@ -1,55 +0,0 @@
-module RESTFramework::Mixins::BulkCreateModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      BulkCreateModelMixin is deprecated; set the `bulk = true` class attribute instead.
-    TXT
-
-    base.bulk = true
-  end
-end
-
-# Mixin for updating records in bulk.
-module RESTFramework::Mixins::BulkUpdateModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      BulkUpdateModelMixin is deprecated; set the `bulk = true`, and `excluded_actions` class
-      attributes instead.
-    TXT
-
-    base.bulk = true
-    base.excluded_actions = (base.excluded_actions - [ :update_all ]).freeze
-  end
-end
-
-# Mixin for destroying records in bulk.
-module RESTFramework::Mixins::BulkDestroyModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      BulkDestroyModelMixin is deprecated; set the `bulk = true`, and `excluded_actions` class
-      attributes instead.
-    TXT
-
-    base.bulk = true
-    base.excluded_actions = (base.excluded_actions - [ :destroy_all ]).freeze
-  end
-end
-
-# Mixin that includes all the CRUD bulk mixins.
-module RESTFramework::Mixins::BulkModelControllerMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      BulkModelControllerMixin is deprecated; use RESTFramework::Controller and set the `model` and
-      `bulk = true` class attributes instead.
-    TXT
-
-    base.include(RESTFramework::Controller)
-    base.model = RESTFramework::Utils.get_model(base)
-    base.bulk = true
-  end
-end
-
-# Aliases for convenience.
-RESTFramework::BulkCreateModelMixin = RESTFramework::Mixins::BulkCreateModelMixin
-RESTFramework::BulkUpdateModelMixin = RESTFramework::Mixins::BulkUpdateModelMixin
-RESTFramework::BulkDestroyModelMixin = RESTFramework::Mixins::BulkDestroyModelMixin
-RESTFramework::BulkModelControllerMixin = RESTFramework::Mixins::BulkModelControllerMixin

data/lib/rest_framework/mixins/model_controller_mixin.rb

@@ -1,110 +0,0 @@
-module RESTFramework::Mixins::BaseModelControllerMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      BaseModelControllerMixin is deprecated; use RESTFramework::Controller and set the `model` and
-      `excluded_actions` class attributes instead.
-    TXT
-
-    base.include(RESTFramework::Controller)
-    base.model = RESTFramework::Utils.get_model(base)
-    base.excluded_actions = [
-      :index, :show, :create, :update, :destroy, :update_all, :destroy_all
-    ].freeze
-  end
-end
-
-module RESTFramework::Mixins::ListModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "ListModelMixin is deprecated; set the `excluded_actions` class attribute instead.",
-    )
-
-    if base.excluded_actions
-      base.excluded_actions = (base.excluded_actions - [ :index ]).freeze
-    end
-  end
-end
-
-module RESTFramework::Mixins::ShowModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "ShowModelMixin is deprecated; set the `excluded_actions` class attribute instead.",
-    )
-
-    if base.excluded_actions
-      base.excluded_actions = (base.excluded_actions - [ :show ]).freeze
-    end
-  end
-end
-
-module RESTFramework::Mixins::CreateModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "CreateModelMixin is deprecated; set the `excluded_actions` class attribute instead.",
-    )
-
-    if base.excluded_actions
-      base.excluded_actions = (base.excluded_actions - [ :create ]).freeze
-    end
-  end
-end
-
-module RESTFramework::Mixins::UpdateModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "UpdateModelMixin is deprecated; set the `excluded_actions` class attribute instead.",
-    )
-
-    if base.excluded_actions
-      base.excluded_actions = (base.excluded_actions - [ :update ]).freeze
-    end
-  end
-end
-
-module RESTFramework::Mixins::DestroyModelMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(
-      "DestroyModelMixin is deprecated; set the `excluded_actions` class attribute instead.",
-    )
-
-    if base.excluded_actions
-      base.excluded_actions = (base.excluded_actions - [ :destroy ]).freeze
-    end
-  end
-end
-
-module RESTFramework::Mixins::ReadOnlyModelControllerMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      ReadOnlyModelControllerMixin is deprecated; use RESTFramework::Controller and set the `model`
-      and `excluded_actions` class attributes instead.
-    TXT
-
-    base.include(RESTFramework::Controller)
-    base.model = RESTFramework::Utils.get_model(base)
-    base.excluded_actions = [ :create, :update, :destroy, :update_all, :destroy_all ].freeze
-  end
-end
-
-module RESTFramework::Mixins::ModelControllerMixin
-  def self.included(base)
-    RESTFramework.deprecator.warn(<<~TXT).squish
-      ModelControllerMixin is deprecated; use RESTFramework::Controller and set the `model` class
-      attribute instead.
-    TXT
-
-    base.include(RESTFramework::Controller)
-    base.model = RESTFramework::Utils.get_model(base)
-    base.excluded_actions = nil
-  end
-end
-
-# Aliases for convenience.
-RESTFramework::BaseModelControllerMixin = RESTFramework::Mixins::BaseModelControllerMixin
-RESTFramework::ListModelMixin = RESTFramework::Mixins::ListModelMixin
-RESTFramework::ShowModelMixin = RESTFramework::Mixins::ShowModelMixin
-RESTFramework::CreateModelMixin = RESTFramework::Mixins::CreateModelMixin
-RESTFramework::UpdateModelMixin = RESTFramework::Mixins::UpdateModelMixin
-RESTFramework::DestroyModelMixin = RESTFramework::Mixins::DestroyModelMixin
-RESTFramework::ReadOnlyModelControllerMixin = RESTFramework::Mixins::ReadOnlyModelControllerMixin
-RESTFramework::ModelControllerMixin = RESTFramework::Mixins::ModelControllerMixin

data/lib/rest_framework/mixins.rb

@@ -1,7 +0,0 @@
-module RESTFramework::Mixins
-end
-
-require_relative "mixins/base_controller_mixin"
-
-require_relative "mixins/bulk_model_controller_mixin"
-require_relative "mixins/model_controller_mixin"