obuf 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc239f32a9cde898a530806bbbb6906b17776b8f0b07fe7e4eec030faec31437
+  data.tar.gz: e9027146f1aada7f15f56f1cd70e31183e0394983352e1dc8790b67ae1b89a9b
+SHA512:
+  metadata.gz: eadd96014ba7b94ecce3ee76a68184e41b49028bc0c78b35e346f76c1c7ee80945633411109b01c020d9b38ef10de004a5be3ed2a6f21e967e0b8047a0ba48e0
+  data.tar.gz: 759e120b23fbd309812f4c8e93ca73a082249c1a9f5de6d6fd5c6123574a267b264c0d425c3d1e90e6c86c387eb95a5d1d550e8c28a2ae09734775f6e55c504e

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.3.0 / 2026-10-02
+
+* Make Obuf usable from within Ractors (Ruby 4.0+)
+* Replace Jeweler with a plain gemspec
+
 === 1.2.0 / 2015-04-17
 
 * Add Obuf::Lens to provide access to externally managed IO objects and files

data/README.md

@@ -1,5 +1,7 @@
 # obuf
 
+[![Build Status](https://travis-ci.org/julik/obuf.svg?branch=master)](https://travis-ci.org/julik/obuf)
+
 A simple Ruby object buffer. Use this if you need to temporarily store alot of serializable Ruby objects.
 
     obuf = Obuf.new

data/lib/obuf/lens.rb

@@ -1,8 +1,10 @@
+# shareable_constant_value: literal
 require 'thread'
 
 # Provides a per-object iterator on top of any IO object or pipe
 class Obuf::Lens
   include Enumerable
+  NothingToRecover = Class.new(StandardError)
   
   DELIM = "\t"
   END_RECORD = "\n"
@@ -32,7 +34,10 @@ class Obuf::Lens
       skip_bytes = @io.gets("\t").to_i
       @io.seek(@io.pos + skip_bytes + 1)
     end
+    
     recover_object
+  rescue NothingToRecover # TODO: we need to honor this exception in the future
+    nil
   end
   
   # Recover the object at the current position in the IO. Returns +nil+
@@ -42,14 +47,17 @@ class Obuf::Lens
     demarshal_bytes = @io.gets("\t").to_i
     
     # When at end of IO return nil
-    return nil if demarshal_bytes == 0
+    raise NothingToRecover if demarshal_bytes.zero?
     
     blob = @io.read(demarshal_bytes)
     demarshal_object(blob)
   end
   
   def each
-    yield(recover_object) until @io.eof?
+    begin
+      loop { yield(recover_object) }
+    rescue NothingToRecover
+    end
   end
   
   private

data/lib/obuf.rb

@@ -19,7 +19,7 @@ require "thread" # required for ruby 18
 #
 # Both reading and writing aim to be threadsafe
 class Obuf
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
   require File.dirname(__FILE__) + "/obuf/lens"
   require File.dirname(__FILE__) + "/obuf/protected_lens"
   

metadata

@@ -1,80 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: obuf
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Julik Tarkhanov
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flexmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: flexmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
 description: Stores marshaled temporary objects on-disk in a simple Enumerable
 email: me@julik.nl
 executables: []
@@ -82,43 +72,30 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .autotest
-- .travis.yml
-- Gemfile
 - History.txt
 - README.md
-- Rakefile
 - lib/obuf.rb
 - lib/obuf/lens.rb
 - lib/obuf/protected_lens.rb
-- obuf.gemspec
-- test/test_obuf.rb
-homepage: http://github.com/julik/obuf
+homepage: https://github.com/julik/obuf
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 4056659205467737583
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23.2
-signing_key: 
-specification_version: 3
+rubygems_version: 4.0.3
+specification_version: 4
 summary: Ruby disk-backed object buffer
 test_files: []

data/.autotest

@@ -1,23 +0,0 @@
-# -*- ruby -*-
-
-require 'autotest/restart'
-
-# Autotest.add_hook :initialize do |at|
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception 'vendor'
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/.travis.yml

@@ -1,8 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.2.0
-  - jruby
-  - ruby-head

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-group :development do
-  gem "bundler"
-  gem "flexmock", "~>0.8"
-  gem "rake"
-  gem "jeweler", '1.8.4' # Last one without the stupid nokogiri dependency
-end

data/Rakefile

@@ -1,27 +0,0 @@
-# -*- ruby -*-
-require 'rubygems'
-require 'jeweler'
-require './lib/obuf'
-
-Jeweler::Tasks.new do |gem|
-  gem.version = Obuf::VERSION
-  gem.name = "obuf"
-  gem.summary = "Ruby disk-backed object buffer"
-  gem.description = "Stores marshaled temporary objects on-disk in a simple Enumerable"
-  gem.email = "me@julik.nl"
-  gem.homepage = "http://github.com/julik/obuf"
-  gem.authors = ["Julik Tarkhanov"]
-  gem.license = 'MIT'
-end
-
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-desc "Run all tests"
-Rake::TestTask.new("test") do |t|
-  t.libs << "test"
-  t.pattern = 'test/**/test_*.rb'
-  t.verbose = true
-end
-
-task :default => [ :test ]

data/obuf.gemspec

@@ -1,58 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = "obuf"
-  s.version = "1.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Julik Tarkhanov"]
-  s.date = "2015-04-17"
-  s.description = "Stores marshaled temporary objects on-disk in a simple Enumerable"
-  s.email = "me@julik.nl"
-  s.extra_rdoc_files = [
-    "README.md"
-  ]
-  s.files = [
-    ".autotest",
-    ".travis.yml",
-    "Gemfile",
-    "History.txt",
-    "README.md",
-    "Rakefile",
-    "lib/obuf.rb",
-    "lib/obuf/lens.rb",
-    "lib/obuf/protected_lens.rb",
-    "obuf.gemspec",
-    "test/test_obuf.rb"
-  ]
-  s.homepage = "http://github.com/julik/obuf"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23.2"
-  s.summary = "Ruby disk-backed object buffer"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<flexmock>, ["~> 0.8"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["= 1.8.4"])
-    else
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<flexmock>, ["~> 0.8"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["= 1.8.4"])
-    end
-  else
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<flexmock>, ["~> 0.8"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["= 1.8.4"])
-  end
-end
-

data/test/test_obuf.rb

@@ -1,184 +0,0 @@
-require "test/unit"
-require "obuf"
-require "flexmock"
-require "flexmock/test_unit"
-require "stringio"
-
-# We are limited to flexmock 0.8 on Ruby 1.8
-# http://redmine.ruby-lang.org/issues/4882
-# https://github.com/jimweirich/flexmock/issues/4
-# https://github.com/julik/flexmock/commit/4acea00677e7b558bd564ec7c7630f0b27d368ca
-class FlexMock::PartialMockProxy
-  def singleton?(method_name)
-    @obj.singleton_methods.include?(method_name.to_s)
-  end
-end
-
-class TestObuf < Test::Unit::TestCase
-  
-  def test_accumulator_saves_objs
-    a = Obuf.new
-    values = [3, {:foo => "bar"}, "foo"]
-    values.map(&a.method(:push))
-    
-    assert_equal 3, a.size
-    assert_equal values, a.map{|e| e }, "Should return the same elements from the storage"
-  end
-  
-  def test_initialize_with_block
-    o = Obuf.new do | buf |
-      buf.push("Excitement!")
-    end
-    
-    assert_equal 1, o.size
-    assert_equal %w( Excitement! ), o.to_a
-  end
-   
-  def test_from_enum
-    a = Obuf.new([1,2,3])
-    assert_equal [1,2,3], a.to_a
-  end
-  
-  def test_accumulator_saves_shitload_of_objs
-    a = Obuf.new
-    50_000.times { a.push("A string" => rand) }
-    assert_equal 50_000, a.size
-  end
-  
-  def test_accumulator_saves_few_strings_with_a_tab
-    a = Obuf.new
-    4.times { a.push("A \tstring") }
-    a.each {|e| assert_equal "A \tstring", e }
-  end
-  
-  def test_accumulator_empty
-    a = Obuf.new
-    assert a.empty?
-    a.push(1)
-    assert !a.empty?
-  end
-  
-  def test_accumulator_supports_nested_iteration
-    a = Obuf.new
-    ("A".."Z").each{|e| a << e}
-    
-    accumulated = []
-    seen_g = false
-    a.each do | first_level |
-      if first_level == "G"
-        seen_g = true
-        # Force a nested iteration and break it midway
-        a.each do | second_level |
-          accumulated.push(second_level)
-          break if second_level == "E"
-        end
-      elsif seen_g
-        assert_equal "H", first_level
-        return
-      end
-    end
-  end
-  
-  def test_random_access
-    a = Obuf.new
-    letters = ("A".."Z").map{|e| "#{e}\r\nWow!"}.to_a
-    letters.map(&a.method(:push))
-    
-    assert_equal "B\r\nWow!", a[1]
-    assert_equal "E\r\nWow!", a[4]
-  end
-  
-  def test_random_access_out_of_bounds
-    a = Obuf.new
-    letters = ("A".."Z").map{|e| "#{e}\r\nWow!"}.to_a
-    letters.map(&a.method(:push))
-    assert_equal nil, a[27]
-    
-    b = Obuf.new
-    assert_nil b[0]
-    assert_nil b[-1]
-  end
-  
-  def test_clear_calls_close_on_buffer
-    io = Tempfile.new("testing")
-    flexmock(io).should_receive(:close!).once
-    flexmock(Tempfile).should_receive(:new).once.with("obuf").and_return(io)
-    
-    a = Obuf.new
-    40.times { a.push("A string" => rand) }
-    assert_equal 40, a.size
-    a.clear
-    assert_equal 0, a.size
-  end
-end
-
-class TestLens < Test::Unit::TestCase
-  def test_lens_write
-    mock_io = flexmock()
-    lens = Obuf::Lens.new(mock_io)
-    flexmock(mock_io).should_receive(:write){|written|
-      assert_kind_of Fixnum, written
-    }
-    flexmock(mock_io).should_receive(:write).with("\t")
-    flexmock(mock_io).should_receive(:write){|byte_blob|
-      assert_kind_of String, byte_blob
-    }
-    flexmock(mock_io).should_receive(:write).with("\n")
-    lens << "Hi there!"
-  end
-  
-  def test_lens_recover_object_after_write
-    mock_io = StringIO.new
-    lens = Obuf::Lens.new(mock_io)
-    lens << "Hi there!"
-    
-    recovered = lens.recover_object
-    assert_nil recovered, "The IO is at the end now"
-    
-    mock_io.rewind
-    recovered = lens.recover_object
-    assert_equal "Hi there!", recovered
-  end
-  
-  def test_lens_each
-    mock_io = StringIO.new
-    
-    writing_lens = Obuf::Lens.new(mock_io)
-    writing_lens << "Hi there!"
-    writing_lens << 98121
-    writing_lens << [123, :a]
-    
-    mock_io.rewind
-    
-    reading_lens = Obuf::Lens.new(mock_io)
-    items = []
-    reading_lens.each do | item |
-      items << item
-    end
-    
-    assert_equal "Hi there!", items[0]
-    assert_equal 98121, items[1]
-    assert_equal [123, :a], items[2]
-  end
-  
-  def test_lens_recover_at
-    mock_io = StringIO.new
-    
-    writing_lens = Obuf::Lens.new(mock_io)
-    writing_lens << "Hi there!"
-    writing_lens << 98121
-    writing_lens << [123, :a]
-    
-    reading_lens = Obuf::Lens.new(mock_io)
-    # Also try to recover object at index 3, which does not exist in the underlying buffer
-    objects_at_positions = (0..3).to_a.reverse.map do | i |
-      reading_lens.recover_at(i)
-    end
-    
-    assert_nil objects_at_positions[0]
-    assert_equal [123, :a], objects_at_positions[1]
-    assert_equal 98121, objects_at_positions[2]
-    assert_equal "Hi there!", objects_at_positions[3]
-  end
-  
-end