tjson 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7d2463b75101ea02b80b1b44ebc77dec455378b
-  data.tar.gz: 6c2ea2c56a7f17de9de38ba66f32b270fd1e2840
+  metadata.gz: 622fe5145c38438258607d59d9358ebe7cfe2d13
+  data.tar.gz: 7a534141296250d532964fbd7a1ccb3e67da126b
 SHA512:
-  metadata.gz: caff166f158c153e930023b91477921298bbe24bf840f4de50c63bd350c274d3216667e28125417c3f61b66108ba408f78afb14c18fefbb3d0cec70342214d71
-  data.tar.gz: ce78fb8dea9c903a3cecbd1947e8d3c83f4ad7904b62c1c72306ba25ec7232fd36f99fd98afb97d542d20a0e1cc98531b8170000c87780a7ebc0974a5afd2f52
+  metadata.gz: 2f2ceb6fe96feea0f77e25ca5318c42aa2e744365aad316942e43904a842f3ca3938ae7fc16979cf2e03e973dfe752739ba83042f36e3eaeb1033da23712574e
+  data.tar.gz: f273f7abd7c79b80b819af9433e47589bb9e773062dae6132aa81138f1024a9cc4cbcd67f4a5b39de6258ab341798e84d63658a00a1465ca6a9df5750747b0d4

data/.rubocop.yml

@@ -15,5 +15,14 @@ Style/StringLiterals:
 # Metrics
 #
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 100
+
+Metrics/MethodLength:
+  Max: 25

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 sudo: false
+before_install: gem install bundler
 
 bundler_args: --without development doc
 
@@ -8,7 +9,7 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.1
-  - jruby-9.0.5.0
+  - jruby-9.1.5.0
 
 matrix:
   fast_finish: true

data/CHANGES.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2016-10-28)
+
+* Initial release

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 
 group :development, :test do
   gem "rake"
+  gem "toml-rb"
   gem "rspec", "~> 3.5"
-  gem "rubocop"
+  gem "rubocop", "0.44.1"
 end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2016 Tony Arcieri
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,9 +1,18 @@
-# TJSON for Ruby
+# TJSON for Ruby [![Gem Version][gem-image]][gem-link] [![Build Status][build-image]][build-link] [![Code Climate][codeclimate-image]][codeclimate-link] [![MIT licensed][license-image]][license-link]
 
 A Ruby implementation of TJSON: Tagged JSON with Rich Types.
 
 https://www.tjson.org
 
+[gem-image]: https://badge.fury.io/rb/tjson.svg
+[gem-link]: https://rubygems.org/gems/tjson
+[build-image]: https://secure.travis-ci.org/tjson/tjson-ruby.svg?branch=master
+[build-link]: https://travis-ci.org/tjson/tjson-ruby
+[codeclimate-image]: https://codeclimate.com/github/tjson/tjson-ruby.svg?branch=master
+[codeclimate-link]: https://codeclimate.com/github/tjson/tjson-ruby
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
+[license-link]: https://github.com/tjson/tjson-ruby/blob/master/LICENSE.txt
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +31,52 @@ Or install it yourself as:
 
 ## Usage
 
-Coming soon!
+### Parsing
+
+To parse a TJSON document, use the `TJSON.parse` method:
+
+```ruby
+>> TJSON.parse('{"s:foo":"s:bar"}')
+=> {"foo"=>"bar"}
+```
+
+The following describes how TJSON types map onto Ruby types during parsing:
+
+ * **UTF-8 Strings**: parsed as Ruby `String` with `Encoding::UTF_8`
+ * **Binary Data**: parsed as Ruby `String` with `Encoding::ASCII_8BIT` (a.k.a. `Encoding::BINARY`)
+ * **Integers**: parsed as Ruby `Integer` (Fixnum or Bignum)
+ * **Floats** (i.e. JSON number literals): parsed as Ruby `Float`
+ * **Timestamps**: parsed as Ruby `Time`
+ * **Arrays**: parsed as `TJSON::Array` (a subclass of `::Array`)
+ * **Objects**: parsed as `TJSON::Object` (a subclass of `::Hash`)
+
+### Generating
+
+To generate TJSON from Ruby objects, use the `TJSON.generate` method:
+
+```ruby
+>> puts TJSON.generate({"foo" => "bar" })
+{"s:foo":"s:bar"}
+```
+
+The `TJSON.generate` method will call `#to_tjson` on any objects which are not
+one of Ruby's core types. You can implement this method on classes you wish to
+serialize as TJSON, although it MUST output tagged strings for encoding TJSON
+types such as UTF-8 strings or binary data.
+
+### TJSON::Binary
+
+The `TJSON::Binary` module contains a set of helper methods for serializing
+binary data in various different encodings:
+
+```ruby
+>> TJSON::Binary.base16("Hello, world!")
+=> "b16:48656c6c6f2c20776f726c6421"
+>> TJSON::Binary.base32("Hello, world!")
+=> "b32:jbswy3dpfqqho33snrscc"
+>> TJSON::Binary.base64("Hello, world!")
+=> "b64:SGVsbG8sIHdvcmxkIQ"
+```
 
 ## Contributing
 

