json 0.4.3 → 1.0.0

data/lib/json/common.rb

@@ -0,0 +1,184 @@
+require 'json/version'
+
+module JSON
+  class << self
+    # If object is string like parse the string and return the parsed result as a
+    # Ruby data structure. Otherwise generate a JSON text from the Ruby data
+    # structure object and return it.
+    def [](object)
+      if object.respond_to? :to_str
+        JSON.parse(object.to_str)
+      else
+        JSON.generate(object)
+      end
+    end
+
+    # Returns the JSON parser class, that is used by JSON. This might be either
+    # JSON::Ext::Parser or JSON::Pure::Parser.
+    attr_reader :parser
+
+    # Set the JSON parser class _parser_ to be used by JSON.
+    def parser=(parser) # :nodoc:
+      @parser = parser
+      remove_const :Parser if const_defined? :Parser
+      const_set :Parser, parser
+    end
+
+    # Return the constant located at _path_. The format of _path_ has to be
+    # either ::A::B::C or A::B::C. In any case A has to be located at the top
+    # level (absolute namespace path?). If there doesn't exist a constant at
+    # the given path, an ArgumentError is raised.
+    def deep_const_get(path) # :nodoc:
+      path.split(/::/).inject(Object) do |p, c|
+        case
+        when c.empty?             then p
+        when p.const_defined?(c)  then p.const_get(c)
+        else                      raise ArgumentError, "can't find #{path}"
+        end
+      end
+    end
+
+    # Set the module _generator_ to be used by JSON.
+    def generator=(generator) # :nodoc:
+      @generator = generator
+      generator_methods = generator::GeneratorMethods
+      for const in generator_methods.constants
+        klass = deep_const_get(const)
+        modul = generator_methods.const_get(const)
+        klass.class_eval do
+          instance_methods(false).each do |m|
+            m.to_s == 'to_json' and remove_method m
+          end
+          include modul
+        end
+      end
+      self.state = generator::State
+      const_set :State, self.state
+    end
+
+    # Returns the JSON generator modul, that is used by JSON. This might be
+    # either JSON::Ext::Generator or JSON::Pure::Generator.
+    attr_reader :generator
+
+    # Returns the JSON generator state class, that is used by JSON. This might
+    # be either JSON::Ext::Generator::State or JSON::Pure::Generator::State.
+    attr_accessor :state
+
+    # This is create identifier, that is used to decide, if the _json_create_
+    # hook of a class should be called. It defaults to 'json_class'.
+    attr_accessor :create_id
+  end
+  self.create_id = 'json_class'
+
+  # The base exception for JSON errors.
+  class JSONError < StandardError; end
+
+  # This exception is raised, if a parser error occurs.
+  class ParserError < JSONError; end
+
+  # This exception is raised, if a generator or unparser error occurs.
+  class GeneratorError < JSONError; end
+  # For backwards compatibility
+  UnparserError = GeneratorError
+
+  # If a circular data structure is encountered while unparsing
+  # this exception is raised.
+  class CircularDatastructure < GeneratorError; end
+
+  # This exception is raised, if the required unicode support is missing on the
+  # system. Usually this means, that the iconv library is not installed.
+  class MissingUnicodeSupport < JSONError; end
+
+  module_function
+
+  # Parse the JSON string _source_ into a Ruby data structure and return it.
+  def parse(source)
+    JSON.parser.new(source).parse
+  end
+
+  # Unparse the Ruby data structure _obj_ into a single line JSON string and
+  # return it. _state_ is a JSON::State object, that can be used to configure
+  # the output further.
+  #
+  # It defaults to a state object, that creates the shortest possible JSON text
+  # in one line and only checks for circular data structures. If you are sure,
+  # that the objects don't contain any circles, you can set _state_ to nil, to
+  # disable these checks in order to create the JSON text faster. See also
+  # fast_generate.
+  def generate(obj, state = JSON.state.new)
+    obj.to_json(state)
+  end
+
+  alias unparse generate
+  module_function :unparse
+
+  # Unparse the Ruby data structure _obj_ into a single line JSON string and
+  # return it. This method disables the checks for circles in Ruby objects.
+  #
+  # *WARNING*: Be careful not to pass any Ruby data structures with circles as
+  # _obj_ argument, because this will cause JSON to go into an infinite loop.
+  def fast_generate(obj)
+    obj.to_json(nil)
+  end
+
+  alias fast_unparse fast_generate
+  module_function :fast_unparse
+
+  # Unparse the Ruby data structure _obj_ into a JSON string and return it. The
+  # returned string is a prettier form of the string returned by #unparse.
+  def pretty_generate(obj)
+    state = JSON.state.new(
+      :indent     => '  ',
+      :space      => ' ',
+      :object_nl  => "\n",
+      :array_nl   => "\n",
+      :check_circular => true
+    )
+    obj.to_json(state)
+  end
+
+  alias pretty_unparse pretty_generate
+  module_function :pretty_unparse
+end
+
+module ::Kernel
+  # Outputs _objs_ to STDOUT as JSON strings in the shortest form, that is in
+  # one line.
+  def j(*objs)
+    objs.each do |obj|
+      puts JSON::generate(obj)
+    end
+    nil
+  end
+
+  # Ouputs _objs_ to STDOUT as JSON strings in a pretty format, with
+  # indentation and over many lines.
+  def jj(*objs)
+    objs.each do |obj|
+      puts JSON::pretty_generate(obj)
+    end
+    nil
+  end
+
+  # If object is string like parse the string and return the parsed result as a
+  # Ruby data structure. Otherwise generate a JSON text from the Ruby data
+  # structure object and return it.
+  def JSON(object)
+    if object.respond_to? :to_str
+      JSON.parse(object.to_str)
+    else
+      JSON.generate(object)
+    end
+  end
+end
+
+class ::Class
+  # Returns true, if this class can be used to create an instance
+  # from a serialised JSON string. The class has to implement a class
+  # method _json_create_ that expects a hash as first parameter, which includes
+  # the required data.
+  def json_creatable?
+    respond_to?(:json_create)
+  end
+end
+  # vim: set et sw=2 ts=2:

data/lib/json/editor.rb

@@ -42,6 +42,11 @@ module JSON
         MessageDialog::ERROR, 
         MessageDialog::BUTTONS_CLOSE, text)
       dialog.run
+    rescue TypeError
+      dialog = MessageDialog.new(Editor.window, Dialog::MODAL, 
+        MessageDialog::ERROR, 
+        MessageDialog::BUTTONS_CLOSE, text)
+      dialog.run
     ensure
       dialog.destroy if dialog
     end
@@ -1182,16 +1187,20 @@ module JSON
       end
     end
 
-    # Starts a JSON Editor. If a block was given, it yields
-    # to the JSON::Editor::MainWindow instance.
-    def Editor.start(encoding = nil) # :yield: window
-      encoding ||= 'utf8'
-      Gtk.init
-      window = Editor::MainWindow.new(encoding)
-      window.icon_list = [ Editor.fetch_icon('json') ]
-      yield window if block_given?
-      window.show_all
-      Gtk.main
+    class << self
+      # Starts a JSON Editor. If a block was given, it yields
+      # to the JSON::Editor::MainWindow instance.
+      def start(encoding = nil) # :yield: window
+        encoding ||= 'utf8'
+        Gtk.init
+        @window = Editor::MainWindow.new(encoding)
+        @window.icon_list = [ Editor.fetch_icon('json') ]
+        yield @window if block_given?
+        @window.show_all
+        Gtk.main
+      end
+
+      attr_reader :window
     end
   end
 end

data/lib/json/ext.rb

@@ -0,0 +1,13 @@
+require 'json/common'
+
+module JSON
+  # This module holds all the modules/classes that implement JSON's
+  # functionality as C extensions.
+  module Ext
+    require 'json/ext/parser'
+    require 'json/ext/generator'
+    $DEBUG and warn "Using c extension for JSON."
+    JSON.parser = Parser
+    JSON.generator = Generator
+  end
+end

