active_scaffold 4.1.6 → 4.2.0

data/lib/active_scaffold/data_structures/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   module Association
     autoload :Abstract, 'active_scaffold/data_structures/association/abstract.rb'

data/lib/active_scaffold/data_structures/bridge.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Bridge
     def self.install
-      raise RunTimeError, "install not defined for bridge #{name}"
+      raise "install not defined for bridge #{name}"
     end
 
     def self.prepare; end

data/lib/active_scaffold/data_structures/column.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Column
     module ProxyableMethods
@@ -92,8 +94,16 @@ module ActiveScaffold::DataStructures
         # a collection of associations to pre-load when finding the records on a page
         attr_reader :includes
 
+        # a collection of associations to pre-load when the column is used as a subform,
+        # defaults to true, which means get associations from subform columns in the associated controller
+        # set to any other value to avoid checking the associated controller, false or nil to prevent preloading
+        attr_reader :subform_includes
+
         # a place to store dev's column specific options
         attr_writer :options
+
+        # define the fields to use with logical search
+        attr_accessor :logical_search
       end
 
       def inplace_edit=(value)
@@ -150,7 +160,7 @@ module ActiveScaffold::DataStructures
       #  update_columns = :name
       #  update_columns = [:name, :age]
       def update_columns=(column_names)
-        @update_columns = Array(column_names)
+        @update_columns = column_names.is_a?(Array) ? column_names : [column_names]
       end
 
       # sorting on a column can be configured four ways:
@@ -169,7 +179,7 @@ module ActiveScaffold::DataStructures
 
       def sort
         initialize_sort if @sort == true
-        @sort
+        @sort if @sort
       end
 
       def sortable?
@@ -181,6 +191,19 @@ module ActiveScaffold::DataStructures
         self.sort = options
       end
 
+      # a collection of associations to do left join when the list is sorted by this column
+      def sort_joins
+        @sort_joins || includes
+      end
+
+      def sort_joins=(value)
+        @sort_joins =
+          case value
+          when Array then value
+          else [value] # automatically convert to an array
+          end
+      end
+
       def associated_number?
         @associated_number
       end
@@ -283,6 +306,14 @@ module ActiveScaffold::DataStructures
           end
       end
 
+      def subform_includes=(value)
+        @subform_includes =
+          case value
+          when Array, TrueClass then value
+          else value ? [value] : value # not convert nil to [nil]
+          end
+      end
+
       # a collection of associations to do left join when this column is included on search
       def search_joins
         @search_joins || includes
@@ -315,7 +346,7 @@ module ActiveScaffold::DataStructures
       end
 
       def searchable?
-        search_sql.present?
+        search_sql.present? || (logical_search.present? && ActiveScaffold::Finder::LOGICAL_COMPARATORS.present?)
       end
 
       def link
@@ -374,6 +405,7 @@ module ActiveScaffold::DataStructures
 
     include ActiveScaffold::Configurable
     include ActiveScaffold::OrmChecks
+
     NO_PARAMS = Set.new.freeze
     NO_OPTIONS = {}.freeze
 
@@ -512,6 +544,7 @@ module ActiveScaffold::DataStructures
       if delegated_association
         self.includes = includes ? [delegated_association.name => includes] : [delegated_association.name]
       end
+      self.subform_includes = true if association
 
       # default all the configurable variables
       self.css_class = ''
@@ -522,6 +555,7 @@ module ActiveScaffold::DataStructures
                       validators_force_require_on.reject { |opt| opt == true }.flatten.presence
       self.sort = true
       self.search_sql = true
+      self.logical_search = [name] unless virtual? || association || tableless?
 
       @weight = estimate_weight
     end

data/lib/active_scaffold/data_structures/columns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Columns
     include Enumerable
@@ -19,13 +21,13 @@ module ActiveScaffold::DataStructures
     # This accessor is used by ActionColumns to create new Column objects without adding them to this set
     attr_reader :active_record_class
 
-    def initialize(active_record_class, *args)
+    def initialize(active_record_class, *)
       @active_record_class = active_record_class
       @_inheritable = ::Set.new
       @set = {}
       @sorted = nil
 
-      add(*args)
+      add(*)
     end
 
     # the way to add columns to the set. this is primarily useful for virtual columns.

data/lib/active_scaffold/data_structures/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Filter
     include Enumerable
@@ -52,9 +54,7 @@ module ActiveScaffold::DataStructures
       @options.each(&)
     end
 
-    def empty?
-      @options.empty?
-    end
+    delegate :empty?, to: :@options
 
     def label(*)
       case @label

data/lib/active_scaffold/data_structures/filter_option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class FilterOption < ActionLink
     attr_reader :name, :filter_name

data/lib/active_scaffold/data_structures/filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Filters
     include Enumerable
