Module: JsonCsv::Utils

Defined in:
lib/json_csv/utils.rb

Class Method Summary collapse

Class Method Details

.recursively_remove_blank_fields!(hash_or_array) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/json_csv/utils.rb', line 14

def self.recursively_remove_blank_fields!(hash_or_array)
  return if hash_or_array.frozen? # We can't modify a frozen value, so we won't.

  if hash_or_array.is_a?(Array)
    # Recurse through non-empty elements
    hash_or_array.each do |element|
      recursively_remove_blank_fields!(element) if element.is_a?(Hash) || element.is_a?(Array)
    end

    # Delete blank array element values on this array level (including empty object ({}) values)
    hash_or_array.delete_if do |element|
      removable_value?(element)
    end
  elsif hash_or_array.is_a?(Hash)
    hash_or_array.each_value do |value|
      recursively_remove_blank_fields!(value) if value.is_a?(Hash) || value.is_a?(Array)
    end

    # Delete blank hash values on this hash level (including empty object ({}) values)
    hash_or_array.delete_if do |_key, value|
      removable_value?(value)
    end
  else
    raise ArgumentError, 'Must supply a hash or array.'
  end

  hash_or_array
end

.recursively_strip_value_whitespace!(obj) ⇒ Object

Recursively goes through an object and strips whitespace, modifying the object’s nested child hashes or array. Note: This method modifies hash values, but does not modify hash keys.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/json_csv/utils.rb', line 47

def self.recursively_strip_value_whitespace!(obj)
  if obj.is_a?(Array)
    obj.each do |element|
      recursively_strip_value_whitespace!(element)
    end
  elsif obj.is_a?(Hash)
    obj.each_value do |value|
      recursively_strip_value_whitespace!(value)
    end
  elsif obj.is_a?(String)
    obj.strip!
  end

  obj
end

.removable_value?(value) ⇒ Boolean

Returns true for empty strings, empty arrays, or empty hashes. Also returns true for strings that only contain whitespace. Returns false for all other values, including booleans and numbers.



7
8
9
10
11
12
 
# File 'lib/json_csv/utils.rb', line 7

def self.removable_value?(value)
  return true if value.respond_to?(:empty?) && value.empty? # empty string, empty array, or empty hash
  return true if value.is_a?(String) && value.strip.empty? # string that only contains whitespace
  return true if value.nil?
  false
end