class Datagrid::Drivers::ActiveRecord

@!visibility private

Public Class Methods

match?(scope) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 6
def self.match?(scope)
  return false unless defined?(::ActiveRecord)
  if scope.is_a?(Class)
    scope.ancestors.include?(::ActiveRecord::Base)
  else
    scope.is_a?(::ActiveRecord::Relation)
  end
end

Public Instance Methods

append_column_queries(assets, columns) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 30
def append_column_queries(assets, columns)
  if columns.present?
    if assets.select_values.empty?
      assets = assets.select(Arel.respond_to?(:star) ? assets.klass.arel_table[Arel.star] : "#{assets.quoted_table_name}.*")
    end
    columns = columns.map {|c| "#{c.query} AS #{c.name}"}
    assets = assets.select(*columns)
  end
  assets
end
asc(scope, order) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 45
def asc(scope, order)
  # Relation#order isn't able to override already applied order
  # Using #reorder instead
  scope.reorder(order)
end
batch_each(scope, batch_size, &block) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 105
def batch_each(scope, batch_size, &block)
  if scope.limit_value
    raise Datagrid::ConfigurationError, "ActiveRecord can not use batches in combination with SQL limit"
  end
  options = batch_size ? { batch_size: batch_size } : {}
  scope.find_each(**options, &block)
end
can_preload?(scope, association) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 121
def can_preload?(scope, association)
  !! scope.klass.reflect_on_association(association)
end
column_names(scope) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 81
def column_names(scope)
  scope.column_names
end
contains(scope, field, value) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 85
def contains(scope, field, value)
  field = prefix_table_name(scope, field)
  scope.where("#{field} #{contains_predicate} ?", "%#{value}%")
end
default_cache_key(asset) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 113
def default_cache_key(asset)
  asset.id || raise(NotImplementedError)
end
default_order(scope, column_name) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 63
def default_order(scope, column_name)
  has_column?(scope, column_name) ? prefix_table_name(scope, column_name) : nil
end
default_preload(scope, value) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 117
def default_preload(scope, value)
  scope.preload(value)
end
desc(scope, order) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 51
def desc(scope, order)
  if order.respond_to?(:desc)
    scope.reorder(order.desc)
  else
    scope.reorder(order).reverse_order
  end
end
greater_equal(scope, field, value) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 67
def greater_equal(scope, field, value)
  scope.where(["#{prefix_table_name(scope, field)} >= ?", value])
end
has_column?(scope, column_name) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 75
def has_column?(scope, column_name)
  scope.column_names.include?(column_name.to_s)
rescue ::ActiveRecord::StatementInvalid
  false
end
less_equal(scope, field, value) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 71
def less_equal(scope, field, value)
  scope.where(["#{prefix_table_name(scope, field)} <= ?", value])
end
normalized_column_type(scope, field) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 90
def normalized_column_type(scope, field)
  return nil unless has_column?(scope, field)
  builtin_type = scope.columns_hash[field.to_s].type
  {
    [:string, :text, :time, :binary] => :string,
    [:integer, :primary_key] => :integer,
    [:float, :decimal] => :float,
    [:date] => :date,
    [:datetime, :timestamp] => :timestamp,
    [:boolean] => :boolean
  }.each do |keys, value|
    return value if keys.include?(builtin_type)
  end
end
reverse_order(scope) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 59
def reverse_order(scope)
  scope.reverse_order
end
to_scope(scope) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 15
def to_scope(scope)
  return scope if scope.is_a?(::ActiveRecord::Relation)
  # Model class or Active record association
  # ActiveRecord association class hides itself under an Array
  # We can only reveal it by checking if it respond to some specific
  # to ActiveRecord method like #scoped
  if scope.is_a?(Class)
    scope.all
  elsif scope.respond_to?(:scoped)
    scope.scoped
  else
    scope
  end
end
where(scope, attribute, value) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 41
def where(scope, attribute, value)
  scope.where(attribute => value)
end

Protected Instance Methods

contains_predicate() click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 131
def contains_predicate
  defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) &&
    ::ActiveRecord::Base.connection.is_a?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) ?
    'ilike' : 'like'
end
prefix_table_name(scope, field) click to toggle source
# File lib/datagrid/drivers/active_record.rb, line 127
def prefix_table_name(scope, field)
  has_column?(scope, field) ?  [scope.table_name, field].join(".") : field
end