restme 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 852b2273c90c0c2eb2673bed5fe62a28df112f2eddd55287c415afff487647db
-  data.tar.gz: 746415d80a0fd053b9fb89e86f06116416c16c978727472475d6e22bf2c974ae
+  metadata.gz: 0f3c9d79dc88d267a1198ec23b54f05d8af00367125b1cf1f3fcd6c458633b35
+  data.tar.gz: 48c79f664b0fb61dea85fdd4d2d56d63520f7389c6b31adbead1c41a6b945268
 SHA512:
-  metadata.gz: 981cfa7a02a73c7024cab361704daf3151660abf062324ce3ad44ecf121083349272782a72df26349f58c0550d7f3b7287b71e03e2fdb8502e386267ef1b3464
-  data.tar.gz: a5d92fa8e80b2f1ff7fceee0c0e0c5d42067b4908d07e45fcf461ebcc6528559dec7b4422ba4c8ae42ab0f7c422482c08fdbe57425d4b0efed0f115975221fc7
+  metadata.gz: 80455f1ab99ddec14145d9ed3229c491abfd48c1d2db0fae6532d56ca3304783749d2cba38216ef6529ed6a2985743ed41c3feb2e3fb72273eb8c1a87eae332a
+  data.tar.gz: e7033c0ded95c20fb3df221af86dff3801a67c80cd7b9f3ac4d070f4f64b979d385e01874bbceccdf0affac556752261ffc24e22acd485651d9163650083f8c8

data/README.md

@@ -13,7 +13,7 @@ This gem manages your controller's responsibilities for:
 
 GEMFILE:
 ```bash
-gem 'restme', '~> 1.0', '>= 1.0.2'
+gem 'restme', '~> 1.1'
 ```
 
 INSTALL:
@@ -28,6 +28,35 @@ gem 'restme'
  - You must create a folder inside app named restfy to define controller rules for authorization, scoping, creation, updating, and field selection (see example below).
 
 
+<br>
+
+## Optional Configuration (Available from version 1.1 or higher)
+
+You can create a `restme.rb` file inside `config/initializers` to customize Restme's behavior:
+
+- Define the name of the controller variable that holds the current user (default: `current_user`).
+- Define the name of the user field that identifies the user's role (default: `role`).
+- Set the default number of items returned per page (default: `12`).
+- Set the default starting page (default: `1`).
+- Define the maximum number of items allowed per page (default: `100`).
+
+Example:
+
+```ruby
+# config/initializers/restme.rb
+
+Restme.configure do |config|
+  config.current_user_variable = :current_user
+  config.user_role_field = :role
+  config.pagination_default_per_page = 12
+  config.pagination_default_page = 1
+  config.pagination_max_per_page = 100
+end
+```
+
+<br>
+
+
 ### Usage examples
 
 Rails API project example here: https://github.com/everson-ever/restme-example/pull/1
@@ -186,6 +215,10 @@ module ProductsController::Field
       },
       category: {
         table_name: :categories
+      },
+      producer: { # When a nested field can be nil, Restme will not return the primary model unless a LEFT JOIN is explicitly used.
+        table_name: :producers,
+        join_type: :left_joins  # Use that so Restme will generate a LEFT JOIN instead of an INNER JOIN. This will
       }
     }.freeze
   end

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/rules.rb

@@ -64,8 +64,8 @@ module Restme
       def pagination
         {
           page: page_no,
-          pages: pages(model_scope),
-          total_items: total_items(model_scope)
+          pages: pages(filtered_scope),
+          total_items: total_items(filtered_scope)
         }
       end
 

data/lib/restme/version.rb

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

metadata

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