io-like 0.3.0 → 0.3.1

data/HACKING

@@ -1,123 +0,0 @@
-= Guide to Hacking IO::Like
-
-== Licensing
-
-Contributed code must be licensed under the same license as this project.  See
-the included LICENSE file for details.  Special consideration MAY be made in
-some cases, but such cases will be rare.
-
-
-== Dependencies
-
-=== Runtime
-
-* Ruby 1.8.6 or greater
-
-
-=== Build
-
-* rubygems 0.9.0 or greater
-* rake 0.8.3 or greater
-* mspec 1.5.9 (optional - used for testing)
-* allison 2.0.3 (optional - used for documentation only, if available)
-* rsync (optional - used for publishing documentation)
-
-
-=== Install
-
-* rubygems 0.9.0 or greater
-
-
-== Versioning Policy
-
-Version numbers will be in <em>x.y.z</em> format, where <em>x</em>, <em>y</em>,
-and <em>z</em> are integers starting from 0.  The version increment rules are
-as follows:
-
-<b>x</b>:: Planned releases which implement significant changes and/or break API
-           compatibility.  An exception is to be made for the transition from
-           the <em>0.y.z</em> series to the <em>1.y.z</em> series since the
-           <em>0.y.z</em> series is expected to be unstable throughout
-           development.  When incremented, <em>y</em> and <em>z</em> are reset
-           to 0.
-<b>y</b>:: Planned releases which incorporate numerous bug fixes and/or new
-           features which do not break backward compatibility.  When
-           incremented, <em>z</em> is reset to 0.
-<b>z</b>:: Generally, unplanned releases which incorporate a single fix for a
-           critical defect.
-
-This is the {Rational Versioning Policy}[http://www.rubygems.org/read/chapter/7]
-as outlined in the {RubyGems User Guide}[http://www.rubygems.org/read/book/1].
-
-
-== Support Policy
-
-Due to limitations in resources (time/money/manpower), this project will focus
-primarily upon the development line of the current release at any given time.
-Fixes and new features should be applied first to that development line and then
-backported to earlier releases if necessary and feasible.  Long term maintenance
-of previous releases is not planned.  Users are generally expected to upgrade to
-the latest release in order to receive updates unless an explicit declaration of
-support for a previous release is made.
-
-
-== Coding Style
-
-The following points are not necessarily set in stone but should rather be used
-as a good guideline.  Consistency is the goal of coding style, and changes will
-be more easily accepted if they are consistent with the rest of the code.
-
-<b>File Encoding</b>::     UTF-8
-<b>Indentation</b>::       Two spaces; no tabs
-<b>Comments</b>::          Document classes, attributes, methods, and code
-<b>Boolean Operators</b>:: Use <tt>&&</tt> and <tt>||</tt> for boolean tests;
-                           avoid <tt>and</tt> and <tt>or</tt>
-<b>Method Calls</b>::      Use <tt>a_method(arg, arg, etc)</tt>; <b>not</b>
-                           <tt>a_method( arg, arg, etc )</tt>,
-                           <tt>a_method arg, arg, etc</tt>, or any other
-                           variation
-<b>Blocks</b>::            <tt>do end</tt> for multi-line blocks and
-                           <tt>{ }</tt> for single-line blocks
-<b>Line length</b>::       Limit lines to a maximum of 80 characters
-<b>General</b>::           Try to follow the flow and style of the rest of the
-                           code
-
-
-== Generating Patches
-
-Patches should usually be generated against the <em>HEAD</em> revision of the
-<em>master</em> branch.  When generating patches, please try to implement only
-a single feature or bug fix per patch.  Documentation describing a patch should
-be included along with the patch so that the maintainer can more easily
-determine whether or not a patch is acceptable.  Patches lacking the necessary
-documentation will be ignored.
-
-Patches will be much more readily accepted if test cases are provided which
-verify correct operation.  Such test cases should be provided within the patch
-rather than as a separate patch.  Proper documentation, especially for
-user-visible APIs, is highly prized; providing accurate and detailed
-documentation, often in the form of rubydocs, throughout new code contributions
-will also increase the desirability of a patch.
-
-If a series of patches is generated which cannot be applied individually, make
-sure to mention the dependency relationships in whatever medium is being used
-to distribute the patches.  For instance, if a bug is discovered while
-implementing a new feature, create a patch which fixes the bug followed by a
-separate patch adding the feature.  If the feature patch requires the bug fix
-patch in order to work, note that dependency in the comments for the feature
-patch by somehow referencing the bug fix patch.
-
-The patch generation process in general:
-  $ git clone git://rubyforge.org/io-like.git  # Clone the repo and check out
-                                               # the master branch.
-  $ cd io-like                                 # Enter the workspace.
-  (make and test changes)
-  $ git add file1 file2 ..                     # Add new/modified files.
-  $ git commit                                 # Commit changes.
-  $ git format-patch -C HEAD^                  # Create a patch for the last
-                                               # commit.
-
-Repeat as necessary until all patches are generated.  Then either attach them to
-1 or more email messages addressed to the maintainer or attach them to tickets
-in the issue tracker for the project.  Remember to include a brief description
-of the patch and its dependencies, if any.

data/LEGAL

@@ -1,56 +0,0 @@
-= Other Legalities
-
-== Files Licensed Differently
-
-The following file(s) are provided under a license or licenses separate from
-this project.
-
-See LICENSE.rubyspec for terms of use for the following:
-  spec/binmode_spec.rb
-  spec/close_read_spec.rb
-  spec/close_spec.rb
-  spec/close_write_spec.rb
-  spec/closed_spec.rb
-  spec/each_byte_spec.rb
-  spec/each_line_spec.rb
-  spec/each_spec.rb
-  spec/eof_spec.rb
-  spec/fixtures/classes.rb
-  spec/fixtures/gets.txt
-  spec/fixtures/numbered_lines.txt
-  spec/fixtures/one_byte.txt
-  spec/fixtures/paragraphs.txt
-  spec/fixtures/readlines.txt
-  spec/flush_spec.rb
-  spec/getc_spec.rb
-  spec/gets_spec.rb
-  spec/isatty_spec.rb
-  spec/lineno_spec.rb
-  spec/output_spec.rb
-  spec/pos_spec.rb
-  spec/print_spec.rb
-  spec/printf_spec.rb
-  spec/putc_spec.rb
-  spec/puts_spec.rb
-  spec/read_spec.rb
-  spec/readchar_spec.rb
-  spec/readline_spec.rb
-  spec/readlines_spec.rb
-  spec/readpartial_spec.rb
-  spec/rewind_spec.rb
-  spec/seek_spec.rb
-  spec/shared/each.rb
-  spec/shared/eof.rb
-  spec/shared/pos.rb
-  spec/shared/tty.rb
-  spec/shared/write.rb
-  spec/sync_spec.rb
-  spec/sysread_spec.rb
-  spec/sysseek_spec.rb
-  spec/syswrite_spec.rb
-  spec/tell_spec.rb
-  spec/to_io_spec.rb
-  spec/tty_spec.rb
-  spec/ungetc_spec.rb
-  spec/write_spec.rb
-  spec_helper.rb

data/MANIFEST

@@ -1,10 +0,0 @@
-CONTRIBUTORS
-GPL
-HACKING
-LEGAL
-LICENSE
-LICENSE.rubyspec
-MANIFEST
-NEWS
-README
-lib/io/like.rb

data/README

@@ -1,150 +0,0 @@
-= IO::Like - in the Likeness of IO
-
-The IO::Like module provides all of the methods of typical IO implementations
-such as File; most importantly the read, write, and seek series of methods.  A
-class which includes IO::Like needs to provide only a few methods in order to
-enable the higher level methods.  Buffering is automatically provided by default
-for the methods which normally provide it in IO.
-
-See the documentation for IO::Like for more details regarding the necessary
-methods.
-
-
-== License
-
-Copyright © 2008,2009 Jeremy Bopp <jeremy at bopp dot net>
-
-Licensed under the same terms as Ruby -- See the included LICENSE file for
-details
-
-Some parts licensed under the same terms as the rubyspec project -- See the
-included LEGAL and LICENSE.rubyspec files for details
-
-
-== Installation/Removal
-
-Download the GEM file and install it with:
-  % sudo gem install io-like-VERSION.gem
-
-or directly with:
-  % sudo gem install io-like
-
-Removal is the same in either case:
-  % sudo gem uninstall io-like
-
-
-== Example
-More examples can be found in the +examples+ directory of the source
-distribution.
-
-A simple ROT13 codec:
-  gem 'io-like'  # Use require_gem for rubygems versions older than 0.9.0.
-  require 'io/like'
-
-  class ROT13Filter
-    include IO::Like
-
-    def self.open(delegate_io)
-      filter = new(delegate_io)
-      return filter unless block_given?
-
-      begin
-        yield(filter)
-      ensure
-        filter.close unless filter.closed?
-      end
-    end
-
-    def initialize(delegate_io)
-      @delegate_io = delegate_io
-    end
-
-    private
-
-    def encode_rot13(string)
-      result = string.dup
-      0.upto(result.length) do |i|
-        case result[i]
-        when 65..90
-          result[i] = (result[i] - 52) % 26 + 65
-        when 97..122
-          result[i] = (result[i] - 84) % 26 + 97
-        end
-      end
-      result
-    end
-
-    def unbuffered_read(length)
-      encode_rot13(@delegate_io.sysread(length))
-    end
-
-    def unbuffered_seek(offset, whence = IO::SEEK_SET)
-      @delegate_io.sysseek(offset, whence)
-    end
-
-    def unbuffered_write(string)
-      @delegate_io.syswrite(encode_rot13(string))
-    end
-  end
-
-  File.open('normal_file.txt', 'w') do |f|
-    f.puts('This is a test')
-  end
-
-  File.open('rot13_file.txt', 'w') do |f|
-    ROT13Filter.open(f) do |rot13|
-      rot13.puts('This is a test')
-    end
-  end
-
-  File.open('normal_file.txt') do |f|
-    ROT13Filter.open(f) do |rot13|
-      puts(rot13.read)                      # -> Guvf vf n grfg
-    end
-  end
-
-  File.open('rot13_file.txt') do |f|
-    ROT13Filter.open(f) do |rot13|
-      puts(rot13.read)                      # -> This is a test
-    end
-  end
-
-  File.open('normal_file.txt') do |f|
-    ROT13Filter.open(f) do |rot13|
-      rot13.pos = 5
-      puts(rot13.read)                      # -> vf n grfg
-    end
-  end
-
-  File.open('rot13_file.txt') do |f|
-    ROT13Filter.open(f) do |rot13|
-      rot13.pos = 5
-      puts(rot13.read)                      # -> is a test
-    end
-  end
-
-  File.open('normal_file.txt') do |f|
-    ROT13Filter.open(f) do |rot13|
-      ROT13Filter.open(rot13) do |rot26|    # ;-)
-        puts(rot26.read)                    # -> This is a test
-      end
-    end
-  end
-
-
-== Known Bugs/Limitations
-
-1. Only up to version 1.8.6 of Ruby's IO interface is implemented.  Version
-   1.8.7 and eventually 1.9.0/2.0.0 support are coming soon.
-2. Ruby's finalization capabilities fall a bit short in a few respects, and as a
-   result, it is impossible to cause the close, close_read, or close_write
-   methods to be called automatically when an including class is garbage
-   collected.  Define a class open method in the manner of File.open which
-   guarantees that an appropriate close method will be called after executing a
-   block.  Other than that, be diligent about calling the close methods.
-
-
-== Contributing
-
-Contributions for bug fixes, documentation, extensions, tests, etc. are
-encouraged.  Please read the file HACKING for details.