Class: String

Inherits:
Object
  • Object
show all
Defined in:
lib/everythingrb/string.rb

Overview

Extensions to Ruby’s core String class

Provides:

  • #to_h, #to_a: Convert JSON strings to Hash/Array with error handling

  • #to_deep_h: Recursively parse nested JSON strings

  • #to_ostruct, #to_istruct, #to_struct: Convert JSON to data structures

  • #with_quotes, #in_quotes: Wrap strings in quotes

Examples:

require "everythingrb/string"

'{"user": {"name": "Alice"}}'.to_ostruct.user.name  # => "Alice"
"Hello".with_quotes  # => "\"Hello\""

Instance Method Summary collapse

Instance Method Details

#to_deep_h ⇒ Hash

Deep parsing of nested JSON strings Recursively attempts to parse string values as JSON

Examples:

nested_json = '{
  "user": "{\"name\":\"Alice\",\"roles\":[\"admin\"]}"
}'
nested_json.to_deep_h
# => {user: {name: "Alice", roles: ["admin"]}}

Returns:

  • (Hash) —

    Deeply parsed hash with all nested JSON strings converted



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/everythingrb/string.rb', line 49

def to_deep_h
  recursive_convert = lambda do |object|
    case object
    when Array
      object.map { |v| recursive_convert.call(v) }
    when String
      result = object.to_deep_h

      # Nested JSON
      if result.is_a?(Array) || result.is_a?(Hash)
        recursive_convert.call(result)
      else
        object
      end
    when Hash
      object.transform_values { |v| recursive_convert.call(v) }
    else
      object
    end
  end

  recursive_convert.call(to_h)
end

#to_h ⇒ Hash? Also known as: to_a

Converts JSON string to Hash, returning nil if it failed

Examples:

'{"name": "Alice"}'.to_h  # => {name: "Alice"}
"invalid json".to_h       # => nil

Returns:

  • (Hash, nil) —

    Parsed JSON as hash or nil if invalid JSON



28
29
30
31
32
 
# File 'lib/everythingrb/string.rb', line 28

def to_h
  JSON.parse(self, symbolize_names: true)
rescue JSON::ParserError
  nil
end

#to_istruct ⇒ Data?

Attempts to parse JSON and convert to Data struct. Returns nil if string does not contain valid JSON

Examples:

'{"name": "Alice"}'.to_istruct      # => #<data name="Alice">
"not json".to_istruct               # => nil

Returns:

  • (Data, nil) —

    Immutable Data structure or nil if invalid JSON



83
84
85
 
# File 'lib/everythingrb/string.rb', line 83

def to_istruct
  to_h&.to_istruct
end

#to_ostruct ⇒ OpenStruct?

Attempts to parse JSON and convert to OpenStruct. Returns nil if string does not contain valid JSON

Examples:

'{"name": "Alice"}'.to_ostruct      # => #<OpenStruct name="Alice">
"not json".to_ostruct               # => nil

Returns:

  • (OpenStruct, nil) —

    OpenStruct or nil if invalid JSON



97
98
99
 
# File 'lib/everythingrb/string.rb', line 97

def to_ostruct
  to_h&.to_ostruct
end

#to_struct ⇒ Struct?

Attempts to parse JSON and convert to Struct. Returns nil if string does not contain valid JSON

Examples:

'{"name": "Alice"}'.to_struct       # => #<struct name="Alice">
"not json".to_struct                # => nil

Returns:

  • (Struct, nil) —

    Struct or nil if invalid JSON



111
112
113
 
# File 'lib/everythingrb/string.rb', line 111

def to_struct
  to_h&.to_struct
end

#with_quotes ⇒ String Also known as: in_quotes

Returns self wrapped in double quotes

Examples:

"Hello World".with_quotes           # => "\"Hello World\""
"Quote \"me\"".with_quotes          # => "\"Quote \\\"me\\\"\""

Returns:

  • (String) —

    The string with surrounding double quotes



124
125
126
 
# File 'lib/everythingrb/string.rb', line 124

def with_quotes
  %("#{self}")
end