Class: FFI_Yajl::Encoder

Inherits:
Object show all
Includes:
FFI_Yajl::Ext::Encoder, FFI::Encoder
Defined in:
lib/ffi_yajl/ext.rb,
lib/ffi_yajl/ffi.rb,
lib/ffi_yajl/encoder.rb,
ext/ffi_yajl/ext/encoder/encoder.c

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FFI::Encoder

#do_yajl_encode

Methods included from FFI_Yajl::Ext::Encoder

#do_yajl_encode

Constructor Details

#initialize(opts = {}) ⇒ Encoder

Returns a new instance of Encoder.



60
61
62
63
# File 'lib/ffi_yajl/encoder.rb', line 60

def initialize(opts = {})
  @opts = opts
  @opts ||= {}
end

Instance Attribute Details

#optsObject

Returns the value of attribute opts.



26
27
28
# File 'lib/ffi_yajl/encoder.rb', line 26

def opts
  @opts
end

Class Method Details

.encode(obj, *args) ⇒ Object



56
57
58
# File 'lib/ffi_yajl/encoder.rb', line 56

def self.encode(obj, *args)
  new(*args).encode(obj)
end

.raise_error_for_status(status, token = nil) ⇒ Object



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/ffi_yajl/encoder.rb', line 65

def self.raise_error_for_status(status, token = nil)
  # scrub token to valid utf-8 since we may be issuing an exception on an invalid utf-8 token
  token = token.to_s.force_encoding("UTF-8")
  if token.respond_to?(:scrub)
    token.scrub!
  else
    token.encode!("UTF-16le", undef: :replace, invalid: :replace).encode!('UTF-8')
  end
  case status
  when 1 # yajl_gen_keys_must_be_strings
    raise FFI_Yajl::EncodeError, "YAJL internal error: attempted use of non-string object as key"
  when 2 # yajl_max_depth_exceeded
    raise FFI_Yajl::EncodeError, "Max nesting depth exceeded"
  when 3 # yajl_gen_in_error_state
    raise FFI_Yajl::EncodeError, "YAJL internal error: a generator function (yajl_gen_XXX) was called while in an error state"
  when 4 # yajl_gen_generation_complete
    raise FFI_Yajl::EncodeError, "YAJL internal error: attempted to encode to an already-complete document"
  when 5 # yajl_gen_invalid_number
    raise FFI_Yajl::EncodeError, "Invalid number: cannot encode Infinity, -Infinity, or NaN"
  when 6 # yajl_gen_no_buf
    raise FFI_Yajl::EncodeError, "YAJL internal error: yajl_gen_get_buf was called, but a print callback was specified, so no internal buffer is available"
  when 7 # yajl_gen_invalid_string
    raise FFI_Yajl::EncodeError, "Invalid UTF-8 string '#{token}': cannot encode to UTF-8"
  else
    raise FFI_Yajl::EncodeError, "Unknown YAJL Error (#{status}), please report this as a bug"
  end
end

Instance Method Details

#encode(obj) ⇒ Object



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/ffi_yajl/encoder.rb', line 28

def encode(obj)
  # initialization that we can do in pure ruby
  yajl_gen_opts = {}

  yajl_gen_opts[:yajl_gen_validate_utf8] = @opts[:validate_utf8] == false ? false : true
  yajl_gen_opts[:yajl_gen_beautify] = false
  yajl_gen_opts[:yajl_gen_indent_string] = " "

  if opts[:pretty]
    yajl_gen_opts[:yajl_gen_beautify] = true
    yajl_gen_opts[:yajl_gen_indent_string] = opts[:indent] ? opts[:indent] : "  "
  end

  # call either the ext or ffi hook
  str = do_yajl_encode(obj, yajl_gen_opts, opts)
  # we can skip cleaning the whole string for utf-8 issues if we have yajl validate as we go

  str.force_encoding("UTF-8")
  unless yajl_gen_opts[:yajl_gen_validate_utf8]
    if str.respond_to?(:scrub)
      str.scrub!
    else
      str.encode!("UTF-16le", undef: :replace, invalid: :replace).encode!('UTF-8')
    end
  end
  str
end