pbio 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8b91516b406e0557ab91a3d3ba4dbed454bddf50ac90e97221cdb7e4a59774
-  data.tar.gz: '09b4907470dc89e4d3aed9682678fb1f5ec6967d01cd45e2623d9cdebf7ccd50'
+  metadata.gz: 77f8f874faf28491854d7dc995406e40addaa679c49353a234ed5e4bff1d209e
+  data.tar.gz: af842f93b1e1d578ee52e089b35776597191090db3e4412f86dfe7850f34f1ed
 SHA512:
-  metadata.gz: af4c6cb33801bfeb830950a6d8abe66e79a85d899d9d523eb3522ebd7edfe1281e68cd229819135d2c02c9da748571d01b315f362dc9e542ef625ceb147d9967
-  data.tar.gz: a9e311d2b1d87cb6a12373f99e34b277d06e00a2976f2022f73e3fb5f98fa26b5d28ae8deeef1ccaeb34e71c5157b709b02b7879a311f17edbcea5ebc249dbab
+  metadata.gz: 0e20fcbb824481fbf59a33a07880f7e1428d115517f6c12373d6a0bbf883ff200b9e33d082bc934de2afb35e06ee4a7c99acf215fe7b4df7e48b9c2f1eebd330
+  data.tar.gz: ac269f15235e35a5c1ed487b5b2d846dde96bb7182616b9f05ab266c9a3fedc14c20bf04cb6ee00b6164835ad176ef4e364e9dc3c04cf9b25b382f0672dd7fd1

data/.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Run lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: latest

data/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  go:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [1.16.x, 1.17.x]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Run tests
+        run: make test
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -1,4 +1,6 @@
 spec/tmp
 pkg
 *.gem
-.rake_tasks~
+*~
+.rubocop-*
+*.makefile

data/.rubocop.yml

@@ -1,6 +1,9 @@
-require: rubocop-performance
-inherit_from:
-  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
 
 AllCops:
-  TargetRubyVersion: "2.4"
+  TargetRubyVersion: 2.7

data/Gemfile.lock

@@ -1,45 +1,60 @@
 PATH
   remote: .
   specs:
-    pbio (0.2.0)
+    pbio (0.3.1)
       google-protobuf
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    google-protobuf (3.10.0-x86_64-linux)
-    jaro_winkler (1.5.3)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    google-protobuf (3.19.2)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.13.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -49,8 +64,7 @@ DEPENDENCIES
   pbio!
   rake
   rspec
-  rubocop
-  rubocop-performance
+  rubocop-bsm
 
 BUNDLED WITH
-   1.17.3
+   2.2.27

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Black Square Media
+Copyright (c) 2020 Black Square Media
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Makefile

@@ -0,0 +1,6 @@
+default: test
+
+.minimal.makefile:
+	curl -fsSL -o $@ https://gitlab.com/bsm/misc/raw/master/make/go/minimal.makefile
+
+include .minimal.makefile

data/README.md

@@ -1,5 +1,6 @@
 # PB IO
 