data/lib/tjson.rb

@@ -2,6 +2,67 @@
 
 require "tjson/version"
 
+require "json"
+require "time"
+require "base32"
+require "base64"
+
+require "tjson/array"
+require "tjson/binary"
+require "tjson/generator"
+require "tjson/object"
+require "tjson/parser"
+
 # Tagged JSON with Rich Types
 module TJSON
+  # Base class of all TJSON errors
+  Error = Class.new(StandardError)
+
+  # Invalid string encoding
+  EncodingError = Class.new(Error)
+
+  # Failure to parse TJSON document
+  ParseError = Class.new(Error)
+
+  # Duplicate object name
+  DuplicateNameError = Class.new(ParseError)
+
+  # Maximum allowed nesting (TODO: use TJSON-specified maximum)
+  MAX_NESTING = 100
+
+  # Parse the given UTF-8 string as TJSON
+  #
+  # @param string [String] TJSON string to be parsed
+  # @raise [TJSON::ParseError] an error occurred parsing the given TJSON
+  # @return [Object] parsed data
+  def self.parse(string)
+    begin
+      utf8_string = string.encode(Encoding::UTF_8)
+    rescue ::EncodingError => ex
+      raise TJSON::EncodingError, ex.message, ex.backtrace
+    end
+
+    begin
+      ::JSON.parse(
+        utf8_string,
+        max_nesting:      MAX_NESTING,
+        allow_nan:        false,
+        symbolize_names:  false,
+        create_additions: false,
+        object_class:     TJSON::Object,
+        array_class:      TJSON::Array
+      )
+    rescue ::JSON::ParserError => ex
+      raise TJSON::ParseError, ex.message, ex.backtrace
+    end
+  end
+
+  # Generate TJSON from a Ruby Hash or Array
+  #
+  # @param obj [Array, Hash] Ruby Hash or Array to serialize as TJSON
+  # @return [String] serialized TJSON
+  def self.generate(obj)
+    raise TypeError, "expected Hash or Array, got #{obj.class}" unless obj.is_a?(Hash) || obj.is_a?(Array)
+    JSON.generate(TJSON::Generator.generate(obj))
+  end
 end

data/lib/tjson/array.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TJSON
+  # TJSON array type
+  class Array < ::Array
+    def <<(obj)
+      super(TJSON::Parser.value(obj))
+    end
+  end
+end

data/lib/tjson/binary.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TJSON
+  # Binary serialization helpers
+  module Binary
+    module_function
+
+    def base16(string)
+      "b16:#{string.unpack('H*').first}"
+    end
+
+    def base32(string)
+      "b32:#{Base32.encode(string).downcase.delete('=')}"
+    end
+
+    def base64(string)
+      "b64:#{Base64.urlsafe_encode64(string).delete('=')}"
+    end
+  end
+end

data/lib/tjson/generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module TJSON
+  # Generates TJSON from Ruby objects
+  module Generator
+    module_function
+
+    def generate(obj)
+      case obj
+      when Hash           then generate_hash(obj)
+      when ::Array        then generate_array(obj)
+      when String, Symbol then generate_string(obj.to_s)
+      when Integer        then generate_integer(obj)
+      when Float          then obj
+      when Time, DateTime then generate_timestamp(obj.to_time)
+      else                     obj.to_tjson
+      end
+    end
+
+    def generate_hash(hash)
+      members = hash.map do |k, v|
+        raise TypeError, "expected String for key, got #{k.class}" unless k.is_a?(String)
+        [generate(k), generate(v)]
+      end
+
+      Hash[members]
+    end
+
+    def generate_array(array)
+      array.map { |o| generate(o) }
+    end
+
+    def generate_string(string)
+      if string.encoding == Encoding::BINARY
+        TJSON::Binary.base64(string)
+      else
+        "s:#{string.encode(Encoding::UTF_8)}"
+      end
+    end
+
+    def generate_integer(int)
+      "i:#{int}"
+    end
+
+    def generate_timestamp(time)
+      "t:#{time.utc.iso8601}"
+    end
+  end
+end

data/lib/tjson/object.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TJSON
+  # TJSON object type (i.e. hash/dict-alike)
+  class Object < ::Hash
+    def []=(name, value)
+      unless name.start_with?("s:", "b16:", "b64:")
+        raise TJSON::ParseError, "invalid tag on object name: #{name[/\A(.*?):/, 1]}" if name.include?(":")
+        raise TJSON::ParseError, "no tag found on object name: #{name.inspect}"
+      end
+
+      name = TJSON::Parser.value(name)
+      raise TJSON::DuplicateNameError, "duplicate member name: #{name.inspect}" if key?(name)
+
+      super(name, TJSON::Parser.value(value))
+    end
+  end
+end

