Class: ThemeCheck::DeprecatedFilter

Inherits:
LiquidCheck show all
Defined in:
lib/theme_check/checks/deprecated_filter.rb

Constant Summary collapse

MAX_SIZE =

The image_url filter does not accept width or height values greater than this numbr.

5760

Constants inherited from Check

Check::CATEGORIES, Check::SEVERITIES, Check::SEVERITY_VALUES

Instance Attribute Summary

Attributes inherited from Check

#ignored_patterns, #offenses, #options, #theme

Instance Method Summary collapse

Methods included from ChecksTracking

#inherited

Methods included from ParsingHelpers

#outside_of_strings

Methods inherited from Check

#==, #add_offense, all, can_disable, #can_disable?, categories, #categories, category, #code_name, doc, #doc, docs_url, #ignore!, #ignored?, #severity, severity, #severity=, #severity_value, severity_value, single_file, #single_file?, #to_s, #whole_theme?

Methods included from JsonHelpers

#format_json_parse_error, #pretty_json

Instance Method Details

#add_default_offense(node, filter, alternatives) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/theme_check/checks/deprecated_filter.rb', line 27

def add_default_offense(node, filter, alternatives)
  alternatives = alternatives.map { |alt| "`#{alt}`" }
  add_offense(
    "Deprecated filter `#{filter}`, consider using an alternative: #{alternatives.join(', ')}",
    node: node,
  )
end

#add_img_url_offense(node) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
 
# File 'lib/theme_check/checks/deprecated_filter.rb', line 35

def add_img_url_offense(node)
  img_url_filter = node.value.filters.find { |filter| filter[0] == "img_url" }
  _name, img_url_filter_size, img_url_filter_props = img_url_filter
  size_spec = img_url_filter_size&.dig(0)
  scale = img_url_filter_props&.delete("scale")

  # Can't correct those.
  return add_default_offense(node, 'img_url', ['image_url']) unless
   (size_spec.nil? || size_spec.is_a?(String)) &&
   (scale.nil? || scale.is_a?(Numeric)) &&
   size_spec != 'small'

  node_source = node.markup
  node_start_index = node.start_index
  match = node_source.match(/img_url[^|]*/)
  img_url_character_range =
    (node_start_index + match.begin(0))...(node_start_index + match.end(0))

  scale = (scale || 1).to_i
  width, height = (size_spec&.split('x') || [100, 100])
    .map { |v| v.to_i * scale }

  image_url_filter_params = [
    width && width > 0 ? "width: #{[width, MAX_SIZE].min}" : nil,
    height && height > 0 ? "height: #{[height, MAX_SIZE].min}" : nil,
  ]
  image_url_filter_params += (img_url_filter_props || {})
    .map do |k, v|
      case v
      when Liquid::VariableLookup
        "#{k}: #{v.name}"
      when String
        "#{k}: '#{v}'"
      else
        "#{k}: #{v}"
      end
    end
  image_url_filter_params = image_url_filter_params
    .reject(&:nil?)
    .join(", ")

  trailing_whitespace = match[0].match(/\s*\Z/)[0]

  image_url_filter = "image_url"
  image_url_filter += ": " + image_url_filter_params unless image_url_filter_params.empty?
  image_url_filter += trailing_whitespace

  add_offense(
    "Deprecated filter `img_url`, consider using `image_url`",
    node: node,
    markup: match[0]
  ) do |corrector|
    corrector.replace(
      node,
      image_url_filter,
      img_url_character_range,
    )
  end

# If anything goes wrong, fail gracefully by returning the default offense.
rescue
  add_default_offense(node, 'img_url', ['image_url'])
end

#on_variable(node) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/theme_check/checks/deprecated_filter.rb', line 12

def on_variable(node)
  used_filters = node.value.filters.map { |name, *_rest| name }
  used_filters.each do |filter|
    alternatives = ShopifyLiquid::DeprecatedFilter.alternatives(filter)
    next unless alternatives

    case filter
    when 'img_url'
      add_img_url_offense(node)
    else
      add_default_offense(node, filter, alternatives)
    end
  end
end