forest_admin_datasource_customizer 1.0.0.pre.beta.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a57e523c5b7c53d6a40452a6f9ea21a7a1b858ab1a39a3f5cac3fe83ec93ec27
+  data.tar.gz: a6cf096f51d0ed6c12fa9787e69b74c75663f1eba63981822369ba41a73bd621
+SHA512:
+  metadata.gz: ba6b15e85b6c7bd38cf9a32b26824b52c8078a33b0001add15942a042c8d5afd8fd4d7a3e21d742cdce700338a62f1a0b928d3d40ee8af171ae92acad415d02f
+  data.tar.gz: 9deebebbc665d471aa7450e23df9bd12df12d0333cca89aefa1cd3cabf710a755c0821ee944d41daa8ee1437b31ce5ddb90256f53b8be8f55cd1b819618a6b2d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,31 @@
+# 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.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/forest_admin_datasource_customizer.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require_relative "lib/forest_admin_datasource_customizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name         = "forest_admin_datasource_customizer"
+  spec.version      = ForestAdminDatasourceCustomizer::VERSION
+  spec.authors      = ["Matthieu", "Nicolas"]
+  spec.email        = ["matthv@gmail.com", "nicolasalexandre9@gmail.com"]
+  spec.homepage     = "https://www.forestadmin.com"
+  spec.summary      = "Ruby agent for Forest Admin."
+  spec.description  = "Forest is a modern admin interface that works on all major web frameworks. This gem makes Forest
+admin work on any Ruby application."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ForestAdmin/agent-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/ForestAdmin/agent-ruby/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "false"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ .git Gemfile LICENSE])
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6.1"
+  spec.add_dependency "zeitwerk", "~> 2.3"
+end

data/lib/forest_admin_datasource_customizer/collection_customizer.rb

@@ -0,0 +1,25 @@
+module ForestAdminDatasourceCustomizer
+  class CollectionCustomizer
+    attr_reader :datasource_customizer, :stack, :name
+
+    def initialize(datasource_customizer, stack, name)
+      @datasource_customizer = datasource_customizer
+      @stack = stack
+      @name = name
+    end
+
+    def schema
+      @stack.datasource.get_collection(@name).schema
+    end
+
+    def collection
+      @stack.datasource.get_collection(@name)
+    end
+
+    def use(plugin, options = [])
+      push_customization(
+        -> { plugin.run(@datasource_customizer, self, options) }
+      )
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/datasource_customizer.rb

@@ -0,0 +1,51 @@
+module ForestAdminDatasourceCustomizer
+  class DatasourceCustomizer
+    attr_reader :stack
+
+    def initialize(_db_config = {})
+      @composite_datasource = ForestAdminDatasourceToolkit::Datasource.new
+      @stack = Decorators::DecoratorsStack.new(@composite_datasource)
+    end
+
+    def schema
+      @stack.datasource.schema
+    end
+
+    def get_collection(name)
+      CollectionCustomizer.new(self, @stack, name)
+    end
+
+    def collections
+      @stack.datasource.collections.transform_values { |collection| get_collection(collection.name) }
+    end
+
+    def datasource
+      # TODO: call @stack.apply_queued_customizations(logger);
+
+      @stack.datasource
+    end
+
+    def add_datasource(datasource, _options)
+      # TODO: add include/exclude behavior
+      # TODO: add rename behavior
+
+      datasource.collections.each_value { |collection| @composite_datasource.add_collection(collection) }
+    end
+
+    def add_chart(name, definition)
+      # TODO: to implement
+    end
+
+    def use(plugin, options)
+      # TODO: to implement
+    end
+
+    def customize_collection(name, handle)
+      # TODO: to implement
+    end
+
+    def remove_collection(names)
+      # TODO: to implement
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/decorators_stack.rb

@@ -0,0 +1,34 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    class DecoratorsStack
+      include ForestAdminDatasourceToolkit::Decorators
+
+      attr_reader :datasource, :empty
+
+      def initialize(datasource)
+        last = datasource
+        last = @empty = DatasourceDecorator.new(last, Empty::EmptyCollectionDecorator)
+        @datasource = last
+      end
+
+      def queue_customization(customization)
+        @customizations << customization
+      end
+
+      # Apply all customizations
+      # Plugins may queue new customizations, or call other plugins which will queue customizations.
+      #
+      # This method will be called recursively and clears the queue at each recursion to ensure
+      # that all customizations are applied in the right order.
+      def apply_queued_customizations(logger)
+        queued_customizations = @customizations.pop
+        @customizations = []
+
+        while queued_customizations.length.positive?
+          queued_customizations.shift.call(logger)
+          apply_queued_customizations(logger)
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/empty/empty_collection_decorator.rb

