active_element 0.0.11 → 0.0.13

data/lib/active_element/controller_interface.rb

@@ -16,7 +16,7 @@ module ActiveElement
     def initialize(controller_class, controller_instance = nil)
       @controller_class = controller_class
       @controller_instance = controller_instance
-      initialize_state
+      initialize_state(controller_class)
       @missing_template_store = {}
       @authorize = false
     end
@@ -25,20 +25,25 @@ module ActiveElement
       @authorize
     end
 
-    def listable_fields(*args)
-      state[:listable_fields] = args.map(&:to_sym)
+    def listable_fields(*args, order: nil)
+      state.list_order = order
+      state.listable_fields.concat(args.map(&:to_sym)).uniq!
     end
 
     def viewable_fields(*args)
-      state[:viewable_fields] = args.map(&:to_sym)
+      state.viewable_fields.concat(args.map(&:to_sym)).uniq!
     end
 
     def editable_fields(*args)
-      state[:editable_fields] = args.map(&:to_sym)
+      state.editable_fields.concat(args.map(&:to_sym)).uniq!
     end
 
     def searchable_fields(*args)
-      state[:searchable_fields] = args.map(&:to_sym)
+      state.searchable_fields.concat(args.map(&:to_sym)).uniq!
+    end
+
+    def deletable
+      state.deletable = true
     end
 
     def application_name
@@ -46,43 +51,39 @@ module ActiveElement
     end
 
     def authenticate_with(&block)
-      state[:authenticator] = block
+      state.authenticator = block
     end
 
     def authorize_with(&block)
       @authorize = true
-      state[:authorizor] = block
+      state.authorizor = block
     end
 
     def sign_out_with(method: :get, &block)
-      state[:sign_out_method] = method
-      state[:sign_out_path] = block
+      state.sign_out_method = method
+      state.sign_out_path = block
     end
 
     def sign_out_path
-      state[:sign_out_path]&.call
+      state.sign_out_path&.call
     end
 
-    def sign_out_method
-      state[:sign_out_method]
-    end
+    delegate :sign_out_method, to: :state
 
     def sign_in_with(method: :get, &block)
-      state[:sign_in_method] = method
-      state[:sign_in_path] = block
+      state.sign_in_method = method
+      state.sign_in_path = block
     end
 
     def sign_in_path
-      state[:sign_in_path]&.call
+      state.sign_in_path&.call
     end
 
-    def sign_in_method
-      state[:sign_in_method]
-    end
+    delegate :sign_in_method, to: :state
 
     def authenticate
       authenticator&.call
-      @current_user = state[:authorizor]&.call
+      @current_user = state.authorizor&.call
 
       nil
     end
@@ -91,16 +92,12 @@ module ActiveElement
       raise ArgumentError, "Must specify `with: '<permission>'` or `always: true`" unless with.present? || always
       raise ArgumentError, 'Cannot specify both `with` and `always: true`' if with.present? && always
 
-      state[:permissions] << { with: with, always: always, action: action }
+      state.permissions << { with: with, always: always, action: action }
     end
 
-    def authenticator
-      state[:authenticator]
-    end
+    delegate :authenticator, to: :state
 
-    def permissions
-      state.fetch(:permissions)
-    end
+    delegate :permissions, to: :state
 
     def component
       return (@component ||= ActiveElement::Component.new(controller_instance)) unless controller_instance.nil?
@@ -116,8 +113,8 @@ module ActiveElement
 
     attr_reader :controller_class, :controller_instance
 
-    def initialize_state
-      self.class.state[controller_class] ||= { permissions: [], authenticator: nil }
+    def initialize_state(key)
+      self.class.state[key] ||= ControllerState.new(controller: controller_instance)
     end
   end
 end

