Contents

# frozen_string_literal: true

require_relative 'field_name_namespaceable'
require_relative 'fields_optionable'

module DecoLite
  # Defines methods to to manage fields that conflict with
  # existing model attributes.
  module FieldConflictable
    include FieldNameNamespaceable
    include FieldsOptionable

    def validate_field_conflicts!(field_name:, options:)
      return unless field_conflict?(field_name:, options:)

      field_name = field_name_or_field_name_with_namespace(field_name:, options:)

      raise "Field :#{field_name} conflicts with existing method(s) " \
            ":#{field_name} and/or :#{field_name}=; " \
            'this will raise an error when loading using strict mode ' \
            "(i.e. options: { #{OPTION_FIELDS}: :#{OPTION_FIELDS_STRICT} }) " \
            'or if the method(s) are native to the object (e.g :to_s, :==, etc.). ' \
            "Current options are: options: #{options.to_h}."
    end

    # This method returns true
    def field_conflict?(field_name:, options:)
      # If field_name was already added using Model#load, there is only a
      # conflict if options.strict? is true.
      return options.strict? if field_names_include?(field_name:, options:)

      # If we get here, we know that :field_name does not exist as an
      # attribute on the model. If the attribute already exists on the
      # model, this is a conflict because we cannot override an attribute
      # that already exists on the model
      attr_accessor_exist?(field_name:, options:)
    end

    def field_names_include?(field_name:, options:)
      field_name = field_name_or_field_name_with_namespace(field_name:, options:)

      field_names.include? field_name
    end

    def attr_accessor_exist?(field_name:, options:)
      field_name = field_name_or_field_name_with_namespace(field_name:, options:)

      respond_to?(field_name) || respond_to?(:"#{field_name}=")
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version	Path
deco_lite-1.5.14	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.13	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.12	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.11	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.10	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.9	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.8	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.7	lib/deco_lite/field_conflictable.rb
deco_lite-1.5.5	lib/deco_lite/field_conflictable.rb