forest_admin_datasource_customizer 1.0.0.pre.beta.21 → 1.0.0.pre.beta.57

data/lib/forest_admin_datasource_customizer/decorators/write/update_relations/update_relations_collection_decorator.rb

@@ -0,0 +1,96 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Write
+      module UpdateRelations
+        class UpdateRelationsCollectionDecorator < ForestAdminDatasourceToolkit::Decorators::CollectionDecorator
+          include ForestAdminDatasourceToolkit::Components::Query
+
+          def update(caller, filter, patch)
+            # Step 1: Perform the normal update
+            if patch.keys.any? { |key| schema[:fields][key].type == 'Column' }
+              patch_without_relations = patch.reduce({}) do |carry, (key, value)|
+                schema[:fields][key].type == 'Column' ? carry.merge(key => value) : carry
+              end
+
+              child_collection.update(caller, filter, patch_without_relations)
+            end
+
+            # Step 2: Perform additional updates for relations
+            return unless patch.keys.any? { |key| schema[:fields][key].type != 'Column' }
+
+            # Fetch the records that will be updated, to know which relations need to be created/updated
+            projection = build_projection(patch)
+            records = list(caller, filter, projection)
+
+            # Perform the updates for each relation
+            patch.keys
+                 .filter { |key| schema[:fields][key].type != 'Column' }
+                 .map { |key| create_or_update_relation(caller, records, key, patch[key]) }
+          end
+
+          private
+
+          # Build a projection that has enough information to know
+          # - which relations need to be created/updated
+          # - the values that will be used to build filters to target records
+          # - the values that will be used to create/update the relations
+          def build_projection(patch)
+            projection = Projection.new.with_pks(self)
+
+            patch.each_key do |key|
+              field_schema = schema[:fields][key]
+
+              next unless field_schema.type != 'Column'
+
+              relation = datasource.get_collection(field_schema.foreign_collection)
+
+              projection = projection.union(Projection.new.with_pks(relation).nest(prefix: key))
+              if field_schema.type == 'ManyToOne'
+                projection = projection.union(Projection.new([field_schema.foreign_key_target]).nest(prefix: key))
+              end
+              if field_schema.type == 'OneToOne'
+                projection = projection.union(Projection.new([field_schema.origin_key_target]).nest(prefix: key))
+              end
+            end
+
+            projection
+          end
+
+          def create_or_update_relation(caller, records, key, patch)
+            field_schema = schema[:fields][key]
+            relation = datasource.get_collection(field_schema.foreign_collection)
+            creates = records.filter { |r| !r[key] || r[key].nil? }
+            updates = records.filter { |r| r[key] && !r[key].nil? }
+
+            unless creates.empty?
+              if field_schema.type == 'ManyToOne'
+                # Create many-to-one relations
+                sub_record = relation.create(caller, patch)
+
+                # Set foreign key on the parent records
+                condition_tree = ConditionTree::ConditionTreeFactory.match_records(self, creates)
+                parent_patch = { field_schema.foreign_key => sub_record[field_schema.foreign_key_target] }
+
+                update(caller, Filter.new(condition_tree: condition_tree), parent_patch)
+              else
+                # Create the one-to-one relations that don't already exist
+                relation.create(
+                  caller,
+                  patch.merge(field_schema.origin_key => creates.first[field_schema.origin_key_target])
+                )
+              end
+            end
+
+            # Update the relations that already exist
+            return if updates.empty?
+
+            sub_records = updates.map { |record| record[key] }
+            condition_tree = ConditionTree::ConditionTreeFactory.match_records(relation, sub_records)
+
+            relation.update(caller, Filter.new(condition_tree: condition_tree), patch)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/write/write_datasource_decorator.rb

@@ -0,0 +1,14 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Write
+      class WriteDatasourceDecorator < ForestAdminDatasourceToolkit::Decorators::DatasourceDecorator
+        include ForestAdminDatasourceToolkit::Decorators
+        def initialize(child_datasource)
+          create = DatasourceDecorator.new(child_datasource, CreateRelations::CreateRelationsCollectionDecorator)
+          update = DatasourceDecorator.new(create, UpdateRelations::UpdateRelationsCollectionDecorator)
+          super(update, WriteReplace::WriteReplaceCollectionDecorator)
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/write/write_replace/write_customization_context.rb

