writev 1.0.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib          = 'minitest/autorun'
+  at.find_directories = ARGV unless ARGV.empty?
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-08-19
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bench.rb
+ext/writev/extconf.rb
+ext/writev/writev.c
+lib/writev.rb
+test/test_writev.rb

data/README.rdoc

@@ -0,0 +1,52 @@
+= writev
+
+* http://github.com/tenderlove/writev
+
+== DESCRIPTION:
+
+This gem adds the `writev` method to IO.  It provides access to the `writev`
+system call on your IO objects.
+
+== FEATURES/PROBLEMS:
+
+* Currently only works on SUS systems and Ruby 1.9
+
+== SYNOPSIS:
+
+    file = Tempfile.new('foo')
+    file.writev %w{ hello world }
+    assert_equal 'helloworld', File.read(file.path)
+    file.unlink
+
+== REQUIREMENTS:
+
+* Ruby 1.9
+
+== INSTALL:
+
+* gem install writev
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,33 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+gem 'rake-compiler', '>= 0.4.1'
+require "rake/extensiontask"
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :minitest
+Hoe.plugin :gemspec   # `gem install hoe-gemspec`
+Hoe.plugin :git       # `gem install hoe-git`
+Hoe.plugin :debugging # `gem install hoe-debugging`
+
+Hoe.spec 'writev' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+
+  extra_dev_deps << ['rake-compiler', '>= 0.4.1']
+
+  self.spec_extras = {
+    :extensions            => ["ext/writev/extconf.rb"],
+    :required_ruby_version => '>= 1.9.2'
+  }
+
+  Rake::ExtensionTask.new "writev", spec do |ext|
+    ext.lib_dir = File.join(*['lib', ENV['FAT_DIR']].compact)
+  end
+end
+
+# vim: syntax=ruby

data/bench.rb

@@ -0,0 +1,29 @@
+require 'writev'
+require 'tempfile'
+require 'benchmark'
+
+LIST = File.readlines '/usr/share/dict/words'
+p LIST.length
+
+Benchmark.bm(7) do |x|
+  x.report('write') {
+    file = Tempfile.new('write')
+    LIST.each { |l| file.write l }
+    file.unlink
+  }
+  x.report('writev') {
+    file = Tempfile.new('write1')
+    LIST.each_slice(IO::IOV_MAX) do |slice|
+      file.writev slice
+    end
+    file.unlink
+  }
+end
+
+# /* vim: set et sws=2 sw=2: */
+__END__
+[aaron@higgins writev (master)]$ ruby -I lib bench.rb
+235886
+              user     system      total        real
+write     0.270000   0.010000   0.280000 (  0.293202)
+writev    0.020000   0.040000   0.060000 (  0.087576)

data/ext/writev/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile 'writev'

data/ext/writev/writev.c

@@ -0,0 +1,59 @@
+#include <ruby.h>
+#include <ruby/io.h>
+#include <sys/uio.h>
+
+VALUE rb_IOV_MAX;
+
+static VALUE
+rb_io_check_io(VALUE io)
+{
+    return rb_check_convert_type(io, T_FILE, "IO", "to_io");
+}
+
+#define rb_sys_fail_path(path) rb_sys_fail(NIL_P(path) ? 0 : RSTRING_PTR(path))
+
+static VALUE rb_writev(VALUE io, VALUE list)
+{
+    rb_io_t * fptr;
+    struct iovec * iov;
+    long i;
+    ssize_t written;
+    VALUE tmp;
+
+#ifdef IOV_MAX
+    if(RARRAY_LEN(list) > IOV_MAX)
+#else
+    if(RARRAY_LEN(list) > NUM2INT(rb_IOV_MAX))
+#endif
+	rb_raise(rb_eArgError, "list is too long");
+
+    tmp = rb_io_check_io(io);
+    GetOpenFile(tmp, fptr);
+    rb_io_check_writable(fptr);
+
+    iov = xcalloc(RARRAY_LEN(list), sizeof(struct iovec));
+
+    for(i = 0; i < RARRAY_LEN(list); i++) {
+	VALUE string = rb_ary_entry(list, i);
+	iov[i].iov_base = StringValuePtr(string);
+	iov[i].iov_len = RSTRING_LEN(string);
+    }
+
+    if((written = writev(fptr->fd, iov, (int)RARRAY_LEN(list))) == -1)
+	rb_sys_fail_path(fptr->pathv);
+
+    return LONG2FIX(written);
+}
+
+void Init_writev()
+{
+    rb_define_method(rb_cIO, "writev", rb_writev, 1);
+#ifdef IOV_MAX
+    rb_IOV_MAX = INT2NUM(IOV_MAX);
+#else
+    rb_IOV_MAX = INT2NUM(sysconf(_SC_IOV_MAX));
+#endif
+    rb_define_const(rb_cIO, "IOV_MAX", rb_IOV_MAX);
+}
+
+/* vim: set noet sws=4 sw=4: */

data/lib/writev.rb

@@ -0,0 +1,5 @@
+require 'writev.so'
+
+module WriteV
+  VERSION = '1.0.0'
+end

data/test/test_writev.rb

@@ -0,0 +1,37 @@
+require 'minitest/autorun'
+require 'writev'
+require 'tempfile'
+
+class TestWritev < MiniTest::Unit::TestCase
+  def test_writev
+    file = Tempfile.new('foo')
+
+    file.writev %w{ hello world }
+    assert_equal 'helloworld', File.read(file.path)
+    file.unlink
+  end
+
+  def test_length
+    file = Tempfile.new('foo')
+
+    assert_equal 'helloworld'.bytesize, file.writev(%w{ hello world })
+    file.unlink
+  end
+
+  def test_fail
+    File.open(__FILE__, 'r') do |f|
+      assert_raises(IOError) do
+        f.writev %w{ hello world }
+      end
+    end
+  end
+
+  def test_list_too_long
+    file = Tempfile.new('foo')
+    assert_raises(ArgumentError) do
+      file.writev %w{ x } * (IO::IOV_MAX + 1)
+    end
+  end
+end
+
+# /* vim: set et sws=2 sw=2: */

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: writev
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 9
+        version: "2.9"
+  type: :development
+  version_requirements: *id003
+description: |-
+  This gem adds the `writev` method to IO.  It provides access to the `writev`
+  system call on your IO objects.
+email: 
+- aaron@tenderlovemaking.com
+executables: []
+
+extensions: 
+- ext/writev/extconf.rb
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bench.rb
+- ext/writev/extconf.rb
+- ext/writev/writev.c
+- lib/writev.rb
+- test/test_writev.rb
+- .gemtest
+homepage: http://github.com/tenderlove/writev
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 55
+      segments: 
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: writev
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: This gem adds the `writev` method to IO
+test_files: 
+- test/test_writev.rb