stream 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55354ecc39933e7f4be1b3b1eaa9bcfec109b00346f739e2f6c675a333ed17e9
-  data.tar.gz: aab007abb0bf1bf998be99a9806d3e3d9a8f305a422ce01ac83ea586b42a778a
+  metadata.gz: 01b456afc318137cc9291dd8f7ec664dcc6370225c1fb8cf0a223794d1a18cb7
+  data.tar.gz: 19824c0406a4e7b253aa682db312f89fea8a1d0c9bd3a3513d2951ffdc3126b2
 SHA512:
-  metadata.gz: 416c8fe937cc016744b8325bd3f15a6210a51fe17900de8e1db8b405ef5793cd2344ff3f0e9b0a3e336bf71c1497b9f84137238f4f92431fa861056f6a34646c
-  data.tar.gz: c07f8c66b7ca2d3a3e7c355b9b7bdbb6bd3151c9871159b0c92376773a732b9fdbabc2e1727f6b4c822b4412aa67a17f0601afd969f50ecd1a9751618e4c72e3
+  metadata.gz: c3fdb6526fabfd8ff52d8ea5b195f83a5644515f99444ab589d389ffb08365dea6de40e69e84bd8c9c93155cabcee3fe0a0e2ef0dd1a96403a7dc2035bf80be2
+  data.tar.gz: 95c2179dca08a24eb24f7aa811be95b4bd1c17ea57e41d218ada55783933cdac30eb958ca61a42294bc719097d98327fe846248bf7f88b47272776fbfcddff07

data/Gemfile.lock

@@ -1,19 +1,23 @@
 PATH
   remote: .
   specs:
-    stream (0.5.4)
-      generator
+    stream (0.5.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    generator (0.0.1)
-    power_assert (1.1.3)
-    rake (12.3.2)
-    rdoc (6.1.1)
-    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

data/README.rdoc

@@ -4,8 +4,9 @@
 
 == 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, 2020 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/lib/stream.rb

@@ -1,4 +1,4 @@
-STREAM_VERSION = '0.5.4'.freeze
+STREAM_VERSION = '0.5.5'.freeze
 
 ##
 # Module Stream defines an interface for an external Iterator which

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: stream
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Horst Duchene
 autorequire: stream
 bindir: bin
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement