sparsam 0.2.9 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34cdf5f3a73cda371b8a1275369af0063e525d0951f44c23a12e02e6dfa3c519
-  data.tar.gz: f5d7efaf6389491e9ceab33839b828fb26757d8b84b8cc3ba9cf87b509716e13
+  metadata.gz: bb363b6de95b82d54b824db9a9e8c1d433e00a31771f730a7edd10a9bc10ef7b
+  data.tar.gz: ce9921ab0a2268cd211873cf9f764e1295e9ef777400ed52ad2d32cf36a7aebc
 SHA512:
-  metadata.gz: c2482ca31e496f3e1fb2597eaf7eb8f83e2f5545d7b2f8165840c5b394b4f63ce522bff6c2d18e11287803cc739ad279b97cf45f97efa1bbdd2f29c5594c8fc2
-  data.tar.gz: 62c14e98d040e76fdf6d9a886c0b138e25f0e8b9b901445b000f6c9fed12947c7537749a24f5601fc84d4e920b6b18b816fbcbe946aa525242de57d269698abd
+  metadata.gz: 360d36ab7da517b81f3ac9fcf2313134856d339da0a12b34684c39b2f9ba238c78912b86a8fdaeceb2652188ede9d561424799ba0149a9f2d50ef6ad9a2083c6
+  data.tar.gz: 7cc72e286b041cbd9e5241781455354ff4faf1c38f439cffaa1844b63d78d6fd0ea40b28101fc06997688d09afa29658398e0551aea95e82a8611d1eae8e27db

data/README.md

@@ -1,4 +1,4 @@
-# Sparsam [![Build Status](https://travis-ci.org/airbnb/sparsam.svg?branch=master)](https://travis-ci.org/airbnb/sparsam) [![Coverage Status](https://coveralls.io/repos/github/airbnb/sparsam/badge.svg?branch=master)](https://coveralls.io/github/airbnb/sparsam?branch=master) [![Gem Version](https://badge.fury.io/rb/sparsam.svg)](https://badge.fury.io/rb/sparsam)
+# Sparsam ![Build Status](https://github.com/airbnb/sparsam/actions/workflows/rspec_rubocop.yml/badge.svg?branch=main) [![Coverage Status](https://coveralls.io/repos/github/airbnb/sparsam/badge.svg?branch=master)](https://coveralls.io/github/airbnb/sparsam?branch=master) [![Gem Version](https://badge.fury.io/rb/sparsam.svg)](https://badge.fury.io/rb/sparsam)
 New Thrift bindings and generator for Ruby!
 
 ## Super basic Example

data/ext/extconf.rb

@@ -14,27 +14,27 @@ brew = find_executable('brew')
 use_homebrew = enable_config('homebrew', brew)
 
 if use_homebrew
-  $stderr.puts "Using #{brew} to locate thrift and boost packages"
-  $stderr.puts '(disable Homebrew integration via --disable-homebrew)'
+  warn "Using #{brew} to locate thrift and boost packages"
+  warn '(disable Homebrew integration via --disable-homebrew)'
 
   thrift_package = with_config('homebrew-thrift-package', 'thrift@0.9')
-  $stderr.puts "looking for Homebrew thrift package '#{thrift_package}'"
-  $stderr.puts '(change Homebrew thrift package name via --with-homebrew-thrift-package=<package>)'
+  warn "looking for Homebrew thrift package '#{thrift_package}'"
+  warn '(change Homebrew thrift package name via --with-homebrew-thrift-package=<package>)'
 
   thrift_prefix = `#{brew} --prefix #{thrift_package}`.strip
 
   unless File.exists?(thrift_prefix)
-    $stderr.puts "#{thrift_prefix} does not exist"
-    $stderr.puts "To resolve, `brew install #{thrift_package}` or pass"
-    $stderr.puts '--with-homebrew-thrift-package=<package> to this build to specify'
-    $stderr.puts 'an alternative thrift package to build against. e.g.:'
-    $stderr.puts
-    $stderr.puts '  $ bundle config --global build.sparsam --with-homebrew-thrift-package=mythrift'
+    warn "#{thrift_prefix} does not exist"
+    warn "To resolve, `brew install #{thrift_package}` or pass"
+    warn '--with-homebrew-thrift-package=<package> to this build to specify'
+    warn 'an alternative thrift package to build against. e.g.:'
+    warn
+    warn '  $ bundle config --global build.sparsam --with-homebrew-thrift-package=mythrift'
 
     raise "Homebrew package #{thrift_package} not installed"
   end
 
