Class JSON::Pure::Generator::State
In: lib/json/pure/generator.rb
Parent: Object

This class is used to create State instances, that are use to hold data while generating a JSON text from a a Ruby data structure.

Methods

allow_nan?   check_circular?   configure   forget   from_state   new   remember   seen?   to_h  

Attributes

array_nl  [RW]  This string is put at the end of a line that holds a JSON array.
indent  [RW]  This string is used to indent levels in the JSON text.
max_nesting  [RW]  This integer returns the maximum level of data structure nesting in the generated JSON, max_nesting = 0 if no maximum is checked.
object_nl  [RW]  This string is put at the end of a line that holds a JSON object (or Hash).
space  [RW]  This string is used to insert a space between the tokens in a JSON string.
space_before  [RW]  This string is used to insert a space before the ’:’ in JSON objects.

Public Class methods

from_state(opts)

Creates a State object from opts, which ought to be Hash to create a new State instance configured by opts, something else to create an unconfigured instance. If opts is a State object, it is just returned.

[Source]

# File lib/json/pure/generator.rb, line 71
        def self.from_state(opts)
          case opts
          when self
            opts
          when Hash
            new(opts)
          else
            new
          end
        end
new(opts = {})

Instantiates a new State object, configured by opts.

opts can have the following keys:

  • indent: a string used to indent levels (default: ’’),
  • space: a string that is put after, a : or , delimiter (default: ’’),
  • space_before: a string that is put before a : pair delimiter (default: ’’),
  • object_nl: a string that is put at the end of a JSON object (default: ’’),
  • array_nl: a string that is put at the end of a JSON array (default: ’’),
  • check_circular: true if checking for circular data structures should be done (the default), false otherwise.
  • check_circular: true if checking for circular data structures should be done, false (the default) otherwise.
  • allow_nan: true if NaN, Infinity, and -Infinity should be generated, otherwise an exception is thrown, if these values are encountered. This options defaults to false.

[Source]

# File lib/json/pure/generator.rb, line 98
        def initialize(opts = {})
          @seen = {}
          @indent         = ''
          @space          = ''
          @space_before   = ''
          @object_nl      = ''
          @array_nl       = ''
          @check_circular = true
          @allow_nan      = false
          configure opts
        end

Public Instance methods

allow_nan?()

Returns true if NaN, Infinity, and -Infinity should be considered as valid JSON and output.

[Source]

# File lib/json/pure/generator.rb, line 146
        def allow_nan?
          @allow_nan
        end
check_circular?()

Returns true, if circular data structures should be checked, otherwise returns false.

[Source]

# File lib/json/pure/generator.rb, line 140
        def check_circular?
          @check_circular
        end
configure(opts)

Configure this State instance with the Hash opts, and return itself.

[Source]

# File lib/json/pure/generator.rb, line 169
        def configure(opts)
          @indent         = opts[:indent] if opts.key?(:indent)
          @space          = opts[:space] if opts.key?(:space)
          @space_before   = opts[:space_before] if opts.key?(:space_before)
          @object_nl      = opts[:object_nl] if opts.key?(:object_nl)
          @array_nl       = opts[:array_nl] if opts.key?(:array_nl)
          @check_circular = !!opts[:check_circular] if opts.key?(:check_circular)
          @allow_nan      = !!opts[:allow_nan] if opts.key?(:allow_nan)
          if !opts.key?(:max_nesting) # defaults to 19
            @max_nesting = 19
          elsif opts[:max_nesting]
            @max_nesting = opts[:max_nesting]
          else
            @max_nesting = 0
          end
          self
        end
forget(object)

Forget object for this generating run.

[Source]

# File lib/json/pure/generator.rb, line 163
        def forget(object)
          @seen.delete object.__id__
        end
remember(object)

Remember object, to find out if it was already encountered (if a cyclic data structure is if a cyclic data structure is rendered).

[Source]

# File lib/json/pure/generator.rb, line 158
        def remember(object)
          @seen[object.__id__] = true
        end
seen?(object)

Returns true, if object was already seen during this generating run.

[Source]

# File lib/json/pure/generator.rb, line 152
        def seen?(object)
          @seen.key?(object.__id__)
        end
to_h()

Returns the configuration instance variables as a hash, that can be passed to the configure method.

[Source]

# File lib/json/pure/generator.rb, line 189
        def to_h
          result = {}
          for iv in %w[indent space space_before object_nl array_nl check_circular allow_nan max_nesting]
            result[iv.intern] = instance_variable_get("@#{iv}")
          end
          result
        end

[Validate]