json 1.0.0 → 2.7.2

data/lib/json/ext.rb

@@ -6,8 +6,10 @@ module JSON
   module Ext
     require 'json/ext/parser'
     require 'json/ext/generator'
-    $DEBUG and warn "Using c extension for JSON."
+    $DEBUG and warn "Using Ext extension for JSON."
     JSON.parser = Parser
     JSON.generator = Generator
   end
+
+  JSON_LOADED = true unless defined?(::JSON::JSON_LOADED)
 end

data/lib/json/generic_object.rb

@@ -0,0 +1,75 @@
+#frozen_string_literal: false
+begin
+  require 'ostruct'
+rescue LoadError
+  warn "JSON::GenericObject requires 'ostruct'. Please install it with `gem install ostruct`."
+end
+
+module JSON
+  class GenericObject < OpenStruct
+    class << self
+      alias [] new
+
+      def json_creatable?
+        @json_creatable
+      end
+
+      attr_writer :json_creatable
+
+      def json_create(data)
+        data = data.dup
+        data.delete JSON.create_id
+        self[data]
+      end
+
+      def from_hash(object)
+        case
+        when object.respond_to?(:to_hash)
+          result = new
+          object.to_hash.each do |key, value|
+            result[key] = from_hash(value)
+          end
+          result
+        when object.respond_to?(:to_ary)
+          object.to_ary.map { |a| from_hash(a) }
+        else
+          object
+        end
+      end
+
+      def load(source, proc = nil, opts = {})
+        result = ::JSON.load(source, proc, opts.merge(:object_class => self))
+        result.nil? ? new : result
+      end
+
+      def dump(obj, *args)
+        ::JSON.dump(obj, *args)
+      end
+    end
+    self.json_creatable = false
+
+    def to_hash
+      table
+    end
+
+    def [](name)
+      __send__(name)
+    end unless method_defined?(:[])
+
+    def []=(name, value)
+      __send__("#{name}=", value)
+    end unless method_defined?(:[]=)
+
+    def |(other)
+      self.class[other.to_hash.merge(to_hash)]
+    end
+
+    def as_json(*)
+      { JSON.create_id => self.class.name }.merge to_hash
+    end
+
+    def to_json(*a)
+      as_json.to_json(*a)
+    end
+  end if defined?(::OpenStruct)
+end

data/lib/json/pure/generator.rb

@@ -1,3 +1,4 @@
+#frozen_string_literal: false
 module JSON
   MAP = {
     "\x0" => '\u0000',
@@ -34,48 +35,83 @@ module JSON
     "\x1f" => '\u001f',
     '"'   =>  '\"',
     '\\'  =>  '\\\\',
-    '/'   =>  '\/',
   } # :nodoc:
 
