RubyGems - rest_framework - Versions diffs - 0.9.7 → 0.9.8 - Mend

rest_framework 0.9.7 → 0.9.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a9201bc66da6f1038a27aad8e0754d3b14973c20ca5bb3486b545c081e1cf31
-  data.tar.gz: af160d2b5f66a1d2ab4b40dcd366e5f10d46e5b4f075ac01926cfbcbc03a5c62
+  metadata.gz: 5b06a61592498f8debce6f504b4eee90ceeef6fdff63dbb769bd70c623cd9631
+  data.tar.gz: ab5b1284a3504104b77cc38278bad01a1dfa30ce7ebcd65323b73e0dd31e58a2
 SHA512:
-  metadata.gz: 756aa93e81e2cd240a6d383df774c8003a4063e514bd19acce8857a36ae6844c4ee3dddafdd2c9a246ab4f213f9c9b01bd52bcf2758d84b6ec09b59f73ae3257
-  data.tar.gz: e7b9e1e1730604c3702e9e1c8b744c87ac6d474db8cb70f32457467ddbc25817bc94404b26560c4b19f3ac0ecdd4704ff9393cbd7a88216052ee13071a97a23a
+  metadata.gz: ed04505314f252ac1058732a875711090fb07499edac42814bf72e5b15f90f833040e40399df279654727041af30789c8a931e06d83b9fc1c67f46d4f0da850f
+  data.tar.gz: abd68ae8ab71f2fff8f7a933270a467811143096f7cdde16d21c99ac3faeadc8f958cb0bcdde94c1b57f1d620fc278f8d9b5e3b4e2cec5851fb4616f9c325d41

data/.yardopts ADDED Viewed

@@ -0,0 +1,5 @@
+--private
+--protected
+-
+LICENSE
+README.md

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.9.7
1	+ 0.9.8

data/app/views/layouts/rest_framework.html.erb CHANGED Viewed

@@ -1,5 +1,5 @@
 <!doctype html>
-<html class="rrf-mode">
+<html lang="en" class="rrf-mode">
   <head>
     <title><%= @title %></title>

data/lib/rest_framework/filters/{base.rb → base_filter.rb} RENAMED Viewed

@@ -1,4 +1,4 @@
-class RESTFramework::BaseFilter
+class RESTFramework::Filters::BaseFilter
   def initialize(controller:)
     @controller = controller
   end
@@ -7,3 +7,6 @@ class RESTFramework::BaseFilter
     raise NotImplementedError
   end
 end
+# Alias for convenience.
+RESTFramework::BaseFilter = RESTFramework::Filters::BaseFilter

data/lib/rest_framework/filters/{model_ordering.rb → model_ordering_filter.rb} RENAMED Viewed

@@ -1,5 +1,5 @@
 # A filter backend which handles ordering of the recordset.
-class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
+class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::BaseFilter
   # Get a list of ordering fields for the current action.
   def _get_fields
     return @controller.ordering_fields&.map(&:to_s) || @controller.get_fields
@@ -46,3 +46,6 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
     return data
   end
 end
+# Alias for convenience.
+RESTFramework::ModelOrderingFilter = RESTFramework::Filters::ModelOrderingFilter

data/lib/rest_framework/filters/{model_query.rb → model_query_filter.rb} RENAMED Viewed

@@ -1,5 +1,5 @@
 # A simple filtering backend that supports filtering a recordset based on query parameters.
-class RESTFramework::ModelQueryFilter < RESTFramework::BaseFilter
+class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFilter
   # Get a list of filterset fields for the current action.
   def _get_fields
     # Always return a list of strings; `@controller.get_fields` already does this.
@@ -49,3 +49,6 @@ class RESTFramework::ModelQueryFilter < RESTFramework::BaseFilter
     return data
   end
 end
+# Alias for convenience.
+RESTFramework::ModelQueryFilter = RESTFramework::Filters::ModelQueryFilter

data/lib/rest_framework/filters/{model_search.rb → model_search_filter.rb} RENAMED Viewed

@@ -1,5 +1,5 @@
 # Multi-field text searching on models.
-class RESTFramework::ModelSearchFilter < RESTFramework::BaseFilter
+class RESTFramework::Filters::ModelSearchFilter < RESTFramework::Filters::BaseFilter
   # Get a list of search fields for the current action.
   def _get_fields
     if search_fields = @controller.search_fields
@@ -39,3 +39,6 @@ class RESTFramework::ModelSearchFilter < RESTFramework::BaseFilter
     return data
   end
 end
+# Alias for convenience.
+RESTFramework::ModelSearchFilter = RESTFramework::Filters::ModelSearchFilter

data/lib/rest_framework/filters/{ransack.rb → ransack_filter.rb} RENAMED Viewed

@@ -1,5 +1,5 @@
 # Adapter for the `ransack` gem.
-class RESTFramework::RansackFilter < RESTFramework::BaseFilter
+class RESTFramework::Filters::RansackFilter < RESTFramework::Filters::BaseFilter
   # Filter data according to the request query parameters.
   def get_filtered_data(data)
     q = @controller.request.query_parameters[@controller.ransack_query_param]
@@ -23,3 +23,6 @@ class RESTFramework::RansackFilter < RESTFramework::BaseFilter
     return data
   end
 end
+# Alias for convenience.
+RESTFramework::RansackFilter = RESTFramework::Filters::RansackFilter

data/lib/rest_framework/filters.rb CHANGED Viewed

@@ -1,9 +1,9 @@
 module RESTFramework::Filters
 end
-require_relative "filters/base"
+require_relative "filters/base_filter"
-require_relative "filters/model_ordering"
-require_relative "filters/model_query"
-require_relative "filters/model_search"
-require_relative "filters/ransack"
+require_relative "filters/model_ordering_filter"
+require_relative "filters/model_query_filter"
+require_relative "filters/model_search_filter"
+require_relative "filters/ransack_filter"

data/lib/rest_framework/{controller_mixins/base.rb → mixins/base_controller_mixin.rb} RENAMED Viewed

@@ -1,11 +1,7 @@
-require_relative "../errors"
-require_relative "../serializers"
-require_relative "../utils"
 # This module provides the common functionality for any controller mixins, a `root` action, and
 # the ability to route arbitrary actions with `extra_actions`. This is also where `api_response`
 # is defined.
