fiveruns-dash-ruby 0.8.3 → 0.8.4

data/lib/fiveruns/json/generator.rb

@@ -0,0 +1,394 @@
+module Fiveruns::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 FiverunsJSON string, encoded with
+  # UTF16 big endian characters as \u????, and return it.
+  def utf8_to_json(string) # :nodoc:
+    string = string.gsub(/["\\\/\x0-\x1f]/) { MAP[$&] }
+    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 = ::Fiveruns::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 FiverunsJSON 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 FiverunsJSON object (default: ''), 
+        # * *array_nl*: a string that is put at the end of a FiverunsJSON 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.
+        def initialize(opts = {})
+          @seen = {}
+          @indent         = ''
+          @space          = ''
+          @space_before   = ''
+          @object_nl      = ''
+          @array_nl       = ''
+          @check_circular = true
+          @allow_nan      = false
+          configure opts
+        end
+
+        # This string is used to indent levels in the FiverunsJSON text.
+        attr_accessor :indent
+
+        # This string is used to insert a space between the tokens in a FiverunsJSON
+        # string.
+        attr_accessor :space
+
+        # This string is used to insert a space before the ':' in FiverunsJSON objects.
+        attr_accessor :space_before
+
+        # This string is put at the end of a line that holds a FiverunsJSON object (or
+        # Hash).
+        attr_accessor :object_nl
+
+        # This string is put at the end of a line that holds a FiverunsJSON array.
+        attr_accessor :array_nl
+
+        # This integer returns the maximum level of data structure nesting in
+        # the generated FiverunsJSON, max_nesting = 0 if no maximum is checked.
+        attr_accessor :max_nesting
+
+        def check_max_nesting(depth) # :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 should be checked,
+        # otherwise returns false.
+        def check_circular?
+          @check_circular
+        end
+
+        # Returns true if NaN, Infinity, and -Infinity should be considered as
+        # valid FiverunsJSON and output.
+        def allow_nan?
+          @allow_nan
+        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
+
+        # Configure this State instance with the Hash _opts_, and return
+        # itself.
+        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
+
+        # Returns the configuration instance variables as a hash, that can be
+        # passed to the configure method.
+        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
+      end
+
+      module GeneratorMethods
+        module Object
+          # Converts this object to a string (calling #to_s), converts
+          # it to a FiverunsJSON string, and returns the result. This is a fallback, if no
+          # special method #to_json was defined for some object.
+          def to_fjson(*) to_s.to_fjson end
+        end
+
+        module Hash
+          # Returns a FiverunsJSON string containing a FiverunsJSON object, that is unparsed from
+          # this Hash instance.
+          # _state_ is a FiverunsJSON::State object, that can also be used to configure the
+          # produced FiverunsJSON string output further.
+          # _depth_ is used to find out nesting depth, to indent accordingly.
+          def to_fjson(state = nil, depth = 0, *)
+            if state
+              state = ::Fiveruns::JSON.state.from_state(state)
+              state.check_max_nesting(depth)
+              fjson_check_circular(state) { fjson_transform(state, depth) }
+            else
+              fjson_transform(state, depth)
+            end
+          end
+
+          private
+
+          def fjson_check_circular(state)
+            if state and state.check_circular?
+              state.seen?(self) and raise ::Fiveruns::JSON::CircularDatastructure,
+                  "circular data structures not supported!"
+              state.remember self
+            end
+            yield
+          ensure
+            state and state.forget self
+          end
+
+          def fjson_shift(state, depth)
+            state and not state.object_nl.empty? or return ''
+            state.indent * depth
+          end
+
+          def fjson_transform(state, depth)
+            delim = ','
+            delim << state.object_nl if state
+            result = '{'
+            result << state.object_nl if state
+            result << map { |key,value|
+              s = fjson_shift(state, depth + 1)
+              s << key.to_s.to_fjson(state, depth + 1)
+              s << state.space_before if state
+              s << ':'
+              s << state.space if state
+              s << value.to_fjson(state, depth + 1)
+            }.join(delim)
+            result << state.object_nl if state
+            result << fjson_shift(state, depth)
+            result << '}'
+            result
+          end
+        end
+
+        module Array
+          # Returns a FiverunsJSON string containing a FiverunsJSON array, that is unparsed from
+          # this Array instance.
+          # _state_ is a FiverunsJSON::State object, that can also be used to configure the
+          # produced FiverunsJSON string output further.
+          # _depth_ is used to find out nesting depth, to indent accordingly.
+          def to_fjson(state = nil, depth = 0, *)
+            if state
+              state = ::Fiveruns::JSON.state.from_state(state)
+              state.check_max_nesting(depth)
+              fjson_check_circular(state) { fjson_transform(state, depth) }
+            else
+              fjson_transform(state, depth)
+            end
+          end
+
+          private
+
+          def fjson_check_circular(state)
+            if state and state.check_circular?
+              state.seen?(self) and raise ::Fiveruns::JSON::CircularDatastructure,
+                "circular data structures not supported!"
+              state.remember self
+            end
+            yield
+          ensure
+            state and state.forget self
+          end
+
+          def fjson_shift(state, depth)
+            state and not state.array_nl.empty? or return ''
+            state.indent * depth
+          end
+
+          def fjson_transform(state, depth)
+            delim = ','
+            delim << state.array_nl if state
+            result = '['
+            result << state.array_nl if state
+            result << map { |value|
+              fjson_shift(state, depth + 1) << value.to_fjson(state, depth + 1)
+            }.join(delim)
+            result << state.array_nl if state
+            result << fjson_shift(state, depth) 
+            result << ']'
+            result
+          end
+        end
+
+        module Integer
+          # Returns a FiverunsJSON string representation for this Integer number.
+          def to_fjson(*) to_s end
+        end
+
+        module Float
+          # Returns a FiverunsJSON string representation for this Float number.
+          def to_fjson(state = nil, *)
+            case
+            when infinite?
+              if !state || state.allow_nan?
+                to_s
+              else
+                raise GeneratorError, "#{self} not allowed in FiverunsJSON"
+              end
+            when nan?
+              if !state || state.allow_nan?
+                to_s
+              else
+                raise GeneratorError, "#{self} not allowed in FiverunsJSON"
+              end
+            else
+              to_s
+            end
+          end
+        end
+
+        module String
+          # This string should be encoded with UTF-8 A call to this method
+          # returns a FiverunsJSON string encoded with UTF16 big endian characters as
+          # \u????.
+          def to_fjson(*)
+            '"' << ::Fiveruns::JSON.utf8_to_json(self) << '"'
+          end
+
+          # Module that holds the extinding methods if, the String module is
+          # included.
+          module Extend
+            # Raw Strings are FiverunsJSON Objects (the raw bytes are stored in an array for the
+            # key "raw"). The Ruby String can be created by this module method.
+            def fjson_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 FiverunsJSON
+          # instead of UTF-8 strings, e. g. binary data.
+          def to_fjson_raw_object
+            {
+              ::Fiveruns::JSON.create_id  => self.class.name,
+              'raw'           => self.unpack('C*'),
+            }
+          end
+
+          # This method creates a FiverunsJSON text from the result of
+          # a call to to_json_raw_object of this String.
+          def to_fjson_raw(*args)
+            to_fjson_raw_object.to_fjson(*args)
+          end
+        end
+
+        module TrueClass
+          # Returns a FiverunsJSON string for true: 'true'.
+          def to_fjson(*) 'true' end
+        end
+
+        module FalseClass
+          # Returns a FiverunsJSON string for false: 'false'.
+          def to_fjson(*) 'false' end
+        end
+
+        module NilClass
+          # Returns a FiverunsJSON string for nil: 'null'.
+          def to_fjson(*) 'null' end
+        end
+      end
+    end
+  end
+end

data/lib/fiveruns/json/pure.rb

@@ -0,0 +1,71 @@
+
+module Fiveruns::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)
+            ::Fiveruns::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 = ::Fiveruns::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 FiverunsJSON's
+  # functionality in pure ruby.
+  module Pure
+    $DEBUG and warn "Using pure library for Fiveruns::JSON."
+    ::Fiveruns::JSON.generator = Generator
+  end
+end