ruby-stream 0.3.0 → 0.4.0

data/LICENSE.md

@@ -0,0 +1,7 @@
+The MIT License (MIT) Copyright (c) Callum Stott, http://www.seadowg.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -45,6 +45,6 @@ will need to be prepared to wait, forever. No seriously, I mean for all
 time. Its infinite.
 
 Streams become most powerful when used with high order functions. At the
-moment ruby-stream supports `map` and `filter` operations that operate
+moment ruby-stream supports `map`, `filter`, `each`, `take` and `scan` operations that operate
 as they would on normal collections (these operations will only actually be
 applied to Stream elements on access or iteration however).

data/lib/ruby-stream.rb

@@ -78,6 +78,16 @@ class Stream
     end
   end
 
+  def drop(n)
+    if n <= 0
+      Stream.new(head) do
+        tail
+      end
+    else
+      tail.drop(n - 1)
+    end
+  end
+
   def map(&block)
     Stream.new(yield head) do
       tail.map(&block)
@@ -90,6 +100,24 @@ class Stream
     end
   end
 
+  def fold_left(*args, &block)
+    zero = args[0]
+    symbol = args[1] || args[0]
+
+    scan = if block
+      self.scan(zero, &block)
+    elsif args.length == 2
+      self.scan(zero, &symbol.to_proc)
+    elsif args.length == 1
+      self.drop(1).scan(head, &symbol.to_proc)
+    end
+
+    scan.last
+  end
+
+  alias :inject :fold_left
+  alias :reduce :fold_left
+
   def filter(&block)
     if block.call(head)
       Stream.new(head) do
@@ -109,6 +137,10 @@ class Stream
       EmptyStream.new
     end
 
+    def last
+      nil
+    end
+
     def [](n)
       nil
     end
@@ -121,6 +153,10 @@ class Stream
       EmptyStream.new
     end
 
+    def drop(n)
+      EmptyStream.new
+    end
+
     def take_while(&block)
       EmptyStream.new
     end
@@ -132,5 +168,11 @@ class Stream
     def filter(&block)
       EmptyStream.new
     end
+
+    def scan(zero, &block)
+      Stream.new(zero) do
+        EmptyStream.new
+      end
+    end
   end
 end

data/ruby-stream.gemspec

@@ -3,11 +3,12 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "ruby-stream"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
-  s.email = ["callum.stott@me.com"]
+  s.email = ["callum@seadowg.com"]
   s.summary = "Lazy stream implementation for Ruby"
+  s.license = 'MIT'
 
   s.require_paths = ['lib']
   s.files = `git ls-files`.split("\n")

data/spec/ruby-stream_spec.rb

@@ -94,6 +94,24 @@ describe Stream do
     end
   end
 
+  describe "#drop(n)" do
+    it "returns another Stream" do
+      @stream.drop(1).kind_of?(Stream).must_equal true
+    end
+
+    it "returns a Stream that skips the first n elements of the original" do
+      stream = @stream.drop(5)
+      stream[0].must_equal 6
+      stream[1].must_equal 7
+    end
+
+    describe "for a finite Stream" do
+      it "returns a Stream with the correct length" do
+        @stream.take(5).drop(1).length.must_equal 4
+      end
+    end
+  end
+
   describe "#each(func)" do
     describe "for a finite Stream" do
       it "should return nil" do
@@ -180,7 +198,7 @@ describe Stream do
     end
   end
 
-  describe "#scan(func)" do
+  describe "#scan(zero, func)" do
     it "returns a new Stream" do
       @stream.scan(0) { |x, i| i }.kind_of?(Stream).must_equal true
     end
@@ -189,13 +207,57 @@ describe Stream do
       @stream.scan(-1) { |x, i| i }.head.must_equal -1
     end
 
-    it "returns a Stream where each element of the tail is the result of feeding the zero (or result) and function through to each of the original elements" do
+    it "returns a Stream that is the scan of the receiver" do
       scan = @stream.scan(0) { |x, i| x + i }
       scan[1].must_equal(1)
       scan[2].must_equal(3)
       scan[3].must_equal(6)
       scan[100].must_equal(5050)
     end
+
+    it "works correctly with finite streams" do
+      scan = @stream.take(1).scan(0) { |x, i| x + i }
+      scan[1].must_equal 1
+    end
+  end
+
+  describe "#fold_left(zero, func)" do
+    it "returns the left fold for an finite Stream" do
+      sum = @stream.take(5).fold_left(1) { |memo, ele|
+        memo + ele
+      }
+      sum.must_equal 16
+    end
+
+    it "returns the zero value for empty lists" do
+      value = @stream.take(0).fold_left(101) { |i, j| j }
+      value.must_equal 101
+    end
+
+    it "allows the func to be a symbol" do
+      sum = @stream.take(5).fold_left(1, :+)
+      sum.must_equal 16
+    end
+
+    it "is aliased with 'inject'" do
+      @stream.method(:fold_left).must_equal @stream.method(:inject)
+    end
+
+    it "is aliased with 'reduce'" do
+      @stream.method(:fold_left).must_equal @stream.method(:reduce)
+    end
+  end
+
+  describe "#fold_left(symbol)" do
+    it "returns the left fold for a finite Stream but skips the zero value step" do
+      sum = @stream.take(5).fold_left(:+)
+      sum.must_equal 15
+    end
+
+    it "returns nil for an empty Stream" do
+      sum = @stream.take(0).fold_left(:+)
+      sum.must_equal nil
+    end
   end
 
   describe ".continually(func)" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-stream
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
-- callum.stott@me.com
+- callum@seadowg.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -21,13 +21,15 @@ files:
 - .ruby-version
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/ruby-stream.rb
 - ruby-stream.gemspec
 - spec/ruby-stream_spec.rb
 homepage: 
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: