ruby-stream-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af76353a382e0c4bc314ff0812d0369c03e34321e2d200b056c38f794df5d2d
-  data.tar.gz: ce869c2f9b0e1ca159ac4334f81c74598bd7c0dc96b3dd9c5eb7942d24f524c0
+  metadata.gz: 13e90c8ce33e8514c95bb829fde6cb17d8a0cea449de2462286cf36e201dadce
+  data.tar.gz: ba63d2d3fa2c1dcf34c12acfff0b2e0d9dd31386e0245468d642d5f8c56dd864
 SHA512:
-  metadata.gz: a06201f56931982cc9b7d53189cf426ab9b410f96102985d9aefaacd7a12f880158bfd93bfa6d18c57d0f9caab3cccfc74a3bcf86bfbb00ea08cd282dccc64d2
-  data.tar.gz: 3b53ab001a35f9d9f33584ac7a4d5663b554a48e196fff4ede0452ba58adb9e6f59ca684f84d8568cf14b3a1643b1a8c9c44821addbb7df1997e810c44f748f8
+  metadata.gz: 2312cb8ed1c8746af6ddd5eb099591e47b2a7a35b3dd6e064acde06bc830ca2f741a2ca3cf22d99194734889a7285e125299cbd32ee7938897879600c18c4afd
+  data.tar.gz: 63872e2f76fabdd64308459ce20aaf667625aed87caaf6338cf56f40da9f097928343ea33abdb3af236a25a76ef45aebcce687c6b4f4898de1ea9ae8a5ec1a07

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-stream-api (0.0.1.pre.SNAPSHOT)
+    ruby-stream-api (0.0.2.pre.SNAPSHOT)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,6 @@
 # Ruby Stream API
 
+[![Gem Version](https://badge.fury.io/rb/ruby-stream-api.svg)](https://badge.fury.io/rb/ruby-stream-api)
 [![Build Status](https://travis-ci.org/ruby-ee/ruby-stream-api.svg?branch=master)](https://travis-ci.org/ruby-ee/ruby-stream-api)
 [![Test Coverage](https://img.shields.io/codecov/c/github/ruby-ee/ruby-stream-api.svg)](https://codecov.io/github/ruby-ee/ruby-stream-api?branch=master)
 
@@ -13,19 +14,48 @@ operations to modify and/or get information about the collection. The operations
 * **Intermediate** operations (skip, filter, map etc) -- operations which are altering the Stream and still leave it open for further modifications.
 * **Terminal** operations (count, collect etc) -- operations which are executed after all the modifications have been done and are returning a finite result.
 
-First glance (finite Stream from an array):
+First glance: 
+
+1) **Finite** Stream from an array:
 
 ```ruby
-array = [1, 2, 2, 2, 3, 3, 4, 5]
-stream = Stream::FromArray(array)
+array = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+stream = Stream::FromArray.new(array)
 collected = stream
-    .distinct()
+    .filter { |num| num % 2 == 0 }
     .skip(2)
     .collect
-puts collected # [3, 4, 5]
+puts collected # [6, 8, 10]
+```
+
+2) Generate a (potentially) **infinite** stream:
+
+```ruby
+stream = Stream.generate(150) { &seed }
 ```
 
-More info and examples soon.
+The ``generate`` method takes a ``limit`` (max number of elements) and a ``&seed`` Block function which
+returns a new element at each ``seed.call``. A limit is necessary as, without it, this Stream would be infinite.
+If no limit is specified, the default is ``100`` elements.
+
+This mechanism is useful, for instance, when you have to consume an incomming stream of objects from some ``IO`` objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'ruby-stream-api'
+```
+
+Or install it as a separate gem:
+```bash
+$gem install ruby-stream-api
+```
+
+To require it inside your Ruby program do:
+```ruby
+require 'stream'
+```
 
 ## Not a Mixin
 

data/lib/fromarray.rb

@@ -26,12 +26,14 @@ module Stream
   # A stream implemented based on an Array.
   # This class is immutable and thread-safe.
   # Author:: Mihai Andronache (amihaiemil@gmail.com)
+  # Since:: 0.0.1
   class FromArray
     def initialize(array)
       @array = array
     end
 
     # Return the number of elements in this stream.
+    # This is a terminal operation.
     def count
       @array.length
     end
@@ -43,6 +45,7 @@ module Stream
     # collected = stream.filter {|num| num % 2 == 0}.collect
     # puts collected # [2, 4]
     #
+    # This is an intermediary operation.
     # +condition+:: Ruby Block taking one parameter (the stream element) and
     #               returning a boolean check on it.
     def filter(&condition)
@@ -60,6 +63,7 @@ module Stream
     # collected = stream.map {|num| num.to_s}.collect
     # puts collected # ['1', '2', '3']
     #
+    # This is an intermediary operation.
     # +function+:: Ruby Block function taking one parameter
     #              (the element in the stream).
     def map(&function)
@@ -70,7 +74,18 @@ module Stream
       FromArray.new(mapped)
     end
 
+    # Remove all the duplicates from the stream.
+    # This is an intermediary operation.
+    def distinct
+      unique = []
+      @array.each do |val|
+        unique.push(val) unless unique.include? val
+      end
+      FromArray.new(unique)
+    end
+
     # Skip the first n elements of the stream.
+    # This is an intermediary operation.
     # +count+:: Number of elements to skip from the beginning of the stream.
     def skip(count)
       raise ArgumentError, 'count has to be positive integer' unless count.positive? and count.is_a? Integer
@@ -82,7 +97,43 @@ module Stream
       FromArray.new(skipped)
     end
 
+    # Returns true if all the elements of the Stream are matching the
+    # given predicate (a function which performs a test on the value and
+    # should return a boolean).
+    #
+    # If the stream is empty, the returned value is true and the predicate
+    # is not called at all.
+    #
+    # This is a terminal operation.
+    # +test+:: A function which should perform some boolean test on the
+    #  given value.
+    def all_match(&test)
+      @array.each do |val|
+        return false unless test.call(val)
+      end
+      true
+    end
+
+    # Returns true if any of the elements of the Stream are matching
+    # the given predicate (a function which performs a test on the value and
+    # should return a boolean). Iteration will stop at the first match.
+    #
+    # If the stream is empty, the returned value is false and the predicate
+    # is not called at all.
+    #
+    # This is a terminal operation.
+    #
+    # +test+:: A function which should perform some boolean test on the
+    #  given value.
+    def any_match(&test)
+      @array.each do |val|
+        return true if test.call(val)
+      end
+      false
+    end
+
     # Collect the stream's data into an array and return it.
+    # This is a terminal operation.
     def collect
       @array.dup
     end

data/lib/version.rb

@@ -23,5 +23,5 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module Stream
-  VERSION = '0.0.1'.freeze # rultor
+  VERSION = '0.0.2'.freeze # rultor
 end

data/release.sh

@@ -29,6 +29,7 @@ gem push *.gem --config-file /home/r/rubygems.yml
 
 # set next dev version in version.rb
 sed -i "s/'${tag}'.freeze # rultor/'${NEXT_VERSION}'.freeze # rultor/" ./lib/version.rb
+bundle install
 
 git commit -am "${NEXT_VERSION}"
 git checkout master

data/ruby-stream-api.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ruby-ee/ruby-stream-api"
-  spec.metadata["changelog_uri"] = "https://github.com/ruby-ee/ruby-stream-api"
+  spec.metadata["changelog_uri"] = "https://github.com/ruby-ee/ruby-stream-api/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-stream-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - amihaiemil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies: []
 description: Stream API for Ruby, inspired by Java 8's Stream API
 email:
@@ -40,7 +40,7 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/ruby-ee/ruby-stream-api
   source_code_uri: https://github.com/ruby-ee/ruby-stream-api
-  changelog_uri: https://github.com/ruby-ee/ruby-stream-api
+  changelog_uri: https://github.com/ruby-ee/ruby-stream-api/releases
 post_install_message: 
 rdoc_options: []
 require_paths: