enumerator_io_reader 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 149f1dbecf68d4f4ed8d55d0297e18355a007374
+  data.tar.gz: f376ce3567eb87380eb787e715c8eaaf24fcefbb
+SHA512:
+  metadata.gz: 6d348c423efc4e36404b7e6eec298b32e44b223419fa506a8454f8c851d88de1055cfa50e010f21f9b7bb676e769502fb36af2160f1186000e19418e74f7a6a5
+  data.tar.gz: d7e7af727e3de28a6c3bc7fe938481a1067772c3397eb89184e560385e683b4d18416b31196b15f8f77d71756980f3e8b3d6376618c00a4ae4e8a5e380c47f3d

data/README.md

@@ -0,0 +1,100 @@
+Enumerator::IO::Reader
+=========================
+
+## Description
+
+Ever had a IO object you wanted to enumerate while not reading the whole stream into memory? no problems just use http://ruby-doc.org/core-2.2.2/IO.html#method-i-each_line and specify separator or any of it's siblings `#each_byte`, `#each_char` etc.
+
+But what if the situation was the opposite, you had your enumerable, in this case a database response that was to big for your wallet to fit in memory and the interface required a IO object to read from.
+
+Like `#put_object` in the legacy aws sdk
+http://www.rubydoc.info/gems/aws-sdk-euca/1.8.5/AWS/S3/Client:put_object
+
+
+## Install
+
+`gem install enumerator_io_reader`
+
+## Usage
+
+A simple case first
+
+```RUBY
+require 'enumerator/io/reader'
+range = "abc".."abz"
+io = Enumerator::IO::Reader.new(range.to_enum)
+io.read(20) # => "abcabdabeabfabgabhab"
+io.read # => "iabjabkablabmabnaboabpabqabrabsabtabuabvabwabxabyabz"
+io.eof? # => true
+
+```
+
+`#to_s` is called for every entry in the enumerable but pass a block to the constructor and you can serialize the object in a lazy manner after it has been yielded. The same lazy mapping can of course be accomplished by something like `Enumerator::Lazy`.
+
+```RUBY
+require 'enumerator/io/reader'
+require 'csv'
+
+io = Enumerator::IO::Reader.new(Post.each.to_enum) do |post|
+  post.attributes.values.to_csv
+end
+
+s3.put_object(
+  bucket_name: 'foo',
+  key: 'key',
+  data: io)
+```
+
+If you use this gem alot through out your project you might consider the following monkey patches
+
+```RUBY
+module Enumerable
+  def to_io(method = :each)
+    Enumerator::IO::Reader.new(enum_for(method))
+  end
+end
+
+range = "abc".."abz"
+io = range.to_io
+io.read(20) # => "abcabdabeabfabgabhab"
+```
+
+```RUBY
+class Enumerator
+  def to_io
+    Enumerator::IO::Reader.new(self)
+  end
+end
+
+enumerator = Enumerator.new do |y|
+  y.yield(1)
+  sleep 1
+  y.yield(2)
+end
+enumerator.to_io.read # => "12"
+```
+
+### License
+
+(The MIT License)
+
+Copyright (c) 2015 Erik Fonselius
+
+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/lib/enumerator/io/reader.rb

@@ -0,0 +1,67 @@
+class Enumerator
+  module IO
+      class Reader
+      def initialize(enumerator, &block)
+        @enumerator = enumerator
+        @reader, @writer = ::IO.pipe
+        @end_of_read_window = 0
+        @read_bytes = 0
+        @block = block
+      end
+
+      def read(*args)
+        length = args.first
+        if length
+          required_read_window = @read_bytes + length 
+          if required_read_window > @end_of_read_window
+            increase_read_window!(required_read_window - @end_of_read_window)
+          end
+        else
+          slurp!
+        end
+        result = @reader.read(*args)
+        @read_bytes += result.size if result
+        result
+      end
+
+      def eof?
+        moar_data if @read_bytes == 0
+        @reader.eof?
+      end
+
+      private
+
+      def increase_read_window!(bytes_left)
+        while bytes_left >= 0 && (written = moar_data) > 0
+          bytes_left -= written
+        end
+      ensure
+        @writer.flush unless @writer.closed?
+      end
+
+      def slurp!
+        return if @writer.closed?
+        while moar_data > 0
+        end
+      end
+
+      def moar_data
+        entry = @enumerator.next
+        chunck = if @block
+          @block.call(entry)
+        else
+          entry.to_s
+        end
+        @writer.write(chunck)
+        @end_of_read_window += chunck.size
+        chunck.size
+      rescue StopIteration
+        unless @writer.closed?
+          @writer.flush
+          @writer.close
+        end
+        0
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: enumerator_io_reader
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Fonsan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: jeweler
+  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'
+description: Read a byte stream from your enumerable
+email: fonsan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/enumerator/io/reader.rb
+homepage: http://github.com/Fonsan/enumerator_io_reader
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Treat your enumerators as readable IO streams
+test_files: []