Class: WebMock::Util::QueryMapper

Inherits:
Object
  • Object
show all
Defined in:
lib/webmock/util/query_mapper.rb

Class Method Summary collapse

Class Method Details

.collect_query_hash(query_array, empty_accumulator, options) ⇒ Object


79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/webmock/util/query_mapper.rb', line 79

def collect_query_hash(query_array, empty_accumulator, options)
  query_array.compact.inject(empty_accumulator.dup) do |accumulator, (key, value)|
    value = if value.nil?
              nil
            else
              ::Addressable::URI.unencode_component(value.tr('+', ' '))
            end
    key = Addressable::URI.unencode_component(key)
    key = key.dup.force_encoding(Encoding::ASCII_8BIT) if key.respond_to?(:force_encoding)
    self.__send__("fill_accumulator_for_#{options[:notation]}", accumulator, key, value)
    accumulator
  end
end

.collect_query_parts(query) ⇒ Object


72
73
74
75
76
77
# File 'lib/webmock/util/query_mapper.rb', line 72

def collect_query_parts(query)
  query_parts = query.split('&').map do |pair|
    pair.split('=', 2) if pair && !pair.empty?
  end
  query_parts.compact
end

.dehash(hash) ⇒ Object


219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/webmock/util/query_mapper.rb', line 219

def dehash(hash)
  hash.each do |(key, value)|
    if value.is_a?(::Hash)
      hash[key] = self.dehash(value)
    end
  end
  if hash != {} && hash.keys.all? { |key| key =~ /^\d+$/ }
    hash.sort.inject([]) do |accu, (_, value)|
      accu << value; accu
    end
  else
    hash
  end
end

.fill_accumulator_for_dot(accumulator, key, value) ⇒ Object


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/webmock/util/query_mapper.rb', line 104

def fill_accumulator_for_dot(accumulator, key, value)
  array_value = false
  subkeys = key.split(".")
  current_hash = accumulator
  subkeys[0..-2].each do |subkey|
    current_hash[subkey] = {} unless current_hash[subkey]
    current_hash = current_hash[subkey]
  end
  if array_value
    if current_hash[subkeys.last] && !current_hash[subkeys.last].is_a?(Array)
      current_hash[subkeys.last] = [current_hash[subkeys.last]]
    end
    current_hash[subkeys.last] = [] unless current_hash[subkeys.last]
    current_hash[subkeys.last] << value
  else
    current_hash[subkeys.last] = value
  end
end

.fill_accumulator_for_flat(accumulator, key, value) ⇒ Object


93
94
95
96
97
98
# File 'lib/webmock/util/query_mapper.rb', line 93

def fill_accumulator_for_flat(accumulator, key, value)
  if accumulator[key]
    raise ArgumentError, "Key was repeated: #{key.inspect}"
  end
  accumulator[key] = value
end

.fill_accumulator_for_flat_array(accumulator, key, value) ⇒ Object


100
101
102
# File 'lib/webmock/util/query_mapper.rb', line 100

def fill_accumulator_for_flat_array(accumulator, key, value)
  accumulator << [key, value]
end

.fill_accumulator_for_subscript(accumulator, key, value) ⇒ Object


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
162
163
164
165
166
167
168
169
# File 'lib/webmock/util/query_mapper.rb', line 123