+[![Test](https://github.com/bsm/pbio/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/pbio/actions/workflows/test.yml)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 Protobuf IO is a Ruby equivalent of https://godoc.org/github.com/gogo/protobuf/io.

data/go.mod

@@ -0,0 +1,5 @@
+module github.com/bsm/pbio
+
+go 1.15
+
+require google.golang.org/protobuf v1.27.1

data/go.sum

@@ -0,0 +1,8 @@
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
+google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
+google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=

data/lib/pbio/delimited.rb

@@ -7,7 +7,7 @@ module PBIO
     def self.encode_uvarint(num)
       bytes = []
       while num >= 0x80
-        b = num & 0xFF | 0x80
+        b = (num & 0xFF) | 0x80
         bytes << b
         num >>= 7
       end
@@ -36,6 +36,11 @@ module PBIO
     # @param [IO] io object
     def initialize(io)
       @io = io
+      if @io.respond_to?(:binmode)
+        @io.binmode
+      elsif @io.respond_to?(:set_encoding)
+        @io.set_encoding(Encoding::BINARY)
+      end
     end
 
     # Writes a message to the IO stream.

data/pbio.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'pbio'
-  s.version     = '0.2.0'
+  s.version     = '0.3.1'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Protobuf Streaming'
@@ -11,13 +11,13 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
   s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.7'
 
   s.add_dependency 'google-protobuf'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-bsm'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/pbio.go

@@ -0,0 +1,74 @@
+package pbio
+
+import (
+	"bufio"
+	"encoding/binary"
+	"io"
+
+	"google.golang.org/protobuf/proto"
+)
+
+// Encoder encodes protobuf messages and writes to the underlying writer.
+type Encoder struct {
+	w   io.Writer
+	buf []byte
+}
+
+// NewEncoder inits a new encoder.
+func NewEncoder(w io.Writer) *Encoder {
+	return &Encoder{
+		w:   w,
+		buf: make([]byte, binary.MaxVarintLen64),
+	}
+}
+
+// Encode encodes a message.
+func (e *Encoder) Encode(msg proto.Message) error {
+	opt := proto.MarshalOptions{}
+	sz := opt.Size(msg)
+	e.buf = e.buf[:binary.PutUvarint(e.buf, uint64(sz))]
+
+	data, err := opt.MarshalAppend(e.buf, msg)
+	if err != nil {
+		return err
+	}
+	e.buf = data
+
+	_, err = e.w.Write(data)
+	return err
+}
+
+// --------------------------------------------------------------------
+
+// Decoder decodes protobuf messages from an underlying reader.
+type Decoder struct {
+	r   *bufio.Reader
+	buf []byte
+}
+
+// NewDecoder inits a new Decoder.
+func NewDecoder(r io.Reader) *Decoder {
+	return &Decoder{
+		r: bufio.NewReader(r),
+	}
+}
+
+// Decode decodes a message.
+func (d *Decoder) Decode(msg proto.Message) error {
+	sz, err := binary.ReadUvarint(d.r)
+	if err != nil {
+		return err
+	}
+
+	if n := int(sz); cap(d.buf) < n {
+		d.buf = make([]byte, n)
+	} else {
+		d.buf = d.buf[:n]
+	}
+	if _, err := io.ReadFull(d.r, d.buf); err != nil {
+		return err
+	}
+
+	opt := proto.UnmarshalOptions{}
+	return opt.Unmarshal(d.buf, msg)
+}

data/pbio_test.go

@@ -0,0 +1,94 @@
+package pbio_test
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"io"
+	"math"
+	"testing"
+
+	"github.com/bsm/pbio"
+	"google.golang.org/protobuf/types/known/structpb"
+)
+
+var message, _ = structpb.NewValue(map[string]interface{}{
+	"firstName": "John",
+	"lastName":  "Smith",
+	"isAlive":   true,
+	"age":       27,
+	"address": map[string]interface{}{
+		"streetAddress": "21 2nd Street",
+		"city":          "New York",
+		"state":         "NY",
+		"postalCode":    "10021-3100",
+	},
+})
+
+func TestEncoder(t *testing.T) {
+	buf := new(bytes.Buffer)
+	enc := pbio.NewEncoder(buf)
+
+	if err := enc.Encode(message); err != nil {
+		t.Fatalf("expected no error, but got %v", err)
+	}
+	if exp, got, delta := 192, buf.Len(), 20; math.Abs(float64(exp)-float64(got)) > float64(delta) {
+		t.Fatalf("expected %d (±%d), got %d", exp, delta, got)
+	}
+
+	if err := enc.Encode(message); err != nil {
+		t.Fatalf("expected no error, but got %v", err)
+	}
+	if exp, got, delta := 384, buf.Len(), 20; math.Abs(float64(exp)-float64(got)) > float64(delta) {
+		t.Fatalf("expected %d (±%d), got %d", exp, delta, got)
+	}
+}
+
+func TestDecoder(t *testing.T) {
+	buf := new(bytes.Buffer)
+	enc := pbio.NewEncoder(buf)
+	for i := 0; i < 2; i++ {
+		if err := enc.Encode(message); err != nil {
+			t.Fatalf("expected no error, but got %v", err)
+		}
+	}
+
+	dec := pbio.NewDecoder(buf)
+	m1 := new(structpb.Value)
+	if err := dec.Decode(m1); err != nil {
+		t.Fatalf("expected no error, but got %v", err)
+	}
+
+	if data, err := m1.MarshalJSON(); err != nil {
+		t.Fatalf("expected no error, but got %v", err)
+	} else if exp, got := `{
+  "address": {
+    "city": "New York",
+    "postalCode": "10021-3100",
+    "state": "NY",
+    "streetAddress": "21 2nd Street"
+  },
+  "age": 27,
+  "firstName": "John",
+  "isAlive": true,
+  "lastName": "Smith"
+}`, normJSON(data); exp != got {
+		t.Fatalf("expected:\n%v, but got:\n%v", exp, got)
+	}
+
+	m2 := new(structpb.Value)
+	if err := dec.Decode(m2); err != nil {
+		t.Fatalf("expected no error, but got %v", err)
+	}
+
+	m3 := new(structpb.Value)
+	if exp, got := io.EOF, dec.Decode(m3); !errors.Is(got, exp) {
+		t.Fatalf("expected %v, but got %v", exp, got)
+	}
+}
+
+func normJSON(data []byte) string {
+	b := new(bytes.Buffer)
+	_ = json.Indent(b, data, "", "  ")
+	return b.String()
+}

data/spec/lib/pbio/delimited_spec.rb

@@ -1,29 +1,30 @@
 require 'spec_helper'
 
 describe PBIO::Delimited do
+  subject { described_class.new io }
+
   let(:io)   { StringIO.new }
   let(:msg1) { PBIO::Spec::Message.new(name: 'Test A') }
   let(:msg2) { PBIO::Spec::Message.new(name: 'Test B') }
   let(:msg3) { PBIO::Spec::Message.new(name: 'x' * 32_000) }
 
-  subject { described_class.new io }
-
-  it 'should write' do
+  it 'writes' do
     expect(subject.write(msg1)).to eq(9)
     expect(subject.write(msg2)).to eq(9)
     expect(io.size).to eq(18)
+    expect(io.string.encoding).to eq(Encoding::BINARY)
 
     expect(subject.write(msg3)).to eq(32_007)
     expect(io.size).to eq(32_025)
   end
 
-  it 'should read' do
+  it 'reads' do
     expect(subject.write(msg1)).to eq(9)
     expect(subject.write(msg2)).to eq(9)
     io.rewind
 
     expect(subject.read(PBIO::Spec::Message)).to eq(msg1)
-    expect(subject).to_not be_eof
+    expect(subject).not_to be_eof
     expect(subject.read(PBIO::Spec::Message)).to eq(msg2)
     expect(subject).to be_eof
     expect(subject.read(PBIO::Spec::Message)).to be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -67,21 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  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: rubocop-performance
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,24 +87,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocop-https---gitlab-com-bsm-misc-raw-master-rubocop-default-yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
+- go.mod
+- go.sum
 - lib/pbio.rb
 - lib/pbio/delimited.rb
 - pbio.gemspec
+- pbio.go
+- pbio_test.go
 - spec/lib/pbio/delimited_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/pbio
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -127,14 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Protobuf Streaming

data/.rubocop-https---gitlab-com-bsm-misc-raw-master-rubocop-default-yml

@@ -1,78 +0,0 @@
-AllCops:
-  Exclude:
-    - "db/schema.rb"
-    - "vendor/**/*"
-    - "**/*_pb.rb"
-
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Exclude:
-    - "**/*.rake"
-    - "db/**/*.rb"
-    - "**/spec/**/*.rb"
-    - "**/*.gemspec"
-Metrics/ClassLength:
-  Max: 1500
-Metrics/CyclomaticComplexity:
-  Max: 20
-Metrics/LineLength:
-  Max: 160
-Metrics/MethodLength:
-  Max: 20
-  Exclude:
-    - "db/**/*.rb"
-Metrics/ModuleLength:
-  Exclude:
-    - "**/*_spec.rb"
-Metrics/PerceivedComplexity:
-  Max: 20
-
-Layout/AlignArguments:
-  EnforcedStyle: with_fixed_indentation
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-Layout/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-Layout/EmptyLinesAroundBlockBody:
-  Exclude:
-    - "db/**/*.rb"
-    - "**/*.rake"
-    - "**/*_spec.rb"
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-Layout/MultilineOperationIndentation:
-  Enabled: false
-Layout/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: no_space
-Layout/SpaceInsideBlockBraces:
-  SpaceBeforeBlockParameters: false
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/HashSyntax:
-  EnforcedStyle: ruby19_no_mixed_keys
-Style/MultilineIfModifier:
-  Enabled: false
-Style/NumericLiterals:
-  Enabled: false
-Style/Semicolon:
-  AllowAsExpressionSeparator: true
-Style/SingleLineBlockParams:
-  Enabled: false
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -1,4 +0,0 @@
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4