Class: SearchSyntax::RansackTransformer

Inherits:
Object
  • Object
show all
Defined in:
lib/search_syntax/ransack_transformer.rb

Constant Summary collapse

PREDICATES =
{
  ">=": :gteq,
  "=>": :gteq,
  "<=": :lteq,
  "=<": :lteq,
  "!=": :not_eq,
  ">": :gt,
  "<": :lt
  # in, not_in, present, blank, null, not_null,
  # matches, does not match, cont, cont_any, cont_all,
  # i_cont..., start, end, true, false, not_true, not_false
}

Instance Method Summary collapse

Constructor Details

#initialize(text:, params:, sort: nil) ⇒ RansackTransformer

Returns a new instance of RansackTransformer.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/search_syntax/ransack_transformer.rb', line 18

def initialize(text:, params:, sort: nil)
  @text = text
  if params.is_a?(Array)
    params = params.to_h { |i| [i.to_s.delete(":"), i] }
  elsif params.is_a?(Hash)
    params = params.map do |k, v|
      k = k.to_s
      skip_predicate = k.include?(":")
      [k.delete(":"), v + (skip_predicate ? ":" : "")]
    end.to_h
  end
  @params = params
  @allowed_params = params.keys
  @sort = sort
  @spell_checker = DidYouMean::SpellChecker.new(dictionary: @allowed_params)
end

Instance Method Details

#transform_sort_param(value) ⇒ Object



35
36
37
38
39
40
41
42
43
# File 'lib/search_syntax/ransack_transformer.rb', line 35

def transform_sort_param(value)
  value.split(",").map do |sort_value|
    if sort_value.start_with?("-")
      "#{sort_value[1..]} desc"
    else
      "#{sort_value} asc"
    end
  end
end

#transform_with_errors(ast) ⇒ Object



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
# File 'lib/search_syntax/ransack_transformer.rb', line 45

def transform_with_errors(ast)
  errors = []
  result = {}

  if @allowed_params.length > 0
    ast = ast.filter do |node|
      if node[:type] != :param
        true
      elsif node[:name] == @sort
        result[:s] = transform_sort_param(node[:value])
        false
      elsif @allowed_params.include?(node[:name])
        key = name_with_predicate(node)
        if !result.key?(key)
          result[key] = node[:value]
        else
          errors.push(DuplicateParamError.new(
            name: node[:name],
            start: node[:start],
            finish: node[:finish]
          ))
        end
        false
      else
        errors.push(UnknownParamError.new(
          name: node[:name],
          start: node[:start],
          finish: node[:finish],
          did_you_mean: @spell_checker.correct(node[:name])
        ))
        true
      end
    end
  end

  previous = -1
  result[@text] = ast.map do |node|
    separator = previous == node[:start] || previous == -1 ? "" : " "
    previous = node[:finish]
    separator + node[:raw]
  end.join

  [result, errors]
end