def fill_accumulator_for_subscript(accumulator, key, value)
  current_node = accumulator
  subkeys = key.split(/(?=\[[^\[\]]+)/)
  subkeys[0..-2].each do |subkey|
    node = subkey =~ /\[\]\z/ ? [] : {}
    subkey = subkey.gsub(/[\[\]]/, '')
    if current_node.is_a? Array
      container = current_node.find { |n| n.is_a?(Hash) && n.has_key?(subkey) }
      if container
        current_node = container[subkey]
      else
        current_node << {subkey => node}
        current_node = node
      end
    else
      current_node[subkey] = node unless current_node[subkey]
      current_node = current_node[subkey]
    end
  end
  last_key = subkeys.last
  array_value = !!(last_key =~ /\[\]$/)
  last_key = last_key.gsub(/[\[\]]/, '')
  if current_node.is_a? Array
    last_container = current_node.select { |n| n.is_a?(Hash) }.last
    if last_container && !last_container.has_key?(last_key)
      if array_value
        last_container[last_key] ||= []
        last_container[last_key] << value
      else
        last_container[last_key] = value
      end
    else
      if array_value
        current_node << {last_key => [value]}
      else
        current_node << {last_key => value}
      end
    end
  else
    if array_value
      current_node[last_key] ||= []
      current_node[last_key] << value unless value.nil?
    else
      current_node[last_key] = value
    end
  end
end

.normalize_query_hash(query_hash, empty_accumulator, options) ⇒ Object


61
62
63
64
65
66
67
68
69
70
# File 'lib/webmock/util/query_mapper.rb', line 61

def normalize_query_hash(query_hash, empty_accumulator, options)
  query_hash.inject(empty_accumulator.dup) do |accumulator, (key, value)|
    if options[:notation] == :flat_array
      accumulator << [key, value]
    else
      accumulator[key] = value.kind_of?(Hash) ? dehash(value) : value
    end
    accumulator
  end
end

.query_to_values(query, options = {}) ⇒ Hash, Array

Converts the query component to a Hash value.

Examples:

WebMock::Util::QueryMapper.query_to_values("?one=1&two=2&three=3")
#=> {"one" => "1", "two" => "2", "three" => "3"}
WebMock::Util::QueryMapper("?one[two][three]=four").query_values
#=> {"one" => {"two" => {"three" => "four"}}}
WebMock::Util::QueryMapper.query_to_values("?one.two.three=four",
  :notation => :dot
)
#=> {"one" => {"two" => {"three" => "four"}}}
WebMock::Util::QueryMapper.query_to_values("?one[two][three]=four",
  :notation => :flat
)
#=> {"one[two][three]" => "four"}
WebMock::Util::QueryMapper.query_to_values("?one.two.three=four",
  :notation => :flat
)
#=> {"one.two.three" => "four"}
WebMock::Util::QueryMapper(
  "?one[two][three][]=four&one[two][three][]=five"
)
#=> {"one" => {"two" => {"three" => ["four", "five"]}}}
WebMock::Util::QueryMapper.query_to_values(
  "?one=two&one=three").query_values(:notation => :flat_array)
#=> [['one', 'two'], ['one', 'three']]

Parameters:

  • [Symbol] (Hash)

    a customizable set of options

Returns:

  • (Hash, Array)

    The query string parsed as a Hash or Array object.


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/webmock/util/query_mapper.rb', line 40

def query_to_values(query, options={})
  return nil if query.nil?
  query = query.dup.force_encoding('utf-8') if query.respond_to?(:force_encoding)

  options[:notation] ||= :subscript

  if ![:flat, :dot, :subscript, :flat_array].include?(options[:notation])
    raise ArgumentError,
          'Invalid notation. Must be one of: ' +
          '[:flat, :dot, :subscript, :flat_array].'
  end

  empty_accumulator = :flat_array == options[:notation] ? [] : {}

  query_array = collect_query_parts(query)

  query_hash = collect_query_hash(query_array, empty_accumulator, options)

  normalize_query_hash(query_hash, empty_accumulator, options)
end

.to_query(parent, value, options = {}) ⇒ Object

new_query_values have form [['key1', 'value1'], ['key2', 'value2']]


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/webmock/util/query_mapper.rb', line 245

def to_query(parent, value, options = {})
  options[:notation] ||= :subscript
  case value
  when ::Hash
    value = value.map do |key, val|
      [
        ::Addressable::URI.encode_component(key.to_s.dup, ::Addressable::URI::CharacterClasses::UNRESERVED),
        val
      ]
    end
    value.sort!
    buffer = ''.dup
    value.each do |key, val|
      new_parent = options[:notation] != :flat_array ? "#{parent}[#{key}]" : parent
      buffer << "#{to_query(new_parent, val, options)}&"
    end
    buffer.chop
  when ::Array
    buffer = ''.dup
    value.each_with_index do |val, i|
      new_parent = options[:notation] != :flat_array ? "#{parent}[#{i}]" : parent
      buffer << "#{to_query(new_parent, val, options)}&"
    end
    buffer.chop
  when NilClass
    parent
  else
    encoded_value = Addressable::URI.encode_component(
      value.to_s.dup, Addressable::URI::CharacterClasses::UNRESERVED
    )
    "#{parent}=#{encoded_value}"
  end
end

.values_to_query(new_query_values, options = {}) ⇒ Object

Sets the query component for this URI from a Hash object. This method produces a query string using the :subscript notation. An empty Hash will result in a nil query.

Parameters:

  • new_query_values (Hash, #to_hash, Array)

    The new query values.


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/webmock/util/query_mapper.rb', line 177

def values_to_query(new_query_values, options = {})
  options[:notation] ||= :subscript
  return if new_query_values.nil?

  unless new_query_values.is_a?(Array)
    unless new_query_values.respond_to?(:to_hash)
      raise TypeError,
            "Can't convert #{new_query_values.class} into Hash."
    end
    new_query_values = new_query_values.to_hash
    new_query_values = new_query_values.inject([]) do |object, (key, value)|
      key = key.to_s if key.is_a?(::Symbol) || key.nil?
      if value.is_a?(Array) && value.empty?
        object << [key.to_s + '[]']
      elsif value.is_a?(Array)
        value.each { |v| object << [key.to_s + '[]', v] }
      elsif value.is_a?(Hash)
        value.each { |k, v| object << ["#{key.to_s}[#{k}]", v]}
      else
        object << [key.to_s, value]
      end
      object
    end
    # Useful default for OAuth and caching.
    # Only to be used for non-Array inputs. Arrays should preserve order.
    begin
      new_query_values.sort! # may raise for non-comparable values
    rescue NoMethodError, ArgumentError
      # ignore
    end
  end

  buffer = ''.dup
  new_query_values.each do |parent, value|
    encoded_parent = ::Addressable::URI.encode_component(
        parent.dup, ::Addressable::URI::CharacterClasses::UNRESERVED
    )
    buffer << "#{to_query(encoded_parent, value, options)}&"
  end
  buffer.chop
end