transit-ruby 0.8.467

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# Copyright 2014 Cognitect. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+unless File.exist?('../transit-format/examples/0.8/simple')
+  puts <<-MSG
+Before you can run the rspec examples, you need to install the
+the https://github.com/cognitect/transit-format repo in a sibling
+directory, e.g.
+
+    cd ..
+    git clone https://github.com/cognitect/transit-format
+
+That repo contains exemplars used by transit-ruby's rspec examples
+(in ../transit-format/examples/0.8/simple), so then you can:
+
+    cd transit-ruby
+    rspec
+
+MSG
+  exit
+end
+
+require 'json'
+require 'rspec'
+require 'wrong/adapters/rspec'
+require 'transit'
+require 'spec_helper-local' if File.exist?(File.expand_path('../spec_helper-local.rb', __FILE__))
+
+RSpec.configure do |c|
+  c.alias_example_to :fit, :focus => true
+  c.filter_run_including :focus => true, :focused => true
+  c.run_all_when_everything_filtered = true
+  c.mock_with :nothing
+end
+
+ALPHA_NUM = 'abcdefghijklmnopqrstuvwxyzABCDESFHIJKLMNOPQRSTUVWXYZ_0123456789'
+
+def random_alphanum
+  ALPHA_NUM[rand(ALPHA_NUM.size)]
+end
+
+def random_string(max_length=10)
+  l = rand(max_length) + 1
+  (Array.new(l).map {|x| random_alphanum}).join
+end
+
+def random_strings(max_length=10, n=100)
+  Array.new(n).map {random_string(max_length)}
+end
+
+def random_symbol(max_length=10)
+  random_string(max_length).to_sym
+end
+
+def ints_centered_on(m, n=5)
+  ((m-n)..(m+n)).to_a
+end
+
+def array_of_symbols(m, n=m)
+  seeds = (0...m).map {|i| ("key%04d" % i).to_sym}
+  seeds.cycle.take(n)
+end
+
+def hash_of_size(n)
+  Hash[array_of_symbols(n).zip((0..n).to_a)]
+end
+
+Person = Struct.new("Person", :first_name, :last_name, :birthdate)
+
+class PersonHandler
+  def tag(_) "person"; end
+  def rep(p) {:first_name => p.first_name, :last_name => p.last_name, :birthdate => p.birthdate} end
+  def string_rep(p) nil end
+end

data/spec/transit/date_time_util_spec.rb

@@ -0,0 +1,65 @@
+# Copyright 2014 Cognitect. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+
+module Transit
+  describe DateTimeUtil do
+    describe "[to|from]_millis" do
+      it "round trips properly" do
+        100.times do
+          n = DateTime.now
+          a = Transit::DateTimeUtil.to_millis(n)
+          b = Transit::DateTimeUtil.from_millis(a)
+          c = Transit::DateTimeUtil.to_millis(b)
+          d = Transit::DateTimeUtil.from_millis(c)
+          assert { a == c }
+          assert { b == d }
+          sleep(0.0001)
+        end
+      end
+    end
+
+    describe "to_millis" do
+      let(:time) { Time.at(1388631845) + 0.678 }
+
+      it "supports DateTime" do
+        assert { Transit::DateTimeUtil.to_millis(time.to_datetime) == 1388631845678 }
+      end
+
+      it "supports Time" do
+        assert { Transit::DateTimeUtil.to_millis(time) == 1388631845678 }
+      end
+
+      it "supports Date" do
+        assert { Transit::DateTimeUtil.to_millis(Date.new(2014,1,2)) == 1388620800000 }
+      end
+    end
+
+    describe "from_millis" do
+      it "converts to utc" do
+        t = DateTime.now
+        m = Transit::DateTimeUtil.to_millis(t)
+        f = Transit::DateTimeUtil.from_millis(m)
+        assert { f.zone == '+00:00' }
+      end
+
+      it "handles millis properly" do
+        assert { Transit::DateTimeUtil.from_millis(1388631845674) == DateTime.new(2014,1,2,3,4,5.674).new_offset(0) }
+        assert { Transit::DateTimeUtil.from_millis(1388631845675) == DateTime.new(2014,1,2,3,4,5.675).new_offset(0) }
+        assert { Transit::DateTimeUtil.from_millis(1388631845676) == DateTime.new(2014,1,2,3,4,5.676).new_offset(0) }
+      end
+    end
+  end
+end

