em-files 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+   gem "eventmachine", ">= 0.12.10"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    eventmachine (0.12.10)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  eventmachine (>= 0.12.10)
+  jeweler (~> 1.5.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+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,50 @@
+EventMachine Files
+==================
+
+**em-files** solve problem of blocking disk IO while operating with 
+large files. Use [EventMachine][4] for multiplexing reads and writes
+to small blocks performed in standalone EM ticks. They speed down the
+file IO operations of sure, but allow running other tasks with them 
+simultaneously (from EM point of view).
+
+API is similar to classic Ruby file IO represented by [File][1] class.
+See an example:
+
+    require "em-files"
+    EM::run do
+        EM::File::open("some_file.txt", "r") do |io|
+            io.read(1024) do |data|     # writing works by very similar way, of sure
+                puts data
+                io.close()              # it's necessary to do it in block too, because reading is evented
+            end
+        end
+    end
+    
+Support of Ruby API is limited to `#open`, `#close`, `#read` and `#write`
+methods only, so for special operations use simply:
+
+    EM::File::open("some_file.txt", "r") do |io|
+        io.native   # returns native Ruby File class object
+    end
+
+    
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[1]: http://www.ruby-doc.org/core/classes/File.html
+[2]: http://github.com/martinkozak/em-sequence/issues
+[3]: http://www.martinkozak.net/
+[4]: http://rubyeventmachine.com/

data/Rakefile

@@ -0,0 +1,37 @@
+# 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 = "em-files"
+  gem.homepage = "https://github.com/martinkozak/em-files"
+  gem.license = "MIT"
+  gem.summary = "Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO while operating with large files."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/em-file.gemspec

@@ -0,0 +1,53 @@
+# 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{em-file}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-02-27}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/em-files.rb",
+    "test.rb"
+  ]
+  s.homepage = %q{https://github.com/martinkozak/em-file}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO while operating with large files.}
+
+  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_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/em-files.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "eventmachine"
+
+##
+# Main EventMachine module.
+# @see http://rubyeventmachine.com/
+#
+
+module EM
+
+    ##
+    # Sequenced file reader and writer.
+    #
+    
+    class File
+
+        ##
+        # Opens the file.
+        #
+        # In opposite to appropriate Ruby method, "block syntax" is only
+        # syntactic sugar, file isn't closed after return from block
+        # because processing is asynchronous so it doesn't know when 
+        # is convenient to close the file.
+        #
+        # @param [String] filepath path to file
+        # @param [String] mode file access mode (see equivalent Ruby method)
+        # @param [Integer] rwsize size of block operated during one tick
+        # @param [Proc] block syntactic sugar for wrapping File access object
+        # @return [File] file access object
+        #
+
+        def self.open(filepath, mode = "r", rwsize = 65536, &block)   # 64 kilobytes
+            file = self::new(filepath, mode, rwsize)
+            if not block.nil?
+                block.call(file)
+            end
+            
+            return file
+        end
+        
+        ##
+        # Reads wholoe content of the file.
+        #
+        # @param [String] filepath path to file
+        # @param [Integer] rwsize size of block operated during one tick
+        # @param [Proc] block block for giving back the result
+        #
+        
+        
+        def self.read(filepath, rwsize = 65536, &block)
+            self::open(filepath, "r", rwsize) do |io|
+                io.read do |out|
+                    block.call(out)
+                    io.close()
+                end
+            end
+        end
+        
+        ##
+        # Writes data to file and closes it.
+        #
+        # @param [String] filepath path to file
+        # @param [String] data data for write
+        # @param [Integer] rwsize size of block operated during one tick
+        # @param [Proc] block block called when writing is finished with
+        #   written bytes size count as parameter
+        #
+        
+        def self.write(filepath, data = "", rwsize = 65536, &block)
+            self::open(filepath, "w", rwsize) do |io|
+                io.write(data) do |length|
+                    block.call(length)
+                    io.close()
+                end
+            end
+        end
+        
+        ###
+        
+        ##
+        # Holds file object.
+        # @return [::File]
+        #
+        
+        attr_accessor :native
+        @native
+        
+        ##
+        # Indicates block size for operate with in one tick.
+        # @return [Integer]
+        #
+        
+        attr_accessor :rw_len
+        @rw_len
+        
+        ##
+        # Constructor.
+        #
+        # @param [String] filepath path to file
+        # @param [String] mode file access mode (see equivalent Ruby method)
+        # @param [Integer] rwsize size of block operated during one tick
+        #
+                
+        def initialize(filepath, mode = "r", rwsize = 65536)
+            @native = ::File::open(filepath, mode)
+            @rw_len = rwsize
+        end
+
+        ##
+        # Reads data from file.
+        #
+        # @overload read(length, &block)
+        #   Reads specified amount of data from file.
+        #   @param [Integer] length length for read from file
+        #   @param [Proc] block callback for returning the result
+        # @overload read(&block)
+        #   Reads whole content of file.
+        #   @param [Proc] block callback for returning the result
+        #
+        
+        def read(length = nil, &block)
+            buffer = ""
+            
+            worker = Proc::new do
+            
+                # Sets length for read
+                if not length.nil?
+                    rlen = length - buffer.length
+                    if rlen > @rw_len
+                        rlen = @rw_len
+                    end
+                else
+                    rlen = @rw_len
+                end
+                
+                # Reads
+                buffer << @native.read(rlen)
+                
+                # Returns or continues work
+                if @native.eof? or (buffer.length == length)
+                    if not block.nil?
+                        block.call(buffer)              # returns result
+                    end
+                else
+                    EM::next_tick { worker.call() }     # continues work
+                end
+                
+            end
+            
+            worker.call()
+        end
+        
+        ##
+        # Writes data to file.
+        #
+        # @param [String] data data for write
+        # @param [Proc] block callback called when finish and for giving
+        #   back the length of written data
+        #
+        
+        def write(data, &block)
+            written = 0
+            
+            worker = Proc::new do
+            
+                # Writes
+                written += @native.write(data[written...(written + @rw_len)])
+            
+                # Returns or continues work
+                if written >= data.bytesize
+                    if not block.nil?
+                        block.call(written)             # returns result
+                    end
+                else
+                    EM::next_tick { worker.call() }     # continues work
+                end
+                
+            end
+            
+            worker.call()
+        end
+        
+        ##
+        # Closes the file.
+        #
+        
+        def close
+            @native.close
+        end
+    end
+end

data/test.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák
+
+$:.push("./lib")
+require 'em-files'
+require "riot"
+
+test = Array::new(5)
+
+EM::run do
+
+    # Test 1
+    test[0] = EM::File::open("./~test1", "w")
+    test[0].close()
+    
+    # Test 2
+    EM::File::open("./~test1", "w") do |io|
+        io.write("x" * 300000) do |len|
+            test[1] = len
+            io.close()
+        end
+    end
+
+    EM::add_timer(1) do
+        # Test 3
+        EM::File::open("./~test1", "r") do |io|
+            io.read do |data|
+                test[2] = data
+                io.close()
+            end
+        end
+    end
+    
+    # Test 4
+    EM::File::write("./~test2", "x" * 300000) do |len|
+        test[3] = len
+    end
+    
+    EM::add_timer(1) do
+        # Test 5
+        EM::File::read("./~test2") do |data|
+            test[4] = data
+        end
+    end
+    
+    EM::add_timer(2) do 
+        EM::stop
+    end
+    
+end
+
+
+context "EM::Files (instance methods)" do
+    setup { test }
+    
+    asserts("#open returns EM::File object") do 
+        topic[0].kind_of? EM::File
+    end
+    asserts("file size produced by #write is equivalent to reported written data length") do 
+        topic[1] == File.size?("./~test1")
+    end
+    asserts("file content produced by #write is correct and #read works well") do
+        topic[2] == "x" * 300000
+    end
+    
+    teardown do 
+        File.unlink("./~test1")
+    end
+end
+
+context "EM::Files (class methods)" do
+    setup { test }
+    
+    asserts("file size produced by #write is equivalent to reported written data length") do 
+        topic[1] == File.size?("./~test2")
+    end
+    asserts("file content produced by #write is correct and #read works well") do
+        topic[2] == "x" * 300000
+    end
+    
+    teardown do 
+        File.unlink("./~test2")
+    end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: em-files
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- em-file.gemspec
+- lib/em-files.rb
+- test.rb
+has_rdoc: true
+homepage: https://github.com/martinkozak/em-files
+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: 2457539952407610451
+      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.5.3
+signing_key: 
+specification_version: 3
+summary: Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO while operating with large files.
+test_files: []
+