data/lib/tjson/parser.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module TJSON
+  # Postprocessing for extracting TJSON tags from JSON
+  module Parser
+    module_function
+
+    TAG_DELIMITER  = ":"
+    MAX_TAG_LENGTH = 3 # Sans ':'
+
+    def value(obj)
+      case obj
+      when String then parse(obj)
+      when Integer then obj.to_f
+      when TJSON::Object, TJSON::Array, Float then obj
+      else raise TypeError, "invalid TJSON value: #{obj.inspect}"
+      end
+    end
+
+    def parse(str)
+      raise TypeError, "expected String, got #{str.class}" unless str.is_a?(::String)
+      raise TJSON::EncodingError, "expected UTF-8, got #{str.encoding.inspect}" unless str.encoding == Encoding::UTF_8
+
+      dpos = str.index(TAG_DELIMITER)
+
+      raise TJSON::ParseError, "invalid tag (missing ':' delimiter)" unless dpos
+      raise TJSON::ParseError, "overlength tag (maximum #{MAX_TAG_LENGTH})" if dpos > MAX_TAG_LENGTH
+
+      tag = str.slice!(0, dpos + 1)
+
+      case tag
+      when "s:" then str
+      when "i:" then parse_signed_int(str)
+      when "u:" then parse_unsigned_int(str)
+      when "t:" then parse_timestamp(str)
+      when "b16:" then parse_base16(str)
+      when "b32:" then parse_base32(str)
+      when "b64:" then parse_base64url(str)
+      else raise TJSON::ParseError, "invalid tag #{tag.inspect} on string #{str.inspect}"
+      end
+    end
+
+    def parse_base16(str)
+      raise TypeError, "expected String, got #{str.class}" unless str.is_a?(::String)
+      raise TJSON::ParseError, "base16 must be lower case: #{str.inspect}" if str =~ /[A-F]/
+      raise TJSON::ParseError, "invalid base16: #{str.inspect}" unless str =~ /\A[a-f0-9]*\z/
+
+      [str].pack("H*")
+    end
+
+    def parse_base32(str)
+      raise TypeError, "expected String, got #{str.class}" unless str.is_a?(::String)
+      raise TJSON::ParseError, "base32 must be lower case: #{str.inspect}" if str =~ /[A-F]/
+      raise TJSON::ParseError, "padding disallowed: #{str.inspect}" if str.include?("=")
+      raise TJSON::ParseError, "invalid base32: #{str.inspect}" unless str =~ /\A[a-z2-7]*\z/
+
+      Base32.decode(str.upcase).force_encoding(Encoding::BINARY)
+    end
+
+    def parse_base64url(str)
+      raise TypeError, "expected String, got #{str.class}" unless str.is_a?(::String)
+      raise TJSON::ParseError, "base64url only: #{str.inspect}" if str =~ %r{\+|\/}
+      raise TJSON::ParseError, "padding disallowed: #{str.inspect}" if str.include?("=")
+      raise TJSON::ParseError, "invalid base64url: #{str.inspect}" unless str =~ /\A[A-Za-z0-9\-_]*\z/
+
+      # Add padding, as older Rubies (< 2.3) require it
+      str = str.ljust((str.length + 3) & ~3, "=") if (str.length % 4).nonzero?
+
+      Base64.urlsafe_decode64(str)
+    end
+
+    def parse_signed_int(str)
+      raise TJSON::ParseError, "invalid integer: #{str.inspect}" unless str =~ /\A\-?(0|[1-9][0-9]*)\z/
+
+      result = Integer(str, 10)
+      raise TJSON::ParseError, "oversized integer: #{result}"  if result > 9_223_372_036_854_775_807
+      raise TJSON::ParseError, "undersized integer: #{result}" if result < -9_223_372_036_854_775_808
+
+      result
+    end
+
+    def parse_unsigned_int(str)
+      raise TJSON::ParseError, "invalid integer: #{str.inspect}" unless str =~ /\A(0|[1-9][0-9]*)\z/
+
+      result = Integer(str, 10)
+      raise TJSON::ParseError, "oversized integer: #{result}" if result > 18_446_744_073_709_551_615
+
+      result
+    end
+
+    def parse_timestamp(str)
+      raise TJSON::ParseError, "invalid timestamp: #{str.inspect}" unless str =~ /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z\z/
+
+      Time.iso8601(str)
+    end
+  end
+end

data/lib/tjson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TJSON
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/tjson.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.version     = TJSON::VERSION
   spec.authors     = ["Tony Arcieri"]
   spec.email       = ["bascule@gmail.com"]
+  spec.licenses    = ["MIT"]
   spec.homepage    = "https://github.com/tjson/tjson-ruby"
   spec.summary     = "Tagged JSON with Rich Types"
   spec.description = "A JSON-compatible serialization format with rich type annotations"
@@ -20,5 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0"
 
+  spec.add_runtime_dependency "base32", ">= 0.3"
+
   spec.add_development_dependency "bundler", "~> 1.13"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tjson
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -36,14 +50,22 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/tjson.rb
+- lib/tjson/array.rb
+- lib/tjson/binary.rb
+- lib/tjson/generator.rb
+- lib/tjson/object.rb
+- lib/tjson/parser.rb
 - lib/tjson/version.rb
 - tjson.gemspec
 homepage: https://github.com/tjson/tjson-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []