stream 0.5.2 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3374a923bc2d44c39ea1c1957d5982b26f55a22ac958cfa119be87a978e17676
-  data.tar.gz: 88b9b768b08a6edf3a689f76f50627784825b15ac1ed07d6b3172bb34ce69fa3
+  metadata.gz: 01b456afc318137cc9291dd8f7ec664dcc6370225c1fb8cf0a223794d1a18cb7
+  data.tar.gz: 19824c0406a4e7b253aa682db312f89fea8a1d0c9bd3a3513d2951ffdc3126b2
 SHA512:
-  metadata.gz: fd0f115fefc0969ccde444c8200d9f279b8d9736af6c91884d89e5fa9dd4a46dccb6b570da4467b7dfaa35e038644b09dbf25348289a66cf0ea919c4c21c732b
-  data.tar.gz: 56d49b892e3355026bb05bd98535471ebfe9e8564f9f1885e43938deda8b7f3e33551fcd15f1b492821944de5707ef296dff3f134812b1f8e904ce0ef8b4f037
+  metadata.gz: c3fdb6526fabfd8ff52d8ea5b195f83a5644515f99444ab589d389ffb08365dea6de40e69e84bd8c9c93155cabcee3fe0a0e2ef0dd1a96403a7dc2035bf80be2
+  data.tar.gz: 95c2179dca08a24eb24f7aa811be95b4bd1c17ea57e41d218ada55783933cdac30eb958ca61a42294bc719097d98327fe846248bf7f88b47272776fbfcddff07

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,32 +1,29 @@
 PATH
   remote: .
   specs:
-    stream (0.5.2)
+    stream (0.5.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    codeclimate-test-reporter (1.0.9)
-      simplecov (<= 0.13)
-    docile (1.1.5)
-    json (2.1.0)
-    power_assert (1.1.3)
-    rake (12.3.2)
-    rdoc (6.1.1)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    test-unit (3.2.9)
+    power_assert (2.0.1)
+    psych (4.0.4)
+      stringio
+    rake (13.0.6)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
+    stringio (3.0.2)
+    test-unit (3.5.3)
       power_assert
-    yard (0.9.16)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
-  codeclimate-test-reporter
   rake
   rdoc
   stream!
@@ -34,4 +31,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.0.1
+   2.3.8

data/LICENSE

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.rdoc

@@ -1,11 +1,12 @@
-{<img src="https://secure.travis-ci.org/monora/stream.png?branch=master" alt="Build Status" />}[https://travis-ci.org/monora/stream]
+{<img src="https://github.com/monora/stream/actions/workflows/ruby.yml/badge.svg" alt="Build Status" />}[https://github.com/monora/stream/actions/workflows/ruby.yml]
 
 = Extended External Iterators (forward and backward)
 
 == Description
 
-Module Stream defines an interface for external iterators. A stream can be
-seen as an iterator on a sequence of objects x1,...,xn. The state of the
+Module +Stream+ defines an interface for {external
+iterators}[https://wiki.c2.com/?ExternalIterator]. A stream can be seen
+as an iterator on a sequence of objects +x1,...,xn+. The state of the
 stream is uniquely determined by the following methods:
 
 * at_beginning?
@@ -20,14 +21,15 @@ State changes are done with the following operations:
 * forward
 * backward
 
-With the help of the method current_edge the state of a stream s can be
+With the help of the method +current_edge+ the state of a stream +s+ can be
 exactly defined
 
  s.current_edge == [s.current, s.peek]
 
-If s a stream on [x1,...,xn]. Consider the edges [xi,xi+1] i=1,...,n and
-[x0,x1] and [xn,xn+1] (x0 and xn+1 are helper elements to define the boundary
-conditions). Then if s is non empty, the following conditions must be true:
+If +s+ a stream on [x1,...,xn]. Consider the edges [xi,xi+1] i=1,...,n
+and [x0,x1] and [xn,xn+1] (x0 and xn+1 are helper elements to define
+the boundary conditions). Then if +s+ is non empty, the following
+conditions must be true:
 
  s.at_beginning? <=> s.current_edge == [x0,x1]
  s.at_end? <=> s.current_edge == [xn,xn+1]
@@ -46,16 +48,18 @@ If 1 <= i < n and s.current_edge == [xi, xi+1] , then:
 The result of peek is the same as of forward without changing state. The result of
 current is the same as of backward without changing state.
 
-Module Stream includes Enumerable implementing #each in the obvious way.
+Module +Stream+ includes +Enumerable+ implementing +each+ in the obvious way.
 
-Not every stream needs to implement #backward and #at_beginning? thus being
-not reversable. If they are reversable peek can easily be implemented using
-forward and backward, as is done in module Stream. If a stream is not
-reversable all derived streams provided by the stream module (filter,
-mapping, concatenation) can be used anyway. Explicit or implicit (via peek or
-current) uses of backward would throw a NotImplementedError.
+Not every stream needs to implement +backward+ and +at_beginning?+
+thus being not reversable. If they are reversable peek can easily be
+implemented using +forward+ and +backward+, as is done in module
++Stream+. If a stream is not reversable all derived streams provided
+by the stream module (filter, mapping, concatenation) can be used
+anyway. Explicit or implicit (via peek or current) uses of backward
+would throw a +NotImplementedError+.
 
-Classes implementing the stream interface must implement the following methods:
+Classes implementing the stream interface must implement the following
+methods:
 
 * basic_forward
 * basic_backward
@@ -63,60 +67,40 @@ Classes implementing the stream interface must implement the following methods:
 * at_end?
 * at_beginning?
 
-The methods set_to_end and set_to_begin are by default implemented as:
+The methods +set_to_end+ and +set_to_begin+ are by default implemented
+as:
 
  set_to_end   :  until at_end?; do basic_forward end
  set_to_begin :  until at_beginning?; do basic_backward end
 
-The methods forward and backward are by default implemented as:
+The methods +forward+ and +backward+ are by default implemented as:
 
- forward:	   raise EndOfStreamException if at_end?; basic_forward.
- backward:   raise EndOfStreamException if at_beginning?; basic_backward
+ forward: raise EndOfStreamException if at_end?; basic_forward.
+ backward: raise EndOfStreamException if at_beginning?; basic_backward
 
 Thus subclasses must only implement *four* methods. Efficiency sometimes
 demands better implementations.
 
 There are several concrete classes implementing the stream interface:
 
-* Stream::EmptyStream (boring)
-* Stream::CollectionStream created by the method Array#create_stream
-* Stream::FilteredStream created by the method Stream#filtered
-* Stream::ReversedStream created by the method Stream#reverse
-* Stream::ConcatenatedStream created by the method Stream#concatenate
-* Stream::ImplicitStream using closures for the basic methods to implement
-
-== Download
-
-The latest version of stream.rb can be found at
-
-* http://github.com/monora/stream
+* +Stream::EmptyStream+ (boring)
+* +Stream::CollectionStream+ created by the method +Array#create_stream+
+* +Stream::FilteredStream+ created by the method +Stream#filtered+
+* +Stream::ReversedStream+ created by the method +Stream#reverse+
+* +Stream::ConcatenatedStream+ created by the method +Stream#concatenate+
+* +Stream::ImplicitStream+ using closures for the basic methods to implement
 
 == Installation
 
-=== Normal Installation
-
-You can install stream with the following command.
-
-  % ruby install.rb
-
-from its distribution directory.
-
-=== GEM Installation
-
-Download the GEM file and install it with ..
-
-   gem -i stream-VERSION.gem
-
-Use the correct version number for VERSION (e.g. 0.5).  You may need
-root privileges to install.
+   gem install stream
 
-== See also
-
-* Streams in Smalltalk: http://wiki.cs.uiuc.edu/PatternStories/FunWithStreams
-* Simon Strandgaards iterator.rb[http://aeditor.rubyforge.org/iterator/files/iterator_rb.html]
+or download the latest sources from the git repository
+https://github.com/monora/stream.
 
 == Examples
 
+=== Iterate over three streams
+
   g = ('a'..'f').create_stream
   h = (1..10).create_stream
   i = (10..20).create_stream
@@ -125,6 +109,17 @@ root privileges to install.
     p [g.forward, h.forward, i.forward]
   end
 
+Output:
+
+  ["a", 1, 10]
+  ["b", 2, 11]
+  ["c", 3, 12]
+  ["d", 4, 13]
+  ["e", 5, 14]
+  ["f", 6, 15]
+
+=== Concatenate file streams
+
   def filestream fname
     Stream::ImplicitStream.new { |s|
       f = open(fname)
@@ -138,7 +133,7 @@ root privileges to install.
     puts l
   end
 
-  puts "\nTwo filtered collection streams concatenated and reversed:\n\n"
+=== Two filtered collection streams concatenated and reversed
 
   def newstream; (1..6).create_stream; end
   s = newstream.filtered { |x| x % 2 == 0 } + newstream.filtered { |x| x % 2 != 0 }
@@ -150,9 +145,21 @@ root privileges to install.
   puts "Forward       : #{s.forward}"
   puts "Peek          : #{s.peek}"
   puts "Current       : #{s.current}"
-  puts "set_to_begin    : Peek=#{s.set_to_begin;s.peek}"
+  puts "set_to_begin  : Peek=#{s.set_to_begin;s.peek}"
+
+Output:
+
+  Contents      : 5 3 1 6 4 2
+  At end?       : true
+  At beginning? : false
+  2xBackwards   : 2 4
+  Forward       : 4
+  Peek          : 2
+  Current       : 4
+  set_to_begin  : Peek=5
+
+=== An infinite stream (do not use +set_to_end+!)
 
-  # an infinite stream (do not use set_to_end!)
   def randomStream
     Stream::ImplicitStream.new { |s|
       s.set_to_begin_proc = proc {srand 1234}
@@ -160,13 +167,14 @@ root privileges to install.
       s.forward_proc = proc {rand}
     }
   end
-  s = randomStream.filtered { |x| x >= 0.5 }.collect { |x| sprintf("%5.2f ",x*100) }
-  puts "5 random numbers: #{(1..5).collect {|x| s.forward}}\n" # =>
+  s = randomStream.filtered { |x| x >= 0.5 }.collect { |x| sprintf("%5.2f",x*100) }
+  puts "5 random numbers: #{(1..5).collect {|x| s.forward}}\n"
+
+Output:
 
-    5 random numbers: 74.05 94.80 87.87 86.07 83.70
+  5 random numbers: ["62.21", "78.54", "78.00", "80.19", "95.81"]
 
-== Other Stuff
+== License
 
 Author:: Horst Duchene
-License:: Copyright (c) 2001, 2013, 2016 Horst Duchene
-Released under the same license as Ruby
+License:: Copyright (c) 2001, 2013, 2016, 2020, 2022 Horst Duchene (Released under the same license as Ruby (see LICENSE))

data/Rakefile

@@ -21,8 +21,8 @@ task :default => :test
 # Define a test task.
 
 Rake::TestTask.new do |t|
-  t.libs << "tests"
-  t.pattern = 'tests/Test*.rb'
+  t.libs << 'test'
+  t.pattern = 'test/test*.rb'
   t.verbose = true
 end