data/spec/transit/decoder_spec.rb

@@ -0,0 +1,60 @@
+# Copyright 2014 Cognitect. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+
+module Transit
+  describe Decoder do
+    def decode(o)
+      Decoder.new.decode(o)
+    end
+
+    describe "caching" do
+      it "decodes cacheable map keys" do
+        assert { decode([{"this" => "a"},{"^0" => "b"}]) == [{"this" => "a"},{"this" => "b"}] }
+      end
+
+      it "does not cache non-map-keys" do
+        assert { decode([{"a" => "~^!"},{"b" => "~^?"}]) == [{"a" => "^!"},{"b" => "^?"}] }
+      end
+    end
+
+    describe "formats" do
+      describe "JSON_M" do
+        it "converts an array starting with '^ ' to a map" do
+          assert { decode(["^ ", :a, :b, :c, :d]) == {:a => :b, :c => :d} }
+        end
+      end
+    end
+
+    describe "unrecognized input" do
+      it "decodes an unrecognized string to a TaggedValue" do
+        assert { decode("~Unrecognized") == TaggedValue.new("U", "nrecognized") }
+      end
+    end
+
+    describe "ints" do
+      it "decodes n as an Integer" do
+        1.upto(64).each do |pow|
+          assert { decode("~n#{2**pow}").kind_of? Integer }
+        end
+      end
+      it "decodes i as an Integer" do
+        1.upto(63).each do |pow|
+          assert { decode("~i#{2**pow - 1}").kind_of? Integer }
+        end
+      end
+    end
+  end
+end

data/spec/transit/exemplar_spec.rb

