Class: ActiveStorageValidations::DimensionValidator

Inherits:
ActiveModel::EachValidator
  • Object
show all
Includes:
ErrorHandler, OptionProcUnfolding
Defined in:
lib/active_storage_validations/dimension_validator.rb

Overview

:nodoc

Constant Summary collapse

AVAILABLE_CHECKS = 
%i[width height min max].freeze

Instance Method Summary collapse

Methods included from ErrorHandler

#add_error, #initialize_error_options

Methods included from OptionProcUnfolding

#unfold_procs

Instance Method Details

#check_validity! ⇒ Object 



35
36
37
38
39
 
# File 'lib/active_storage_validations/dimension_validator.rb', line 35

def check_validity!
  unless AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
    raise ArgumentError, 'You must pass either :width, :height, :min or :max to the validator'
  end
end

#is_valid?(record, attribute, file_metadata) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/active_storage_validations/dimension_validator.rb', line 73

def is_valid?(record, attribute, file_metadata)
  flat_options = process_options(record)
  errors_options = initialize_error_options(options)

  # Validation fails unless file metadata contains valid width and height.
  if file_metadata[:width].to_i <= 0 || file_metadata[:height].to_i <= 0
    add_error(record, attribute, :image_metadata_missing, **errors_options)
    return false
  end

  # Validation based on checks :min and :max (:min, :max has higher priority to :width, :height).
  if flat_options[:min] || flat_options[:max]
    if flat_options[:min] && (
      (flat_options[:width][:min] && file_metadata[:width] < flat_options[:width][:min]) ||
      (flat_options[:height][:min] && file_metadata[:height] < flat_options[:height][:min])
      )
      errors_options[:width] = flat_options[:width][:min]
      errors_options[:height] = flat_options[:height][:min]

      add_error(record, attribute, :dimension_min_inclusion, **errors_options)
      return false
    end
    if flat_options[:max] && (
      (flat_options[:width][:max] && file_metadata[:width] > flat_options[:width][:max]) ||
      (flat_options[:height][:max] && file_metadata[:height] > flat_options[:height][:max])
      )
      errors_options[:width] = flat_options[:width][:max]
      errors_options[:height] = flat_options[:height][:max]

      add_error(record, attribute, :dimension_max_inclusion, **errors_options)
      return false
    end

  # Validation based on checks :width and :height.
  else
    width_or_height_invalid = false

    [:width, :height].each do |length|
      next unless flat_options[length]
      if flat_options[length].is_a?(Hash)
        if flat_options[length][:in] && (file_metadata[length] < flat_options[length][:min] || file_metadata[length] > flat_options[length][:max])
          error_type = :"dimension_#{length}_inclusion"
          errors_options[:min] = flat_options[length][:min]
          errors_options[:max] = flat_options[length][:max]

          add_error(record, attribute, error_type, **errors_options)
          width_or_height_invalid = true
        else
          if flat_options[length][:min] && file_metadata[length] < flat_options[length][:min]
            error_type = :"dimension_#{length}_greater_than_or_equal_to"
            errors_options[:length] = flat_options[length][:min]

            add_error(record, attribute, error_type, **errors_options)
            width_or_height_invalid = true
          elsif flat_options[length][:max] && file_metadata[length] > flat_options[length][:max]
            error_type = :"dimension_#{length}_less_than_or_equal_to"
            errors_options[:length] = flat_options[length][:max]

            add_error(record, attribute, error_type, **errors_options)
            width_or_height_invalid = true
          end
        end
      else
        if file_metadata[length] != flat_options[length]
          error_type = :"dimension_#{length}_equal_to"
          errors_options[:length] = flat_options[length]

          add_error(record, attribute, error_type, **errors_options)
          width_or_height_invalid = true
        end
      end
    end

    return false if width_or_height_invalid
  end

  true # valid file
end

#process_options(record) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/active_storage_validations/dimension_validator.rb', line 12

def process_options(record)
  flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)

  [:width, :height].each do |length|
    if flat_options[length] and flat_options[length].is_a?(Hash)
      if (range = flat_options[length][:in])
        raise ArgumentError, ":in must be a Range" unless range.is_a?(Range)
        flat_options[length][:min], flat_options[length][:max] = range.min, range.max
      end
    end
  end
  [:min, :max].each do |dim|
    if (range = flat_options[dim])
      raise ArgumentError, ":#{dim} must be a Range (width..height)" unless range.is_a?(Range)
      flat_options[:width] = { dim => range.first }
      flat_options[:height] = { dim => range.last }
    end
  end

  flat_options
end

#validate_each(record, attribute, _value) ⇒ Object

Rails 5



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/active_storage_validations/dimension_validator.rb', line 58

def validate_each(record, attribute, _value)
  return true unless record.send(attribute).attached?

  changes = record.attachment_changes[attribute.to_s]
  return true if changes.blank?

  files = Array.wrap(changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable)
  files.each do |file|
    metadata = Metadata.new(file).metadata
    next if is_valid?(record, attribute, metadata)
    break
  end
end