module StewEucen::Acts::FertileForest::Table::Configs

This module is for extending into derived class by ActiveRecord.
The caption contains “Instance Methods”, but it means “Class Methods” of each derived class.

Public Instance Methods

enable_grove_delete?() click to toggle source

Is enable to use soft-delete by grove field?

@author StewEucen @return [Boolean] true: enable. @return [Boolean] false: disable. @since Release 1.0.0

# File lib/fertile_forest/modules/configs.rb, line 57
def enable_grove_delete?
  has_grove? \
      && !has_soft_delete? \
      && ff_options[:enable_grove_delete]
  # Need back slashes for this writing.
end
has_grove?() click to toggle source

Exists grove field in table?

@author StewEucen @return [Boolean] true: has grove column. @return [Boolean] false: no grove column. @since Release 1.0.0

# File lib/fertile_forest/modules/configs.rb, line 33
def has_grove?
  ff_has_column? :ff_grove
end
has_soft_delete?() click to toggle source

Exists soft-delete field in table?

@author StewEucen @return [Boolean] true: has soft-delete column. @return [Boolean] false: no soft-delete column. @since Release 1.0.0

# File lib/fertile_forest/modules/configs.rb, line 45
def has_soft_delete?
  ff_has_column? :ff_soft_delete
end

Protected Instance Methods

ff_get_query_interval() click to toggle source

Recommended queue interval for appending node. Can overwrite [queue interval] at setup()/initialize().

@author StewEucen @return [Integer] Default queue interval. @since Release 1.0.0

# File lib/fertile_forest/modules/configs.rb, line 86
def ff_get_query_interval
  QUEUE_DEFAULT_INTERVAL
end
ff_has_column?(column) click to toggle source

Exists field in table?

@author StewEucen @param column [Symbol] Column symbol to check. @return [Boolean] true: has specified column. @return [Boolean] false: no specified column. @since Release 1.0.0

# File lib/fertile_forest/modules/configs.rb, line 73
def ff_has_column?(column)
  key = column.to_s
  attribute_aliases[key] || column_names.include?(key)
end