snappy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b633f54dc239a8a5a4ef4df91fd0a23a100298ca83192d30096490f6174670b
-  data.tar.gz: 7caed929e615860f65dc0a25568cbe1c4f01ed377fbbc96de457acffb9dcc349
+  metadata.gz: 0f0d6e3b8ecb62795d4e7cc9b9f68b6028922bd1aa0d6d760b1524f1d791baca
+  data.tar.gz: 225b39658d6a081b0bd45304b98414cc442830230f7b3c242552ff432cf9bfcb
 SHA512:
-  metadata.gz: 6c51f97d066a0bc256498157c9e9a2dab2da1191f310da24d0b54531de6ceb4db09471a4d8738180e20ca06f8e7147440ded43c6ad6baf1599f626c751a9086a
-  data.tar.gz: 8d8b5494df7e5858ebe77c2a86845257409cd71d793f8cd7c2123f9f784e75fb0d66294ce87ddd5fc5140b4702a135e8a644b5a07308414a9fc747fb6111658a
+  metadata.gz: e682ccd1e650089dc5b83d2e1020e02770d61e99d42406973311ec12a0897c18c652370679e50955f4644159e61c8ff922bfca8cd7b97ed446d4f46c83f63ba7
+  data.tar.gz: 576ba5ed1c73fcf34b63f57afadc90a02f40944f810684b2211f87bfc50362cb71f5fc8c8c1faa414c0fe7549ceade05b611827bb906ee7b4b0cfb3177a82e84

data/.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Ruby
+
+on: [pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, jruby]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: |
+        bundle exec rake clobber clean test build
+        gem install --no-document "$(ls pkg/snappy-*.gem)"
+        cat <<EOF | ruby
+        require "snappy"
+        if Snappy.inflate(Snappy.deflate(File.read("README.md"))) == File.read("README.md")
+          puts "OK"
+          exit 0
+        else
+          puts "NG"
+          exit 0
+        end
+        EOF

data/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, jruby]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run release task
+      run: |
+        mkdir -p ~/.gem
+        cat << EOF > ~/.gem/credentials
+        ---
+        :github: Bearer ${{secrets.GITHUB_TOKEN}}
+        :rubygems_api_key: ${{secrets.RUBYGEMS_API_KEY}}
+        EOF
+        chmod 600 ~/.gem/credentials
+        bundle exec rake release[remote]
+        rm -f ~/.gem/credentials

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in snappy.gemspec
 gemspec
 
-group :development do
-  gem 'rake'
-  gem 'minitest'
-end
+gem "rake", "~> 13.0"
+gem "test-unit", "~> 3.0"
+gem "test-unit-rr"

data/Rakefile

@@ -2,49 +2,51 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "rbconfig"
-DLEXT = RbConfig::CONFIG['DLEXT']
+DLEXT = RbConfig::CONFIG["DLEXT"]
 
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/test-*.rb'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
   t.warning = true
   t.verbose = true
 end
 
 if defined?(JRUBY_VERSION)
-  require 'ant'
+  require "ant"
 
-  directory 'ext/java/build'
+  directory "ext/java/build"
 
-  task :setup => 'ext/java/build' do
-    ant.property name: 'src.dir', value: 'ext/java/src'
-    ant.property name: 'build.dir', value: 'ext/java/build'
+  task setup: "ext/java/build" do
+    ant.property name: "src.dir", value: "ext/java/src"
+    ant.property name: "build.dir", value: "ext/java/build"
 
-    ant.path id: 'compile.class.path' do
-      pathelement location: File.join(RbConfig::CONFIG['prefix'], 'lib', 'jruby.jar')
-      $LOAD_PATH.flat_map { |path| Dir[File.join(path, '**', '*.jar')] }.each do |jar|
+    ant.path id: "compile.class.path" do
+      pathelement location: File.join(RbConfig::CONFIG["prefix"], "lib", "jruby.jar")
+      $LOAD_PATH.flat_map { |path| Dir[File.join(path, "**", "*.jar")] }.each do |jar|
         pathelement location: jar
       end
     end
   end
 