@@ -0,0 +1,18 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Write
+      module WriteReplace
+        class WriteCustomizationContext < ForestAdminDatasourceCustomizer::Context::CollectionCustomizationContext
+          attr_reader :action, :record, :filter
+
+          def initialize(collection, caller, action, record, filter = nil)
+            super(collection, caller)
+            @action = action
+            @record = record
+            @filter = filter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/write/write_replace/write_replace_collection_decorator.rb

@@ -0,0 +1,125 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Write
+      module WriteReplace
+        class WriteReplaceCollectionDecorator < ForestAdminDatasourceToolkit::Decorators::CollectionDecorator
+          include ForestAdminDatasourceToolkit::Exceptions
+          include ForestAdminDatasourceToolkit::Validations
+          attr_reader :handlers
+
+          def initialize(child_collection, datasource)
+            super
+            @handlers = {}
+          end
+
+          def replace_field_writing(field_name, &definition)
+            raise ForestException, 'A new writing method should be provided to replace field writing' unless definition
+
+            ForestAdminDatasourceToolkit::Validations::FieldValidator.validate(self, field_name)
+
+            @handlers[field_name] = definition
+            mark_schema_as_dirty
+          end
+
+          def refine_schema(child_schema)
+            schema = child_schema.dup
+            schema[:fields] = child_schema[:fields].dup
+
+            @handlers.each do |field_name, handler|
+              schema[:fields][field_name].is_read_only = handler.nil?
+            end
+
+            schema
+          end
+
+          def create(caller, record)
+            new_record = rewrite_patch(caller, 'create', record)
+
+            child_collection.create(caller, new_record)
+          end
+
+          def update(caller, filter, patch)
+            new_patch = rewrite_patch(caller, 'update', patch, [], filter)
+
+            child_collection.update(caller, filter, new_patch)
+          end
+
+          # Takes a patch and recursively applies all rewriting rules to it.
+          def rewrite_patch(caller, action, patch, used_handlers = [], filter = nil)
+            # We rewrite the patch by applying all handlers on each field.
+            context = WriteCustomizationContext.new(self, caller, action, patch, filter)
+
+            patches = patch.map { |key, _| rewrite_key(context, key, used_handlers) }
+
+            # We now have a list of patches (one per field) that we can merge.
+            new_patch = deep_merge(*patches)
+
+            # Check that the customer handlers did not introduce invalid data.
+            RecordValidator.validate(self, new_patch) if new_patch.length.positive?
+
+            new_patch
+          end
+
+          private
+
+          def rewrite_key(context, key, used)
+            if used.include?(key)
+              raise ForestException, "Conflict value on the field #{key}. It received several values."
+            end
+
+            field_schema = schema.nil? ? nil : schema[:fields][key]
+
+            if field_schema&.type == 'Column'
+              # We either call the customer handler or a default one that does nothing.
+              handler = @handlers[key] || proc { |v| { key => v } }
+              field_patch = if context.record[key] && handler.call(context.record[key], context)
+                              handler.call(context.record[key], context)
+                            else
+                              []
+                            end
+
+              if field_patch && !field_patch.is_a?(Hash)
+                raise ForestException, "The write handler of #{key} should return an Hash or nothing."
+              end
+
+              # Isolate change to our own value (which should not recurse) and the rest which should
+              # trigger the other handlers.
+              value = field_patch[key] || nil
+              new_patch = rewrite_patch(context.caller, context.action, field_patch.except(key), used + [key])
+
+              value ? deep_merge({ key => value }, new_patch) : new_patch
+            elsif field_schema&.type == 'ManyToOne' || field_schema&.type == 'OneToOne'
+              # Delegate relations to the appropriate collection.
+              relation = datasource.get_collection(field_schema.foreign_collection)
+
+              { key => relation.rewrite_patch(context.caller, context.action, context.record[key]) }
+            else
+              raise ForestException, "Unknown field: '#{key}'"
+            end
+          end
+
+          # Recursively merge patches into a single one ensuring that there is no conflict.
+          def deep_merge(*patches)
+            acc = {}
+
+            patches.each do |patch|
+              patch = { patch => patch } unless patch.is_a?(Hash)
+
+              patch.each do |sub_key, sub_value|
+                if !acc.key?(sub_key)
+                  acc[sub_key] = sub_value
+                elsif sub_value.is_a?(Hash)
+                  acc[sub_key] = deep_merge(acc[sub_key], sub_value)
+                else
+                  raise ForestException, "Conflict value on the field #{sub_key}. It received several values."
+                end
+              end
+            end
+
+            acc
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/plugins/add_external_relation.rb

