ddbuffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 574fdd8a2e913618eb41f95db6ea7d3eaf16ee46
+  data.tar.gz: c013a57234f5dc71e365a4e228056504d78b7502
+SHA512:
+  metadata.gz: cfb8bcd4801d0dd214037d85d470d35be418eabe1b115305c16a75c565e64b8bae2db7d34453278fd62c63f657b0e28bcf2cd012229e800ce21dff3da653beb3
+  data.tar.gz: 1de6bfb037df2cb87f47b4df54c30cab9c555a5d163f1658d3a283cecceda8c786c54d736203ff67480d79406a90d0ad34bff5ae7e67245a52348199af8f5075

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+-r ./spec/spec_helper.rb
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,64 @@
+# ----- CONFIGURED -----
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+
+
+# ----- DISABLED (metrics) -----
+
+# Cops for metrics are disabled because they should not cause tests to fail.
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+
+
+# ----- DISABLED (opinionated) -----
+
+# We should embrace UTF-8, not avoid it. Since the Encoding cop is enabled,
+# there’s no point in enforcing ASCII comments.
+AsciiComments:
+  Enabled: false
+
+# It does not make sense to enforce everything to have documentation.
+Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+# This does not always semantically make sense.
+GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at denis.defreyne@stoneship.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'fuubar'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Denis Defreyne
+
+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,49 @@
+# DDBuffer
+
+Provides a way to buffer Ruby enumerables/enumerators.
+
+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:
+
+```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
+```
+
+## Usage
+
+To install, add the `ddbuffer` gem to your Gemfile, and run `bundle`.
+
+To buffer an enumerable `enum` with a buffer size of `size`:
+
+```ruby
+buffered_enum = DDBuffer.new(size).call(enum)
+```
+
+## Development
+
+To run the tests:
+
+```
+bundle install
+bundle exec rake
+```
+
+## 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/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'rake/testtask'
+
+RuboCop::RakeTask.new(:rubocop)
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+task test: %i[spec rubocop]
+
+task default: :test

data/ddbuffer.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ddbuffer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ddbuffer'
+  spec.version       = DDBuffer::VERSION
+  spec.authors       = ['Denis Defreyne']
+  spec.email         = ['denis.defreyne@stoneship.org']
+
+  spec.summary       = 'Buffer enumerables'
+  spec.homepage      = 'https://github.com/ddfreyne/ddbuffer'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+end

data/lib/ddbuffer/version.rb

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

data/lib/ddbuffer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+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 => 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
+
+  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)
+  end
+end

data/spec/ddbuffer_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe DDBuffer do
+  it 'has a version number' do
+    expect(DDBuffer::VERSION).not_to be nil
+  end
+
+  describe '.new + #call' do
+    subject { described_class.new(size).call(enum) }
+
+    let(:enum) { [] }
+    let(:size) { 10 }
+
+    context 'empty array' do
+      example do
+        expect(subject.to_a).to eq([])
+      end
+    end
+
+    context 'small array' do
+      let(:enum) { [1, 2, 3] }
+
+      example do
+        expect(subject.to_a).to eq([1, 2, 3])
+      end
+    end
+
+    context 'infinite array' do
+      let(:enum) { (1..(1.0 / 0)) }
+
+      example do
+        expect(subject.take(3).to_a).to eq([1, 2, 3])
+      end
+    end
+
+    context 'error in taken elements' do
+      let(:enum) do
+        Enumerator.new do |y|
+          y << 1
+          y << 2
+          raise 'boom'
+        end
+      end
+
+      it 'does not raise right away' do
+        subject
+      end
+
+      it 'does not raise when only taken' do
+        subject.take(3)
+      end
+
+      it 'raises when evaluated' do
+        expect { subject.take(3).to_a }
+          .to raise_error(RuntimeError, 'boom')
+      end
+    end
+
+    context 'error past taken elements' do
+      let(:enum) do
+        Enumerator.new do |y|
+          y << 1
+          y << 2
+          y << 3
+          raise 'boom'
+        end
+      end
+
+      it 'does not raise right away' do
+        subject
+      end
+
+      it 'does not raise when only taken' do
+        subject.take(3)
+      end
+
+      it 'does not raise when evaluated' do
+        expect(subject.take(3).to_a).to eq([1, 2, 3])
+      end
+    end
+
+    context 'slow source' do
+      let(:enum) do
+        Enumerator.new do |y|
+          20.times do |i|
+            y << i
+            sleep 0.1
+          end
+        end
+      end
+
+      it 'takes a while to take elements when unbuffered' do
+        expect { subject.take(5).to_a }
+          .to finish_in(0.5, 0.1)
+      end
+
+      it 'takes no time to take elements when buffered' do
+        subject
+        sleep 0.5
+        expect { subject.take(5).to_a }
+          .to finish_in(0.0, 0.1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'ddbuffer'
+
+require 'fuubar'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.fuubar_progress_bar_options = {
+    format: '%c/%C |<%b>%i| %p%%',
+  }
+end
+
+RSpec::Matchers.define :finish_in do |expected, delta|
+  supports_block_expectations
+
+  match do |actual|
+    before = Time.now
+    actual.call
+    after = Time.now
+    @actual_duration = after - before
+    range = (expected - delta..expected + delta)
+    range.include?(@actual_duration)
+  end
+
+  failure_message do |_actual|
+    "expected that proc would finish in #{expected}s (±#{delta}s), but took #{format '%0.1fs', @actual_duration}"
+  end
+
+  failure_message_when_negated do |_actual|
+    "expected that proc would not finish in #{expected}s (±#{delta}s), but took #{format '%0.1fs', @actual_duration}"
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: ddbuffer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Defreyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: 
+email:
+- denis.defreyne@stoneship.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ddbuffer.gemspec
+- lib/ddbuffer.rb
+- lib/ddbuffer/version.rb
+- spec/ddbuffer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ddfreyne/ddbuffer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Buffer enumerables
+test_files: []