data/lib/active_element/controller_state.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  # Stores various data for a controller, including various field definitions and authentication
+  # configuration. Used throughout ActiveElement for generating dynamic content based on
+  # controller configuration.
+  class ControllerState
+    attr_reader :permissions, :listable_fields, :viewable_fields, :editable_fields, :searchable_fields
+    attr_accessor :sign_in_path, :sign_in, :sign_in_method, :sign_out_path, :sign_out_method,
+                  :deletable, :authorizor, :authenticator, :list_order
+
+    def initialize(controller:)
+      @controller = controller
+      @permissions = []
+      @authenticator = nil
+      @authorizor = nil
+      @deletable = false
+      @listable_fields = []
+      @viewable_fields = []
+      @editable_fields = []
+      @searchable_fields = []
+    end
+
+    def deletable?
+      !!deletable
+    end
+
+    def viewable?
+      viewable_fields.present? || controller.public_methods(false).include?(:show)
+    end
+
+    def editable?
+      editable_fields.present? || controller.public_methods(false).include?(:edit)
+    end
+
+    def creatable?
+      editable_fields.present? || controller.public_methods(false).include?(:new)
+    end
+
+    private
+
+    attr_reader :controller
+  end
+end

data/lib/active_element/default_controller/actions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+# TODO: Move each default controller action into individual classes inside
+# ActiveElement::DefaultController::Actions

data/lib/active_element/default_controller/controller.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  module DefaultController
+    # Encapsulation of all logic performed for default controller actions when no action is defined
+    # by the current controller.
+    class Controller # rubocop:disable Metrics/ClassLength
+      def initialize(controller:)
+        @controller = controller
+      end
+
+      def index
+        return render_forbidden(:listable) unless configured?(:listable)
+
+        controller.render 'active_element/default_views/index',
+                          locals: {
+                            collection: ordered(collection),
+                            search_filters: default_text_search.search_filters
+                          }
+      end
+
+      def show
+        return render_forbidden(:viewable) unless configured?(:viewable)
+
+        controller.render 'active_element/default_views/show', locals: { record: record }
+      end
+
+      def new
+        return render_forbidden(:editable) unless configured?(:editable)
+
+        controller.render 'active_element/default_views/new', locals: { record: model.new, namespace: namespace }
+      end
+
+      def create # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        return render_forbidden(:editable) unless configured?(:editable)
+
+        new_record = model.new(default_record_params.params)
+        # XXX: Ensure associations are applied - there must be a better way.
+        if new_record.save && new_record.reload.update(default_record_params.params)
+          controller.flash.notice = "#{new_record.model_name.to_s.titleize} created successfully."
+          controller.redirect_to record_path(new_record, :show).path
+        else
+          controller.flash.now.alert = "Failed to create #{model.name.to_s.titleize}."
+          controller.render 'active_element/default_views/new', locals: { record: new_record, namespace: namespace }
+        end
+      rescue ActiveRecord::RangeError => e
+        render_range_error(error: e, action: :new)
+      end
+
+      def edit
+        return render_forbidden(:editable) unless configured?(:editable)
+
+        controller.render 'active_element/default_views/edit', locals: { record: record, namespace: namespace }
+      end
+
+      def update # rubocop:disable Metrics/AbcSize
+        return render_forbidden(:editable) unless configured?(:editable)
+
+        if record.update(default_record_params.params)
+          controller.flash.notice = "#{record.model_name.to_s.titleize} updated successfully."
+          controller.redirect_to record_path(record, :show).path
+        else
+          controller.flash.now.alert = "Failed to update #{model.name.to_s.titleize}."
+          controller.render 'active_element/default_views/edit', locals: { record: record, namespace: namespace }
+        end
+      rescue ActiveRecord::RangeError => e
+        render_range_error(error: e, action: :edit)
+      end
+
+      def destroy
+        return render_forbidden(:deletable) unless configured?(:deletable)
+
+        record.destroy
+        controller.flash.notice = "Deleted #{record.model_name.to_s.titleize}."
+        controller.redirect_to record_path(model, :index).path
+      end
+
+      private
+
+      attr_reader :controller
+
+      def ordered(unordered_collection)
+        return unordered_collection if state.list_order.blank?
+
+        unordered_collection.order(state.list_order)
+      end
+
+      def render_forbidden(type)
+        controller.render 'active_element/default_views/forbidden', locals: { type: type }
+      end
+
+      def configured?(type)
+        return state.deletable? if type == :deletable
+
+        state.public_send("#{type}_fields").present?
+      end
+
+      def state
+        @state ||= controller.active_element.state
+      end
+
+      def default_record_params
+        @default_record_params ||= DefaultController::Params.new(controller: controller, model: model)
+      end
+
+      def default_text_search
+        @default_text_search ||= DefaultController::Search.new(controller: controller, model: model)
+      end
+
+      def record_path(record, type = nil)
+        ActiveElement::Components::Util::RecordPath.new(record: record, controller: controller, type: type)
+      end
+
+      def namespace
+        controller.controller_path.rpartition('/').first.presence&.to_sym
+      end
+
+      def model
+        controller.controller_name.classify.constantize
+      end
+
+      def record
+        @record ||= model.find(controller.params[:id])
+      end
+
+      def collection
+        return model.all unless default_text_search.text_search?
+
+        model.left_outer_joins(default_text_search.search_relations).where(*default_text_search.text_search)
+      end
+
+      def render_range_error(error:, action:)
+        controller.flash.now.alert = formatted_error(error)
+        controller.render "active_element/default_views/#{action}", locals: { record: record, namespace: namespace }
+      end
+
+      def formatted_error(error)
+        return error.cause.message.split("\n").join(', ') if error.try(:cause)&.try(:message).present?
+        return error.message if error.try(:message).present?
+
+        I18n.t('active_element.unexpected_error')
+      end
+    end
+  end
+end

data/lib/active_element/default_controller/json_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  module DefaultController
+    # Provides permitted parameters for fields generated from a JSON schema file.
+    class JsonParams
+      def initialize(schema:)
+        @base_schema = schema
+      end
+
+      def params(schema = base_schema)
+        return simple_object_field(schema) if simple_object_field?(schema)
+        return simple_array_field(schema) if simple_array_field?(schema)
+        return complex_array_field(schema) if complex_array_field?(schema)
+
+        schema[:name]
+      end
+
+      private
+
+      attr_reader :fields, :base_schema
+
+      def simple_object_field(schema)
+        schema.key?(:name) ? { schema[:name] => {} } : {}
+      end
+
+      def simple_array_field(schema)
+        schema.key?(:name) ? { schema[:name] => [] } : []
+      end
+
+      def simple_object_field?(schema)
+        schema[:type] == 'object'
+      end
+
+      def simple_array_field?(schema)
+        schema[:type] == 'array' && schema.dig(:shape, :type) != 'object'
+      end
+
+      def complex_array_field?(schema)
+        schema[:type] == 'array' && schema.dig(:shape, :type) == 'object'
+      end
+
+      def complex_array_field(schema)
+        schema.dig(:shape, :shape, :fields).map { |field| params(field) }
+      end
+    end
+  end
+end

data/lib/active_element/default_controller/params.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  module DefaultController
+    # Provides params for ActiveRecord models when using the default boilerplate controller
+    # actions. Navigates input parameters and maps them to appropriate relations as needed.
+    class Params
+      def initialize(controller:, model:)
+        @controller = controller
+        @model = model
+      end
+
+      def params
+        with_transformed_relations(
+          controller.params.require(controller.controller_name.singularize)
+                    .permit(*permitted_fields)
+        )
+      end
+
+      private
+
+      attr_reader :controller, :model
+
+      def with_transformed_relations(params)
+        params.to_h.to_h do |key, value|
+          next [key, value] unless relation?(key)
+
+          relation_param(key, value)
+        end
+      end
+
+      def permitted_fields
+        scalar, json = controller.active_element.state.editable_fields.partition do |field|
+          scalar?(field)
+        end
+        scalar + [json_params(json)]
+      end
+
+      def scalar?(field)
+        return true if relation?(field)
+        return true if %i[json jsonb].exclude?(column(field)&.type)
+
+        false
+      end
+
+      def json_params(fields)
+        # XXX: We assume all non-scalar fields are JSON fields, i.e. they must have a definition
+        # defined as `config/forms/<model>/<field>.yml`. If that file does not exist, allow
+        # Errno::ENOENT to raise to let the form submission fail and avoid losing data. This
+        # would need to be adjusted if we start allowing non-JSON nested fields in the default
+        # controller.
+        fields.index_with do |field|
+          DefaultController::JsonParams.new(schema: schema_for(field)).params
+        end
+      end
+
+      def schema_for(field)
+        ActiveElement::Components::Util.json_schema(model: model, field: field)
+      end
+
+      def relation_param(key, value)
+        case relation(key).macro
+        when :belongs_to
+          belongs_to_param(key, value)
+        when :has_one
+          has_one_param(key, value)
+        when :has_many
+          has_many_param(key, value)
+        end
+      end
+
+      def belongs_to_param(key, value)
+        [relation(key).foreign_key, value]
+      end
+
+      def has_one_param(key, value) # rubocop:disable Naming/PredicateName
+        [relation(key).name, relation(key).klass.find_by(relation(key).klass.primary_key => value)]
+      end
+
+      def has_many_param(key, _value) # rubocop:disable Naming/PredicateName
+        [relation(key).name, relation(key).klass.where(relation(key).klass.primary_key => relation(key).value)]
+      end
+
+      def relation?(attribute)
+        relation(attribute.to_sym).present?
+      end
+
+      def relation(attribute)
+        model.reflect_on_association(attribute.to_sym)
+      end
+
+      def column(attribute)
+        model.columns.find { |column| column.name.to_s == attribute.to_s }
+      end
+    end
+  end
+end

data/lib/active_element/default_controller/search.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  module DefaultController
+    # Full text search and datetime querying for DefaultController, provides full text search
+    # filters for all controllers with configured searchable fields. Includes support for querying
+    # across relations.
+    class Search
+      def initialize(controller:, model:)
+        @controller = controller
+        @model = model
+      end
+
+      def search_filters
+        @search_filters ||= controller.params.permit(*searchable_fields).transform_values do |value|
+          value.try(:compact_blank) || value
+        end.compact_blank
+      end
+
+      def text_search?
+        search_filters.present?
+      end
+
+      def text_search
+        conditions = search_filters.to_h.map do |key, value|
+          next relation_matches(key, value) if relation?(key)
+          next datetime_between(key, value) if datetime?(key)
+
+          model.arel_table[key].matches("#{value}%")
+        end
+        conditions[1..].reduce(conditions.first) do |accumulated, condition|
+          accumulated.and(condition)
+        end
+      end
+
+      def search_relations
+        search_filters.to_h.keys.map { |key| relation?(key) ? key.to_sym : nil }.compact
+      end
+
+      private
+
+      attr_reader :controller, :model
+
+      def searchable_fields
+        controller.active_element.state.searchable_fields.map do |field|
+          next field unless field.to_s.end_with?('_at')
+
+          { field => %i[from to] }
+        end
+      end
+
+      def noop
+        Arel::Nodes::True.new.eq(Arel::Nodes::True.new)
+      end
+
+      def datetime?(key)
+        model.columns.find { |column| column.name.to_s == key.to_s }&.type == :datetime
+      end
+
+      def datetime_between(key, value)
+        return noop if value[:from].blank? && value[:to].blank?
+
+        model.arel_table[key].between(range_begin(value)...range_end(value))
+      end
+
+      def range_begin(value)
+        value[:from].present? ? Time.zone.parse(value[:from]) + timezone_offset : -Float::INFINITY
+      end
+
+      def range_end(value)
+        value[:to].present? ? Time.zone.parse(value[:to]) + timezone_offset : Float::INFINITY
+      end
+
+      def timezone_offset
+        controller.request.cookies['timezone_offset'].to_i.minutes
+      end
+
+      def relation_matches(key, value)
+        fields = searchable_relation_fields(key)
+        relation_model = relation(key).klass
+        fields.select! do |field|
+          relation_model.columns.find { |column| column.name.to_s == field.to_s }&.type == :string
+        end
+
+        return noop if fields.empty?
+
+        relation_conditions(fields, value, relation_model)
+      end
+
+      def relation_conditions(fields, value, relation_model)
+        fields[1..].reduce(relation_model.arel_table[fields.first].matches("#{value}%")) do |condition, field|
+          condition.or(relation_model.arel_table[field].matches("#{value}%"))
+        end
+      end
+
+      def searchable_relation_fields(key)
+        Components::Util.relation_controller(model, controller, key)
+                        &.active_element
+                        &.state
+                        &.fetch(:searchable_fields, []) || []
+      end
+
+      def relation?(attribute)
+        relation(attribute.to_sym).present?
+      end
+
+      def relation(attribute)
+        model.reflect_on_association(attribute.to_sym)
+      end
+    end
+  end
+end

data/lib/active_element/default_controller.rb

@@ -1,93 +1,15 @@
 # frozen_string_literal: true
 
-module ActiveElement
-  # Encapsulation of all logic performed for default controller actions when no action is defined
-  # by the current controller.
-  class DefaultController
-    def initialize(controller:)
-      @controller = controller
-    end
-
-    def index
-      controller.render 'active_element/default_views/index',
-                        locals: {
-                          collection: collection,
-                          search_filters: default_text_search.search_filters
-                        }
-    end
-
-    def show
-      controller.render 'active_element/default_views/show', locals: { record: record }
-    end
-
-    def new
-      controller.render 'active_element/default_views/new', locals: { record: model.new, namespace: namespace }
-    end
-
-    def create # rubocop:disable Metrics/AbcSize
-      new_record = model.new(default_record_params.params)
-      # Ensure associations are applied:
-      if new_record.save && new_record.reload.update(default_record_params.params)
-        controller.flash.notice = "#{new_record.model_name.to_s.titleize} created successfully."
-        controller.redirect_to record_path(new_record, :show).path
-      else
-        controller.flash.now.alert = "Failed to create #{model.name.to_s.titleize}."
-        controller.render 'active_element/default_views/new', locals: { record: new_record, namespace: namespace }
-      end
-    end
-
-    def edit
-      controller.render 'active_element/default_views/edit', locals: { record: record, namespace: namespace }
-    end
-
-    def update # rubocop:disable Metrics/AbcSize
-      if record.update(default_record_params.params)
-        controller.flash.notice = "#{record.model_name.to_s.titleize} updated successfully."
-        controller.redirect_to record_path(record, :show).path
-      else
-        controller.flash.now.alert = "Failed to update #{model.name.to_s.titleize}."
-        controller.render 'active_element/default_views/edit', locals: { record: record, namespace: namespace }
-      end
-    end
-
-    def destroy
-      record.destroy
-      controller.flash.notice = "Deleted #{record.model_name.to_s.titleize}."
-      controller.redirect_to record_path(model, :index).path
-    end
-
-    private
+require_relative 'default_controller/controller'
+require_relative 'default_controller/actions'
+require_relative 'default_controller/params'
+require_relative 'default_controller/json_params'
+require_relative 'default_controller/search'
 
-    attr_reader :controller
-
-    def default_record_params
-      @default_record_params ||= ActiveElement::DefaultRecordParams.new(controller: controller, model: model)
-    end
-
-    def default_text_search
-      @default_text_search ||= ActiveElement::DefaultTextSearch.new(controller: controller, model: model)
-    end
-
-    def record_path(record, type = nil)
-      ActiveElement::Components::Util::RecordPath.new(record: record, controller: controller, type: type)
-    end
-
-    def namespace
-      controller.controller_path.rpartition('/').first.presence&.to_sym
-    end
-
-    def model
-      controller.controller_name.classify.constantize
-    end
-
-    def record
-      @record ||= model.find(controller.params[:id])
-    end
-
-    def collection
-      return model.all unless default_text_search.text_search?
-
-      model.left_outer_joins(default_text_search.search_relations).where(*default_text_search.text_search)
-    end
+module ActiveElement
+  # Provides default boilerplate functionality for quick setup of an application.
+  # Implements all standard Rails controller actions, provides parameter permitting of configured
+  # fields and text search functionality.
+  module DefaultController
   end
 end

data/lib/active_element/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveElement
-  VERSION = '0.0.11'
+  VERSION = '0.0.13'
 end