look_ahead_iterator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d1df7b4de99de92d267fde8715c983bed263b07
+  data.tar.gz: 2ef9bb0c40a1cac6e1171d12e1026a2061cca87a
+SHA512:
+  metadata.gz: daad525f977bbba31418be79091d408a01172eaeb153a592ab2de24ca992fa1f54b28129d7fcd096b9085433db584b30f104710be32ea83520f6144f28fe9176
+  data.tar.gz: 7d5b8b95cc8d9cadc7e5e9a302616aad2ed0c5d63bd603449a7881972115a543f6cc69af3c64559bc82c87542de7ca3ce194c46e157b4e97d91890ad5fea1319

data/.gitignore

@@ -0,0 +1,55 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 1.9.3
+before_install:
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in look_ahead_iterator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Javier Goizueta
+
+MIT License
+
+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

@@ -0,0 +1,36 @@
+# LookAheadIterator
+
+Ruby iterator with look ahead operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'look_ahead_iterator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install look_ahead_iterator
+
+## Usage
+
+```ruby
+require 'look_ahead_iterator'
+i = LookAheadIterator.new((1..4), stop: true)
+loop do
+  puts "Current_value: #{i.next.inspect}"
+  puts "  (next value: #{i.look_ahead.inspect})"
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/jgoizueta/look_ahead_iterator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = LookAheadIterator::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "LookAheadIterator #{version}"
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.markup = 'markdown' if rdoc.respond_to?(:markup)
+end
+
+task :default => :test

data/lib/look_ahead_iterator.rb

@@ -0,0 +1,110 @@
+require "look_ahead_iterator/version"
+
+class LookAheadIterator
+
+  # A LookAheadIterator can be created from any enumerable object.
+  #
+  # Options:
+  #
+  # * :stop : If true, the iteration will stop by throwing +StopIteration+
+  #   like other external iterators. This will end a +loop+.
+  #   Otherwise the user must check of end of iteration by
+  # * :end : is used to define a special value to be returned
+  #   if the iteration has ended (or when looking beyond the end of the
+  #   collection). By default it is +nil+.
+  #
+  def initialize(enumerable, options = {})
+    @end_value = options[:end]
+    @stop = options[:stop]
+    @iterator = enumerable.each
+    @iterator_ended = false
+    @buffer = []
+    @current = nil
+    @ended = false
+  end
+
+  attr_reader :current, :end_value
+
+  def each
+    if @stop
+      loop do
+        yield self.next
+      end
+    else
+      yield self.next while next?
+    end
+  end
+
+  include Enumerable
+
+  def next
+    if @buffer.size > 0
+      @current = @buffer.shift
+    else
+      if @stop
+        begin
+          @current = @iterator.next
+        rescue StopIteration
+          @iterator_ended = @ended = true
+          @current = @end_value
+          raise
+        end
+      else
+        @current = next_or_end
+        @ended = @iterator_ended
+        @current
+      end
+    end
+  end
+
+  def ended?
+    # If @end_value cannot be contained in the collection,
+    # then this is equivalent to:
+    #   @buffer.empty? && @current = @end_value
+    @ended
+  end
+
+  def next?
+    # If @end_value cannot be contained in the collection,
+    # then this is equivalent to:
+    #   !ended? && (look_ahead(1) != @end_value)
+    !ended? && (look_ahead(1); !(@iterator_ended && @buffer.size==0))
+  end
+
+  # This method is used to obtained the next value to be
+  # returned by +each+. If a parameter +n+ is passed
+  # the value to be returned after +n+ calls to +each+ is
+  # returned. The value 0 can be used to return the current
+  # value (from the previous call to +each+),
+  def look_ahead(n=1)
+    raise "Can't look back!" if n < 0
+    return @current if n == 0
+
+    while n > @buffer.size && !@iterator_ended
+      value = next_or_end
+      @buffer << value unless @iterator_ended
+    end
+    n <= @buffer.size ? @buffer[n-1] : @end_value
+  end
+
+  def is_end?(value)
+    value == @end_value
+  end
+
+  def is_valid?(value)
+    value != @end_value
+  end
+
+private
+
+  def next_or_end
+    return @end_value if @ended
+    begin
+      @iterator.next
+    rescue StopIteration
+      @iterator_ended = true
+      @end_value
+    end
+  end
+
+end

data/lib/look_ahead_iterator/version.rb

@@ -0,0 +1,3 @@
+class LookAheadIterator
+  VERSION = "0.0.1"
+end

data/look_ahead_iterator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'look_ahead_iterator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "look_ahead_iterator"
+  spec.version       = LookAheadIterator::VERSION
+  spec.authors       = ["Javier Goizueta"]
+  spec.email         = ["jgoizueta@gmail.com"]
+  spec.summary       = %q{Iterator with look ahead operation}
+  spec.description   = %q{Look ahead when iterating over an enumerable collection}
+  spec.homepage      = "https://github.com/jgoizueta/look_ahead_iterator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.7"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'look_ahead_iterator'
+
+require 'minitest/autorun'

data/test/test_look_ahead_iterator.rb

@@ -0,0 +1,261 @@
+require 'minitest_helper'
+
+class TestLookAheadIterator < Minitest::Test
+
+  def test_simple_iteration
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    refute it.ended?
+    assert_equal 11, it.next
+    refute it.ended?
+    assert_equal 22, it.next
+    refute it.ended?
+    assert_equal 33, it.next
+    refute it.ended?
+    assert_equal 44, it.next
+    refute it.ended?
+    assert_equal 55, it.next
+    refute it.ended?
+    assert_equal :end, it.next
+    assert it.ended?
+  end
+
+  def test_iterate_and_look_ahead_with_end_value
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert it.next?
+    refute it.ended?
+    assert_equal 33, it.next
+    assert_equal 44, it.next
+    assert_equal 55, it.next
+    assert_equal :end, it.next
+    assert it.ended?
+
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert it.next?
+    refute it.ended?
+    assert_equal 33, it.next
+    assert_equal 44, it.next
+    assert it.next?
+    assert_equal 55, it.next
+    refute it.next?
+    refute it.ended?
+    assert_equal :end, it.next
+    assert it.ended?
+  end
+
+  def test_iterate_and_look_ahead_past_end
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert it.next?
+    refute it.ended?
+    assert_equal 33, it.next
+    assert_equal 44, it.next
+    assert_equal 55, it.look_ahead(1)
+    refute it.ended?
+    assert it.next?
+    assert_equal 55, it.look_ahead(1)
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(4)
+    refute it.ended?
+    assert it.next?
+    assert_equal 55, it.next
+    refute it.ended?
+    assert_equal :end, it.next
+    assert it.ended?
+    refute it.next?
+  end
+
+  def test_iterate_and_look_ahead_with_stop
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: true)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert it.next?
+    refute it.ended?
+    assert_equal 33, it.next
+    assert_equal 44, it.next
+    assert_equal 55, it.next
+    assert_raises(StopIteration){ it.next }
+    assert it.ended?
+    refute it.next?
+
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: true)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert it.next?
+    refute it.ended?
+    assert_equal 33, it.next
+    assert_equal 44, it.next
+    assert_equal 55, it.look_ahead(1)
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(4)
+    assert_equal 55, it.next
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(1)
+    assert_raises(StopIteration){ it.next }
+    assert it.ended?
+    refute it.next?
+  end
+
+  def test_overlapping_look_ahead
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert it.next?
+    refute it.ended?
+    assert_equal 11, it.look_ahead
+    assert_equal 11, it.next
+    assert_equal 33, it.look_ahead(2)
+    assert_equal 22, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(3)
+    assert_equal 22, it.next
+    assert_equal 33, it.look_ahead(1)
+    assert_equal 44, it.look_ahead(2)
+    assert_equal 55, it.look_ahead(3)
+    assert_equal 33, it.next
+    assert_equal 44, it.look_ahead(1)
+    assert_equal 55, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(3)
+    assert_equal 44, it.next
+    assert_equal 55, it.look_ahead(1)
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(3)
+    assert_equal 55, it.next
+    assert_equal :end, it.look_ahead(1)
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(3)
+    assert_equal :end, it.next
+    assert_equal :end, it.look_ahead(1)
+    assert_equal :end, it.look_ahead(2)
+    assert_equal :end, it.look_ahead(3)
+  end
+
+  def test_unreliable_end_value
+    # If the end-marking value is contained in the collection,
+    # then the user may be confused (checking for the end value doesn't
+    # detect the end of the iterator reliably), but the ended? and
+    # next? methods should still work reliably.
+
+    # Check ended? without look ahead
+    it = LookAheadIterator.new([11,22,nil,44,nil], stop: false)
+    assert_nil it.end_value
+    assert_equal 11, it.next
+    assert_equal 22, it.next
+    refute it.ended?
+    assert_nil it.next
+    refute it.ended?
+    assert_equal 44, it.next
+    refute it.ended?
+    assert_nil it.next
+    refute it.ended?
+    assert_nil it.next
+    assert it.ended?
+
+    # Check next? without look ahead
+    it = LookAheadIterator.new([11,22,nil,44,nil], stop: false)
+    assert_nil it.end_value
+    assert_equal 11, it.next
+    assert_equal 22, it.next
+    assert it.next?
+    assert_nil it.next
+    assert it.next?
+    assert_equal 44, it.next
+    assert it.next?
+    assert_nil it.next
+    refute it.next?
+    assert_nil it.next
+    refute it.next?
+
+    # Check ended? with look ahead
+    it = LookAheadIterator.new([11,22,nil,44,nil], stop: false)
+    assert_nil it.end_value
+    assert_equal 11, it.next
+    assert_equal 22, it.next
+    refute it.ended?
+    assert_nil it.look_ahead
+    refute it.ended?
+    assert_nil it.next
+    refute it.ended?
+    assert_equal 44, it.look_ahead(1)
+    assert_nil it.look_ahead(2)
+    assert_nil it.look_ahead(3)
+    refute it.ended?
+    assert_equal 44, it.next
+    refute it.ended?
+    assert_nil it.next
+    refute it.ended?
+    assert_nil it.next
+    assert it.ended?
+
+    # Check next? with look ahead
+    it = LookAheadIterator.new([11,22,nil,44,nil], stop: false)
+    assert_nil it.end_value
+    assert_equal 11, it.next
+    assert_equal 22, it.next
+    assert it.next?
+    assert_nil it.next
+    assert it.next?
+    assert_equal 44, it.look_ahead(1)
+    assert_nil it.look_ahead(2)
+    assert_nil it.look_ahead(3)
+    assert it.next?
+    assert_equal 44, it.next
+    assert it.next?
+    assert_nil it.next
+    refute it.next?
+    assert_nil it.next
+    refute it.next?
+  end
+
+  def test_each_with_stop_exception
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: true)
+    result = []
+    it.each do |value|
+      result << value
+    end
+    assert_equal [11,22,33,44,55], result
+  end
+
+  def test_each_without_stop_exception
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    result = []
+    it.each do |value|
+      result << value
+    end
+    assert_equal [11,22,33,44,55], result
+  end
+
+  def test_enumerable
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert_equal [11,22,33,44,55], it.to_a
+    it = LookAheadIterator.new([11,22,33,44,55], end: :end, stop: false)
+    assert_equal [11,22,33,44,55], it.map{|v| v}
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: look_ahead_iterator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Goizueta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+description: Look ahead when iterating over an enumerable collection
+email:
+- jgoizueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/look_ahead_iterator.rb
+- lib/look_ahead_iterator/version.rb
+- look_ahead_iterator.gemspec
+- test/minitest_helper.rb
+- test/test_look_ahead_iterator.rb
+homepage: https://github.com/jgoizueta/look_ahead_iterator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Iterator with look ahead operation
+test_files:
+- test/minitest_helper.rb
+- test/test_look_ahead_iterator.rb