Module: HasMetadataColumn::ClassMethods

Defined in:
lib/has_metadata_column.rb

Overview

Class methods that are added to your model.

Instance Method Summary collapse

Instance Method Details

#has_metadata_column(column, fields) ⇒ Object

Defines a set of fields whose values exist in the JSON metadata column. Each key in the fields hash is the name of a metadata field, and the value is a set of options to pass to the validates method. If you do not want to perform any validation on a field, simply pass true as its key value.

In addition to the normal validates keys, you can also include a :type key to restrict values to certain classes, or a :default key to specify a value to return for the getter should none be set (normal default is nil). See TYPES for a list of valid values.

Examples:

Three metadata fields, one basic, one validated, and one type-checked.

has_metadata_column(optional: true, required: { presence: true }, number: { type: Fixnum })

Parameters:

  • column (Symbol) —

    (:metadata) The column containing the metadata information.

  • fields (Hash<Symbol, Hash>) —

    A mapping of field names to their validation options (and/or the :type key).

Raises:

  • (ArgumentError) —

    If invalid arguments are given, or an invalid class for the :type key.

  • (StandardError) —

    If invalid field names are given (see source).



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/has_metadata_column.rb', line 91

def has_metadata_column(*args)
  fields = args.extract_options!
  column = args.shift

  raise ArgumentError, "has_metadata_column takes a column name and a hash of fields" unless args.empty?
  raise "Can't define Rails-magic timestamped columns as metadata" if Rails.version >= '3.2.0' && (fields.keys & [:created_at, :created_on, :updated_at, :updated_on]).any?
  classes = fields.values.select { |o| o[:type] && !TYPES.include?(o[:type]) }
  raise ArgumentError, "#{classes.to_sentence} cannot be serialized to JSON" if classes.any?

  if !respond_to?(:metadata_column_fields) then
    class_attribute :metadata_column_fields
    self.metadata_column_fields = fields.deep_clone
    class_attribute :metadata_column
    self.metadata_column = column || :metadata

    after_save :_reset_metadata

    alias_method_chain :changed_attributes, :metadata_column
    alias_method_chain :attribute_will_change!, :metadata_column
    alias_method_chain :attribute_method?, :metadata
    alias_method_chain :attribute, :metadata
    alias_method_chain :attribute_before_type_cast, :metadata
    alias_method_chain :_attribute, :metadata
    alias_method_chain :attribute=, :metadata
    alias_method_chain :query_attribute, :metadata
    alias_method_chain :reload, :metadata
  else
    raise "Cannot redefine existing metadata column #{self.metadata_column}" if column && column != self.metadata_column
    if metadata_column_fields.slice(*fields.keys) != fields
      raise "Cannot redefine existing metadata fields: #{(fields.keys & self.metadata_column_fields.keys).to_sentence}" unless (fields.keys & self.metadata_column_fields.keys).empty?
      self.metadata_column_fields = self.metadata_column_fields.merge(fields)
    end
  end

  fields.each do |name, options|
    if options.kind_of?(Hash) then
      type          = options.delete(:type)
      type_validate = !options.delete(:skip_type_validation)
      options.delete :default

      validate do |obj|
        value = obj.send(name)
        errors.add(name, :incorrect_type) if !HasMetadataColumn.metadata_typecast(value, type).kind_of?(type) &&
          (!options[:allow_nil] || (options[:allow_nil] && !value.nil?)) &&
          (!options[:allow_blank] || (options[:allow_blank] && !value.blank?))
      end if type && type_validate
      validates(name, options) unless options.empty? or (options.keys - [:allow_nil, :allow_blank]).empty?
    end
  end

  if !respond_to?(:define_attribute_methods_with_metadata) && !superclass.respond_to?(:define_attribute_methods_with_metadata) &&
    !respond_to?(:define_method_attribute_with_metadata) && !superclass.respond_to?(:define_method_attribute_with_metadata)
    class << self
      def define_attribute_methods_with_metadata
        define_attribute_methods_without_metadata
        metadata_column_fields.keys.each { |field| define_attribute_method field }
      end
      alias_method_chain :define_attribute_methods, :metadata

      def define_method_attribute_with_metadata(attr_name)
        return define_method_attribute_without_metadata(attr_name) unless metadata_column_fields.include?(attr_name.to_sym)
        attribute_method_matchers.each do |matcher|
          method_name = matcher.method_name(attr_name)
          define_optimized_call generated_attribute_methods, method_name, matcher.method_missing_target, attr_name.to_s
          attribute_method_matchers_cache.clear
        end
      end
      alias_method_chain :define_method_attribute, :metadata
    end
  end
end