Module: JsonCsv::Utils

Defined in:
lib/json_csv/utils.rb

Class Method Summary collapse

Class Method Details

.hash_or_array?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/json_csv/utils.rb', line 16

def self.hash_or_array?(obj)
  obj.is_a?(Hash) || obj.is_a?(Array)
end

.recursively_remove_blank_fields!(hash_or_array) ⇒ Object

Given a Hash or Array, recursively removes all blank fields. Note: This method will raise an ArgumentError if the supplied object is a frozen Hash or Array.

Raises:

  • (ArgumentError) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/json_csv/utils.rb', line 23

def self.recursively_remove_blank_fields!(hash_or_array)
  raise ArgumentError, 'Must supply a Hash or Array' unless hash_or_array?(hash_or_array)
  raise ArgumentError, "Cannot modify frozen value: #{hash_or_array.inspect}" if hash_or_array.frozen?

  case hash_or_array
  when Array
    # Recurse through non-empty elements
    hash_or_array.each do |element|
      recursively_remove_blank_fields!(element) if hash_or_array?(element)
    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
  when Hash
    hash_or_array.each_value do |value|
      recursively_remove_blank_fields!(value) if hash_or_array?(value)
    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
  end

  hash_or_array
end

.recursively_strip_value_whitespace!(obj, replace_frozen_strings_when_stripped: false) ⇒ 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.



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
 
# File 'lib/json_csv/utils.rb', line 56

def self.recursively_strip_value_whitespace!(obj, replace_frozen_strings_when_stripped: false)
  case obj
  when Array
    obj.each_with_index do |element, ix|
      if element.is_a?(String) && replace_frozen_strings_when_stripped
        stripped_string = element.strip
        obj[ix] = stripped_string if stripped_string != obj[ix]
      else
        recursively_strip_value_whitespace!(
          element,
          replace_frozen_strings_when_stripped: replace_frozen_strings_when_stripped
        )
      end
    end
  when Hash
    obj.each do |key, value|
      if value.is_a?(String) && replace_frozen_strings_when_stripped
        stripped_string = obj[key].strip
        obj[key] = stripped_string if stripped_string != obj[key]
      else
        recursively_strip_value_whitespace!(
          value,
          replace_frozen_strings_when_stripped: replace_frozen_strings_when_stripped
        )
      end
    end
  when 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.

Returns:

  • (Boolean) 


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

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