data/lib/json/pure.rb

@@ -0,0 +1,75 @@
+require 'json/common'
+require 'json/pure/parser'
+require 'json/pure/generator'
+
+module JSON
+  begin
+    require 'iconv'
+    # An iconv instance to convert from UTF8 to UTF16 Big Endian.
+    UTF16toUTF8 = Iconv.new('utf-8', 'utf-16be') # :nodoc:
+    # An iconv instance to convert from UTF16 Big Endian to UTF8.
+    UTF8toUTF16 = Iconv.new('utf-16be', 'utf-8') # :nodoc:
+    UTF8toUTF16.iconv('no bom')
+  rescue Errno::EINVAL, Iconv::InvalidEncoding
+    # Iconv doesn't support big endian utf-16. Let's try to hack this manually
+    # into the converters.
+    begin
+      old_verbose, $VERBSOSE = $VERBOSE, nil
+      # An iconv instance to convert from UTF8 to UTF16 Big Endian.
+      UTF16toUTF8 = Iconv.new('utf-8', 'utf-16') # :nodoc:
+      # An iconv instance to convert from UTF16 Big Endian to UTF8.
+      UTF8toUTF16 = Iconv.new('utf-16', 'utf-8') # :nodoc:
+      UTF8toUTF16.iconv('no bom')
+      if UTF8toUTF16.iconv("\xe2\x82\xac") == "\xac\x20"
+        swapper = Class.new do
+          def initialize(iconv) # :nodoc:
+            @iconv = iconv
+          end
+
+          def iconv(string) # :nodoc:
+            result = @iconv.iconv(string)
+            JSON.swap!(result)
+          end
+        end
+        UTF8toUTF16 = swapper.new(UTF8toUTF16) # :nodoc:
+      end
+      if UTF16toUTF8.iconv("\xac\x20") == "\xe2\x82\xac"
+        swapper = Class.new do
+          def initialize(iconv) # :nodoc:
+            @iconv = iconv
+          end
+
+          def iconv(string) # :nodoc:
+            string = JSON.swap!(string.dup)
+            @iconv.iconv(string)
+          end
+        end
+        UTF16toUTF8 = swapper.new(UTF16toUTF8) # :nodoc:
+      end
+    rescue Errno::EINVAL, Iconv::InvalidEncoding
+      raise MissingUnicodeSupport, "iconv doesn't seem to support UTF-8/UTF-16 conversions"
+    ensure
+      $VERBOSE = old_verbose
+    end
+  rescue LoadError
+    raise MissingUnicodeSupport,
+      "iconv couldn't be loaded, which is required for UTF-8/UTF-16 conversions"
+  end
+
+  # Swap consecutive bytes of _string_ in place.
+  def self.swap!(string) # :nodoc:
+    0.upto(string.size / 2) do |i|
+      break unless string[2 * i + 1]
+      string[2 * i], string[2 * i + 1] = string[2 * i + 1], string[2 * i]
+    end
+    string
+  end
+
+  # This module holds all the modules/classes that implement JSON's
+  # functionality in pure ruby.
+  module Pure
+    $DEBUG and warn "Using pure library for JSON."
+    JSON.parser = Parser
+    JSON.generator = Generator
+  end
+end

data/lib/json/pure/generator.rb

