ddbuffer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18a7511205723f69c3f1975f528b5c7c77478cf7
-  data.tar.gz: 4cbd691685cc43fb2f8cd7500647497871224a12
+SHA256:
+  metadata.gz: aaa9bbb025759cb2843a1958a0a145ba5e6fd14970b12077da0eef7bfc0fc7e5
+  data.tar.gz: 29a34a8d792e38b08d23e70b36f4d3f9fff5ae193bf3192c98a35cd943a8cf84
 SHA512:
-  metadata.gz: 4e436cecf19bdd288fa688bacd4b05ff0b46abb7e02c9e1082073102be4c7d516dcfbb584a65f7b455d077206e45febd00f50589fa3879e091ff5aa82c64cc93
-  data.tar.gz: 228c9d71c3aee58d6206cd249a46d844bfeac8385dedf16f1e19b842257497f5c3597233c0f28963900c60bf18b3064fb3d897f2f5f6cbb8ef6720cdd177cbea
+  metadata.gz: 512e43cb24a634a925ad4bcab5f81ecf515025d03b293d642a9bb250981fcafdd2c077f8a558eff1fb373f69d43366fc149e9866ca490452d80802a45f615c71
+  data.tar.gz: c1ef5243c60cecd9de8fe06187fed2678498be28e546828846b571a9db6138c8ce7cd016c87c95c842757f83c2213f91d5e96081805733ed3aaded99900f2d7c

data/NEWS.md

@@ -1,5 +1,9 @@
 # DDBuffer release notes
 
+## 1.0.1 (2017-11-08)
+
+Marked as deprecated in favor of slow_enumerator_tools (https://github.com/ddfreyne/slow_enumerator_tools).
+
 ## 1.0.0 (2017-10-21)
 
 No changes (first stable release).

data/README.md

@@ -1,54 +1,15 @@
-[![Gem version](http://img.shields.io/gem/v/ddbuffer.svg)](http://rubygems.org/gems/ddbuffer)
-[![Build status](http://img.shields.io/travis/ddfreyne/ddbuffer.svg)](https://travis-ci.org/ddfreyne/ddbuffer)
-[![Code Climate](http://img.shields.io/codeclimate/github/ddfreyne/ddbuffer.svg)](https://codeclimate.com/github/ddfreyne/ddbuffer)
-[![Code Coverage](https://img.shields.io/codecov/c/github/ddfreyne/ddbuffer.svg)](https://codecov.io/gh/ddfreyne/ddbuffer)
-
 # DDBuffer
 
-Provides a way to buffer Ruby enumerables/enumerators.
+**Deprecated** in favor of [slow_enumerator_tools](https://github.com/ddfreyne/slow_enumerator_tools).
 
-This is particularly useful when reading from a slow source and reading to a slow sink, because the two will be able to work concurrently. For example:
+Replace
 
 ```ruby
-# Read articles (an Enumerator)
-articles = my_web_service.each_article
-
-# Buffer 100 articles at a time
-articles = DDBuffer.new(100).call(articles)
-
-# Write buffered articles
-articles.each_slice(50) do |slice|
-  my_slow_db.insert_articles(slice)
-end
+DDBuffer.new(size).call(enum)
 ```
 
-## Usage
-
-To install, add the `ddbuffer` gem to your Gemfile, and run `bundle`.
-
-To buffer an enumerable `enum` with a buffer size of `size`:
+with
 
 ```ruby
-buffered_enum = DDBuffer.new(size).call(enum)
-```
-
-## Development
-
-To run the tests:
-
-```
-bundle install
-bundle exec rake
+SlowEnumeratorTools.buffer(enum, size)
 ```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ddfreyne/ddbuffer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the DDBuffer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ddfreyne/ddbuffer/blob/master/CODE_OF_CONDUCT.md).

data/ddbuffer.gemspec

@@ -15,5 +15,6 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0")
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'slow_enumerator_tools', '~> 1.1'
   spec.add_development_dependency 'bundler', '~> 1.15'
 end

data/lib/ddbuffer.rb

@@ -2,48 +2,14 @@
 
 require 'ddbuffer/version'
 
-class DDBuffer
-  module Impl
-    STOP_OK = Object.new
-    STOP_ERR = Object.new
-
-    def self.gen_collector_thread(enum, queue)
-      Thread.new do
-        begin
-          enum.each { |e| queue << e }
-          queue << STOP_OK
-        rescue StandardError => e
-          queue << STOP_ERR
-          queue << e
-        end
-      end
-    end
-
-    def self.gen_enumerator(queue, collector_thread)
-      Enumerator.new do |y|
-        loop do
-          e = queue.pop
-
-          if STOP_OK.equal?(e)
-            break
-          elsif STOP_ERR.equal?(e)
-            raise queue.pop
-          end
-
-          y << e
-        end
-        collector_thread.join
-      end.lazy
-    end
-  end
+require 'slow_enumerator_tools'
 
+class DDBuffer
   def initialize(size)
     @size = size
   end
 
   def call(enum)
-    queue = SizedQueue.new(@size)
-    thread = Impl.gen_collector_thread(enum, queue)
-    Impl.gen_enumerator(queue, thread)
+    SlowEnumeratorTools.buffer(enum, @size)
   end
 end

data/lib/ddbuffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DDBuffer
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ddbuffer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: slow_enumerator_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: Buffer enumerables