@@ -37,9 +39,7 @@ module ActiveScaffold::DataStructures
       @set.each(&)
     end
 
-    def empty?
-      @set.empty?
-    end
+    delegate :empty?, to: :@set
 
     # default filter type for all app filters, can be :links or :select
     cattr_accessor :default_type

data/lib/active_scaffold/data_structures/nested_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class NestedInfo
     def self.get(model, params)
@@ -31,7 +33,7 @@ module ActiveScaffold::DataStructures
       false
     end
 
-    def has_many? # rubocop:disable Naming/PredicateName
+    def has_many? # rubocop:disable Naming/PredicatePrefix
       false
     end
 
@@ -39,7 +41,7 @@ module ActiveScaffold::DataStructures
       false
     end
 
-    def has_one? # rubocop:disable Naming/PredicateName
+    def has_one? # rubocop:disable Naming/PredicatePrefix
       false
     end
 

data/lib/active_scaffold/data_structures/set.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   class Set
     include Enumerable
     include ActiveScaffold::Configurable
 
-    def initialize(*args)
-      set_values(*args)
+    def initialize(*)
+      set_values(*)
     end
 
     def initialize_dup(other)
       @set = other.set.dup
     end
 
-    def set_values(*args)
+    def set_values(*)
       @set = []
-      add(*args)
+      add(*)
     end
 
     # the way to add items to the set.
@@ -52,13 +54,9 @@ module ActiveScaffold::DataStructures
     end
 
     # returns the number of items in the set
-    def length
-      @set.length
-    end
+    delegate :length, to: :@set
 
-    def empty?
-      @set.empty?
-    end
+    delegate :empty?, to: :@set
 
     def +(other)
       self.class.new(@set, *other)

data/lib/active_scaffold/data_structures/sorting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold::DataStructures
   # encapsulates the column sorting configuration for the List view
   class Sorting
@@ -22,7 +24,7 @@ module ActiveScaffold::DataStructures
       # fallback to setting primary key ordering
       setup_primary_key_order_clause
       model_scope = model.send(:build_default_scope)
-      order_clause = model_scope.order_values.join(',') if model_scope
+      order_clause = model_scope.order_values.map { |ordering| ordering.respond_to?(:to_sql) ? ordering.to_sql : ordering }.join(',') if model_scope
       return unless order_clause
 
       # If an ORDER BY clause is found set default sorting according to it
@@ -115,13 +117,9 @@ module ActiveScaffold::DataStructures
     end
 
     # provides quick access to the first (and sometimes only) clause
-    def first
-      @clauses.first
-    end
+    delegate :first, to: :@clauses
 
-    def size
-      @clauses.size
-    end
+    delegate :size, to: :@clauses
 
     # builds an order-by clause
     def clause(grouped_columns = nil)

data/lib/active_scaffold/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   class Engine < ::Rails::Engine
     initializer 'active_scaffold.action_controller' do
@@ -30,6 +32,7 @@ module ActiveScaffold
         require 'active_scaffold/extensions/unsaved_associated'
         require 'active_scaffold/extensions/unsaved_record'
         include ActiveScaffold::ActiveRecordPermissions::ModelUserAccess::Model
+
         ActiveRecord::Associations.module_eval do
           self::Association.include ActiveScaffold::Tableless::Association
           self::CollectionAssociation.include ActiveScaffold::Tableless::CollectionAssociation
@@ -48,10 +51,6 @@ module ActiveScaffold
       end
     end
 
-    initializer 'active_scaffold.assets' do
-      config.assets.precompile << 'active_scaffold_manifest.js' if Rails::VERSION::MAJOR < 7
-    end
-
     initializer 'active_scaffold.extensions' do
       require 'active_scaffold/extensions/ice_nine'
       require 'active_scaffold/extensions/localize'

data/lib/active_scaffold/extensions/action_controller_rendering.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # wrap the action rendering for ActiveScaffold controllers
 module ActiveScaffold
   module ActionController # :nodoc:

data/lib/active_scaffold/extensions/action_controller_rescueing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionController # :nodoc:
   class Base
     # adding to ActionController::Base so it can overrided in ApplicationController

data/lib/active_scaffold/extensions/action_view_rendering.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module LookupContext
     attr_accessor :last_template

data/lib/active_scaffold/extensions/connection_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module ConnectionAdapters
     module AbstractAdapter

data/lib/active_scaffold/extensions/ice_nine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IceNine
   class Freezer
     def self.find(name)

data/lib/active_scaffold/extensions/localize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Object
   def as_(key, options = {})
     if key.present?

data/lib/active_scaffold/extensions/name_option_for_datetime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module DateSelectExtension
     private

data/lib/active_scaffold/extensions/paginator_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_scaffold/paginator'
 
 module ActiveScaffold
@@ -27,7 +29,7 @@ module ActiveScaffold
       if @pager.infinite?
         items.to_a.empty?
       else
-        @pager.count.zero?
+        @pager.count.zero? # rubocop:disable Style/CollectionQuerying -- @pager doesn't have none? method
       end
     end
   end

data/lib/active_scaffold/extensions/routing_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module Routing
     ACTIVE_SCAFFOLD_CORE_ROUTING = {

data/lib/active_scaffold/extensions/to_label.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # the ever-useful to_label method
 class ActiveRecord::Base
   def to_label

data/lib/active_scaffold/extensions/unsaved_associated.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 # save and validation support for associations.
 class ActiveRecord::Base
-  def associated_valid?(path = [])
+  def associated_valid?(path = ::Set.new)
     return true if path.include?(self) # prevent recursion (if associated and parent are new records)
 
     path << self
     # using [].all? syntax to avoid a short-circuit
     # errors to associated record can be added by update_record_from_params when association fails to set and ActiveRecord::RecordNotSaved is raised
-    with_unsaved_associated { |a| [a.keeping_errors { a.valid? }, a.associated_valid?(path)].all? }
+    with_unsaved_associated { |a| [a.keeping_errors { a.valid? }, a.associated_valid?(path)].all? }.all?
   end
 
-  def save_associated
-    with_unsaved_associated { |a| a.save && a.save_associated }
+  def save_associated # rubocop:disable Naming/PredicateMethod
+    with_unsaved_associated { |a| a.save && a.save_associated }.all?
   end
 
   def save_associated!
@@ -18,7 +20,7 @@ class ActiveRecord::Base
   end
 
   def no_errors_in_associated?
-    with_unsaved_associated { |a| a.errors.count.zero? && a.no_errors_in_associated? }
+    with_unsaved_associated { |a| a.errors.none? && a.no_errors_in_associated? }.all?
   end
 
   protected
@@ -49,16 +51,16 @@ class ActiveRecord::Base
   # returns false if any yield returns false.
   # returns true otherwise, even when none of the associations have been instantiated. build wrapper methods accordingly.
   def with_unsaved_associated(&block)
-    associations_for_update.map do |assoc|
+    associations_for_update.flat_map do |assoc|
       association_proxy = association(assoc.name)
       if association_proxy.target.present?
         records = association_proxy.target
         records = [records] unless records.is_a? Array # convert singular associations into collections for ease of use
         # must use select instead of find_all, which Rails overrides on association proxies for db access
-        records.select { |r| r.unsaved? && !r.readonly? }.map(&block).all?
+        records.select { |r| r.unsaved? && !r.readonly? }.map(&block)
       else
         true
       end
-    end.all?
+    end
   end
 end

data/lib/active_scaffold/extensions/unsaved_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # a simple (manual) unsaved? flag and method. at least it automatically reverts after a save!
 module ActiveScaffold::UnsavedRecord
   # acts like a dirty? flag, manually thrown during update_record_from_params.

data/lib/active_scaffold/finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveScaffold
   module Finder
     def self.like_operator
@@ -106,7 +108,7 @@ module ActiveScaffold
           args << session if method(column_method).arity == 4
           return send(:"condition_for_#{column.name}_column", *args)
         end
-        return unless column.search_sql && value.present?
+        return unless column.searchable? && value.present?
 
         search_ui = column.search_ui || column.column_type
         begin
@@ -119,6 +121,7 @@ module ActiveScaffold
               condition_for_search_ui(column, value, like_pattern, search_ui)
             end
           return nil unless sql
+          return sql if sql.is_a? ::ActiveRecord::Relation
 
           where_values = []
           sql_conditions = []
@@ -134,8 +137,9 @@ module ActiveScaffold
           end
           [sql_conditions.join(' OR '), *where_values]
         rescue StandardError => e
-          Rails.logger.error "#{e.class.name}: #{e.message} -- on the ActiveScaffold column :#{column.name}, search_ui = #{search_ui} in #{name}"
-          raise e
+          message = "on the ActiveScaffold column :#{column.name}, search_ui = #{search_ui} in #{name}"
+          ActiveScaffold.log_exception(e, message)
+          raise e.class, "#{e.message} -- #{message}", e.backtrace
         end
       end
 
@@ -227,9 +231,40 @@ module ActiveScaffold
           ['(%<search_sql>s BETWEEN ? AND ?)', value[:from], value[:to]]
         elsif ActiveScaffold::Finder::NUMERIC_COMPARATORS.include?(value[:opt])
           ["%<search_sql>s #{value[:opt]} ?", value[:from]]
+        elsif ActiveScaffold::Finder::LOGICAL_COMPARATORS.include?(value[:opt])
+          operator =
+            case value[:opt]
+            when 'all_tokens' then 'AND'
+            when 'any_token'  then 'OR'
+            end
+          parser = ActiveScaffold::Bridges::LogicalQueryParser::TokensGrammar::Parser.new(operator) if operator
+          [logical_search_condition(column, value[:from], parser)]
         end
       end
 
+      def logical_search_condition(column, search, parser = nil)
+        model = column.active_record_class
+        subquery = alias_query_for_same_table_exists(model.all) if column.logical_search.any?(Hash)
+        query = ::LogicalQueryParser.search(search, subquery || model, columns: column.logical_search, parser: parser)
+        if subquery
+          model.where(same_table_exists_subquery(query))
+        else
+          query
+        end
+      end
+
+      def alias_query_for_same_table_exists(query)
+        query.instance_variable_set(:@table, query.table.dup)
+        query.table.instance_variable_set(:@table_alias, "_#{query.table_name}_exists")
+        query
+      end
+
+      def same_table_exists_subquery(query)
+        alias_query_for_same_table_exists(query) unless query.table.table_alias
+        subquery = query.where(query.arel_table[query.primary_key].eq(query.table[query.primary_key]))
+        subquery.select(1).arel.exists
+      end
+
       def tables_for_translating_days_and_months(format)
         keys = {
           '%A' => 'date.day_names',
@@ -245,7 +280,8 @@ module ActiveScaffold
       end
 
       def translate_days_and_months(value, format)
-        translated = ''
+        translated = +''
+        value = value.dup # ensure the string can be changed
         tables_for_translating_days_and_months(format).each do |table|
           regexp = Regexp.union(table.keys)
           index = value.index(regexp)
@@ -490,6 +526,7 @@ module ActiveScaffold
       doesnt_begin_with: 'not_?%',
       doesnt_end_with:   'not_%?'
     }.freeze
+    LOGICAL_COMPARATORS = [].freeze
     NULL_COMPARATORS = %w[null not_null].freeze
     DATE_COMPARATORS = %w[PAST FUTURE RANGE].freeze
     DATE_UNITS = %w[DAYS WEEKS MONTHS YEARS].freeze
@@ -502,12 +539,17 @@ module ActiveScaffold
 
     protected
 
-    attr_writer :active_scaffold_conditions, :active_scaffold_preload, :active_scaffold_joins, :active_scaffold_outer_joins, :active_scaffold_references
+    attr_writer :active_scaffold_conditions, :active_scaffold_preload, :active_scaffold_joins,
+                :active_scaffold_outer_joins, :active_scaffold_references, :active_scaffold_relations
 
     def active_scaffold_conditions
       @active_scaffold_conditions ||= []
     end
 
+    def active_scaffold_relations
+      @active_scaffold_relations ||= []
+    end
+
     def active_scaffold_preload
       @active_scaffold_preload ||= []
     end
@@ -516,16 +558,6 @@ module ActiveScaffold
       @active_scaffold_joins ||= []
     end
 
-    def active_scaffold_habtm_joins
-      ActiveScaffold.deprecator.warn 'use active_scaffold_joins'
-      active_scaffold_joins
-    end
-
-    def active_scaffold_habtm_joins=(value)
-      ActiveScaffold.deprecator.warn 'use active_scaffold_joins='
-      self.active_scaffold_joins = value
-    end
-
     def active_scaffold_outer_joins
       @active_scaffold_outer_joins ||= []
     end
@@ -603,6 +635,7 @@ module ActiveScaffold
           preload:    active_scaffold_preload,
           includes:   active_scaffold_references.presence,
           references: active_scaffold_references.presence,
+          relations:  active_scaffold_relations.presence,
           select:     options[:select]
         )
       end