-  $stderr.puts "using Homebrew thrift at #{thrift_prefix}"
+  warn "using Homebrew thrift at #{thrift_prefix}"
   $CFLAGS << " -I#{thrift_prefix}/include"
   $CXXFLAGS << " -I#{thrift_prefix}/include"
   $CPPFLAGS << " -I#{thrift_prefix}/include"
@@ -42,18 +42,18 @@ if use_homebrew
 
   # Also add boost to the includes search path if it is installed.
   boost_package = with_config('homebrew-boost-package', 'boost')
-  $stderr.puts "looking for Homebrew boost package '#{boost_package}'"
-  $stderr.puts '(change Homebrew boost package name via --with-homebrew-boost-package=<package>)'
+  warn "looking for Homebrew boost package '#{boost_package}'"
+  warn '(change Homebrew boost package name via --with-homebrew-boost-package=<package>)'
 
   boost_prefix = `#{brew} --prefix #{boost_package}`.strip
 
   if File.exists?(boost_prefix)
-    $stderr.puts("using Homebrew boost at #{boost_prefix}")
+    warn("using Homebrew boost at #{boost_prefix}")
     $CFLAGS << " -I#{boost_prefix}/include"
     $CXXFLAGS << " -I#{boost_prefix}/include"
     $CPPFLAGS << " -I#{boost_prefix}/include"
   else
-    $stderr.puts 'Homebrew boost not found; assuming boost is in default search paths'
+    warn 'Homebrew boost not found; assuming boost is in default search paths'
   end
 end
 

data/ext/serializer.cpp

@@ -1,7 +1,5 @@
-extern "C" {
 #include <ruby.h>
 #include <ruby/intern.h>
-}
 #include <ruby/encoding.h>
 #include <stdio.h>
 #include <thrift/protocol/TBinaryProtocol.h>
@@ -51,6 +49,8 @@ VALUE SetClass;
 KlassFieldsCache klassCache;  // consider the memory leaked.
 std::unordered_set<VALUE> unions;
 
