array_enumerator 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.4)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kasper Johansen
+
+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.rdoc

@@ -0,0 +1,19 @@
+= array_enumerator
+
+Description goes here.
+
+== Contributing to array_enumerator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "array_enumerator"
+  gem.homepage = "http://github.com/kaspernj/array_enumerator"
+  gem.license = "MIT"
+  gem.summary = %Q{Enumerator abstraction layer that emulates certain array functionality (methods).}
+  gem.description = %Q{Enumerator abstraction layer that emulates certain array functionality (methods like empty?, slice, shift and more) by using a small cache and other tricks without loading all the data from the enumerator at the same time.}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "array_enumerator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/array_enumerator.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{array_enumerator}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = %q{2012-07-03}
+  s.description = %q{Enumerator abstraction layer that emulates certain array functionality (methods like empty?, slice, shift and more) by using a small cache and other tricks without loading all the data from the enumerator at the same time.}
+  s.email = %q{k@spernj.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "array_enumerator.gemspec",
+    "lib/array_enumerator.rb",
+    "spec/array_enumerator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kaspernj/array_enumerator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Enumerator abstraction layer that emulates certain array functionality (methods).}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/array_enumerator.rb

@@ -0,0 +1,183 @@
+#This class is ment as an enumerator but with a cache that enables it to emulate array-functionality (first, empty and so on). If elements goes out of memory, then the array becomes corrupted and methods like 'first' and 'slice' will no longer work (raise errors).
+class Array_enumerator
+  #Takes an enumerator to work with as argument.
+  def initialize(enum)
+    #The enumerator being used.
+    @enum = enum
+    
+    #Used to calculate length without depending corruption.
+    @length_cache = 0
+    
+    #If the virtual array has become corrupted because of forgotten elements (by calling each and enumerating through elements).
+    @array_corrupted = false
+    
+    #To allow the object to be thread-safe.
+    @mutex = Mutex.new
+  end
+  
+  #Cache the first elements (if not cached already) and returns it.
+  def first
+    check_corrupted
+    cache_ele if !@eles or @eles.empty?
+    return @eles.first
+  end
+  
+  #Returns true if the array is empty.
+  def empty?
+    if @empty == nil
+      cache_ele if !@eles
+      
+      if @length_cache > 0
+        @empty = false
+      else
+        @empty = true
+      end
+    end
+    
+    return @empty
+  end
+  
+  #Returns each element and releases them from cache.
+  def each(&block)
+    if block
+      to_enum.each(&block)
+      return nil
+    else
+      return to_enum
+    end
+  end
+  
+  #Returns a enumerator that can yield the all the lements (both cached and future un-cached ones).
+  def to_enum
+    check_corrupted
+    @array_corrupted = true
+    
+    return Enumerator.new do |yielder|
+      if @eles
+        while ele = @eles.shift
+          yielder << ele
+        end
+      end
+      
+      yield_rest do |ele|
+        yielder << ele
+      end
+    end
+  end
+  
+  #Returns the counted length. Can only be called after the end of the enumerator has been reached.
+  def length
+    raise "Cant call length before the end has been reached." if !@end
+    return @length_cache
+  end
+  
+  #Giving slice negaive arguments will force it to cache all elements and crush the memory for big results.
+  def slice(*args)
+    check_corrupted
+    
+    if args[0].is_a?(Range) and !args[1]
+      need_eles = args[0].begin + args[0].end
+    elsif args[0] and !args[1]
+      need_eles = args[0]
+    elsif args[0] and args[1] and args[0] > 0 and args[1] > 0
+      need_eles = args[0] + args[1]
+    elsif args[0] < 0 or args[1] < 0
+      raise "Slice cant take negative arguments."
+    else
+      raise "Dont now what to do with args: '#{args}'."
+    end
+    
+    @eles = [] if !@eles
+    cache_eles = need_eles - @eles.length if need_eles
+    cache_ele(cache_eles) if need_eles and cache_eles > 0
+    return @eles.slice(*args)
+  end
+  
+  #Caches necessary needed elements and then returns the result as on a normal array.
+  def shift(*args)
+    check_corrupted
+    
+    if args[0]
+      amount = args[0]
+    else
+      amount = 1
+    end
+    
+    @eles = [] if !@eles
+    cache_ele(amount - @eles.length) if !@eles or @eles.length < amount
+    res = @eles.shift(*args)
+    
+    #Since we are removing an element, the length should go down with the amount of elements captured.
+    if args[0]
+      @length_cache -= res.length
+    else
+      @length_cache -= 1
+    end
+    
+    return res
+  end
+  
+  #Returns a normal array with all elements. Can also raise corrupted error if elements have been thrown out.
+  def to_a
+    check_corrupted
+    cache_all
+    return @eles
+  end
+  
+  alias to_ary to_a
+  
+  private
+  
+  #Raises error because elements have been forgotten to spare memory.
+  def check_corrupted
+    raise "Too late to call. Corrupted." if @array_corrupted
+  end
+  
+  #Yields the rest of the elements to the given block.
+  def yield_rest
+    @array_corrupted = true
+    
+    begin
+      @mutex.synchronize do
+        while ele = @enum.next
+          @length_cache += 1
+          yield(ele)
+        end
+      end
+    rescue StopIteration
+      @end = true
+    end
+  end
+  
+  #Caches a given amount of elements.
+  def cache_ele(amount = 1)
+    @eles = [] if !@cache
+    
+    begin
+      @mutex.synchronize do
+        while @eles.length <= amount
+          @eles << @enum.next
+          @length_cache += 1
+        end
+      end
+    rescue StopIteration
+      @end = true
+    end
+  end
+  
+  #Forces the rest of the elements to be cached.
+  def cache_all
+    @eles = [] if !@eles
+    
+    begin
+      @mutex.synchronize do
+        while ele = @enum.next
+          @length_cache += 1
+          @eles << ele
+        end
+      end
+    rescue StopIteration
+      @end = true
+    end
+  end
+end

data/spec/array_enumerator_spec.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ArrayEnumerator" do
+  it "shift" do
+    cont = %w[a b c d e].to_enum
+    ae = Array_enumerator.new(cont)
+    
+    res = ae.shift
+    raise "Expected 'a' but got: '#{res}'." if res != "a"
+    
+    arr = ae.to_a
+    exp = %w[b c d e]
+    raise "Expected array to be '#{exp}' but got: '#{arr}'." if arr != exp
+  end
+  
+  it "each" do
+    arr = %w[a b c]
+    cont = arr.to_enum
+    ae = Array_enumerator.new(cont)
+    
+    count = 0
+    ae.each do |ele|
+      raise "Expected #{arr[count]} but got: #{ele}" if ele != arr[count]
+      count += 1
+    end
+    
+    raise "Expected 3 elements to yield through but got: #{count}" if count != 3
+    
+    arr = %w[a b c]
+    cont = arr.to_enum
+    ae = Array_enumerator.new(cont)
+    
+    res = ae.empty?
+    raise "Expected empty to be false but got: '#{res}'." if res != false
+    
+    count = 0
+    ae.each do |ele|
+      raise "Expected #{arr[count]} but got: #{ele}" if ele != arr[count]
+      count += 1
+    end
+    
+    raise "Expected 3 elements to yield through but got: #{count}" if count != 3
+    
+    begin
+      ae.to_a
+      raise "Should have raised exception but didnt."
+    rescue
+      #ignore.
+    end
+    
+    begin
+      ae.first
+      raise "Should have raised exception but didnt."
+    rescue
+      #ignore.
+    end
+    
+    begin
+      ae.each do |ele|
+        raise "Should get here?"
+      end
+      
+      raise "Should get here?"
+    rescue
+      #ignore.
+    end
+  end
+  
+  it "empty" do
+    cont = %w[a b c].to_enum
+    ae = Array_enumerator.new(cont)
+    
+    res = ae.empty?
+    raise "Expected empty to be false but got: '#{res}'." if res != false
+    
+    first = ae.first
+    raise "Expected first to be 'a' but it wasnt: '#{first}'." if first != "a"
+  end
+  
+  it "length" do
+    cont = %w[a b c d e].to_enum
+    ae = Array_enumerator.new(cont)
+    
+    begin
+      ae.length
+      raise "Should have failed but didnt."
+    rescue
+      #ignore.
+    end
+    
+    ae.each do |ele|
+      #ignore.
+    end
+    
+    res = ae.length
+    raise "Expected length to be 5 but it wasnt: '#{res}'." if res != 5
+  end
+  
+  it "slice" do
+    arr = %w[a b c d e f g h i j k l m n]
+    cont = arr.to_enum
+    ae = Array_enumerator.new(cont)
+    
+    runs = [
+      [6],
+      [1, 2],
+      [1..3]
+    ]
+    
+    fails = [
+      [-2, 2],
+      [2, -2]
+    ]
+    
+    runs.each do |args|
+      res1 = arr.slice(*args)
+      res2 = ae.slice(*args)
+      
+      raise "Expected res to be: #{res1} but got #{res2} for args '#{args}'." if res1 != res2
+    end
+    
+    fails.each do |args|
+      begin
+        res2 = ae.slice(*args)
+        raise "Should have failed but didnt."
+      rescue
+        #ignore.
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'array_enumerator'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: array_enumerator
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kasper Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Enumerator abstraction layer that emulates certain array functionality (methods like empty?, slice, shift and more) by using a small cache and other tricks without loading all the data from the enumerator at the same time.
+email: k@spernj.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- array_enumerator.gemspec
+- lib/array_enumerator.rb
+- spec/array_enumerator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kaspernj/array_enumerator
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4369946615704607040
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Enumerator abstraction layer that emulates certain array functionality (methods).
+test_files: []
+