-  desc 'Compile the extension'
-  task :compile => :setup do
-    ant.javac destdir: '${build.dir}', includeantruntime: 'no', target: '1.6', source: '1.6', debug: 'on' do
-      classpath refid: 'compile.class.path'
-      src { pathelement location: '${src.dir}' }
+  desc "Compile the extension"
+  task compile: :setup do
+    ant.javac destdir: "${build.dir}", includeantruntime: "no", target: "1.6", source: "1.6", debug: "on" do
+      classpath refid: "compile.class.path"
+      src { pathelement location: "${src.dir}" }
     end
   end
 
-  desc 'Package the jar'
-  file 'lib/snappy_ext.jar' => :compile do |t|
-    ant.jar destfile: 'lib/snappy_ext.jar', basedir: '${build.dir}' do
-      ant.fileset dir: '${build.dir}', includes: 'snappy/*.class'
-      ant.fileset dir: '${build.dir}', includes: 'SnappyExtLibraryService.class'
+  desc "Package the jar"
+  file "lib/snappy_ext.jar" => :compile do |t|
+    ant.jar destfile: "lib/snappy_ext.jar", basedir: "${build.dir}" do
+      ant.fileset dir: "${build.dir}", includes: "snappy/*.class"
+      ant.fileset dir: "${build.dir}", includes: "SnappyExtLibraryService.class"
     end
   end
 
-  task :test => 'lib/snappy_ext.jar'
-  task :build => [:clean, 'lib/snappy_ext.jar']
+  task test: "lib/snappy_ext.jar"
+  task build: [:clean, "lib/snappy_ext.jar"]
 else
   file "ext/snappy_ext.#{DLEXT}" => Dir.glob("ext/*{.rb,.c}") do
     Dir.chdir("ext") do
@@ -54,15 +56,15 @@ else
     cp "ext/snappy_ext.#{DLEXT}", "lib/snappy_ext.#{DLEXT}"
   end
 
-
-  task :test => "ext/snappy_ext.#{DLEXT}"
+  task test: "ext/snappy_ext.#{DLEXT}"
 end
 
-desc 'Clean up build artifacts'
+desc "Clean up build artifacts"
 task :clean do
-  rm_rf 'ext/java/build'
-  rm_rf 'lib/snappy_ext.jar'
-  rm_rf(["ext/snappy_ext.#{DLEXT}", "lib/snappy_ext.#{DLEXT}", 'ext/mkmf.log', 'ext/config.h', 'ext/api.o', 'ext/Makefile', 'ext/snappy.cc', 'ext/snappy.h', 'ext/snappy.o'] + Dir['ext/snappy-*'])
+  rm_rf "ext/java/build"
+  rm_rf "lib/snappy_ext.jar"
+  rm_rf(["ext/snappy_ext.#{DLEXT}", "lib/snappy_ext.#{DLEXT}", "ext/mkmf.log", "ext/config.h", "ext/api.o",
+         "ext/Makefile", "ext/snappy.cc", "ext/snappy.h", "ext/snappy.o"] + Dir["ext/snappy-*"])
 end
 
-task :default => :test
+task default: :test

data/ext/api.c

@@ -1,7 +1,6 @@
 #include "ruby.h"
 #include "snappy-c.h"
 
-static VALUE rb_mSnappy;
 static VALUE rb_eSnappy;
 
 static VALUE
@@ -92,10 +91,16 @@ snappy_valid_p(VALUE self, VALUE str)
 
 void Init_snappy_ext()
 {
+#if HAVE_RB_EXT_RACTOR_SAFE
+    rb_ext_ractor_safe(true);
+#endif
+
+    VALUE rb_mSnappy;
     VALUE rb_mSnappy_singleton;
 
     rb_mSnappy = rb_define_module("Snappy");
     rb_eSnappy = rb_define_class_under(rb_mSnappy, "Error", rb_eStandardError);
+    rb_global_variable(&rb_eSnappy);
     rb_define_singleton_method(rb_mSnappy, "deflate", snappy_deflate, -1);
     rb_define_singleton_method(rb_mSnappy, "inflate", snappy_inflate, -1);
     rb_define_singleton_method(rb_mSnappy, "valid?",  snappy_valid_p, 1);

data/lib/snappy.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'snappy-jars' if defined?(JRUBY_VERSION)
-require 'snappy_ext'
-require 'snappy/reader'
-require 'snappy/writer'
-require 'snappy/hadoop'
+require "snappy-jars" if defined?(JRUBY_VERSION)
+require "snappy_ext"
+require "snappy/reader"
+require "snappy/writer"
+require "snappy/hadoop"

data/lib/snappy/hadoop/reader.rb

@@ -14,6 +14,8 @@ module Snappy
       end
 
       def each
+        return to_enum unless block_given?
+
         until @io.eof?
           # Uncompressed size (32 bit integer, BE).
           uncompressed_size = @io.read(4).unpack('N').first
@@ -29,7 +31,7 @@ module Snappy
             raise RuntimeError("Invalid data: expected #{uncompressed_size} bytes, got #{Uncompressed.size}")
           end
 
-          yield uncompressed_block_io.string if block_given?
+          yield uncompressed_block_io.string
         end
       end
 
@@ -42,13 +44,15 @@ module Snappy
       end
 
       def each_line(sep_string = $/)
+        return to_enum(:each_line, sep_string) unless block_given?
+
         last = ""
         each do |chunk|
           chunk = last + chunk
           lines = chunk.split(sep_string)
           last = lines.pop
           lines.each do |line|
-            yield line if block_given?
+            yield line
           end
         end
         yield last

data/lib/snappy/reader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'snappy/shim'
-require 'snappy/writer'
+require "snappy/shim"
+require "snappy/writer"
 
 module Snappy
   class Reader
@@ -14,12 +14,14 @@ module Snappy
     end
 
     def each
+      return to_enum unless block_given?
+
       until @io.eof?
         if @chunked
-          size = @io.read(4).unpack('N').first
-          yield Snappy.inflate(@io.read(size)) if block_given?
+          size = @io.read(4).unpack1("N")
+          yield Snappy.inflate(@io.read(size))
         else
-          yield Snappy.inflate(@io.read) if block_given?
+          yield Snappy.inflate(@io.read)
         end
       end
     end
@@ -33,13 +35,15 @@ module Snappy
     end
 
     def each_line(sep_string = $/)
+      return to_enum(:each_line, sep_string) unless block_given?
+
       last = ""
       each do |chunk|
         chunk = last + chunk
         lines = chunk.split(sep_string)
         last = lines.pop
         lines.each do |line|
-          yield line if block_given?
+          yield line
         end
       end
       yield last
@@ -50,7 +54,7 @@ module Snappy
     def read_header!
       header = @io.read Snappy::Writer::MAGIC.length
       if header.length == Snappy::Writer::MAGIC.length && header == Snappy::Writer::MAGIC
-        @magic, @default_version, @minimum_compatible_version = header, *@io.read(8).unpack('NN')
+        @magic, @default_version, @minimum_compatible_version = header, *@io.read(8).unpack("NN")
         @chunked = true
       else
         @io.rewind

data/lib/snappy/shim.rb

@@ -3,7 +3,7 @@
 module Snappy
   module_function
 
-  if RUBY_VERSION[0..2] == '1.8'
+  if RUBY_VERSION[0..2] == "1.8"
     def set_encoding(io)
       io
     end

data/lib/snappy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snappy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/snappy.gemspec

@@ -1,31 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'snappy/version'
+require "snappy/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "snappy"
   spec.version       = Snappy::VERSION
   spec.authors       = ["miyucy"]
   spec.email         = ["fistfvck@gmail.com"]
-  spec.description   = %q{libsnappy binding for Ruby}
-  spec.summary       = %q{libsnappy binding for Ruby}
+  spec.description   = "libsnappy binding for Ruby"
+  spec.summary       = "libsnappy binding for Ruby"
   spec.homepage      = "http://github.com/miyucy/snappy"
   spec.license       = "MIT"
 
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
   spec.test_files    = `git ls-files -z -- test`.split("\x0")
   spec.files         = `git ls-files -z`.split("\x0")
   spec.files        -= spec.test_files
-  spec.files        -= ['vendor/snappy']
-  spec.files        += Dir['vendor/snappy/**/*'].reject { |e| e.start_with? 'vendor/snappy/testdata' }
+  spec.files        -= ["vendor/snappy"]
+  spec.files        += Dir["vendor/snappy/**/*"].reject { |e| e.start_with? "vendor/snappy/testdata" }
 
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   if defined?(JRUBY_VERSION)
     spec.files += %w[lib/snappy_ext.jar]
-    spec.platform = 'java'
-    spec.add_dependency 'snappy-jars', '~> 1.1.0'
+    spec.platform = "java"
+    spec.add_dependency "snappy-jars", "~> 1.1.0"
   else
     spec.extensions = ["ext/extconf.rb"]
   end

data/test/hadoop/snappy_hadoop_reader_test.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "stringio"
+
+class SnappyHadoopReaderTest < Test::Unit::TestCase
+  def setup
+    @buffer = StringIO.new
+    Snappy::Hadoop::Writer.new @buffer do |w|
+      w << "foo"
+      w << "bar"
+      w << "baz"
+      w << "quux"
+    end
+    @buffer.rewind
+  end
+
+  def subject
+    @subject ||= Snappy::Hadoop::Reader.new @buffer
+  end
+
+  sub_test_case "#initialize" do
+    test "should yield itself to the block" do
+      yielded = nil
+      returned = Snappy::Hadoop::Reader.new @buffer do |r|
+        yielded = r
+      end
+      assert_equal returned, yielded
+    end
+  end
+
+  sub_test_case "#io" do
+    test "should be a constructor argument" do
+      assert_equal @buffer, subject.io
+    end
+
+    test "should not receive `length' in initializing" do
+      dont_allow(@buffer).length
+      Snappy::Hadoop::Reader.new @buffer
+    end
+  end
+
+  sub_test_case "#each" do
+    def setup
+      @buffer = StringIO.new
+      Snappy::Hadoop::Writer.new @buffer do |w|
+        w << "foo"
+        w << "bar"
+        w.dump!
+        w << "baz"
+        w << "quux"
+      end
+      @buffer.rewind
+    end
+
+    test "should yield each chunk" do
+      chunks = []
+      subject.each do |chunk|
+        chunks << chunk
+      end
+      assert_equal %w[foobar bazquux], chunks
+    end
+  end
+
+  sub_test_case "#read" do
+    test "should return the bytes" do
+      assert_equal "foobarbazquux", subject.read
+    end
+  end
+
+  sub_test_case "#each_line" do
+    def setup
+      @buffer = StringIO.new
+      Snappy::Hadoop::Writer.new @buffer do |w|
+        w << "foo\n"
+        w << "bar"
+        w.dump!
+        w << "baz\n"
+        w << "quux\n"
+      end
+      @buffer.rewind
+    end
+
+    test "should yield each line" do
+      lines = []
+      subject.each_line do |line|
+        lines << line
+      end
+      assert_equal %w[foo barbaz quux], lines
+    end
+
+    test "should return enumerator w/o block" do
+      eacher = subject.each_line
+      assert_instance_of Enumerator, eacher
+      lines = []
+      loop { lines << eacher.next }
+      assert_equal %w[foo barbaz quux], lines
+    end
+
+    test "each_line split by sep_string" do
+      buffer = StringIO.new
+      Snappy::Hadoop::Writer.new buffer do |w|
+        w << %w[a b c].join(",")
+        w.dump!
+        w << %w[d e f].join(",")
+      end
+      buffer.rewind
+      reader = Snappy::Hadoop::Reader.new buffer
+      eacher = reader.each_line(",")
+      lines = []
+      loop { lines << eacher.next }
+      assert_equal %w[a b cd e f], lines
+    end
+  end
+end