@@ -0,0 +1,82 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Empty
+      class EmptyCollectionDecorator < ForestAdminDatasourceToolkit::Decorators::CollectionDecorator
+        include ForestAdminDatasourceToolkit::Decorators
+        include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+
+        def list(_caller, filter, _projection)
+          return super unless return_empty_set(filter.condition_tree)
+
+          []
+        end
+
+        def update(caller, filter, patch)
+          super unless return_empty_set(filter.condition_tree)
+        end
+
+        def delete(caller, filter)
+          super unless return_empty_set(filter.condition_tree)
+        end
+
+        def aggregate(caller, filter, aggregation, limit = nil)
+          return super unless return_empty_set(filter.condition_tree)
+
+          []
+        end
+
+        private
+
+        def return_empty_set(tree)
+          return leaf_return_empty_set(tree) if tree.is_a? Nodes::ConditionTreeLeaf
+
+          if tree.is_a?(Nodes::ConditionTreeBranch) && tree.aggregator == 'Or'
+            return or_return_empty_set(tree.conditions)
+          end
+
+          if tree.is_a?(Nodes::ConditionTreeBranch) && tree.aggregator == 'And'
+            return and_return_empty_set(tree.conditions)
+          end
+
+          false
+        end
+
+        def leaf_return_empty_set(leaf)
+          # Empty 'in` always return zero records.
+          leaf.operator == Operators::IN && leaf.value.empty?
+        end
+
+        def or_return_empty_set(conditions)
+          # Or return no records when
+          # - they have no conditions
+          # - they have only conditions which return zero records.
+          conditions.empty? || conditions.all? { |condition| return_empty_set(condition) }
+        end
+
+        def and_return_empty_set(conditions)
+          # There is a leaf which returns zero records
+          return true if conditions.one? { |condition| return_empty_set(condition) }
+
+          # Scans for mutually exclusive conditions
+          # (this a naive implementation, it will miss many occurrences)
+          values_by_field = {}
+          leafs = conditions.select { |condition| condition.is_a? Nodes::ConditionTreeLeaf }
+          leafs.each do |leaf|
+            field, operator, value = leaf.to_h.values_at(:field, :operator, :value)
+            if !values_by_field.key?(field) && operator == Operators::EQUAL
+              values_by_field[field] = [value]
+            elsif !values_by_field.key?(field) && operator == Operators::IN
+              values_by_field[field] = value
+            elsif values_by_field.key?(field) && operator == Operators::EQUAL
+              values_by_field[field] = values_by_field[field].include?(value) ? [value] : []
+            elsif values_by_field.key?(field) && operator == Operators::IN
+              values_by_field[field] = values_by_field[field].select { |v| value.include?(v) }
+            end
+          end
+
+          values_by_field.values.one?(&:empty?)
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/plugins/plugin.rb

@@ -0,0 +1,9 @@
+module ForestAdminDatasourceCustomizer
+  module Plugins
+    class Plugin
+      def run(_datasource_customizer, _collection_customizer = nil, _options = [])
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/version.rb

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

data/lib/forest_admin_datasource_customizer.rb

@@ -0,0 +1,10 @@
+require_relative 'forest_admin_datasource_customizer/version'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ForestAdminDatasourceCustomizer
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/forest_admin_datasource_customizer.rbs

@@ -0,0 +1,4 @@
+module ForestAdminDatasourceCustomizer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: forest_admin_datasource_customizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta.21
+platform: ruby
+authors:
+- Matthieu
+- Nicolas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: |-
+  Forest is a modern admin interface that works on all major web frameworks. This gem makes Forest
+  admin work on any Ruby application.
+email:
+- matthv@gmail.com
+- nicolasalexandre9@gmail.com
+executables: []
+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/datasource_customizer.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/plugins/plugin.rb
+- lib/forest_admin_datasource_customizer/version.rb
+- sig/forest_admin_datasource_customizer.rbs
+homepage: https://www.forestadmin.com
+licenses:
+- MIT
+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
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Ruby agent for Forest Admin.
+test_files: []