-module RESTFramework::BaseControllerMixin
+module RESTFramework::Mixins::BaseControllerMixin
   RRF_BASE_CONFIG = {
     extra_actions: nil,
     extra_member_actions: nil,
@@ -348,3 +344,6 @@ module RESTFramework::BaseControllerMixin
     return api_response(self.get_options_metadata)
   end
 end
+# Alias for convenience.
+RESTFramework::BaseControllerMixin = RESTFramework::Mixins::BaseControllerMixin

data/lib/rest_framework/{controller_mixins/bulk.rb → mixins/bulk_model_controller_mixin.rb} RENAMED Viewed

@@ -1,8 +1,8 @@
-require_relative "models"
+require_relative "model_controller_mixin"
 # Mixin for creating records in bulk. This is unique compared to update/destroy because we overload
 # the existing `create` action to support bulk creation.
-module RESTFramework::BulkCreateModelMixin
+module RESTFramework::Mixins::BulkCreateModelMixin
   # While bulk update/destroy are obvious because they create new router endpoints, bulk create
   # overloads the existing collection `POST` endpoint, so we add a special key to the options
   # metadata to indicate bulk create is supported.
@@ -31,8 +31,11 @@ module RESTFramework::BulkCreateModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::BulkCreateModelMixin = RESTFramework::Mixins::BulkCreateModelMixin
 # Mixin for updating records in bulk.
-module RESTFramework::BulkUpdateModelMixin
+module RESTFramework::Mixins::BulkUpdateModelMixin
   def update_all
     records = self.update_all!
     serialized_records = self.bulk_serialize(records)
@@ -56,8 +59,11 @@ module RESTFramework::BulkUpdateModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::BulkUpdateModelMixin = RESTFramework::Mixins::BulkUpdateModelMixin
 # Mixin for destroying records in bulk.
-module RESTFramework::BulkDestroyModelMixin
+module RESTFramework::Mixins::BulkDestroyModelMixin
   def destroy_all
     if params[:_json].is_a?(Array)
       records = self.destroy_all!
@@ -83,8 +89,11 @@ module RESTFramework::BulkDestroyModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::BulkDestroyModelMixin = RESTFramework::Mixins::BulkDestroyModelMixin
 # Mixin that includes all the CRUD bulk mixins.
-module RESTFramework::BulkModelControllerMixin
+module RESTFramework::Mixins::BulkModelControllerMixin
   include RESTFramework::ModelControllerMixin
   include RESTFramework::BulkCreateModelMixin
@@ -95,3 +104,6 @@ module RESTFramework::BulkModelControllerMixin
     RESTFramework::ModelControllerMixin.included(base)
   end
 end
+# Alias for convenience.
+RESTFramework::BulkModelControllerMixin = RESTFramework::Mixins::BulkModelControllerMixin

data/lib/rest_framework/{controller_mixins/models.rb → mixins/model_controller_mixin.rb} RENAMED Viewed

@@ -1,8 +1,5 @@
-require_relative "base"
-require_relative "../filters"
 # This module provides the core functionality for controllers based on models.
-module RESTFramework::BaseModelControllerMixin
+module RESTFramework::Mixins::BaseModelControllerMixin
   BASE64_REGEX = /data:(.*);base64,(.*)/
   BASE64_TRANSLATE = ->(field, value) {
     _, content_type, payload = value.match(BASE64_REGEX).to_a
@@ -552,54 +549,28 @@ module RESTFramework::BaseModelControllerMixin
   alias_method :get_create_params, :get_body_params
   alias_method :get_update_params, :get_body_params
-  # Get the set of records this controller has access to. The return value is cached and exposed to
-  # the view as the `@recordset` instance variable.
+  # Get the set of records this controller has access to.
   def get_recordset
-    return @recordset if instance_variable_defined?(:@recordset)
-    return (@recordset = self.class.recordset) if self.class.recordset
+    return self.class.recordset if self.class.recordset
     # If there is a model, return that model's default scope (all records by default).
-    if (model = self.class.get_model)
-      return @recordset = model.all
-    end
-    return @recordset = nil
-  end
-  # Get the recordset but with any associations included to avoid N+1 queries.
-  def get_recordset_with_includes
-    reflections = self.class.get_model.reflections
-    associations = self.get_fields.map { |f|
-      if reflections.key?(f)
-        f.to_sym
-      elsif reflections.key?("rich_text_#{f}")
-        :"rich_text_#{f}"
-      elsif reflections.key?("#{f}_attachment")
-        :"#{f}_attachment"
-      elsif reflections.key?("#{f}_attachments")
-        :"#{f}_attachments"
-      end
-    }.compact
-    if associations.any?
-      return self.get_recordset.includes(associations)
+    if model = self.class.get_model
+      return model.all
     end
-    return self.get_recordset
+    return nil
   end
   # Get the records this controller has access to *after* any filtering is applied.
   def get_records
-    return @records if instance_variable_defined?(:@records)
-    return @records = self.get_filtered_data(self.get_recordset_with_includes)
+    return @records ||= self.get_filtered_data(self.get_recordset)
   end
   # Get a single record by primary key or another column, if allowed. The return value is cached and
   # exposed to the view as the `@record` instance variable.
   def get_record
     # Cache the result.
-    return @record if instance_variable_defined?(:@record)
+    return @record if @record
     recordset = self.get_recordset
     find_by_key = self.class.get_model.primary_key
@@ -660,8 +631,11 @@ module RESTFramework::BaseModelControllerMixin
   end
 end
+# Alias for convenience.
+RESTFramework::BaseModelControllerMixin = RESTFramework::Mixins::BaseModelControllerMixin
 # Mixin for listing records.
-module RESTFramework::ListModelMixin
+module RESTFramework::Mixins::ListModelMixin
   def index
     return api_response(self.get_index_records)
   end
@@ -688,15 +662,21 @@ module RESTFramework::ListModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::ListModelMixin = RESTFramework::Mixins::ListModelMixin
 # Mixin for showing records.
-module RESTFramework::ShowModelMixin
+module RESTFramework::Mixins::ShowModelMixin
   def show
     return api_response(self.get_record)
   end
 end
+# Alias for convenience.
+RESTFramework::ShowModelMixin = RESTFramework::Mixins::ShowModelMixin
 # Mixin for creating records.
-module RESTFramework::CreateModelMixin
+module RESTFramework::Mixins::CreateModelMixin
   def create
     return api_response(self.create!, status: :created)
   end
@@ -707,8 +687,11 @@ module RESTFramework::CreateModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::CreateModelMixin = RESTFramework::Mixins::CreateModelMixin
 # Mixin for updating records.
-module RESTFramework::UpdateModelMixin
+module RESTFramework::Mixins::UpdateModelMixin
   def update
     return api_response(self.update!)
   end
@@ -721,8 +704,11 @@ module RESTFramework::UpdateModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::UpdateModelMixin = RESTFramework::Mixins::UpdateModelMixin
 # Mixin for destroying records.
-module RESTFramework::DestroyModelMixin
+module RESTFramework::Mixins::DestroyModelMixin
   def destroy
     self.destroy!
     return api_response("")
@@ -734,8 +720,11 @@ module RESTFramework::DestroyModelMixin
   end
 end
+# Alias for convenience.
+RESTFramework::DestroyModelMixin = RESTFramework::Mixins::DestroyModelMixin
 # Mixin that includes show/list mixins.
-module RESTFramework::ReadOnlyModelControllerMixin
+module RESTFramework::Mixins::ReadOnlyModelControllerMixin
   include RESTFramework::BaseModelControllerMixin
   include RESTFramework::ListModelMixin
@@ -746,8 +735,11 @@ module RESTFramework::ReadOnlyModelControllerMixin
   end
 end
+# Alias for convenience.
+RESTFramework::ReadOnlyModelControllerMixin = RESTFramework::Mixins::ReadOnlyModelControllerMixin
 # Mixin that includes all the CRUD mixins.
-module RESTFramework::ModelControllerMixin
+module RESTFramework::Mixins::ModelControllerMixin
   include RESTFramework::BaseModelControllerMixin
   include RESTFramework::ListModelMixin
@@ -760,3 +752,6 @@ module RESTFramework::ModelControllerMixin
     RESTFramework::BaseModelControllerMixin.included(base)
   end
 end
+# Alias for convenience.
+RESTFramework::ModelControllerMixin = RESTFramework::Mixins::ModelControllerMixin

data/lib/rest_framework/mixins.rb ADDED Viewed

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

data/lib/rest_framework/paginators/base_paginator.rb ADDED Viewed

@@ -0,0 +1,19 @@
+class RESTFramework::Paginators::BasePaginator
+  def initialize(data:, controller:, **kwargs)
+    @data = data
+    @controller = controller
+  end
+  # Get the page and return it so the caller can serialize it.
+  def get_page
+    raise NotImplementedError
+  end
+  # Wrap the serialized page with appropriate metadata.
+  def get_paginated_response(serialized_page)
+    raise NotImplementedError
+  end
+end
+# Alias for convenience.
+RESTFramework::BasePaginator = RESTFramework::Paginators::BasePaginator

data/lib/rest_framework/paginators/page_number_paginator.rb ADDED Viewed

@@ -0,0 +1,73 @@
+# A simple paginator based on page numbers.
+#
+# Example: http://example.com/api/users/?page=3&page_size=50
+class RESTFramework::Paginators::PageNumberPaginator < RESTFramework::Paginators::BasePaginator
+  def initialize(**kwargs)
+    super
+    # Exclude any `select` clauses since that would cause `count` to fail with a SQL `SyntaxError`.
+    @count = @data.except(:select).count
+    @page_size = self._page_size
+    @total_pages = @count / @page_size
+    @total_pages += 1 if @count % @page_size != 0
+  end
+  def _page_size
+    page_size = nil
+    # Get from context, if allowed.
+    if @controller.page_size_query_param
+      if page_size = @controller.params[@controller.page_size_query_param].presence
+        page_size = page_size.to_i
+      end
+    end
+    # Otherwise, get from config.
+    if !page_size && @controller.page_size
+      page_size = @controller.page_size
+    end
+    # Ensure we don't exceed the max page size.
+    if @controller.max_page_size && page_size > @controller.max_page_size
+      page_size = @controller.max_page_size
+    end
+    # Ensure we return at least 1.
+    return page_size.zero? ? 1 : page_size
+  end
+  # Get the page and return it so the caller can serialize it.
+  def get_page(page_number=nil)
+    # If page number isn't provided, infer from the params or use 1 as a fallback value.
+    unless page_number
+      page_number = @controller&.params&.[](@controller.page_query_param&.to_sym)
+      if page_number.blank?
+        page_number = 1
+      else
+        page_number = page_number.to_i
+        if page_number.zero?
+          page_number = 1
+        end
+      end
+    end
+    @page_number = page_number
+    # Get the data page and return it so the caller can serialize the data in the proper format.
+    page_index = @page_number - 1
+    return @data.limit(@page_size).offset(page_index * @page_size)
+  end
+  # Wrap the serialized page with appropriate metadata. TODO: include links.
+  def get_paginated_response(serialized_page)
+    return {
+      count: @count,
+      page: @page_number,
+      page_size: @page_size,
+      total_pages: @total_pages,
+      results: serialized_page,
+    }
+  end
+end
+# Alias for convenience.
+RESTFramework::PageNumberPaginator = RESTFramework::Paginators::PageNumberPaginator

data/lib/rest_framework/paginators.rb CHANGED Viewed

@@ -1,90 +1,9 @@
-class RESTFramework::BasePaginator
-  def initialize(data:, controller:, **kwargs)
-    @data = data
-    @controller = controller
-  end
-  # Get the page and return it so the caller can serialize it.
-  def get_page
-    raise NotImplementedError
-  end
-  # Wrap the serialized page with appropriate metadata.
-  def get_paginated_response(serialized_page)
-    raise NotImplementedError
-  end
+module RESTFramework::Paginators
 end
-# A simple paginator based on page numbers.
-#
-# Example: http://example.com/api/users/?page=3&page_size=50
-class RESTFramework::PageNumberPaginator < RESTFramework::BasePaginator
-  def initialize(**kwargs)
-    super
-    # Exclude any `select` clauses since that would cause `count` to fail with a SQL `SyntaxError`.
-    @count = @data.except(:select).count
-    @page_size = self._page_size
-    @total_pages = @count / @page_size
-    @total_pages += 1 if @count % @page_size != 0
-  end
-  def _page_size
-    page_size = nil
-    # Get from context, if allowed.
-    if @controller.page_size_query_param
-      if page_size = @controller.params[@controller.page_size_query_param].presence
-        page_size = page_size.to_i
-      end
-    end
-    # Otherwise, get from config.
-    if !page_size && @controller.page_size
-      page_size = @controller.page_size
-    end
+require_relative "paginators/base_paginator"
-    # Ensure we don't exceed the max page size.
-    if @controller.max_page_size && page_size > @controller.max_page_size
-      page_size = @controller.max_page_size
-    end
-    # Ensure we return at least 1.
-    return page_size.zero? ? 1 : page_size
-  end
-  # Get the page and return it so the caller can serialize it.
-  def get_page(page_number=nil)
-    # If page number isn't provided, infer from the params or use 1 as a fallback value.
-    unless page_number
-      page_number = @controller&.params&.[](@controller.page_query_param&.to_sym)
-      if page_number.blank?
-        page_number = 1
-      else
-        page_number = page_number.to_i
-        if page_number.zero?
-          page_number = 1
-        end
-      end
-    end
-    @page_number = page_number
-    # Get the data page and return it so the caller can serialize the data in the proper format.
-    page_index = @page_number - 1
-    return @data.limit(@page_size).offset(page_index * @page_size)
-  end
-  # Wrap the serialized page with appropriate metadata. TODO: include links.
-  def get_paginated_response(serialized_page)
-    return {
-      count: @count,
-      page: @page_number,
-      page_size: @page_size,
-      total_pages: @total_pages,
-      results: serialized_page,
-    }
-  end
-end
+require_relative "paginators/page_number_paginator"
 # TODO: implement this
 # class RESTFramework::CountOffsetPaginator

data/lib/rest_framework/routers.rb CHANGED Viewed

@@ -1,5 +1,4 @@
 require "action_dispatch/routing/mapper"
-require_relative "utils"
 module ActionDispatch::Routing
   class Mapper

data/lib/rest_framework/serializers/active_model_serializer_adapter_factory.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# This is a helper factory to wrap an ActiveModelSerializer to provide a `serialize` method which
+# accepts both collections and individual records. Use `.for` to build adapters.
+class RESTFramework::Serializers::ActiveModelSerializerAdapterFactory
+  def self.for(active_model_serializer)
+    return Class.new(active_model_serializer) do
+      def serialize
+        if self.object.respond_to?(:to_ary)
+          return self.object.map { |r| self.class.superclass.new(r).serializable_hash }
+        end
+        return self.serializable_hash
+      end
+    end
+  end
+end
+# Alias for convenience.
+# rubocop:disable Layout/LineLength
+RESTFramework::ActiveModelSerializerAdapterFactory = RESTFramework::Serializers::ActiveModelSerializerAdapterFactory
+# rubocop:enable Layout/LineLength

data/lib/rest_framework/serializers/base_serializer.rb ADDED Viewed

@@ -0,0 +1,40 @@
+# The base serializer defines the interface for all REST Framework serializers.
+class RESTFramework::Serializers::BaseSerializer
+  # Add `object` accessor to be compatible with `ActiveModel::Serializer`.
+  attr_accessor :object
+  # Accept/ignore `*args` to be compatible with the `ActiveModel::Serializer#initialize` signature.
+  def initialize(object=nil, *args, controller: nil, **kwargs)
+    @object = object
+    @controller = controller
+  end
+  # The primary interface for extracting a native Ruby types. This works both for records and
+  # collections. We accept and ignore `*args` for compatibility with `active_model_serializers`.
+  def serialize(*args)
+    raise NotImplementedError
+  end
+  # Synonym for `serialize` for compatibility with `active_model_serializers`.
+  def serializable_hash(*args)
+    return self.serialize(*args)
+  end
+  # For compatibility with `active_model_serializers`.
+  def self.cache_enabled?
+    return false
+  end
+  # For compatibility with `active_model_serializers`.
+  def self.fragment_cache_enabled?
+    return false
+  end
+  # For compatibility with `active_model_serializers`.
+  def associations(*args, **kwargs)
+    return []
+  end
+end
+# Alias for convenience.
+RESTFramework::BaseSerializer = RESTFramework::Serializers::BaseSerializer