@@ -684,9 +717,15 @@ module ActiveScaffold
     def append_to_query(relation, options)
       options.assert_valid_keys :where, :select, :having, :group, :reorder, :order, :limit, :offset,
                                 :joins, :left_joins, :left_outer_joins, :includes, :lock, :readonly,
-                                :from, :conditions, :preload, :references
+                                :from, :conditions, :preload, :references, :relations
       relation = options.compact_blank.inject(relation) do |rel, (k, v)|
-        k == :conditions ? apply_conditions(rel, *v) : rel.send(k, v)
+        if k == :conditions
+          apply_conditions(rel, *v)
+        elsif k == :relations
+          v.reduce(rel, :merge)
+        else
+          rel.send(k, v)
+        end
       end
       relation.distinct_value = true if options[:left_outer_joins].present? || options[:left_joins].present?
       relation
@@ -717,7 +756,7 @@ module ActiveScaffold
     def sort_collection_by_column(collection, column, order)
       sorter = column.sort[:method]
       collection = collection.sort_by do |record|
-        value = sorter.is_a?(Proc) ? record.instance_eval(&sorter) : record.instance_eval(sorter.to_s)
+        value = sorter.is_a?(Proc) ? record.instance_exec(record, &sorter) : record.instance_eval(sorter.to_s)
         value = '' if value.nil?
         value
       end