pbio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b7b794873adade256aa3a133018ca891d5b160aff747233db4cf0ea534da3fc
+  data.tar.gz: 909c3ed71f37ab6dcb1140c7bc999ea295604b28c3ffcc5269373890529c79df
+SHA512:
+  metadata.gz: 10b80972ce679a9a1243dab4eb5740b4a5a828249c0863c95f6920eae1e5084c0b93c71e58ee19f0d6c1e9df40876a205cafeb2281cdfceeab5bc019c0bdceaa
+  data.tar.gz: e3fbb13072427cde21c717db1282e27ab0fe9b40295ba71b88d096f291466321a7c32361e0cc579ccc640ee21d79bd355439b4efee4acd5b59bdb39ac9c78b67

data/.gitignore

@@ -0,0 +1,4 @@
+spec/tmp
+pkg
+*.gem
+.rake_tasks~

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude: [spec/**]
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+
+Style/NumericLiterals:
+  Exclude: [spec/**]
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    pbio (0.1.0)
+      google-protobuf
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    google-protobuf (3.5.1.2)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pbio!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Black Square Media
+
+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

@@ -0,0 +1,27 @@
+# PB IO
+
+[![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.
+
+## Installation
+
+Add `gem 'pbio'` to your Gemfile.
+
+## Usage
+
+```ruby
+File.open("file.txt", "w") do |f|
+  pbio = PBIO::Delimited.new(f)
+  pbio.write MyProtoMsg.new(title: "Foo")
+  pbio.write MyProtoMsg.new(title: "Bar")
+end
+
+File.open("file.txt", "r") do |f|
+  pbio = PBIO::Delimited.new(f)
+  pbio.read MyProtoMsg # => #<MyProtoMsg: title: "Foo">
+  pbio.read MyProtoMsg # => #<MyProtoMsg: title: "Bar">
+  pbio.read MyProtoMsg # => nil
+  f.eof?               # => true
+end
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/lib/pbio.rb

@@ -0,0 +1,3 @@
+module PBIO # :nodoc:
+  autoload :Delimited, 'pbio/delimited'
+end

data/lib/pbio/delimited.rb

@@ -0,0 +1,60 @@
+module PBIO
+  # Delimited contains write and read methods to consume and generate
+  # delimited protobuf IO streams.
+  class Delimited
+    # @param [Integer] num number
+    # @return [Array<Byte>] uvarint byte array
+    def self.encode_uvarint(num)
+      bytes = []
+      while num >= 0x80
+        b = num & 0xFF | 0x80
+        bytes << b
+        num >>= 7
+      end
+      bytes << num
+      bytes.pack('c*')
+    end
+
+    # @param [IO] io stream
+    # @return [Integer] decoded number
+    def self.read_uvarint(io)
+      num = shift = 0
+      io.each_byte do |b|
+        if b < 0x80
+          num |= b << shift
+          break
+        end
+
+        num |= (b & 0x7f) << shift
+        shift += 7
+      end
+      num
+    end
+
+    attr_reader :io
+
+    # @param [IO] io object
+    def initialize(io)
+      @io = io
+    end
+
+    # Writes a message to the IO stream.
+    # @param [Protobuf::Message] msg the message
+    def write(msg)
+      payload = msg.to_proto
+      size = Delimited.encode_uvarint(payload.bytesize)
+      io.write(size) + io.write(payload)
+    end
+
+    # Reads the next message
+    def read(klass)
+      size = Delimited.read_uvarint(io)
+      klass.decode io.read(size) unless size.zero?
+    end
+
+    # @return [Boolean] EOF status
+    def eof?
+      io.respond_to?(:eof?) && io.eof?
+    end
+  end
+end

data/pbio.gemspec

@@ -0,0 +1,23 @@
+
+Gem::Specification.new do |s|
+  s.name        = 'pbio'
+  s.version     = '0.1.0'
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = ['dimitrij@blacksquaremedia.com']
+  s.summary     = 'Protobuf Streaming'
+  s.description = ''
+  s.homepage    = 'https://github.com/bsm/pbio'
+  s.license     = 'MIT'
+
+  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.2.0'
+
+  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'
+end

data/spec/lib/pbio/delimited_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe PBIO::Delimited do
+  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
+    expect(subject.write(msg1)).to eq(9)
+    expect(subject.write(msg2)).to eq(9)
+    expect(io.size).to eq(18)
+
+    expect(subject.write(msg3)).to eq(32_007)
+    expect(io.size).to eq(32_025)
+  end
+
+  it 'should read' 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.read(PBIO::Spec::Message)).to eq(msg2)
+    expect(subject).to be_eof
+    expect(subject.read(PBIO::Spec::Message)).to be_nil
+    expect(subject).to be_eof
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'pbio'
+require 'rspec'
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message 'pbio.spec.Message' do
+    optional :name, :string, 1
+  end
+end
+
+module PBIO
+  module Spec
+    Message = Google::Protobuf::DescriptorPool.generated_pool.lookup('pbio.spec.Message').msgclass
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pbio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+  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'
+description: ''
+email:
+- dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pbio.rb
+- lib/pbio/delimited.rb
+- pbio.gemspec
+- spec/lib/pbio/delimited_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/pbio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Protobuf Streaming
+test_files:
+- spec/lib/pbio/delimited_spec.rb
+- spec/spec_helper.rb