sparsam 0.1.4

data/spec/sparsam_spec.rb

@@ -0,0 +1,304 @@
+# -*- coding: UTF-8 -*-
+
+require 'rubygems'
+require 'rspec'
+require 'json'
+
+RSpec.configure do |configuration|
+  configuration.before(:each) do
+  end
+end
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'gen-ruby')
+
+require 'sparsam'
+require 'user_types'
+serialized =        "\x15\x14\x18\x10woohoo blackbird\x1C\x15\xC8\x01\x18\bsubdata!\x00\x1A<\x15"\
+                    "\x02\x18\fid_s default\x00\x15\x04\x18\fid_s default\x00\x15\x06\x18\fid_s "\
+                    "default\x00+\x02X\x02\x03one\x04\x03two,\x15\xD0\x0F\x00\x00"
+serialized_binary = "\b\x00\x01\x00\x00\x00\n\v\x00\x02\x00\x00\x00\x10woohoo blackbird\f\x00"\
+                    "\x03\b\x00\x01\x00\x00\x00d\v\x00\x02\x00\x00\x00\bsubdata!\x00\x0E\x00"\
+                    "\x04\f\x00\x00\x00\x03\b\x00\x01\x00\x00\x00\x01\v\x00\x02\x00\x00\x00\f"\
+                    "id_s default\x00\b\x00\x01\x00\x00\x00\x02\v\x00\x02\x00\x00\x00\fid_s defaul"\
+                    "t\x00\b\x00\x01\x00\x00\x00\x03\v\x00\x02\x00\x00\x00\fid_s default\x00\r\x00"\
+                    "\x06\b\v\x00\x00\x00\x02\x00\x00\x00\x01\x00\x00\x00\x03one\x00\x00\x00\x02"\
+                    "\x00\x00\x00\x03two\f\x00\b\b\x00\x01\x00\x00\x03\xE8\x00\x00"
+
+describe 'Sparsam' do
+  describe Sparsam::Serializer do
+    it "respect default values" do
+      subdata = US.new
+      subdata.id_s.should == "id_s default"
+    end
+
+    it "can serialize structs" do
+      data = SS.new
+      data.id_i32 = 10
+      data.id_s = "woohoo blackbird"
+      subdata = US.new
+      subdata.id_i32 = 100
+      subdata.id_s = "subdata!"
+      data.us_i = subdata
+      data.us_s = Set.new
+      data.us_s.add(US.new({ "id_i32" => 1 }))
+      data.us_s.add(US.new({ "id_i32" => 2 }))
+      data.us_s.add(US.new({ "id_i32" => 3 }))
+      data.mappy = {}
+      data.mappy[1] = "one"
+      data.mappy[2] = "two"
+      data.un_field = UN.new({ :id_i32 => 1000 })
+      result = data.serialize
+      Sparsam.validate(SS, data, Sparsam::RECURSIVE).should == true
+      result.force_encoding("BINARY").should == serialized.force_encoding("BINARY")
+    end
+
+    it "can handle utf-8 strings" do
+      data = SS.new
+      data.id_s = "中国电信"
+      result = data.serialize
+      data2 = Sparsam::Deserializer.deserialize(SS, result)
+      data2.id_s.encoding.should == data.id_s.encoding
+      data2.id_s.should == data.id_s
+    end
+
+    it "can deserialize structs" do
+      data = Sparsam::Deserializer.deserialize(SS, serialized)
+      data.id_i32.should == 10
+      data.id_s.should == "woohoo blackbird"
+      data.mappy[1].should == "one"
+      data.mappy[2].should == "two"
+      data.us_i.id_i32.should == 100
+      data.us_i.id_s.should == "subdata!"
+      data.un_field.id_i32.should == 1000
+      data.us_s.size.should == 3
+      ids = Set.new([1, 2, 3])
+      data.us_s.each { |val|
+        ids.delete(val.id_i32)
+        val.id_s.should == "id_s default"
+      }
+      ids.size.should == 0
+    end
+
+    it "can handle passing in initialization data" do
+      init = { "id_i32" => 10, "id_s" => "woohoo blackbird" }
+      data = SS.new(init)
+      data.id_i32.should == 10
+      data.id_s.should == "woohoo blackbird"
+    end
+
+    it "will throw exceptions when strict validation received a non-conforming type" do
+      data = EasilyInvalid.new
+      data.tail = SS.new
+      expect {
+        Sparsam.validate(NotSS, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.s_self = Set.new([EasilyInvalid.new, SS.new])
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.l_self = [EasilyInvalid.new, SS.new]
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy1 = { SS.new => 123 }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy2 = { 123 => SS.new }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy3 = { SS.new => SS.new }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy3 = { EasilyInvalid.new => SS.new }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy3 = { SS.new => EasilyInvalid.new }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.mappy3 = { EasilyInvalid.new => EasilyInvalid.new, SS.new => EasilyInvalid.new }
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+
+      data = EasilyInvalid.new
+      data.id_i32 = "I'm pretty sure this is not an I32 LOL"
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
+      }.to raise_error(Sparsam::TypeMismatch)
+    end
+
+    it "works with crazy thriftness" do
+      data = EasilyInvalid.new
+      data.sure = [{ Set.new([1]) => { 1 => Set.new([[{ EasilyInvalid.new => "sure" }]]) } }]
+      Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE).should == true
+
+      data = EasilyInvalid.new
+      data.sure = [{ Set.new([1]) => { 1 => Set.new([[{ EasilyInvalid.new => 123 }]]) } }]
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
+      }.to raise_error(Sparsam::TypeMismatch)
+    end
+
+    it "will throw exceptions when recursive validation is passed wrong data" do
+      data = EasilyInvalid.new
+      data.required_stuff = MiniRequired.new
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
+      }.to raise_error(Sparsam::MissingMandatory)
+
+      data = EasilyInvalid.new
+      data.tail = EasilyInvalid.new
+      data.tail.s_self = Set.new([SS.new])
+      expect {
+        Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
+      }.to raise_error(Sparsam::TypeMismatch)
+    end
+
+    it "will throw exceptions when passed data that doesn't match type" do
+      data = SS.new
+      data.id_i32 = "I am not an int"
+      expect { data.serialize }.to raise_error(StandardError)
+    end
+
+    it "will validate required fields" do
+      data = MiniRequired.new
+      expect { data.validate }.to raise_error(Sparsam::MissingMandatory)
+    end
+
+    it "will throw errors when given junk data" do
+      expect {
+        Sparsam::Deserializer.deserialize(SS, "wolololololol")
+      }.to raise_error(Sparsam::Exception)
+    end
+
+    it "will throw errors when deserializing data with incorrect types" do
+      # SS expects field 1 to be an INT
+      # this is a struct w/ field 1 as a STRING instead
+      data = NotSS.new
+      data.id_s = "I am not an INT"
+      bad_type = data.serialize
+      expect {
+        Sparsam::Deserializer.deserialize(SS, bad_type)
+      }.to raise_error(Sparsam::TypeMismatch)
+    end
+
+    it "can deserialize objects with fields it doesn't know about" do
+      # NotSS_plus is NotSS with additional fields
+      # Thrift should ignore the additional fields
+      data = NotSS_plus.new
+      data.id_s = "This is ok"
+      data.id_s2 = "This is also ok"
+      data.id_i32 = 100
+      ser = data.serialize
+      notss = Sparsam::Deserializer.deserialize(NotSS, ser)
+      notss.id_s.should == "This is ok"
+      notss.id_i32.should == 100
+      Sparsam::Deserializer.deserialize(Nothing, ser)
+    end
+
+    it 'only allows one field to be set in a union' do
+      expect {
+        UN.new({ :id_i32 => 1000, :id_s => "woops" })
+      }.to raise_error(Sparsam::UnionException)
+
+      d = UN.new({ :id_i32 => 1000 })
+      d.id_s = "woops"
+      d.id_s
+
+      expect {
+        d.id_i32
+      }.to raise_error(Sparsam::UnionException)
+
+      d.instance_variables.should eq([:@setfield, :@id_s])
+    end
+
+    it 'handles empty arrays' do
+      data = SS.new
+      data.mappy = {}
+      data.us_s = Set.new
+      ser = data.serialize
+      unser = Sparsam::Deserializer.deserialize(SS, ser)
+      unser.mappy.size.should == 0
+      unser.us_s.size.should == 0
+    end
+
+    it "can serialize structs with binary" do
+      data = SS.new
+      data.id_i32 = 10
+      data.id_s = "woohoo blackbird"
+      data.mappy = {}
+      data.mappy[1] = "one"
+      data.mappy[2] = "two"
+      subdata = US.new
+      subdata.id_i32 = 100
+      subdata.id_s = "subdata!"
+      data.us_i = subdata
+      data.us_s = Set.new
+      data.us_s.add(US.new({ "id_i32" => 1 }))
+      data.us_s.add(US.new({ "id_i32" => 2 }))
+      data.us_s.add(US.new({ "id_i32" => 3 }))
+      data.un_field = UN.new({ :id_i32 => 1000 })
+      result = data.serialize(Sparsam::BinaryProtocol)
+      result.force_encoding("BINARY").should == serialized_binary.force_encoding("BINARY")
+    end
+
+    it "can deserialize structs with binary" do
+      data = Sparsam::Deserializer.deserialize(SS, serialized_binary, Sparsam::BinaryProtocol)
+      data.id_i32.should == 10
+      data.id_s.should == "woohoo blackbird"
+      data.mappy[1].should == "one"
+      data.mappy[2].should == "two"
+      data.mappy.size.should == 2
+      data.us_i.id_i32.should == 100
+      data.us_i.id_s.should == "subdata!"
+      data.un_field.id_i32.should == 1000
+      data.us_s.size.should == 3
+      ids = Set.new([1, 2, 3])
+      data.us_s.each { |val|
+        ids.delete(val.id_i32)
+        val.id_s.should == "id_s default"
+      }
+      ids.size.should == 0
+    end
+
+    it "can handle nested collections like a boss" do
+      data = SS.new
+      data.troll = {}
+      data.troll[1] = { 2 => 3 }
+      ser = data.serialize
+      new_data = Sparsam::Deserializer.deserialize(SS, ser)
+      new_data.troll[1][2].should == 3
+    end
+
+    it "doesn't segfault on malformed data" do
+      really_bad = "\x0f\x00\x05\x0b\x00\x00\x00\x01\x00\x00\x00\x03\x00"
+      expect {
+        Sparsam::Deserializer.deserialize(SS, really_bad, Sparsam::BinaryProtocol)
+      }.to raise_error(Sparsam::Exception)
+    end
+  end
+end

data/spec/user.thrift

@@ -0,0 +1,62 @@
+struct US {
+ 1: optional i32 id_i32
+ 2: optional binary id_s = "id_s default"
+ 3: optional set<string> string_set
+ 4: optional set<i32> int_set
+}
+
+union UN {
+ 1: optional i32 id_i32
+ 2: optional string id_s
+}
+
+enum Magic {
+  Black,
+  White,
+  Red,
+  Blue,
+  Green
+}
+
+struct SS {
+ 1: optional i32 id_i32
+ 2: optional string id_s
+ 3: optional US us_i
+ 4: optional set<US> us_s
+ 5: optional list<string> s_l
+ 6: optional map<i32, string> mappy
+ 7: optional byte byte_field
+ 8: optional UN un_field
+ 9: optional Magic magic_field
+ 10: optional map<i32, map<i32, i32>> troll
+}
+
+struct MiniRequired {
+ 1: i32 id_i32
+}
+
+struct EasilyInvalid {
+  1: optional EasilyInvalid tail
+  2: optional set<EasilyInvalid> s_self
+  3: optional list<EasilyInvalid> l_self
+  4: optional map<EasilyInvalid, i32> mappy1
+  5: optional map<i32, EasilyInvalid> mappy2
+  6: optional map<EasilyInvalid, EasilyInvalid> mappy3
+  7: optional list<map<set<i32>, map<i32, set<list<map<EasilyInvalid, string>>>>>> sure
+  8: optional MiniRequired required_stuff
+  9: optional i32 id_i32
+}
+
+struct NotSS {
+ 1: optional string id_s
+ 3: optional i32 id_i32
+}
+
+struct NotSS_plus {
+ 1: optional string id_s
+ 2: optional string id_s2
+ 3: optional i32 id_i32
+}
+
+struct nothing {
+}

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: sparsam
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Airbnb Thrift Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: Ruby bindings for the Apache Thrift RPC system
+email:
+- foundation.performance-eng@airbnb.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- README.md
+- ext/ruby_hooks.c
+- ext/serializer.h
+- ext/third-party/sparsepp/sparsepp/spp.h
+- ext/third-party/sparsepp/sparsepp/spp_config.h
+- ext/third-party/sparsepp/sparsepp/spp_dlalloc.h
+- ext/third-party/sparsepp/sparsepp/spp_memory.h
+- ext/third-party/sparsepp/sparsepp/spp_smartptr.h
+- ext/third-party/sparsepp/sparsepp/spp_stdint.h
+- ext/third-party/sparsepp/sparsepp/spp_timer.h
+- ext/third-party/sparsepp/sparsepp/spp_traits.h
+- ext/third-party/sparsepp/sparsepp/spp_utils.h
+- ext/extconf.rb
+- ext/serializer.cpp
+- lib/sparsam/base_class.rb
+- lib/sparsam/deserializer.rb
+- lib/sparsam/exceptions.rb
+- lib/sparsam/struct.rb
+- lib/sparsam/types.rb
+- lib/sparsam/union.rb
+- lib/sparsam.rb
+files:
+- README.md
+- ext/extconf.rb
+- ext/ruby_hooks.c
+- ext/serializer.cpp
+- ext/serializer.h
+- ext/third-party/sparsepp/sparsepp/spp.h
+- ext/third-party/sparsepp/sparsepp/spp_config.h
+- ext/third-party/sparsepp/sparsepp/spp_dlalloc.h
+- ext/third-party/sparsepp/sparsepp/spp_memory.h
+- ext/third-party/sparsepp/sparsepp/spp_smartptr.h
+- ext/third-party/sparsepp/sparsepp/spp_stdint.h
+- ext/third-party/sparsepp/sparsepp/spp_timer.h
+- ext/third-party/sparsepp/sparsepp/spp_traits.h
+- ext/third-party/sparsepp/sparsepp/spp_utils.h
+- lib/sparsam.rb
+- lib/sparsam/base_class.rb
+- lib/sparsam/deserializer.rb
+- lib/sparsam/exceptions.rb
+- lib/sparsam/struct.rb
+- lib/sparsam/types.rb
+- lib/sparsam/union.rb
+- spec/gen-ruby/user_constants.rb
+- spec/gen-ruby/user_types.rb
+- spec/sparsam_spec.rb
+- spec/user.thrift
+homepage: http://thrift.apache.org
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- Thrift
+- "--main"
+- README
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: thrift
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Apache Thrift
+test_files:
+- spec/gen-ruby/user_constants.rb
+- spec/gen-ruby/user_types.rb
+- spec/sparsam_spec.rb
+- spec/user.thrift