+  ESCAPE_PATTERN = /[\/"\\\x0-\x1f]/n # :nodoc:
+
+  SCRIPT_SAFE_MAP = MAP.merge(
+    '/'  =>  '\\/',
+    "\u2028".b => '\u2028',
+    "\u2029".b => '\u2029',
+  )
+
+  SCRIPT_SAFE_ESCAPE_PATTERN = Regexp.union(ESCAPE_PATTERN, "\u2028".b, "\u2029".b)
+
   # Convert a UTF8 encoded Ruby string _string_ to a JSON string, encoded with
   # UTF16 big endian characters as \u????, and return it.
-  def utf8_to_json(string) # :nodoc:
-    string = string.gsub(/["\\\/\x0-\x1f]/) { |c| MAP[c] }
+  def utf8_to_json(string, script_safe = false) # :nodoc:
+    string = string.dup
+    string.force_encoding(::Encoding::ASCII_8BIT)
+    if script_safe
+      string.gsub!(SCRIPT_SAFE_ESCAPE_PATTERN) { SCRIPT_SAFE_MAP[$&] || $& }
+    else
+      string.gsub!(ESCAPE_PATTERN) { MAP[$&] || $& }
+    end
+    string.force_encoding(::Encoding::UTF_8)
+    string
+  end
+
+  def utf8_to_json_ascii(string, script_safe = false) # :nodoc:
+    string = string.dup
+    string.force_encoding(::Encoding::ASCII_8BIT)
+    map = script_safe ? SCRIPT_SAFE_MAP : MAP
+    string.gsub!(/[\/"\\\x0-\x1f]/n) { map[$&] || $& }
     string.gsub!(/(
-                    (?:
-                      [\xc2-\xdf][\x80-\xbf]    |
-                      [\xe0-\xef][\x80-\xbf]{2} |
-                      [\xf0-\xf4][\x80-\xbf]{3}
-                    )+ |
-                    [\x80-\xc1\xf5-\xff]       # invalid
-                  )/nx) { |c|
+      (?:
+       [\xc2-\xdf][\x80-\xbf]    |
+       [\xe0-\xef][\x80-\xbf]{2} |
+       [\xf0-\xf4][\x80-\xbf]{3}
+      )+ |
+      [\x80-\xc1\xf5-\xff]       # invalid
+    )/nx) { |c|
       c.size == 1 and raise GeneratorError, "invalid utf8 byte: '#{c}'"
-      s = JSON::UTF8toUTF16.iconv(c).unpack('H*')[0]
+      s = JSON.iconv('utf-16be', 'utf-8', c).unpack('H*')[0]
+      s.force_encoding(::Encoding::ASCII_8BIT)
       s.gsub!(/.{4}/n, '\\\\u\&')
+      s.force_encoding(::Encoding::UTF_8)
     }
+    string.force_encoding(::Encoding::UTF_8)
     string
-  rescue Iconv::Failure => e
-    raise GeneratorError, "Caught #{e.class}: #{e}"
+  rescue => e
+    raise GeneratorError.wrap(e)
   end
-  module_function :utf8_to_json
+
+  def valid_utf8?(string)
+    encoding = string.encoding
+    (encoding == Encoding::UTF_8 || encoding == Encoding::ASCII) &&
+      string.valid_encoding?
+  end
+  module_function :utf8_to_json, :utf8_to_json_ascii, :valid_utf8?
 
   module Pure
     module Generator
       # 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.
+      # while generating a JSON text from a Ruby data structure.
       class State
         # 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.
         def self.from_state(opts)
-          case opts
-          when self
+          case
+          when self === opts
             opts
-          when Hash
-            new(opts)
+          when opts.respond_to?(:to_hash)
+            new(opts.to_hash)
+          when opts.respond_to?(:to_h)
+            new(opts.to_h)
           else
-            new
+            SAFE_STATE_PROTOTYPE.dup
           end
         end
 
@@ -86,18 +122,28 @@ module JSON
         # * *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: ''), 
+        # * *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, false (the default) otherwise.
+        # * *script_safe*: true if U+2028, U+2029 and forward slash (/) should be escaped
+        #   as to make the JSON object safe to interpolate in a script tag (default: false).
+        # * *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.
         def initialize(opts = {})
-          @indent         = opts[:indent]       || ''
-          @space          = opts[:space]        || ''
-          @space_before   = opts[:space_before] || ''
-          @object_nl      = opts[:object_nl]    || ''
-          @array_nl       = opts[:array_nl]     || ''
-          @check_circular = !!(opts[:check_circular] || false)
-          @seen           = {}
+          @indent                = ''
+          @space                 = ''
+          @space_before          = ''
+          @object_nl             = ''
+          @array_nl              = ''
+          @allow_nan             = false
+          @ascii_only            = false
+          @script_safe          = false
+          @strict                = false
+          @buffer_initial_length = 1024
+          configure opts
         end
 
         # This string is used to indent levels in the JSON text.
@@ -117,27 +163,151 @@ module JSON
         # This string is put at the end of a line that holds a JSON array.
         attr_accessor :array_nl
 
-        # Returns true, if circular data structures should be checked,
+        # This integer returns the maximum level of data structure nesting in
+        # the generated JSON, max_nesting = 0 if no maximum is checked.
+        attr_accessor :max_nesting
+
+        # If this attribute is set to true, forward slashes will be escaped in
+        # all json strings.
+        attr_accessor :script_safe
+
+        # If this attribute is set to true, attempting to serialize types not
+        # supported by the JSON spec will raise a JSON::GeneratorError
+        attr_accessor :strict
+
+        # :stopdoc:
+        attr_reader :buffer_initial_length
+
+        def buffer_initial_length=(length)
+          if length > 0
+            @buffer_initial_length = length
+          end
+        end
+        # :startdoc:
+
+        # This integer returns the current depth data structure nesting in the
+        # generated JSON.
+        attr_accessor :depth
+
+        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
+
+        # Returns true, if circular data structures are checked,
         # otherwise returns false.
         def check_circular?
-          @check_circular
+          !@max_nesting.zero?
         end
 
-        # Returns _true_, if _object_ was already seen during this generating
-        # run. 
-        def seen?(object)
-          @seen.key?(object.__id__)
+        # Returns true if NaN, Infinity, and -Infinity should be considered as
+        # valid JSON and output.
+        def allow_nan?
+          @allow_nan
         end
 
-        # Remember _object_, to find out if it was already encountered (if a
-        # cyclic data structure is if a cyclic data structure is rendered). 
-        def remember(object)
-          @seen[object.__id__] = true
+        # Returns true, if only ASCII characters should be generated. Otherwise
+        # returns false.
+        def ascii_only?
+          @ascii_only
         end
 
-        # Forget _object_ for this generating run.
-        def forget(object)
-          @seen.delete object.__id__
+        # Returns true, if forward slashes are escaped. Otherwise returns false.
+        def script_safe?
+          @script_safe
+        end
+
+        # Returns true, if forward slashes are escaped. Otherwise returns false.
+        def strict?
+          @strict
+        end
+
+        # Configure this State instance with the Hash _opts_, and return
+        # itself.
+        def configure(opts)
+          if opts.respond_to?(:to_hash)
+            opts = opts.to_hash
+          elsif opts.respond_to?(:to_h)
+            opts = opts.to_h
+          else
+            raise TypeError, "can't convert #{opts.class} into Hash"
+          end
+          opts.each do |key, value|
+            instance_variable_set "@#{key}", value
+          end
+          @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
+          @buffer_initial_length ||= opts[:buffer_initial_length]
+
+          @script_safe = if opts.key?(:script_safe)
+            !!opts[:script_safe]
+          elsif opts.key?(:escape_slash)
+            !!opts[:escape_slash]
+          else
+            false
+          end
+
+          @strict                = !!opts[:strict] if opts.key?(:strict)
+
+          if !opts.key?(:max_nesting) # defaults to 100
+            @max_nesting = 100
+          elsif opts[:max_nesting]
+            @max_nesting = opts[:max_nesting]
+          else
+            @max_nesting = 0
+          end
+          self
+        end
+        alias merge configure
+
+        # Returns the configuration instance variables as a hash, that can be
+        # passed to the configure method.
+        def to_h
+          result = {}
+          instance_variables.each do |iv|
+            iv = iv.to_s[1..-1]
+            result[iv.to_sym] = self[iv]
+          end
+          result
+        end
+
+        alias to_hash to_h
+
+        # 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.
+        def generate(obj)
+          result = obj.to_json(self)
+          JSON.valid_utf8?(result) or raise GeneratorError,
+            "source sequence #{result.inspect} is illegal/malformed utf-8"
+          result
+        end
+
+        # Return the value returned by method +name+.
+        def [](name)
+          if respond_to?(name)
+            __send__(name)
+          else
+            instance_variable_get("@#{name}") if
+              instance_variables.include?("@#{name}".to_sym) # avoid warning
+          end
+        end
+
+        def []=(name, value)
+          if respond_to?(name_writer = "#{name}=")
+            __send__ name_writer, value
+          else
+            instance_variable_set "@#{name}", value
+          end
         end
       end
 
@@ -146,7 +316,13 @@ module JSON
           # Converts this object to a string (calling #to_s), converts
           # it to a JSON string, and returns the result. This is a fallback, if no
           # special method #to_json was defined for some object.
-          def to_json(*) to_s.to_json end
+          def to_json(generator_state)
+            if generator_state.strict?
+              raise GeneratorError, "#{self.class} not allowed in JSON"
+            else
+              to_s.to_json
+            end
+          end
         end
 
         module Hash
@@ -155,48 +331,43 @@ module JSON
           # _state_ is a JSON::State object, that can also be used to configure the
           # produced JSON string output further.
           # _depth_ is used to find out nesting depth, to indent accordingly.
-          def to_json(state = nil, depth = 0, *)
-            if state
-              state = JSON.state.from_state(state)
-              json_check_circular(state) { json_transform(state, depth) }
-            else
-              json_transform(state, depth)
-            end
+          def to_json(state = nil, *)
+            state = State.from_state(state)
+            state.check_max_nesting
+            json_transform(state)
           end
 
           private
 
-          def json_check_circular(state)
-            if state
-              state.seen?(self) and raise JSON::CircularDatastructure,
-                  "circular data structures not supported!"
-              state.remember self
-            end
-            yield
-          ensure
-            state and state.forget self
+          def json_shift(state)
+            state.object_nl.empty? or return ''
+            state.indent * state.depth
           end
 
-          def json_shift(state, depth)
-            state and not state.object_nl.empty? or return ''
-            state.indent * depth
-          end
-
-          def json_transform(state, depth)
-            delim = ','
-            delim << state.object_nl if state
-            result = '{'
-            result << state.object_nl if state
-            result << map { |key,value|
-              s = json_shift(state, depth + 1)
-              s << key.to_s.to_json(state, depth + 1)
-              s << state.space_before if state
-              s << ':'
-              s << state.space if state
-              s << value.to_json(state, depth + 1)
-            }.join(delim)
-            result << state.object_nl if state
-            result << json_shift(state, depth)
+          def json_transform(state)
+            delim = ",#{state.object_nl}"
+            result = "{#{state.object_nl}"
+            depth = state.depth += 1
+            first = true
+            indent = !state.object_nl.empty?
+            each { |key, value|
+              result << delim unless first
+              result << state.indent * depth if indent
+              result = "#{result}#{key.to_s.to_json(state)}#{state.space_before}:#{state.space}"
+              if state.strict?
+                raise GeneratorError, "#{value.class} not allowed in JSON"
+              elsif value.respond_to?(:to_json)
+                result << value.to_json(state)
+              else
+                result << %{"#{String(value)}"}
+              end
+              first = false
+            }
+            depth = state.depth -= 1
+            unless first
+              result << state.object_nl
+              result << state.indent * depth if indent
+            end
             result << '}'
             result
           end
@@ -207,46 +378,38 @@ module JSON
           # this Array instance.
           # _state_ is a JSON::State object, that can also be used to configure the
           # produced JSON string output further.
-          # _depth_ is used to find out nesting depth, to indent accordingly.
-          def to_json(state = nil, depth = 0, *)
-            if state
-              state = JSON.state.from_state(state)
-              json_check_circular(state) { json_transform(state, depth) }
-            else
-              json_transform(state, depth)
-            end
+          def to_json(state = nil, *)
+            state = State.from_state(state)
+            state.check_max_nesting
+            json_transform(state)
           end
 
           private
 
-          def json_check_circular(state)
-            if state
-              state.seen?(self) and raise JSON::CircularDatastructure,
-                "circular data structures not supported!"
-              state.remember self
-            end
-            yield
-          ensure
-            state and state.forget self
-          end
-
-          def json_shift(state, depth)
-            state and not state.array_nl.empty? or return ''
-            state.indent * depth
-          end
-
-          def json_transform(state, depth)
+          def json_transform(state)
             delim = ','
-            delim << state.array_nl if state
+            delim << state.array_nl
             result = '['
-            result << state.array_nl if state
-            result << map { |value|
-              json_shift(state, depth + 1) << value.to_json(state, depth + 1)
-            }.join(delim)
-            result << state.array_nl if state
-            result << json_shift(state, depth) 
+            result << state.array_nl
+            depth = state.depth += 1
+            first = true
+            indent = !state.array_nl.empty?
+            each { |value|
+              result << delim unless first
+              result << state.indent * depth if indent
+              if state.strict?
+                raise GeneratorError, "#{value.class} not allowed in JSON"
+              elsif value.respond_to?(:to_json)
+                result << value.to_json(state)
+              else
+                result << %{"#{String(value)}"}
+              end
+              first = false
+            }
+            depth = state.depth -= 1
+            result << state.array_nl
+            result << state.indent * depth if indent
             result << ']'
-            result
           end
         end
 
@@ -257,22 +420,51 @@ module JSON
 
         module Float
           # Returns a JSON string representation for this Float number.
-          def to_json(*) to_s end
+          def to_json(state = nil, *)
+            state = State.from_state(state)
+            case
+            when infinite?
+              if state.allow_nan?
+                to_s
+              else
+                raise GeneratorError, "#{self} not allowed in JSON"
+              end
+            when nan?
+              if state.allow_nan?
+                to_s
+              else
+                raise GeneratorError, "#{self} not allowed in JSON"
+              end
+            else
+              to_s
+            end
+          end
         end
 
         module String
           # This string should be encoded with UTF-8 A call to this method
           # returns a JSON string encoded with UTF16 big endian characters as
           # \u????.
-          def to_json(*)
-            '"' << JSON.utf8_to_json(self) << '"'
+          def to_json(state = nil, *args)
+            state = State.from_state(state)
+            if encoding == ::Encoding::UTF_8
+              string = self
+            else
+              string = encode(::Encoding::UTF_8)
+            end
+            if state.ascii_only?
+              '"' << JSON.utf8_to_json_ascii(string, state.script_safe) << '"'
+            else
+              '"' << JSON.utf8_to_json(string, state.script_safe) << '"'
+            end
           end
 
-          # Module that holds the extinding methods if, the String module is
+          # Module that holds the extending methods if, the String module is
           # included.
           module Extend
-            # Raw Strings are JSON Objects (the raw bytes are stored in an array for the
-            # key "raw"). The Ruby String can be created by this module method.
+            # Raw Strings are JSON Objects (the raw bytes are stored in an
+            # array for the key "raw"). The Ruby String can be created by this
+            # module method.
             def json_create(o)
               o['raw'].pack('C*')
             end