restme 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cccc4f918f72719fedda5f137e14cdccf49de3931209a7adf2e9f7d7a974068c
-  data.tar.gz: 0e3a7821d6883250e28bb75b5f6ca50841166f6fff2a180740daf8f59dd323df
+  metadata.gz: 9a2a5ee870751a00ca5907e773e8d1aaf34fefd68c66bdcbbd42a0809d38ca19
+  data.tar.gz: 8ef1ff2ab867c127615d53fa903808cc5579f961204cc9ff9306f217f1c7e4ae
 SHA512:
-  metadata.gz: ef683d119c129847df93624eb7f5480db6ec8bb190fe2aff432c59bb228aecec0a699ce1eb9cd91b23e73888fb1d03abe6c01accf1fe278d5ffab57ef51963f3
-  data.tar.gz: bcfefa780c6c4303e47b85492cd80ca51d404c83c8f68976bb0750a949236c0ccc45cd2278a4741747fa877a45b87e418cee46f6675c212e2a80f6572c6ec0bf
+  metadata.gz: 062df3cf4301fad020426e57ee07eb373ab2751c03f6aed5928e32db4988f8283c4e20254c993515d617dbb4b1e581eae2492aad4aecb0fd2610b0cc38c3afbe
+  data.tar.gz: ade0cf78bcce6e49a3ecdeb2eb54513c7761c28bce0df20cdd1630bf61393962b68eb9394bdb6eb5e20c9ff04d619ad94932de1a3218ef1578321ca0ecce9fa0

data/README.md

@@ -8,12 +8,15 @@ This gem manages your controller's responsibilities for:
 - Read Actions: Provide complete pagination, filtering, sorting, and field selection for records, all handled through query parameters (e.g., `http://127.0.0.1/products?name_equal=foo`).
 - Create/Update Actions: Enabling automatic creation and updating of records.
 
+## ℹ️ This doc reference latest version of Restme
+
+
 ## Installation
 
 
 GEMFILE:
 ```bash
-gem 'restme', '~> 1.1'
+gem 'restme', '~> 1.2'
 ```
 
 INSTALL:
@@ -207,15 +210,10 @@ This rule defines which nested_fields are selectable (nested fields are model re
 module ProductsController::Field
   class Rules
     NESTED_SELECTABLE_FIELDS = {
-      unit: {
-        table_name: :units
-      },
-      establishment: {
-        table_name: :establishments
-      },
-      category: {
-        table_name: :categories
-      }
+      unit: {},
+      establishment: {},
+      category: {},
+      producer: {}
     }.freeze
   end
 end
@@ -360,6 +358,15 @@ Example:
 
 ```bash
 http://localhost:3000/api/v1/products?attachment_fields_select=image
+
+{
+  "products": [
+    {
+      "id": 1,
+      "image_url": "http://localhost/image.png", // The field includes the `_url` suffix
+    }
+  ]
+}
 ```
 
 <br><br>

data/lib/restme/scope/field/attachable.rb

@@ -8,19 +8,35 @@ module Restme
         def insert_attachments(scope)
           unallowed_attachment_fields_error
 
-          return scope.uniq if attachment_fields_select.blank?
+          return scope.as_json(json_options) if attachment_fields_select.blank?
 
-          scope = scope.includes(attachment_fields_select_includes).uniq
+          define_attachment_methods
 
-          scope.map do |record|
-            attachment_fields_select.each do |field|
-              @record = record.as_json.merge({ "#{field}": record.send(field).url })
-            end
+          scope.includes(attachment_fields_select_includes)
+               .as_json(json_options)
+        end
+
+        def json_options
+          {
+            include: valid_nested_fields_select,
+            methods: attachment_methods
+          }
+        end
 
-            @record
+        def define_attachment_methods
+          attachment_fields_select.each do |attachment_field_name|
+            klass.class_eval do
+              define_method(:"#{attachment_field_name}_url") do
+                send(attachment_field_name).url
+              end
+            end
           end
         end
 
+        def attachment_methods
+          attachment_fields_select&.map { |field| "#{field}_url" }
+        end
+
         def attachment_fields_select_includes
           attachment_fields_select.map { |field| { "#{field}_attachment": :blob } }
         end

data/lib/restme/scope/field/rules.rb

@@ -22,23 +22,13 @@ module Restme
         end
 
         def select_nested_scope(scoped)
-          scoped.joins(nested_fields_joins)
-                .left_joins(nested_fields_left_joins)
-                .preload(valid_nested_fields_select)
-                .select(nesteds_table)
+          scoped.preload(valid_nested_fields_select)
         end
 
         def select_any_field?
           fields_select || nested_fields_select || attachment_fields_select
         end
 
-        def nesteds_table
-          valid_nested_fields_select&.map do |field|
-            table = nested_selectable_fields_keys.dig(field, :table_name)
-            table.present? ? "#{table}::text AS #{field}" : nil
-          end
-        end
-
         def model_fields_select
           @model_fields_select ||= begin
             fields = fields_select&.split(",")
@@ -51,22 +41,10 @@ module Restme
           @model_attributes ||= klass.new.attributes.keys
         end
 
-        def nested_fields_joins
-          @nested_fields_joins ||= valid_nested_fields_select.select do |field|
-            nested_selectable_fields_keys[field.to_sym][:join_type].blank?
-          end
-        end
-
-        def nested_fields_left_joins
-          @nested_fields_left_joins ||= valid_nested_fields_select.select do |field|
-            nested_selectable_fields_keys[field.to_sym][:join_type] == :left_joins
-          end
-        end
-
         def valid_nested_fields_select
           @valid_nested_fields_select ||=
             nested_fields_select&.split(",")&.select do |field|
-              nested_selectable_fields_keys[field.to_sym].present?
+              nested_selectable_fields_keys.key?(field.to_sym)
             end&.map(&:to_sym)
         end
 

data/lib/restme/scope/filter/rules.rb

@@ -39,7 +39,7 @@ module Restme
           @user_scope = user_scope
 
           return user_scope unless filterable_scope?
-          return user_scope if record_not_found_errors
+          return none_scope if record_not_found_errors
 
           processed_scope
         end

data/lib/restme/scope/rules.rb

@@ -22,11 +22,18 @@ module Restme
       include ::Restme::Shared::CurrentModel
       include ::Restme::Shared::RestmeCurrentUserRole
 
-      attr_reader :filtered_scope, :sorted_scope, :paginated_scope, :fieldated_scope
+      attr_reader :sortable_scope_response, :paginable_scope_response
       attr_writer :restme_scope_errors, :restme_scope_status
 
+      SCOPE_ERROR_METHODS = %i[
+        per_page_errors
+        unknown_sortable_fields_errors
+        unallowed_filter_fields_errors
+        unallowed_select_fields_errors
+      ].freeze
+
       def pagination_response
-        @pagination_response ||= restme_response
+        @pagination_response ||= restme_pagination_response
       end
 
       def model_scope_object
@@ -39,7 +46,7 @@ module Restme
 
       private
 
-      def restme_response
+      def restme_pagination_response
         any_scope_errors
 
         restme_scope_errors.presence || {
@@ -49,10 +56,7 @@ module Restme
       end
 
       def any_scope_errors
-        per_page_errors
-        unknown_sortable_fields_errors
-        unallowed_filter_fields_errors
-        unallowed_select_fields_errors
+        SCOPE_ERROR_METHODS.each { |m| send(m) }
 
         restme_scope_errors
       end
@@ -64,8 +68,8 @@ module Restme
       def pagination
         {
           page: page_no,
-          pages: pages(filtered_scope),
-          total_items: total_items(filtered_scope)
+          pages: pages(filterable_scope_response),
+          total_items: total_items(filterable_scope_response)
         }
       end
 
@@ -80,10 +84,16 @@ module Restme
       end
 
       def custom_scope
-        @filtered_scope = filterable_scope(user_scope)
-        @sorted_scope = sortable_scope(filtered_scope)
-        @paginated_scope = paginable_scope(sorted_scope)
-        @fieldated_scope = fieldable_scope(paginated_scope)
+        return filterable_scope_response if filterable_scope_response.blank?
+
+        @sortable_scope_response = sortable_scope(filterable_scope_response)
+        @paginable_scope_response = paginable_scope(sortable_scope_response)
+
+        fieldable_scope(paginable_scope_response)
+      end
+
+      def filterable_scope_response
+        @filterable_scope_response ||= filterable_scope(user_scope)
       end
 
       def user_scope

data/lib/restme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restme
-  VERSION = "1.1.1"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restme
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - everson-ever