[+] Resources getter - Add a get_ids_from_request method to get all models IDs given a query or an ID list (#345) (#349)

Author: rap2hpoutre

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 
 ## [Unreleased]
+
+## RELEASE 5.0.0-beta.0 - 2020-03-03
+### Added
+- Resources Getter - Add a get_ids_from_request method to get all models IDs given a query or an ID list.
+- Resource Deletion - Users can now bulk delete records.
+
 ### Fixed
 - Has Many Relationships - Fix records count, i.e consider filters when counting.
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    forest_liana (4.2.0)
+    forest_liana (5.0.0.pre.beta.0)
       arel-helpers
       base32
       bcrypt

app/controllers/forest_liana/resources_controller.rb

@@ -137,16 +137,28 @@ def update
     end
 
     def destroy
-      begin
-        checker = ForestLiana::PermissionsChecker.new(@resource, 'delete', @rendering_id)
-        return head :forbidden unless checker.is_authorized?
+      checker = ForestLiana::PermissionsChecker.new(@resource, 'delete', @rendering_id)
+      return head :forbidden unless checker.is_authorized?
 
-        @resource.destroy(params[:id]) if @resource.exists?(params[:id])
-        head :no_content
-      rescue => error
-        FOREST_LOGGER.error "Record Destroy error: #{error}\n#{format_stacktrace(error)}"
-        internal_server_error
-      end
+      @resource.destroy(params[:id]) if @resource.exists?(params[:id])
+
+      head :no_content
+    rescue => error
+      FOREST_LOGGER.error "Record Destroy error: #{error}\n#{format_stacktrace(error)}"
+      internal_server_error
+    end
+
+    def destroy_bulk
+      checker = ForestLiana::PermissionsChecker.new(@resource, 'delete', @rendering_id)
+      return head :forbidden unless checker.is_authorized?
+
+      ids = ForestLiana::ResourcesGetter.get_ids_from_request(params)
+      @resource.destroy(ids) if ids&.any?
+
+      head :no_content
+    rescue => error
+      FOREST_LOGGER.error "Records Destroy error: #{error}\n#{format_stacktrace(error)}"
+      internal_server_error
     end
 
     private

app/controllers/forest_liana/router.rb

@@ -30,7 +30,11 @@ def call(env)
         when 'POST'
           action = 'create'
         when 'DELETE'
-          action = 'destroy'
+          if params[:id]
+            action = 'destroy'
+          else
+            action = 'destroy_bulk'
+          end
         end
 
         controller.action(action.to_sym).call(env)

app/services/forest_liana/has_many_dissociator.rb

@@ -14,17 +14,22 @@ def perform
 
       remove_association = !@with_deletion || @association.macro == :has_and_belongs_to_many
 
-      if remove_association
-        if @data.is_a?(Array)
-          @data.each do |record_deleted|
-            associated_records.delete(@association.klass.find(record_deleted[:id]))
+      if @data.is_a?(Array)
+        record_ids = @data.map { |record| record[:id] }
+      elsif @data.dig('attributes').present?
+        record_ids = ForestLiana::ResourcesGetter.get_ids_from_request(@params)
+      else
+        record_ids = Array.new
+      end
+
+      if !record_ids.nil? && record_ids.any?
+        if remove_association
+          record_ids.each do |id|
+            associated_records.delete(@association.klass.find(id))
           end
         end
-      end
 
-      if @with_deletion
-        if @data.is_a?(Array)
-          record_ids = @data.map { |record| record[:id] }
+        if @with_deletion
           record_ids = record_ids.select { |record_id| @association.klass.exists?(record_id) }
           @association.klass.destroy(record_ids)
         end

app/services/forest_liana/resources_getter.rb

@@ -19,6 +19,51 @@ def initialize(resource, params)
       prepare_query()
     end
 
+    def self.get_ids_from_request(params)
+      attributes = params.dig('data', 'attributes')
+      has_body_attributes = attributes != nil
+      is_select_all_records_query = has_body_attributes && attributes[:all_records] == true
+
+      # NOTICE: If it is not a "select all records" query and it receives a list of ID, return list of ID.
+      return attributes[:ids] if (!is_select_all_records_query && attributes[:ids])
+
+      # NOTICE: If it is a "select all records" we have to perform query to build ID list.
+      ids = Array.new
+
+      # NOTICE: Merging all_records_subset_query into attributes preserves filters in HasManyGetter and ResourcesGetter.
+      attributes = attributes.merge(attributes[:all_records_subset_query].dup.to_unsafe_h)
+
+      # NOTICE: Initialize actual resources getter (could either a HasManyGetter or a ResourcesGetter).
+      is_related_data = attributes[:parent_collection_id] &&
+        attributes[:parent_collection_name] &&
+        attributes[:parent_association_name]
+      if is_related_data
+        parent_collection_name = attributes[:parent_collection_name]
+        parent_model = ForestLiana::SchemaUtils.find_model_from_collection_name(parent_collection_name)
+        model = parent_model.reflect_on_association(attributes[:parent_association_name].try(:to_sym))
+        resources_getter = ForestLiana::HasManyGetter.new(parent_model, model, attributes.merge({
+          collection: parent_collection_name,
+          id: attributes[:parent_collection_id],
+          association_name: attributes[:parent_association_name],
+        }))
+      else
+        collection_name = attributes[:collection_name]
+        model = ForestLiana::SchemaUtils.find_model_from_collection_name(collection_name)
+        resources_getter = ForestLiana::ResourcesGetter.new(model, attributes)
+      end
+
+      # NOTICE: build IDs list.
+      resources_getter.query_for_batch.find_in_batches() do |records|
+        ids += records.map { |record| record.id }
+      end
+
+      # NOTICE: remove excluded IDs.
+      ids_excluded = (attributes[:all_records_ids_excluded]).map { |id_excluded| id_excluded.to_s }
+      return ids.select { |id| !ids_excluded.include? id.to_s } if (ids_excluded && ids_excluded.any?)
+
+      return ids
+    end
+
     def perform
       @records = @records.eager_load(@includes)
     end

config/routes.rb

@@ -53,6 +53,7 @@
   post ':collection', to: router
   put ':collection/:id', to: router
   delete ':collection/:id', to: router
+  delete ':collection', to: router
 
   # Smart Actions forms value
   post 'actions/:action_name/values' => 'actions#values'

lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "4.2.0"
+  VERSION = "5.0.0-beta.0"
 end

package.json

@@ -1,6 +1,6 @@
 {
   "name": "forest-rails",
-  "version": "4.2.0",
+  "version": "5.0.0-beta.0",
   "description": "The official Rails liana for Forest.",
   "directories": {
     "test": "test"