piperator 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c2413016f50d1f376666a3997bb0419fd3bbe0311913c9b2d694ab80b47083
-  data.tar.gz: 5b452fb6d8bc029accb4c32cd5b692d377ead539cc164dd65f6aba4715d51c75
+  metadata.gz: 9269910cd3b64e1184e36d5569a356820a72faac26c3a06dc8fc2e5e5542c6ae
+  data.tar.gz: 5a38bc706afb02a408ff6e45a5dd991a05185b8e2c93025cab42f720bda636cb
 SHA512:
-  metadata.gz: '07794c6e1760367b51fab0667afac9275fa61c81d34e1de3b1d68be245246a04d0040869e6e27f49e7d2de90057e0edddd3ab9bcba0cb0620fd4d61ac3112d7e'
-  data.tar.gz: 372fc0fb1fc79832d312bf661019ff6f4203c702a139a3c3fe03ab8f8b2636826ade5a20fa60e288580177ae58f812320e6419ab341d9ac2bb80c51e9fa599d9
+  metadata.gz: 06e1e83db7fd2e8bdb6fa699168f034a97ae83fecb07f694b027f9c87c504bf934e83d08384f9201b0d5111be6d2a4bb1ca4a9567fc49e2359d5b1bc5cb4db01
+  data.tar.gz: 7896a21f84da09fc97b66ccb35f384fe872e1ffcca98033c388154a809560c34ac83f9ae97d8accb67fa1ebcb9d119c8c8d8550b00be2d77caf1809fb8cac6db

data/.codecov.yaml

@@ -0,0 +1,7 @@
+comment: false
+
+coverage:
+  status:
+    project:
+      default:
+        only_pulls: true

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: >-
+      Test (${{ matrix.os }} ${{ matrix.ruby }})
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos, windows]
+        ruby:
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - jruby
+          - truffleruby
+        exclude:
+          - os: windows
+            ruby: jruby
+          - os: windows
+            ruby: truffleruby
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v2
+        if: ${{ matrix.os == 'ubuntu' && matrix.ruby == '3.0' }}
+        with:
+          file: ./coverage/coverage.xml
+          fail_ci_if_error: true

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in piperator.gemspec
 gemspec
+
+if RUBY_VERSION >= '2.5'
+  gem 'simplecov', '~> 0.21.2', group: [:development]
+  gem 'simplecov-cobertura', '~> 2.1.0', group: [:development]
+end

data/README.md

@@ -2,9 +2,7 @@
 
 Pipelines for streaming large collections. The pipeline enables composition of streaming pipelines with lazy enumerables.
 
-The library is heavily inspired by [Elixir pipe operator](https://elixirschool.com/lessons/basics/pipe-operator/) and [Node.js Stream](https://nodejs.org/api/stream.html).
-
-[![Build Status](https://travis-ci.org/lautis/piperator.svg?branch=master)](https://travis-ci.org/lautis/piperator)
+The library is heavily inspired by [Elixir pipe operator](https://elixirschool.com/en/lessons/basics/pipe-operator/) and [Node.js Stream](https://nodejs.org/api/stream.html).
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -69,6 +67,18 @@ Piperator.
 # => 18
 ```
 
+Have reasons to defer constructing a pipe? Evaluate it lazily:
+
+```ruby
+summing = ->(values) { values.sum }
+Piperator.build
+  pipe(->(values) { values.lazy.map { |i| i * 3 } })
+  lazy do
+    summing
+  end
+end.call([1, 2, 3])
+```
+
 There is, of course, a much more idiomatic alternative in Ruby:
 
 ```ruby

data/lib/piperator/builder.rb

@@ -16,11 +16,12 @@ module Piperator
     #
     #   @see Pipeline.$1
     def self.dsl_method(method_name)
-      define_method(method_name) do |*arguments|
-        @pipeline = @pipeline.send(method_name, *arguments)
+      define_method(method_name) do |*arguments, &block|
+        @pipeline = @pipeline.send(method_name, *arguments, &block)
       end
     end
 
+    dsl_method :lazy
     dsl_method :pipe
     dsl_method :wrap
 

data/lib/piperator/io.rb

@@ -62,14 +62,15 @@ module Piperator
     # Reads length bytes from the I/O stream.
     #
     # @param length [Integer] number of bytes to read
+    # @param buffer [String] optional read buffer
     # @return String
-    def read(length = nil)
+    def read(length = nil, buffer = nil)
       return @enumerator.next.tap { |e| @pos += e.bytesize } if length.nil? && readable_bytes.zero?
       @buffer.write(@enumerator.next) while !@eof && readable_bytes < (length || 1)
-      read_with { @buffer.read(length) }
+      read_with { @buffer.read(length, buffer) }
     rescue StopIteration
       @eof = true
-      read_with { @buffer.read(length) } if readable_bytes > 0
+      read_with { @buffer.read(length, buffer) } if readable_bytes > 0
     end
 
     # Current buffer size - including non-freed read content

data/lib/piperator/pipeline.rb

@@ -6,6 +6,16 @@ module Piperator
   # For streaming purposes, it usually is desirable to have pipes that takes
   # a lazy Enumerator as an argument a return a (modified) lazy Enumerator.
   class Pipeline
+    # Build a new pipeline from a lazily evaluated callable or an enumerable
+    # object.
+    #
+    # @param block A block returning a callable(enumerable)
+    # @return [Pipeline] A pipeline containing only the lazily evaluated
+    # callable.
+    def self.lazy(&block)
+      Pipeline.new([]).lazy(&block)
+    end
+
     # Build a new pipeline from a callable or an enumerable object
     #
     # @param callable An object responding to call(enumerable)
@@ -59,6 +69,19 @@ module Piperator
       call(enumerable).to_a
     end
 
+    # Add a new lazily evaluated part to the pipeline.
+    #
+    # @param block A block returning a callable(enumerable) to append in
+    # pipeline.
+    # @return [Pipeline] A new pipeline instance
+    def lazy(&block)
+      callable = nil
+      Pipeline.new(@pipes + [lambda do |e|
+        callable ||= block.call
+        callable.call(e)
+      end])
+    end
+
     # Add a new part to the pipeline
     #
     # @param other A pipe to append in pipeline. Responds to #call.

data/lib/piperator/version.rb

@@ -1,4 +1,4 @@
 module Piperator
   # Piperator version
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piperator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ville Lautanala
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2023-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,9 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codecov.yaml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -80,7 +81,7 @@ homepage: https://github.com/lautis/piperator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Composable pipelines for streaming large collections
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-sudo: false
-cache: bundler
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - jruby
-  - truffleruby