@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 Cognitect. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+# Assumes that the examples are in the simple_examples dir at the top.
+
+TOP_DIR=File.dirname(File.dirname(File.dirname(__FILE__)))
+
+ARRAY_SIMPLE = [1, 2, 3]
+ARRAY_MIXED = [0, 1, 2.0, true, false, 'five', :six, Transit::Symbol.new(:seven), '~eight', nil]
+ARRAY_NESTED = [ARRAY_SIMPLE, ARRAY_MIXED]
+SMALL_STRINGS = ["","a","ab","abc","abcd","abcde","abcdef"]
+POWERS_OF_TWO = (0..65).map {|x| 2**x}
+INTERESTING_INTS = (POWERS_OF_TWO.map {|x| ints_centered_on(x, 2)}).flatten
+
+UUIDS = [
+  Transit::UUID.new('5a2cbea3-e8c6-428b-b525-21239370dd55'),
+  Transit::UUID.new('d1dc64fa-da79-444b-9fa4-d4412f427289'),
+  Transit::UUID.new('501a978e-3a3e-4060-b3be-1cf2bd4b1a38'),
+  Transit::UUID.new('b3ba141a-a776-48e4-9fae-a28ea8571f58')]
+
+URIS = [
+  Addressable::URI.parse('http://example.com'),
+  Addressable::URI.parse('ftp://example.com'),
+  Addressable::URI.parse('file:///path/to/file.txt'),
+  Addressable::URI.parse('http://www.詹姆斯.com/')]
+
+DATES = [-6106017600000, 0, 946728000000, 1396909037000].map {|x| Transit::DateTimeUtil.from_millis(x)}
+
+SYMBOLS = [:a, :ab ,:abc ,:abcd, :abcde, :a1, :b2, :c3, :a_b]
+TRANSIT_SYMBOLS = SYMBOLS.map {|x| Transit::Symbol.new(x)}
+
+SET_SIMPLE = Set.new(ARRAY_SIMPLE)
+SET_MIXED = Set.new(ARRAY_MIXED)
+SET_NESTED= Set.new([SET_SIMPLE, SET_MIXED])
+
+MAP_SIMPLE = {a: 1, b: 2, c: 3}
+MAP_MIXED = {:a=>1, :b=>"a string", :c=>true}
+MAP_NESTED = {simple: MAP_SIMPLE, mixed: MAP_MIXED}
+
+Exemplar = Struct.new(:name, :expected_value)
+
+EXEMPLARS = [
+  Exemplar.new('nil', nil),
+  Exemplar.new('true',  true),
+  Exemplar.new('false', false),
+  Exemplar.new('zero',  0),
+  Exemplar.new('one', 1),
+  Exemplar.new('one_string', 'hello'),
+  Exemplar.new('one_keyword', :hello),
+  Exemplar.new('one_symbol',  Transit::Symbol.new('hello')),
+  Exemplar.new('one_date', DateTime.new(2000,1,1,12)), # Transit::DateTimeUtil.from_millis(946728000000)),
+  Exemplar.new("vector_simple", ARRAY_SIMPLE),
+  Exemplar.new("vector_empty", []),
+  Exemplar.new("vector_mixed", ARRAY_MIXED),
+  Exemplar.new("vector_nested", ARRAY_NESTED),
+  Exemplar.new("small_strings", SMALL_STRINGS ),
+  Exemplar.new("strings_tilde", SMALL_STRINGS.map{|s| "~#{s}"}),
+  Exemplar.new("strings_hash", SMALL_STRINGS.map{|s| "##{s}"}),
+  Exemplar.new("strings_hat", SMALL_STRINGS.map{|s| "^#{s}"}),
+  Exemplar.new("small_ints", ints_centered_on(0)),
+  Exemplar.new("ints", (0...128).to_a),
+  Exemplar.new("ints_interesting", INTERESTING_INTS),
+  Exemplar.new("ints_interesting_neg", INTERESTING_INTS.map {|x| -1 * x}),
+  Exemplar.new("doubles_small", ints_centered_on(0).map {|x| Float(x)}),
+  Exemplar.new("doubles_interesting", [-3.14159, 3.14159, 4E11, 2.998E8, 6.626E-34]),
+  Exemplar.new('one_uuid', UUIDS.first),
+  Exemplar.new('uuids', UUIDS),
+  Exemplar.new('one_uri', URIS.first),
+  Exemplar.new('uris', URIS),
+  Exemplar.new('dates_interesting', DATES),
+  Exemplar.new('symbols', TRANSIT_SYMBOLS),
+  Exemplar.new('keywords', SYMBOLS),
+  Exemplar.new('list_simple', ARRAY_SIMPLE),
+  Exemplar.new('list_empty', []),
+  Exemplar.new('list_mixed', ARRAY_MIXED),
+  Exemplar.new('list_nested', [ARRAY_SIMPLE, ARRAY_MIXED]),
+  Exemplar.new('set_simple', SET_SIMPLE),
+  Exemplar.new("set_empty", Set.new),
+  Exemplar.new("set_mixed", SET_MIXED),
+  Exemplar.new("set_nested", SET_NESTED),
+  Exemplar.new('map_simple', MAP_SIMPLE),
+  Exemplar.new('map_mixed',  MAP_MIXED),
+  Exemplar.new('map_nested',  MAP_NESTED),
+  Exemplar.new('map_string_keys',  {"first"=>1, "second"=>2, "third"=>3}),
+  Exemplar.new('map_numeric_keys',  {1=>"one", 2=>"two"}),
+  Exemplar.new('map_vector_keys', {[1,1] => 'one', [2, 2] => 'two'}),
+  Exemplar.new('map_10_items', hash_of_size(10)),
+  Exemplar.new("maps_two_char_sym_keys", [{:aa=>1, :bb=>2}, {:aa=>3, :bb=>4}, {:aa=>5, :bb=>6}]),
+  Exemplar.new("maps_three_char_sym_keys", [{:aaa=>1, :bbb=>2}, {:aaa=>3, :bbb=>4}, {:aaa=>5, :bbb=>6}]),
+  Exemplar.new("maps_four_char_sym_keys", [{:aaaa=>1, :bbbb=>2}, {:aaaa=>3, :bbbb=>4}, {:aaaa=>5, :bbbb=>6}]),
+  Exemplar.new("maps_two_char_string_keys", [{'aa'=>1, 'bb'=>2}, {'aa'=>3, 'bb'=>4}, {'aa'=>5, 'bb'=>6}]),
+  Exemplar.new("maps_three_char_string_keys", [{'aaa'=>1, 'bbb'=>2}, {'aaa'=>3, 'bbb'=>4}, {'aaa'=>5, 'bbb'=>6}]),
+  Exemplar.new("maps_four_char_string_keys", [{'aaaa'=>1, 'bbbb'=>2}, {'aaaa'=>3, 'bbbb'=>4}, {'aaaa'=>5, 'bbbb'=>6}]),
+  Exemplar.new("maps_unrecognized_keys",
+               [Transit::TaggedValue.new("abcde", :anything), Transit::TaggedValue.new("fghij", :"anything-else")]),
+  Exemplar.new("map_unrecognized_vals", {key: "~Unrecognized"}),
+  Exemplar.new("vector_unrecognized_vals", ["~Unrecognized"]),
+  Exemplar.new("vector_1935_keywords_repeated_twice", array_of_symbols(1935, 3870)),
+  Exemplar.new("vector_1936_keywords_repeated_twice", array_of_symbols(1936, 3872)),
+  Exemplar.new("vector_1937_keywords_repeated_twice", array_of_symbols(1937, 3874))
+  ]
+
+[10, 1935, 1936, 1937].each do |i|
+  EXEMPLARS << Exemplar.new( "map_#{i}_nested", {f: hash_of_size(i), s: hash_of_size(i)})
+end
+
+def verify_exemplar(exemplar, type, suffix)
+  path = "../transit-format/examples/0.8/simple/#{exemplar.name}#{suffix}"
+  it "reads what we expect from #{path}" do
+    raise "Can't open #{path}" unless File.exist?(path)
+    File.open(path) do |io|
+      actual_value = Transit::Reader.new(type, io).read
+      assert { exemplar.expected_value == actual_value }
+    end
+  end
+end
+
+module Transit
+  shared_examples "exemplars" do |type, suffix|
+    EXEMPLARS.each {|ex| verify_exemplar(ex, type, suffix)}
+  end
+
+  describe "JSON exemplars" do
+    include_examples "exemplars", :json, '.json'
+  end
+
+  describe "JSON-VERBOSE exemplars" do
+    include_examples "exemplars", :json_verbose, '.verbose.json'
+  end
+
+  describe "MessagePack exemplars" do
+    include_examples "exemplars", :msgpack, '.mp'
+  end
+end

data/spec/transit/reader_spec.rb

@@ -0,0 +1,129 @@
+# Copyright 2014 Cognitect. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+
+module Transit
+  describe Reader do
+    def read(value, &block)
+      reader = Reader.new(:json, StringIO.new(value.to_json, 'r+'))
+      reader.read &block
+    end
+
+    it 'reads without a block' do
+      assert { read([1,2,3]) == [1,2,3] }
+    end
+
+    it 'reads with a block' do
+      result = nil
+      read([1,2,3]) {|v| result = v}
+      assert { result == [1,2,3] }
+    end
+
+    describe 'handler registration' do
+      describe 'overrides' do
+        describe 'ground types' do
+          Decoder::GROUND_TAGS.each do |ground|
+            it "prevents override of #{ground} handler" do
+              assert {
+                rescuing {
+                  Reader.new(:json, StringIO.new, :handlers => {ground => Object.new})
+                }.message =~ /ground types/ }
+            end
+          end
+        end
+
+        it 'supports override of default string handlers' do
+          io = StringIO.new("[\"~rhttp://foo.com\"]","r+")
+          reader = Reader.new(:json, io, :handlers => {"r" => Class.new { def from_rep(v) "DECODED: #{v}" end}.new})
+          assert { reader.read == ["DECODED: http://foo.com"] }
+        end
+
+        it 'supports override of default hash handlers' do
+          my_uuid_class = Class.new(String)
+          my_uuid = my_uuid_class.new(UUID.new.to_s)
+          io = StringIO.new({"~#u" => my_uuid.to_s}.to_json)
+          reader = Reader.new(:json, io, :handlers => {"u" => Class.new { define_method(:from_rep) {|v| my_uuid_class.new(v)}}.new})
+          assert { reader.read == my_uuid }
+        end
+
+        it 'supports override of the default handler' do
+          io = StringIO.new("~Xabc".to_json)
+          reader = Reader.new(:json, io, :default_handler => Class.new { def from_rep(tag,val) raise "Unacceptable: #{s}" end}.new)
+          assert { rescuing {reader.read }.message =~ /Unacceptable/ }
+        end
+      end
+
+      describe 'extensions' do
+        it 'supports string-based extensions' do
+          io = StringIO.new("~D2014-03-15".to_json)
+          reader = Reader.new(:json, io, :handlers => {"D" => Class.new { def from_rep(v) Date.parse(v) end}.new})
+          assert { reader.read == Date.new(2014,3,15) }
+        end
+
+        it 'supports hash based extensions' do
+          io = StringIO.new({"~#Times2" => 44}.to_json)
+          reader = Reader.new(:json, io, :handlers => {"Times2" => Class.new { def from_rep(v) v * 2 end}.new})
+          assert { reader.read == 88 }
+        end
+
+        it 'supports hash based extensions that return nil'  do
+          io = StringIO.new({"~#Nil" => :anything}.to_json)
+          reader = Reader.new(:json, io, :handlers => {"Nil" => Class.new { def from_rep(_) nil end}.new})
+          assert { reader.read == nil }
+        end
+
+        it 'supports hash based extensions that return false' do
+          io = StringIO.new({"~#False" => :anything}.to_json)
+          reader = Reader.new(:json, io, :handlers => {"False" => Class.new { def from_rep(_) false end}.new})
+          assert { reader.read == false }
+        end
+
+        it 'supports complex hash values' do
+          io = StringIO.new([
+                             {"~#person"=>
+                               {"~:first_name" => "Transit","~:last_name" => "Ruby","~:birthdate" => "~D2014-01-02"}},
+                             {"^0"=>
+                               {"^1" => "Transit","^2" => "Ruby","^3" => "~D2014-01-03"}}].to_json)
+
+          person_handler = Class.new do
+            def from_rep(v)
+              Person.new(v[:first_name],v[:last_name],v[:birthdate])
+            end
+          end
+          date_handler = Class.new do
+            def from_rep(v) Date.parse(v) end
+          end
+          reader = Reader.new(:json, io,
+                              :handlers => {
+                                "person" => person_handler.new,
+                                "D"      => date_handler.new})
+          expected = [Person.new("Transit", "Ruby", Date.new(2014,1,2)),
+                      Person.new("Transit", "Ruby", Date.new(2014,1,3))]
+          assert { reader.read == expected }
+        end
+      end
+
+      describe 'edge cases found in generative testing' do
+        it 'supports ...' do
+          io = StringIO.new(["~#cmap",[["~#ratio",["~n10","~n11"]],"~:foobar",["^1",["~n10","~n13"]],"^2"]].to_json)
+          reader = Reader.new(:json, io)
+          expected = {TaggedValue.new("ratio",[10,11]) => :foobar,
+                      TaggedValue.new("ratio",[10,13]) => :foobar}
+          assert { reader.read == expected }
+        end
+      end
+    end
+  end
+end