@@ -0,0 +1,27 @@
+module ForestAdminDatasourceCustomizer
+  module Plugins
+    class AddExternalRelation < Plugin
+      include ForestAdminDatasourceToolkit::Exceptions
+      include ForestAdminDatasourceCustomizer::Decorators::Computed
+
+      def run(_datasource_customizer, collection_customizer = nil, options = {})
+        primary_keys = ForestAdminDatasourceToolkit::Utils::Schema.primary_keys(collection_customizer.collection)
+
+        unless options.key?(:name) && options.key?(:schema) && options.key?(:listRecords)
+          raise ForestException, 'The options parameter must contains the following keys: `name, schema, listRecords`'
+        end
+
+        collection_customizer.add_field(
+          options[:name],
+          ComputedDefinition.new(
+            column_type: [options[:schema]],
+            dependencies: options[:dependencies] || primary_keys,
+            values: proc { |records, context|
+              records.map { |record| options[:listRecords].call(record, context) }
+            }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/plugins/import_field.rb

@@ -0,0 +1,74 @@
+module ForestAdminDatasourceCustomizer
+  module Plugins
+    class ImportField < Plugin
+      include ForestAdminDatasourceToolkit::Exceptions
+      include ForestAdminDatasourceCustomizer::Decorators::Computed
+
+      def run(datasource_customizer, collection_customizer = nil, options = {})
+        if options[:name].nil? || options[:path].nil?
+          raise ForestException, 'The options parameter must contains the following keys: `name, path`'
+        end
+
+        options[:readonly] = false unless options.key?(:readonly)
+        name = options[:name]
+        result = options[:path].split(':').reduce({ collection: collection_customizer.name }) do |memo, field|
+          collection = datasource_customizer.get_collection(memo[:collection])
+          unless collection.schema[:fields].key?(field)
+            raise ForestException, "Field #{field} not found in collection #{collection.name}"
+          end
+
+          field_schema = collection.schema[:fields][field]
+          if field_schema.type == 'Column'
+            { schema: field_schema }
+          elsif field_schema.type == 'ManyToOne' || field_schema.type == 'OneToOne'
+            { collection: field_schema.foreign_collection }
+          end
+        end
+
+        schema = result[:schema]
+        collection_customizer.add_field(
+          name,
+          ComputedDefinition.new(
+            column_type: schema.column_type,
+            dependencies: [options[:path]],
+            values: proc { |records|
+              records.map { |record| ForestAdminDatasourceToolkit::Utils::Record.field_value(record, options[:path]) }
+            },
+            default_value: schema.default_value,
+            enum_values: schema.enum_values
+          )
+        )
+
+        unless options[:readonly] || schema.is_read_only
+          collection_customizer.replace_field_writing(name) do |value|
+            path = options[:path].split(':')
+            writing_path = path.reduce({}) do |nested_path, current_path|
+              nested_path[current_path] = path.index(current_path) == path.size - 1 ? value : {}
+              nested_path[current_path]
+            end
+
+            writing_path
+          end
+        end
+
+        if !options[:readonly] && schema.is_read_only
+          raise ForestException,
+                "Readonly option should not be false because the field #{options[:path]} is not writable"
+        end
+
+        schema.filter_operators.each do |operator|
+          collection_customizer.replace_field_operator(name, operator) do |value|
+            { field: options[:path], operator: operator, value: value }
+          end
+        end
+
+        return unless schema.is_sortable
+
+        collection_customizer.replace_field_sorting(
+          name,
+          [{ field: options[:path], ascending: true }]
+        )
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminDatasourceCustomizer
-  VERSION = "1.0.0-beta.21"
+  VERSION = "1.0.0-beta.57"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_datasource_customizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.21
+  version: 1.0.0.pre.beta.57
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +25,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -50,24 +70,83 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- README.md
 - Rakefile
 - forest_admin_datasource_customizer.gemspec
 - lib/forest_admin_datasource_customizer.rb
 - lib/forest_admin_datasource_customizer/collection_customizer.rb
+- lib/forest_admin_datasource_customizer/context/agent_customization_context.rb
+- lib/forest_admin_datasource_customizer/context/collection_customization_context.rb
+- lib/forest_admin_datasource_customizer/context/relaxed_wrappers/relaxed_collection.rb
+- lib/forest_admin_datasource_customizer/context/relaxed_wrappers/relaxed_data_source.rb
 - lib/forest_admin_datasource_customizer/datasource_customizer.rb
+- lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/action/base_action.rb
+- lib/forest_admin_datasource_customizer/decorators/action/context/action_context.rb
+- lib/forest_admin_datasource_customizer/decorators/action/context/action_context_single.rb
+- lib/forest_admin_datasource_customizer/decorators/action/dynamic_field.rb
+- lib/forest_admin_datasource_customizer/decorators/action/result_builder.rb
+- lib/forest_admin_datasource_customizer/decorators/action/types/action_scope.rb
+- lib/forest_admin_datasource_customizer/decorators/action/types/field_type.rb
+- lib/forest_admin_datasource_customizer/decorators/action/widget_field.rb
+- lib/forest_admin_datasource_customizer/decorators/binary/binary_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/binary/binary_helper.rb
+- lib/forest_admin_datasource_customizer/decorators/chart/chart_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/chart/chart_context.rb
+- lib/forest_admin_datasource_customizer/decorators/chart/chart_datasource_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/chart/result_builder.rb
+- lib/forest_admin_datasource_customizer/decorators/computed/compute_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/computed/computed_definition.rb
+- lib/forest_admin_datasource_customizer/decorators/computed/utils/computed_field.rb
+- lib/forest_admin_datasource_customizer/decorators/computed/utils/flattener.rb
 - lib/forest_admin_datasource_customizer/decorators/decorators_stack.rb
 - lib/forest_admin_datasource_customizer/decorators/empty/empty_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/after/hook_after_aggregate_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/after/hook_after_create_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/after/hook_after_delete_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/after/hook_after_list_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/after/hook_after_update_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/before/hook_before_aggregate_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/before/hook_before_create_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/before/hook_before_delete_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/before/hook_before_list_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/before/hook_before_update_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/context/hook_context.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/hook_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/hook/hooks.rb
+- lib/forest_admin_datasource_customizer/decorators/operators_emulate/operators_emulate_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/operators_equivalence/operators_equivalence_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/override/context/create_override_customization_context.rb
+- lib/forest_admin_datasource_customizer/decorators/override/context/delete_override_customization_context.rb
+- lib/forest_admin_datasource_customizer/decorators/override/context/update_override_customization_context.rb
+- lib/forest_admin_datasource_customizer/decorators/override/override_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/publication/publication_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/publication/publication_datasource_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/relation/relation_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/rename_collection/rename_collection_datasource_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/rename_collection/rename_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/rename_field/rename_field_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/schema/schema_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/search/search_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/segment/segment_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/sort/sort_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/validation/validation_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/write/create_relations/create_relations_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/write/update_relations/update_relations_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/write/write_datasource_decorator.rb
+- lib/forest_admin_datasource_customizer/decorators/write/write_replace/write_customization_context.rb
+- lib/forest_admin_datasource_customizer/decorators/write/write_replace/write_replace_collection_decorator.rb
+- lib/forest_admin_datasource_customizer/plugins/add_external_relation.rb
+- lib/forest_admin_datasource_customizer/plugins/import_field.rb
 - lib/forest_admin_datasource_customizer/plugins/plugin.rb
 - lib/forest_admin_datasource_customizer/version.rb
 - sig/forest_admin_datasource_customizer.rbs
 homepage: https://www.forestadmin.com
 licenses:
-- MIT
+- GPL-3.0
 metadata:
   homepage_uri: https://www.forestadmin.com
   source_code_uri: https://github.com/ForestAdmin/agent-ruby
-  changelog_uri: https://github.com/ForestAdmin/agent-ruby/CHANGELOG.md
+  changelog_uri: https://github.com/ForestAdmin/agent-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []

data/README.md

@@ -1,31 +0,0 @@
-# ForestAdminDatasourceCustomizer
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/forest_admin_datasource_customizer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/forest_admin_datasource_customizer.