rest_framework 1.0.0.rc1 → 1.0.0

data/lib/rest_framework/utils.rb

@@ -1,9 +1,9 @@
 module RESTFramework::Utils
-  HTTP_VERB_ORDERING = %w(GET POST PUT PATCH DELETE OPTIONS HEAD)
+  HTTP_VERB_ORDERING = %w[GET POST PUT PATCH DELETE OPTIONS HEAD]
 
   # Convert `extra_actions` hash to a consistent format: `{path:, methods:, metadata:, kwargs:}`.
   def self.parse_extra_actions(extra_actions)
-    return (extra_actions || {}).map { |k, v|
+    (extra_actions || {}).map { |k, v|
       path = k
       kwargs = {}
 
@@ -13,7 +13,7 @@ module RESTFramework::Utils
         v = v.symbolize_keys
 
         # Cast method/methods to an array.
-        methods = [v.delete(:methods), v.delete(:method)].flatten.compact
+        methods = [ v.delete(:methods), v.delete(:method) ].flatten.compact
 
         # Override path if it's provided.
         if v.key?(:path)
@@ -26,7 +26,7 @@ module RESTFramework::Utils
         # Pass any further kwargs to the underlying Rails interface.
         kwargs = v
       else
-        methods = [v].flatten
+        methods = [ v ].flatten
       end
 
       next [
@@ -43,7 +43,7 @@ module RESTFramework::Utils
 
   # Get actions which should be skipped for a given controller.
   def self.get_skipped_builtin_actions(controller_class)
-    return (
+    (
       RESTFramework::BUILTIN_ACTIONS.keys + RESTFramework::BUILTIN_MEMBER_ACTIONS.keys
     ).reject do |action|
       controller_class.method_defined?(action)
@@ -58,7 +58,7 @@ module RESTFramework::Utils
   # Normalize a path pattern by replacing URL params with generic placeholder, and removing the
   # `(.:format)` at the end.
   def self.comparable_path(path)
-    return path.gsub("(.:format)", "").gsub(/:[0-9A-Za-z_-]+/, ":x")
+    path.gsub("(.:format)", "").gsub(/:[0-9A-Za-z_-]+/, ":x")
   end
 
   # Show routes under a controller action; used for the browsable API.
@@ -74,7 +74,7 @@ module RESTFramework::Utils
 
     # Return routes that match our current route subdomain/pattern, grouped by controller. We
     # precompute certain properties of the route for performance.
-    return application_routes.routes.select { |r|
+    application_routes.routes.select { |r|
       # We `select` first to avoid unnecessarily calculating metadata for routes we don't even want
       # to show.
       (r.defaults[:subdomain].blank? || r.defaults[:subdomain] == request.subdomain) &&
@@ -100,7 +100,7 @@ module RESTFramework::Utils
         verb: r.verb,
         path: path,
         path_with_params: r.format(
-          r.required_parts.each_with_index.map { |p, i| [p, path_params[i]] }.to_h,
+          r.required_parts.each_with_index.map { |p, i| [ p, path_params[i] ] }.to_h,
         ),
         relative_path: relative_path,
         concat_path: concat_path,
@@ -125,17 +125,17 @@ module RESTFramework::Utils
       # Sort the controller groups by current controller first, then alphanumerically.
       # Note: Use `controller_path` instead of `params[:controller]` to avoid re-raising a
       # `ActionDispatch::Http::Parameters::ParseError` exception.
-      [request.controller_class.controller_path == c ? 0 : 1, c]
+      [ request.controller_class.controller_path == c ? 0 : 1, c ]
     }.to_h
   end
 
   # Custom inflector for RESTful controllers.
-  def self.inflect(s, acronyms=nil)
+  def self.inflect(s, acronyms = nil)
     acronyms&.each do |acronym|
       s = s.gsub(/\b#{acronym}\b/i, acronym)
     end
 
-    return s
+    s
   end
 
   # Parse fields hashes.
@@ -153,12 +153,12 @@ module RESTFramework::Utils
     parsed_fields -= h[:except].map(&:to_s) if h[:except]
 
     # Warn for any unknown keys.
-    (h.keys - [:only, :except, :include, :exclude]).each do |k|
+    (h.keys - [ :only, :except, :include, :exclude ]).each do |k|
       Rails.logger.warn("RRF: Unknown key in fields hash: #{k}")
     end
 
     # We should always return strings, not symbols.
-    return parsed_fields.map(&:to_s)
+    parsed_fields.map(&:to_s)
   end
 
   # Get the fields for a given model, including not just columns (which includes
@@ -181,7 +181,7 @@ module RESTFramework::Utils
     # Associations:
     associations = model.reflections.map { |association, ref|
       # Ignore associations for which we have custom integrations.
-      if ref.class_name.in?(%w(ActionText::RichText ActiveStorage::Attachment ActiveStorage::Blob))
+      if ref.class_name.in?(%w[ActionText::RichText ActiveStorage::Attachment ActiveStorage::Blob])
         next nil
       end
 
@@ -194,29 +194,29 @@ module RESTFramework::Utils
       next association
     }.compact
 
-    return base_fields + associations + atf + asf
+    base_fields + associations + atf + asf
   end
 
   # Get the sub-fields that may be serialized and filtered/ordered for a reflection.
   def self.sub_fields_for(ref)
     if !ref.polymorphic? && model = ref.klass
-      sub_fields = [model.primary_key].flatten.compact
+      sub_fields = [ model.primary_key ].flatten.compact
       label_fields = RESTFramework.config.label_fields
 
       # Preferrably find a database column to use as label.
       if match = label_fields.find { |f| f.in?(model.column_names) }
-        return sub_fields + [match]
+        return sub_fields + [ match ]
       end
 
       # Otherwise, find a method.
       if match = label_fields.find { |f| model.method_defined?(f) }
-        return sub_fields + [match]
+        return sub_fields + [ match ]
       end
 
       return sub_fields
     end
 
-    return ["id", "name"]
+    [ "id", "name" ]
   end
 
   # Get a field's id/ids variation.
@@ -229,7 +229,7 @@ module RESTFramework::Utils
       return reflection.foreign_key
     end
 
-    return nil
+    nil
   end
 
   # Wrap a serializer with an adapter if it is an ActiveModel::Serializer.
@@ -238,6 +238,6 @@ module RESTFramework::Utils
       return RESTFramework::ActiveModelSerializerAdapterFactory.for(s)
     end
 
-    return s
+    s
   end
 end

data/lib/rest_framework/version.rb

@@ -19,7 +19,7 @@ module RESTFramework
       end
 
       # No VERSION file, so version is unknown.
-      return UNKNOWN
+      UNKNOWN
     end
 
     def self.stamp_version

data/lib/rest_framework.rb

@@ -9,14 +9,14 @@ module RESTFramework
   BUILTIN_MEMBER_ACTIONS = {
     show: :get,
     edit: :get,
-    update: [:put, :patch].freeze,
+    update: [ :put, :patch ].freeze,
     destroy: :delete,
   }.freeze
   RRF_BUILTIN_ACTIONS = {
     options: :options,
   }.freeze
   RRF_BUILTIN_BULK_ACTIONS = {
-    update_all: [:put, :patch].freeze,
+    update_all: [ :put, :patch ].freeze,
     destroy_all: :delete,
   }.freeze
 
@@ -65,12 +65,12 @@ module RESTFramework
     "highlight-a11y-dark.min.css" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-dark.min.css",
       sri: "sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==",
-      extra_tag_attrs: {class: "rrf-dark-mode"},
+      extra_tag_attrs: { class: "rrf-dark-mode" },
     },
     "highlight-a11y-light.min.css" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-light.min.css",
       sri: "sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==",
-      extra_tag_attrs: {class: "rrf-light-mode"},
+      extra_tag_attrs: { class: "rrf-light-mode" },
     },
 
     # NeatJSON
@@ -117,7 +117,7 @@ module RESTFramework
       raise "Unknown asset extension: #{ext}."
     end
 
-    [name, cfg]
+    [ name, cfg ]
   }.to_h.freeze
   # rubocop:enable Layout/LineLength
 
@@ -126,8 +126,8 @@ module RESTFramework
   # Global configuration should be kept minimal, as controller-level configurations allows multiple
   # APIs to be defined to behave differently.
   class Config
-    DEFAULT_LABEL_FIELDS = %w(name label login title email username url).freeze
-    DEFAULT_SEARCH_COLUMNS = DEFAULT_LABEL_FIELDS + %w(description note).freeze
+    DEFAULT_LABEL_FIELDS = %w[name label login title email username url].freeze
+    DEFAULT_SEARCH_COLUMNS = DEFAULT_LABEL_FIELDS + %w[description note].freeze
     DEFAULT_EXCLUDE_BODY_FIELDS = %w[
       created_at
       created_by
@@ -192,7 +192,7 @@ module RESTFramework
   end
 
   def self.config
-    return @config ||= Config.new
+    @config ||= Config.new
   end
 
   def self.configure
@@ -200,7 +200,7 @@ module RESTFramework
   end
 
   def self.features
-    return @features ||= {}
+    @features ||= {}
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-24 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,12 +96,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: