Class: JSON::Pure::Generator::State

Inherits:
Object
  • Object
show all
Defined in:
lib/json/pure/generator.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ State

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: is deprecated now, use the :max_nesting option instead,

  • max_nesting: sets the maximum level of data structure nesting in the generated JSON, max_nesting = 0 if no maximum should be checked.

  • 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.

  • quirks_mode: Enables quirks_mode for parser, that is for example generating single JSON values instead of documents is possible.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/json/pure/generator.rb', line 138

def initialize(opts = {})
  @indent                = ''
  @space                 = ''
  @space_before          = ''
  @object_nl             = ''
  @array_nl              = ''
  @allow_nan             = false
  @ascii_only            = false
  @quirks_mode           = false
  @buffer_initial_length = 1024
  configure opts
end

Instance Attribute Details

#array_nl ⇒ Object

This string is put at the end of a line that holds a JSON array.



166
167
168
 
# File 'lib/json/pure/generator.rb', line 166

def array_nl
  @array_nl
end

#buffer_initial_length ⇒ Object

:stopdoc:



177
178
179
 
# File 'lib/json/pure/generator.rb', line 177

def buffer_initial_length
  @buffer_initial_length
end

#depth ⇒ Object

This integer returns the current depth data structure nesting in the generated JSON.



188
189
190
 
# File 'lib/json/pure/generator.rb', line 188

def depth
  @depth
end

#indent ⇒ Object

This string is used to indent levels in the JSON text.



152
153
154
 
# File 'lib/json/pure/generator.rb', line 152

def indent
  @indent
end

#max_nesting ⇒ Object

This integer returns the maximum level of data structure nesting in the generated JSON, max_nesting = 0 if no maximum is checked.



170
171
172
 
# File 'lib/json/pure/generator.rb', line 170

def max_nesting
  @max_nesting
end

#object_nl ⇒ Object

This string is put at the end of a line that holds a JSON object (or Hash).



163
164
165
 
# File 'lib/json/pure/generator.rb', line 163

def object_nl
  @object_nl
end

#quirks_mode ⇒ Object

If this attribute is set to true, quirks mode is enabled, otherwise it’s disabled.



174
175
176
 
# File 'lib/json/pure/generator.rb', line 174

def quirks_mode
  @quirks_mode
end

#space ⇒ Object

This string is used to insert a space between the tokens in a JSON string.



156
157
158
 
# File 'lib/json/pure/generator.rb', line 156

def space
  @space
end

#space_before ⇒ Object

This string is used to insert a space before the ‘:’ in JSON objects.



159
160
161
 
# File 'lib/json/pure/generator.rb', line 159

def space_before
  @space_before
end

Class Method Details

.from_state(opts) ⇒ Object

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.



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/json/pure/generator.rb', line 108

def self.from_state(opts)
  case
  when self === opts
    opts
  when opts.respond_to?(:to_hash)
    new(opts.to_hash)
  when opts.respond_to?(:to_h)
    new(opts.to_h)
  else
    SAFE_STATE_PROTOTYPE.dup
  end
end

Instance Method Details

#[](name) ⇒ Object

Return the value returned by method name.



269
270
271
 
# File 'lib/json/pure/generator.rb', line 269

def [](name)
  __send__ name
end

#allow_nan? ⇒ Boolean

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

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/json/pure/generator.rb', line 205

def allow_nan?
  @allow_nan
end

#ascii_only? ⇒ Boolean

Returns true, if only ASCII characters should be generated. Otherwise returns false.

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/json/pure/generator.rb', line 211

def ascii_only?
  @ascii_only
end

#check_circular? ⇒ Boolean

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

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/json/pure/generator.rb', line 199

def check_circular?
  !@max_nesting.zero?
end

#check_max_nesting ⇒ Object

:nodoc:



190
191
192
193
194
195
 
# File 'lib/json/pure/generator.rb', line 190

def check_max_nesting # :nodoc:
  return if @max_nesting.zero?
  current_nesting = depth + 1
  current_nesting > @max_nesting and
    raise NestingError, "nesting of #{current_nesting} is too deep"
end

#configure(opts) ⇒ Object Also known as: merge

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/json/pure/generator.rb', line 222

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)
  @allow_nan      = !!opts[:allow_nan] if opts.key?(:allow_nan)
  @ascii_only     = opts[:ascii_only] if opts.key?(:ascii_only)
  @depth          = opts[:depth] || 0
  @quirks_mode    = opts[:quirks_mode] if opts.key?(:quirks_mode)
  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

#generate(obj) ⇒ Object

Generates a valid JSON document from object obj and returns the result. If no valid JSON document can be created this method raises a GeneratorError exception.



256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/json/pure/generator.rb', line 256

def generate(obj)
  result = obj.to_json(self)
  unless @quirks_mode
    unless result =~ /\A\s*\[/ && result =~ /\]\s*\Z/ ||
      result =~ /\A\s*\{/ && result =~ /\}\s*\Z/
    then
      raise GeneratorError, "only generation of JSON objects or arrays allowed"
    end
  end
  result
end

#quirks_mode? ⇒ Boolean

Returns true, if quirks mode is enabled. Otherwise returns false.

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/json/pure/generator.rb', line 216

def quirks_mode?
  @quirks_mode
end

#to_h ⇒ Object

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



245
246
247
248
249
250
251
 
# File 'lib/json/pure/generator.rb', line 245

def to_h
  result = {}
  for iv in %w[indent space space_before object_nl array_nl allow_nan max_nesting ascii_only quirks_mode buffer_initial_length depth]
    result[iv.intern] = instance_variable_get("@#{iv}")
  end
  result
end