slow_enumerator_tools 1.0.0a1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33dc358ef4d7c116477605b28b24a83c6a9f902a
-  data.tar.gz: 91ac07dd9c7f7ed253c80aa3a638ba600cb2c0a0
+  metadata.gz: 5cecaee8660e212274a61072f434341d20318afd
+  data.tar.gz: 953e06c5e5beb1bca606f7a6c95ab399d7967a46
 SHA512:
-  metadata.gz: 395e9429d2ddddf3367cb2ff35d64b1f0d5456ffad14f7c41e0679206c9c4a85fb7a46b93af08d14088755c22cd693d8c0b7b302f59c2e2c7e852615a0828685
-  data.tar.gz: 92b0eaf5eef204f3612f1069e8c8c7facdbcb6f468b542a9516d0042c5d84dd22f84b203e8e525a2434caf34db84e07d3ca3726526bc52622fcbf48fd63af8e8
+  metadata.gz: e41bd66e2621550a7132d7b8e4f092a713cc6cab2cae3d29e4cd9b0f230d03bd914e5396bc5cfd070b446c06a37dafaa29dab322175234ee0221f68769171542
+  data.tar.gz: ed7b14c899dba6e8c9ccc5b1142017f69b37bc5271867299ea06822a453fd0c4b111ca8141ae7b6db5c1844d87eb91a472b84f9c080e970e85a4f068fbb8ee55

data/.rubocop.yml

@@ -56,3 +56,7 @@ Metrics/PerceivedComplexity:
 # It does not make sense to enforce everything to have documentation.
 Style/Documentation:
   Enabled: false
+
+# This does not always make sense
+Style/GuardClause:
+  Enabled: false

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :devel do
+  gem 'codecov', require: false
   gem 'fuubar'
   gem 'pry'
   gem 'rake'

data/NEWS.md

@@ -1,5 +1,11 @@
 # SlowEnumeratorTools news
 
+## 1.0.0 (2017-10-21)
+
+Changes:
+
+* Renamed buffer to batch
+
 ## 1.0.0a1 (2017-10-08)
 
 Initial release.

data/README.md

@@ -10,7 +10,7 @@ _SlowEnumeratorTools_ provides tools for transforming Ruby enumerators that prod
 
 * `SlowEnumeratorTools.merge`: given a collection of enumerables, creates a new enumerator that yields elements from any of these enumerables as soon as they become available.
 
-* `SlowEnumeratorTools.buffer`: given an enumerable, creates a new enumerable that yields batches containing all elements currently available.
+* `SlowEnumeratorTools.batch`: given an enumerable, creates a new enumerable that yields batches containing all elements currently available.
 
 ## Installation
 
@@ -68,7 +68,7 @@ Example output:
 [:a, 4]
 ```
 
-### `SlowEnumeratorTools.buffer`
+### `SlowEnumeratorTools.batch`
 
 Given an enumerable, creates a new enumerable that yields batches containing all elements currently available.
 
@@ -78,21 +78,21 @@ This is useful for fetching all outstanding events on an event stream, without b
 # Generate a slow enum
 enum = 4.times.lazy.map { |i| sleep(0.1); i }
 
-# Buffer
-buffer_enum = SlowEnumeratorTools.buffer(enum)
+# Batch
+batch_enum = SlowEnumeratorTools.batch(enum)
 
 # Wait until first batch is available
 # … prints [0]
-p buffer_enum.next
+p batch_enum.next
 
 # Give it enough time for the second batch to have accumulated more elements,
 # … prints [1, 2]
 sleep 0.25
-p buffer_enum.next
+p batch_enum.next
 
 # Wait until final batch is available
 # … prints [3]
-p buffer_enum.next
+p batch_enum.next
 ```
 
 ## Development

data/lib/slow_enumerator_tools.rb

@@ -5,11 +5,11 @@ module SlowEnumeratorTools
     SlowEnumeratorTools::Merger.merge(es)
   end
 
-  def self.buffer(es)
-    SlowEnumeratorTools::Bufferer.buffer(es)
+  def self.batch(es)
+    SlowEnumeratorTools::Batcher.batch(es)
   end
 end
 
 require_relative 'slow_enumerator_tools/version'
-require_relative 'slow_enumerator_tools/bufferer'
+require_relative 'slow_enumerator_tools/batcher'
 require_relative 'slow_enumerator_tools/merger'

data/lib/slow_enumerator_tools/{bufferer.rb → batcher.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module SlowEnumeratorTools
-  module Bufferer
-    def self.buffer(enum)
+  module Batcher
+    def self.batch(enum)
       q = Queue.new
       stop = Object.new
 

data/lib/slow_enumerator_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SlowEnumeratorTools
-  VERSION = '1.0.0a1'
+  VERSION = '1.0.0'
 end

data/scripts/release

@@ -10,7 +10,7 @@ def run(*args)
   print 'Is this correct? [y/N] '
   res = gets
   unless res.strip.casecmp('y').zero?
-    $stderr.puts 'Answer was not Y; release aborted.'
+    warn 'Answer was not Y; release aborted.'
     exit 1
   end
 
@@ -20,7 +20,7 @@ def run(*args)
   print 'Continue? [y/N] '
   res = gets
   unless res.strip.casecmp('y').zero?
-    $stderr.puts 'Answer was not Y; release aborted.'
+    warn 'Answer was not Y; release aborted.'
     exit 1
   end
 end
@@ -38,7 +38,7 @@ puts
 
 puts '=== Verifying presence of release date…'
 unless File.readlines('NEWS.md').drop(2).first =~ / \(\d{4}-\d{2}-\d{2}\)$/
-  $stderr.puts 'No proper release date found!'
+  warn 'No proper release date found!'
   exit 1
 end
 puts
@@ -56,8 +56,8 @@ puts '=== Verifying that release does not yet exist…'
 releases = client.releases('ddfreyne/slow_enumerator_tools')
 release = releases.find { |r| r.tag_name == SlowEnumeratorTools::VERSION }
 if release
-  $stderr.puts 'Release already exists!'
-  $stderr.puts 'ABORTED!'
+  warn 'Release already exists!'
+  warn 'ABORTED!'
   exit 1
 end
 puts

data/spec/{bufferer_spec.rb → batcher_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe SlowEnumeratorTools::Bufferer do
+describe SlowEnumeratorTools::Batcher do
   let(:wrapped) do
     Enumerator.new do |y|
       5.times do |i|
@@ -11,7 +11,7 @@ describe SlowEnumeratorTools::Bufferer do
   end
 
   subject do
-    described_class.buffer(wrapped)
+    described_class.batch(wrapped)
   end
 
   example do

data/spec/slow_enumerator_tools_spec.rb

@@ -10,8 +10,8 @@ describe SlowEnumeratorTools do
       .to match_array([1, 2, 3, 4])
   end
 
-  it 'supports .buffer shorthand' do
-    expect(SlowEnumeratorTools.buffer([1, 2]).to_a)
+  it 'supports .batch shorthand' do
+    expect(SlowEnumeratorTools.batch([1, 2]).to_a)
       .to match_array([[1, 2]])
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
 require 'slow_enumerator_tools'
 
 require 'fuubar'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slow_enumerator_tools
 version: !ruby/object:Gem::Version
-  version: 1.0.0a1
+  version: 1.0.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2017-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,12 +42,12 @@ files:
 - README.md
 - Rakefile
 - lib/slow_enumerator_tools.rb
-- lib/slow_enumerator_tools/bufferer.rb
+- lib/slow_enumerator_tools/batcher.rb
 - lib/slow_enumerator_tools/merger.rb
 - lib/slow_enumerator_tools/version.rb
 - scripts/release
 - slow_enumerator_tools.gemspec
-- spec/bufferer_spec.rb
+- spec/batcher_spec.rb
 - spec/merger_spec.rb
 - spec/slow_enumerator_tools_spec.rb
 - spec/spec_helper.rb
@@ -66,12 +66,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: provides tools for transforming Ruby enumerators that produce data slowly