@@ -0,0 +1,321 @@
+module JSON
+  MAP = {
+    "\x0" => '\u0000',
+    "\x1" => '\u0001',
+    "\x2" => '\u0002',
+    "\x3" => '\u0003',
+    "\x4" => '\u0004',
+    "\x5" => '\u0005',
+    "\x6" => '\u0006',
+    "\x7" => '\u0007',
+    "\b"  =>  '\b',
+    "\t"  =>  '\t',
+    "\n"  =>  '\n',
+    "\xb" => '\u000b',
+    "\f"  =>  '\f',
+    "\r"  =>  '\r',
+    "\xe" => '\u000e',
+    "\xf" => '\u000f',
+    "\x10" => '\u0010',
+    "\x11" => '\u0011',
+    "\x12" => '\u0012',
+    "\x13" => '\u0013',
+    "\x14" => '\u0014',
+    "\x15" => '\u0015',
+    "\x16" => '\u0016',
+    "\x17" => '\u0017',
+    "\x18" => '\u0018',
+    "\x19" => '\u0019',
+    "\x1a" => '\u001a',
+    "\x1b" => '\u001b',
+    "\x1c" => '\u001c',
+    "\x1d" => '\u001d',
+    "\x1e" => '\u001e',
+    "\x1f" => '\u001f',
+    '"'   =>  '\"',
+    '\\'  =>  '\\\\',
+    '/'   =>  '\/',
+  } # :nodoc:
+
+  # 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] }
+    string.gsub!(/(
+                    (?:
+                      [\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.gsub!(/.{4}/n, '\\\\u\&')
+    }
+    string
+  rescue Iconv::Failure => e
+    raise GeneratorError, "Caught #{e.class}: #{e}"
+  end
+  module_function :utf8_to_json
+
+  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.
+      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
+            opts
+          when Hash
+            new(opts)
+          else
+            new
+          end
+        end
+
+        # 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, false (the default) otherwise.
+        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           = {}
+        end
+
+        # This string is used to indent levels in the JSON text.
+        attr_accessor :indent
+
+        # This string is used to insert a space between the tokens in a JSON
+        # string.
+        attr_accessor :space
+
+        # This string is used to insert a space before the ':' in JSON objects.
+        attr_accessor :space_before
+
+        # This string is put at the end of a line that holds a JSON object (or
+        # Hash).
+        attr_accessor :object_nl
+
+        # 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,
+        # otherwise returns false.
+        def check_circular?
+          @check_circular
+        end
+
+        # Returns _true_, if _object_ was already seen during this generating
+        # run. 
+        def seen?(object)
+          @seen.key?(object.__id__)
+        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
+        end
+
+        # Forget _object_ for this generating run.
+        def forget(object)
+          @seen.delete object.__id__
+        end
+      end
+
+      module GeneratorMethods
+        module Object
+          # 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
+        end
+
+        module Hash
+          # Returns a JSON string containing a JSON object, that is unparsed from
+          # this Hash 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
+          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.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)
+            result << '}'
+            result
+          end
+        end
+
+        module Array
+          # Returns a JSON string containing a JSON array, that is unparsed from
+          # 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
+          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)
+            delim = ','
+            delim << state.array_nl if state
+            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 << ']'
+            result
+          end
+        end
+
+        module Integer
+          # Returns a JSON string representation for this Integer number.
+          def to_json(*) to_s end
+        end
+
+        module Float
+          # Returns a JSON string representation for this Float number.
+          def to_json(*) to_s 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) << '"'
+          end
+
+          # Module that holds the extinding 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.
+            def json_create(o)
+              o['raw'].pack('C*')
+            end
+          end
+
+          # Extends _modul_ with the String::Extend module.
+          def self.included(modul)
+            modul.extend Extend
+          end
+
+          # This method creates a raw object hash, that can be nested into
+          # other data structures and will be unparsed as a raw string. This
+          # method should be used, if you want to convert raw strings to JSON
+          # instead of UTF-8 strings, e. g. binary data.
+          def to_json_raw_object
+            {
+              JSON.create_id  => self.class.name,
+              'raw'           => self.unpack('C*'),
+            }
+          end
+
+          # This method creates a JSON text from the result of
+          # a call to to_json_raw_object of this String.
+          def to_json_raw(*args)
+            to_json_raw_object.to_json(*args)
+          end
+        end
+
+        module TrueClass
+          # Returns a JSON string for true: 'true'.
+          def to_json(*) 'true' end
+        end
+
+        module FalseClass
+          # Returns a JSON string for false: 'false'.
+          def to_json(*) 'false' end
+        end
+
+        module NilClass
+          # Returns a JSON string for nil: 'null'.
+          def to_json(*) 'null' end
+        end
+      end
+    end
+  end
+end