+#define SPARSAM_CHECK_TYPE(x, t, outer_struct, field_sym) if (!(RB_TYPE_P(x, t))) { raise_type_mismatch(outer_struct, field_sym, t, x); }
+
 void *serializer_create() { return (void *)(new ThriftSerializer()); }
 
 void serializer_free(void *data) {
@@ -185,12 +185,6 @@ static inline long raise_type_mismatch_as_value(VALUE outer_struct,
   return 0;
 }
 
-static inline void Sparsam_Check_Type(VALUE x, int t, VALUE outer_struct,
-                                      VALUE field_sym) {
-  if (!(RB_TYPE_P(x, t))) {
-    raise_type_mismatch(outer_struct, field_sym, t, x);
-  }
-}
 
 static inline VALUE make_ruby_bool(bool val) { return val ? Qtrue : Qfalse; }
 
@@ -513,7 +507,7 @@ void ThriftSerializer::writeAny(TType ttype, FieldInfo *field_info,
     HANDLE_TYPE(BYTE, Byte, CONVERT_FIXNUM(byte_convert, protocol::T_BYTE))
 
     case protocol::T_STRING: {
-      Sparsam_Check_Type(actual, T_STRING, outer_struct, field_sym);
+      SPARSAM_CHECK_TYPE(actual, T_STRING, outer_struct, field_sym);
 
       string data = string(StringValuePtr(actual), RSTRING_LEN(actual));
       if (field_info->isBinaryString) {
@@ -525,7 +519,7 @@ void ThriftSerializer::writeAny(TType ttype, FieldInfo *field_info,
     }
 
     case protocol::T_LIST: {
-      Sparsam_Check_Type(actual, T_ARRAY, outer_struct, field_sym);
+      SPARSAM_CHECK_TYPE(actual, T_ARRAY, outer_struct, field_sym);
 
       long length = RARRAY_LEN(actual);
       TType elem = field_info->elementType->ftype;
@@ -556,7 +550,7 @@ void ThriftSerializer::writeAny(TType ttype, FieldInfo *field_info,
     }
 
     case protocol::T_MAP: {
-      Sparsam_Check_Type(actual, T_HASH, outer_struct, field_sym);
+      SPARSAM_CHECK_TYPE(actual, T_HASH, outer_struct, field_sym);
 
       TType keyTType = field_info->keyType->ftype,
             valueTType = field_info->elementType->ftype;

data/lib/sparsam/base_type.rb

@@ -65,12 +65,16 @@ module Sparsam
       end
     end
 
+    # rubocop:disable Airbnb/OptArgParameters
     def serialize(prot = Sparsam::CompactProtocol)
+      # rubocop:enable Airbnb/OptArgParameters
       s = Sparsam::Serializer.new(prot, "")
       s.serialize(self.class, self)
     end
 
+    # rubocop:disable Airbnb/OptArgParameters
     def validate(mode = Sparsam::NORMAL)
+      # rubocop:enable Airbnb/OptArgParameters
       Sparsam.validate(self.class, self, mode)
     end
 

data/lib/sparsam/deserializer.rb

@@ -1,6 +1,8 @@
 module Sparsam
   module Deserializer
+    # rubocop:disable Airbnb/OptArgParameters
     def self.deserialize(klass, serialized_string, prot = Sparsam::CompactProtocol)
+      # rubocop:enable Airbnb/OptArgParameters
       s = Sparsam::Serializer.new(prot, serialized_string)
       if klass <= Sparsam::Union
         s.deserializeUnion(klass)

data/lib/sparsam/exceptions.rb

@@ -7,33 +7,37 @@ module Sparsam
     end
   end
 
-  class MissingMandatory < Exception
+  class MissingMandatory < ::Sparsam::Exception
     attr_reader :struct_name, :field_name
 
+    # rubocop:disable Airbnb/OptArgParameters
     def initialize(msg, struct_name = nil, field_name = nil)
+      # rubocop:enable Airbnb/OptArgParameters
       @struct_name = struct_name
       @field_name = field_name
       super(msg)
     end
   end
 
-  class TypeMismatch < Exception
+  class TypeMismatch < ::Sparsam::Exception
     attr_reader :struct_name, :field_name
 
+    # rubocop:disable Airbnb/OptArgParameters
     def initialize(msg, struct_name = nil, field_name = nil)
+      # rubocop:enable Airbnb/OptArgParameters
       @struct_name = struct_name
       @field_name = field_name
       super(msg)
     end
   end
 
-  class UnionException < Exception
+  class UnionException < ::Sparsam::Exception
     def initialize(msg)
       super
     end
   end
 
-  class UnknownTypeException < Exception
+  class UnknownTypeException < ::Sparsam::Exception
     def initialize(msg)
       super
     end

data/lib/sparsam/struct.rb

@@ -1,4 +1,5 @@
 # -*- coding: UTF-8 -*-
+
 require 'sparsam/base_type'
 require 'sparsam/base_struct'
 

data/lib/sparsam/types.rb

@@ -1,4 +1,5 @@
 # -*- coding: UTF-8 -*-
+
 require 'set'
 
 module Sparsam

data/lib/sparsam/union.rb

@@ -1,11 +1,14 @@
 # -*- coding: UTF-8 -*-
+
 require 'sparsam/base_type'
 
 module Sparsam
   class Union
     include ::Sparsam::BaseType
 
+    # rubocop:disable Airbnb/OptArgParameters
     def initialize(name = nil, value = nil)
+      # rubocop:enable Airbnb/OptArgParameters
       if name
         if name.is_a? Hash
           if name.size > 1

data/lib/sparsam.rb

@@ -1,4 +1,5 @@
 # -*- coding: UTF-8 -*-
+
 require 'sparsam_native'
 
 require 'sparsam/types'

data/spec/sparsam_spec.rb

@@ -72,10 +72,10 @@ describe 'Sparsam' do
       data.un_field.id_i32.should == 1000
       data.us_s.size.should == 3
       ids = Set.new([1, 2, 3])
-      data.us_s.each { |val|
+      data.us_s.each do |val|
         ids.delete(val.id_i32)
         val.id_s.should == "id_s default"
-      }
+      end
       ids.size.should == 0
     end
 
@@ -97,67 +97,67 @@ describe 'Sparsam' do
     it "will throw exceptions when strict validation received a non-conforming type" do
       data = EasilyInvalid.new
       data.tail = SS.new
-      expect {
+      expect do
         Sparsam.validate(NotSS, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.s_self = Set.new([EasilyInvalid.new, SS.new])
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.l_self = [EasilyInvalid.new, SS.new]
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy1 = { SS.new => 123 }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy2 = { 123 => SS.new }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy3 = { SS.new => SS.new }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy3 = { EasilyInvalid.new => SS.new }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy3 = { SS.new => EasilyInvalid.new }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.mappy3 = { EasilyInvalid.new => EasilyInvalid.new, SS.new => EasilyInvalid.new }
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
 
       data = EasilyInvalid.new
       data.id_i32 = "I'm pretty sure this is not an I32 LOL"
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::STRICT)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
     end
 
     it "includes additional data in TypeMismatch errors" do
@@ -182,24 +182,24 @@ describe 'Sparsam' do
 
       data = EasilyInvalid.new
       data.sure = [{ Set.new([1]) => { 1 => Set.new([[{ EasilyInvalid.new => 123 }]]) } }]
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.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 {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
-      }.to raise_error(Sparsam::MissingMandatory)
+      end.to raise_error(Sparsam::MissingMandatory)
 
       data = EasilyInvalid.new
       data.tail = EasilyInvalid.new
       data.tail.s_self = Set.new([SS.new])
-      expect {
+      expect do
         Sparsam.validate(EasilyInvalid, data, Sparsam::RECURSIVE)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
     end
 
     it "will throw exceptions when passed data that doesn't match type" do
@@ -266,9 +266,9 @@ describe 'Sparsam' do
     end
 
     it "will throw errors when given junk data" do
-      expect {
+      expect do
         Sparsam::Deserializer.deserialize(SS, "wolololololol")
-      }.to raise_error(Sparsam::Exception)
+      end.to raise_error(Sparsam::Exception)
     end
 
     it "will throw errors when deserializing data with incorrect types" do
@@ -277,9 +277,9 @@ describe 'Sparsam' do
       data = NotSS.new
       data.id_s = "I am not an INT"
       bad_type = data.serialize
-      expect {
+      expect do
         Sparsam::Deserializer.deserialize(SS, bad_type)
-      }.to raise_error(Sparsam::TypeMismatch)
+      end.to raise_error(Sparsam::TypeMismatch)
     end
 
     it "can deserialize objects with fields it doesn't know about" do
@@ -297,17 +297,17 @@ describe 'Sparsam' do
     end
 
     it 'only allows one field to be set in a union' do
-      expect {
+      expect do
         UN.new({ :id_i32 => 1000, :id_s => "woops" })
-      }.to raise_error(Sparsam::UnionException)
+      end.to raise_error(Sparsam::UnionException)
 
       d = UN.new({ :id_i32 => 1000 })
       d.id_s = "woops"
       d.id_s
 
-      expect {
+      expect do
         d.id_i32
-      }.to raise_error(Sparsam::UnionException)
+      end.to raise_error(Sparsam::UnionException)
 
       d.instance_variables.should eq([:@setfield, :@id_s])
     end
@@ -354,10 +354,10 @@ describe 'Sparsam' do
       data.un_field.id_i32.should == 1000
       data.us_s.size.should == 3
       ids = Set.new([1, 2, 3])
-      data.us_s.each { |val|
+      data.us_s.each do |val|
         ids.delete(val.id_i32)
         val.id_s.should == "id_s default"
-      }
+      end
       ids.size.should == 0
     end
 
@@ -372,9 +372,9 @@ describe 'Sparsam' do
 
     it "doesn't segfault on malformed data" do
       really_bad = "\x0f\x00\x05\x0b\x00\x00\x00\x01\x00\x00\x00\x03\x00"
-      expect {
+      expect do
         Sparsam::Deserializer.deserialize(SS, really_bad, Sparsam::BinaryProtocol)
-      }.to raise_error(Sparsam::Exception)
+      end.to raise_error(Sparsam::Exception)
     end
 
     it "handles all sorts of type issues without crashing" do
@@ -434,18 +434,18 @@ describe 'Sparsam' do
 
           # Validation doesn't do range checking, though serialization does
           unless val_type.to_s =~ /bigint/
-            expect {
+            expect do
               Sparsam.validate(s.class, s, Sparsam::STRICT)
-            }.to(
+            end.to(
               raise_error(Sparsam::TypeMismatch),
               "assigning #{field} : #{type} a value of " \
               "#{val.inspect} : #{val_type} did not raise TypeMismatch"
             )
           end
 
-          expect {
+          expect do
             s.serialize
-          }.to(
+          end.to(
             raise_error(Sparsam::TypeMismatch),
             "assigning #{field} : #{type} a value of " \
             "#{val.inspect} : #{val_type} did not raise TypeMismatch"
@@ -471,16 +471,16 @@ describe 'Sparsam' do
           [max_val, ~max_val].each do |val|
             s.send(:"#{field}=", val)
 
-            expect {
+            expect do
               s.serialize
-            }.not_to raise_error, "#{field} of #{size} bits unable to hold #{val}"
+            end.not_to raise_error, "#{field} of #{size} bits unable to hold #{val}"
           end
 
           [max_val + 1, ~(max_val + 1)].each do |val|
             s.send(:"#{field}=", val)
-            expect {
+            expect do
               s.serialize
-            }.to(
+            end.to(
               raise_error(RangeError),
               "#{field} of #{size} bits apparently able to hold value #{val} in defiance of nature"
             )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparsam
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.11
 platform: ruby
 authors:
 - Airbnb Thrift Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-airbnb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 description: Ruby bindings for the Apache Thrift RPC system
 email:
 - foundation.performance-eng@airbnb.com