em-files 0.2.2 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62ff47859673a6926ae57bbdcda8ca008c6c984e
+  data.tar.gz: 63012e9ebab2c65fca2a46d8a3206881983b191f
+SHA512:
+  metadata.gz: 4b42eb937b66da976d1287dd2dd01200c8ff0229dfe7f3738df7ed17b39ac124e84a088087719c7b28f623c22003a987a49f2ea853289b11f89886d56c1bbd9d
+  data.tar.gz: 8417c47d9eab4d9e02ecdf478b7b0fe767d89db5d23bbde324e7f66fbc08a18275d725d2a969120f1006c306f8a49d91947c64de9f3e8f307c164ace434397d6

data/Gemfile

@@ -1,13 +1,13 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-   gem "eventmachine", ">= 0.12.10"
+   gem "eventmachine", ">= 0"
    gem "hash-utils", ">= 0.14.0"
 
 # 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"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.5.2"
   gem "riot", ">= 0.12.1"
 end

data/Gemfile.lock

@@ -1,24 +1,66 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    eventmachine (0.12.10)
-    git (1.2.5)
-    hash-utils (0.14.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    addressable (2.3.8)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    eventmachine (1.0.7)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hash-utils (2.2.0)
+      ruby-version (>= 0.4.0)
+    hashie (3.4.2)
+    highline (1.7.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
       git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
       rake
-    rake (0.8.7)
-    riot (0.12.2)
+      rdoc
+    jwt (1.5.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    riot (0.12.7)
       rr
-    rr (1.0.2)
+    rr (1.1.2)
+    ruby-version (0.4.3)
+    thread_safe (0.3.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  eventmachine (>= 0.12.10)
+  bundler (>= 1.0.0)
+  eventmachine
   hash-utils (>= 0.14.0)
-  jeweler (~> 1.5.2)
+  jeweler (>= 1.5.2)
   riot (>= 0.12.1)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+Copyright (c) 2011 - 2015 Martin Poljak (martin@poljak.cz)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,85 +1,86 @@
 EventMachine Files
 ==================
 
-**em-files** solve problem of blocking disk IO when operating with 
+**em-files** solve problem of blocking disk IO when 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 
+file IO operations of sure, but allow running other tasks with them
 simultaneously (from EM point of view).
 
+There  is, of sure, question whethet this all has sense as `EM::defer` is availiable for handing these blocking tasks. But sometimes are situations, in which it's undesirable to do them in separate thread.
+
 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
+```ruby
+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
-    
+```ruby
+EM::File::open("some_file.txt", "r") do |io|
+    io.native   # returns native Ruby File class object
+end
+```
+
 ### Special Uses
 
-It's possible to use also another IO objects than `File` object by 
+It's possible to use also another IO objects than `File` object by
 giving appropriate IO instance instead of filename to methods:
 
-    require "em-files"
-    require "stringio"
-    
-    io = StringIO::new
-    
-    EM::run do
-        EM::File::open(io) do |io|
-            # some multiplexed operations
-        end
+```ruby
+require "em-files"
+require "stringio"
+
+io = StringIO::new
+
+EM::run do
+    EM::File::open(io) do |io|
+        # some multiplexed operations
     end
-    
+end
+```
+
 By this way you can also perform for example more time consuming
-operations by simple way (if they can be processed in block manner) 
+operations by simple way (if they can be processed in block manner)
 using filters:
 
-    require "em-files"
-    require "zlib"
+```ruby
+require "em-files"
+require "zlib"
 
-    zip = Zlib::Deflate::new
-    filter = Proc::new { |chunk| zip.deflate(chunk, Zlib::SYNC_FLUSH) }
-    data = "..."    # some data bigger than big
-    
-    EM::run do
-        EM::File::write(data, filter)   # done in several ticks
-    end
-    
-`#write` supports also copying data from another IO stream because it 
-uses `StringIO` internally. Simply give it IO object instead of 
-`String`. It will read it until EOF will occur.
+zip = Zlib::Deflate::new
+filter = Proc::new { |chunk| zip.deflate(chunk, Zlib::SYNC_FLUSH) }
+data = "..."    # some data bigger than big
+
+EM::run do
+    EM::File::write(data, filter)   # done in several ticks
+end
+```
 
-    
-Contributing
-------------
+`#write` supports also copying data from another IO stream because it
+uses `StringIO` internally. Simply give it IO object instead of
+`String`. It will read it until EOF will occur.
 
-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.
+Copyright © 2011 – 2015 [Martin Poljak][3]. See `LICENSE.txt` for further details.
 
 [1]: http://www.ruby-doc.org/core/classes/File.html
 [2]: http://github.com/martinkozak/em-files/issues
-[3]: http://www.martinkozak.net/
+[3]: http://www.martinpoljak.net/
 [4]: http://rubyeventmachine.com/

data/Rakefile

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -8,30 +9,21 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
+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 when operating with large files."
-  gem.email = "martinkozak@martinkozak.net"
-  gem.authors = ["Martin Kozák"]
+  gem.email = "martin@poljak.cz"
+  gem.authors = ["Martin Poljak"]
   # 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

@@ -1 +1 @@
-0.2.2
+0.2.3

data/em-files.gemspec

@@ -2,15 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: em-files 0.2.3 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = %q{em-files}
-  s.version = "0.2.2"
+  s.name = "em-files"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Martin Kozák"]
-  s.date = %q{2011-03-25}
-  s.email = %q{martinkozak@martinkozak.net}
+  s.require_paths = ["lib"]
+  s.authors = ["Martin Poljak"]
+  s.date = "2015-07-18"
+  s.email = "martin@poljak.cz"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -27,33 +29,32 @@ Gem::Specification.new do |s|
     "lib/em-files.rb",
     "test.rb"
   ]
-  s.homepage = %q{https://github.com/martinkozak/em-files}
+  s.homepage = "https://github.com/martinkozak/em-files"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO when operating with large files.}
+  s.rubygems_version = "2.4.5"
+  s.summary = "Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO when operating with large files."
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
       s.add_runtime_dependency(%q<hash-utils>, [">= 0.14.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_development_dependency(%q<riot>, [">= 0.12.1"])
     else
-      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
       s.add_dependency(%q<hash-utils>, [">= 0.14.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_dependency(%q<riot>, [">= 0.12.1"])
     end
   else
-    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
     s.add_dependency(%q<hash-utils>, [">= 0.14.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
     s.add_dependency(%q<riot>, [">= 0.12.1"])
   end
 end

data/lib/em-files.rb

@@ -39,6 +39,7 @@ module EM
         # @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
+        # @yield [File] file access object
         #
 
         def self.open(filepath, mode = "r", rwsize = self::RWSIZE, &block)   # 64 kilobytes
@@ -46,7 +47,7 @@ module EM
             
             file = self::new(filepath, mode, rwsize)
             if not block.nil?
-                block.call(file)
+                yield file
             end
             
             return file
@@ -62,6 +63,7 @@ module EM
         # @param [Proc] filter filter which for postprocessing each 
         #   read chunk
         # @param [Proc] block block for giving back the result
+        # @yield [String] read data
         #
         
         
@@ -70,7 +72,7 @@ module EM
             self::open(filepath, "rb", rwsize) do |io|
                 io.read(nil, filter) do |out|
                     io.close()
-                    block.call(out)
+                    yield out
                 end
             end
         end
@@ -87,6 +89,7 @@ module EM
         #   written chunk
         # @param [Proc] block block called when writing is finished with
         #   written bytes size count as parameter
+        # @yield [Integer] really written data length
         #
         
         def self.write(filepath, data = "", rwsize = self::RWSIZE, filter = nil, &block)
@@ -94,7 +97,9 @@ module EM
             self::open(filepath, "wb", rwsize) do |io|
                 io.write(data, filter) do |length|
                     io.close()
-                    block.call(length)
+                    if not block.nil?
+                        yield length
+                    end
                 end
             end
         end
@@ -161,10 +166,12 @@ module EM
         #   @param [Proc] filter filter which for postprocessing each 
         #       read chunk
         #   @param [Proc] block callback for returning the result
+        #   @yield [String] read data
         # @overload read(&block)
         #   Reads whole content of file.
         #   @param [Proc] filter filter which for processing each block
         #   @param [Proc] block callback for returning the result
+        #   @yield [String] read data
         #
         
         def read(length = nil, filter = nil, &block)
@@ -211,7 +218,7 @@ module EM
                 # Returns or continues work
                 if @native.eof? or (buffer.length == length)
                     if not block.nil?
-                        block.call(buffer)              # returns result
+                        yield buffer              # returns result
                     end
                 else
                     EM::next_tick { worker.call() }     # continues work
@@ -232,7 +239,9 @@ module EM
         
         ##
         # Writes data to file. Supports writing both strings or copying 
-        # from another IO object.
+        # from another IO object. Returns length of written data to 
+        # callback if filename given or current position of output 
+        # string if IO used.
         #
         # It will reopen the file if +EBADF: Bad file descriptor+ of 
         # +File+ class IO object will occur on +File+ object.
@@ -242,6 +251,7 @@ module EM
         #   written chunk
         # @param [Proc] block callback called when finish and for giving
         #   back the length of written data
+        # @yield [Integer] length of really written data
         #
         
         def write(data, filter = nil, &block)
@@ -277,7 +287,7 @@ module EM
                 # Returns or continues work
                 if io.eof?
                     if not block.nil?
-                        block.call(pos)                 # returns result
+                        yield pos                 # returns result
                     end
                 else
                     EM::next_tick { worker.call() }     # continues work

metadata

@@ -1,84 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-files
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.2.2
+version: !ruby/object:Gem::Version
+  version: 0.2.3
 platform: ruby
-authors: 
-- "Martin Koz\xC3\xA1k"
+authors:
+- Martin Poljak
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-25 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.12.10
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: hash-utils
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.14.0
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
   name: riot
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.12.1
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
 description: 
-email: martinkozak@martinkozak.net
+email: martin@poljak.cz
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
-- .document
+files:
+- ".document"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -88,36 +98,29 @@ files:
 - em-files.gemspec
 - lib/em-files.rb
 - test.rb
-has_rdoc: true
 homepage: https://github.com/martinkozak/em-files
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -2585745239736637618
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: Sequenced file reader and writer through EventMachine. Solves problem of blocking disk IO when operating with large files.
+specification_version: 4
+summary: Sequenced file reader and writer through EventMachine. Solves problem of
+  blocking disk IO when operating with large files.
 test_files: []
-