io-like-0.3.0/0000755000175000017500000000000013323132033013224 5ustar mujipackmujipackio-like-0.3.0/CONTRIBUTORS0000644000175000017500000000026213323132033015104 0ustar mujipackmujipack= Authors * Jeremy Bopp * Primary author and maintainer = Bug Fixes * Jarred Holman = Testers = Documentation io-like-0.3.0/GPL0000644000175000017500000010666013323132033013602 0ustar mujipackmujipackGPL text follows: GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . io-like-0.3.0/io-like.gemspec0000644000175000017500000000426013323132033016124 0ustar mujipackmujipack######################################################### # This file has been automatically generated by gem2tgz # ######################################################### # -*- encoding: utf-8 -*- # stub: io-like 0.3.0 ruby lib Gem::Specification.new do |s| s.name = "io-like".freeze s.version = "0.3.0" s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version= s.require_paths = ["lib".freeze] s.authors = ["Jeremy Bopp".freeze] s.date = "2009-04-29" s.description = "The IO::Like module provides the methods of an IO object based upon on a few simple methods provided by the including class: unbuffered_read, unbuffered_write, and unbuffered_seek. These methods provide the underlying read, write, and seek support respectively, and only the method or methods necessary to the correct operation of the IO aspects of the including class need to be provided. Missing functionality will cause the resulting object to appear read-only, write-only, and/or unseekable depending on which underlying methods are absent. Additionally, read and write operations which are buffered in IO are buffered with independently configurable buffer sizes. Duplexed objects (those with separate read and write streams) are also supported.".freeze s.email = "jeremy at bopp dot net".freeze s.extra_rdoc_files = ["CONTRIBUTORS".freeze, "GPL".freeze, "HACKING".freeze, "LEGAL".freeze, "LICENSE".freeze, "LICENSE.rubyspec".freeze, "NEWS".freeze, "README".freeze] s.files = ["CONTRIBUTORS".freeze, "GPL".freeze, "HACKING".freeze, "LEGAL".freeze, "LICENSE".freeze, "LICENSE.rubyspec".freeze, "MANIFEST".freeze, "NEWS".freeze, "README".freeze, "lib/io/like.rb".freeze] s.homepage = "http://io-like.rubyforge.org".freeze s.rdoc_options = ["--title".freeze, "IO::Like Documentation".freeze, "--charset".freeze, "utf-8".freeze, "--line-numbers".freeze, "--inline-source".freeze] s.required_ruby_version = Gem::Requirement.new(">= 1.8.1".freeze) s.rubyforge_project = "io-like".freeze s.rubygems_version = "2.7.6".freeze s.summary = "A module which provides the functionality of an IO object to any class which provides a couple of simple methods.".freeze end io-like-0.3.0/HACKING0000644000175000017500000001257513323132033014225 0ustar mujipackmujipack= 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 x.y.z format, where x, y, and z are integers starting from 0. The version increment rules are as follows: x:: Planned releases which implement significant changes and/or break API compatibility. An exception is to be made for the transition from the 0.y.z series to the 1.y.z series since the 0.y.z series is expected to be unstable throughout development. When incremented, y and z are reset to 0. y:: Planned releases which incorporate numerous bug fixes and/or new features which do not break backward compatibility. When incremented, z is reset to 0. z:: 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. File Encoding:: UTF-8 Indentation:: Two spaces; no tabs Comments:: Document classes, attributes, methods, and code Boolean Operators:: Use && and || for boolean tests; avoid and and or Method Calls:: Use a_method(arg, arg, etc); not a_method( arg, arg, etc ), a_method arg, arg, etc, or any other variation Blocks:: do end for multi-line blocks and { } for single-line blocks Line length:: Limit lines to a maximum of 80 characters General:: Try to follow the flow and style of the rest of the code == Generating Patches Patches should usually be generated against the HEAD revision of the master 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. io-like-0.3.0/LICENSE0000644000175000017500000000512013323132033014227 0ustar mujipackmujipackLICENSE text follows: IO::Like is copyrighted free software by Jeremy Bopp . You can redistribute it and/or modify it under either the terms of the GPL (see the included GPL file), or the conditions below: 1. You may make and give away verbatim copies of the source form of the software without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may modify your copy of the software in any way, provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or by allowing the author to include your modifications in the software. b) use the modified software only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided. d) make other distribution arrangements with the author. 3. You may distribute the software in object code or executable form, provided that you do at least ONE of the following: a) distribute the executables and library files of the software, together with instructions (in the manual page or equivalent) on where to get the original distribution. b) accompany the distribution with the machine-readable source of the software. c) give non-standard executables non-standard names, with instructions on where to get the original software distribution. d) make other distribution arrangements with the author. 4. You may modify and include the covered part of the software into any other software (possibly commercial). But some files in the distribution may not be written by the author, such that they are not under these terms. (See the file LEGAL for a listing and conditions) 5. The scripts and library files supplied as input to or produced as output from the software do not automatically fall under the copyright of the software, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this software. 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. io-like-0.3.0/NEWS0000644000175000017500000000211513323132033013722 0ustar mujipackmujipack= News and Notifications by Version This file lists noteworthy changes which may affect users of this project. More detailed information is available in the rest of the documentation. NOTE: Date stamps in the following entries are in YYYY/MM/DD format. == v0.3.0 (2009/04/29) * Fixed the rewind method to work with write-only streams * Fixed the read, gets, and readline methods to return partial data if they have such data but receive low level errors before reaching a stopping point * Renamed all private methods so that it is highly unlikely that they will be accidentally overridden. * Eliminated warnings caused by referencing uninitialized instance variables * Improved the documentation for the read, gets, and readline methods == v0.2.0 (2009/03/11) * Added mspec tests borrowed from the rubyspec project * Fixed many, many defects related to IO compatibility (Mostly obscure corner cases) == v0.1.0 (2008/07/03) * Initial release * All read, write, and seek functions implemented as defined in Ruby 1.8.6 * Most other IO methods also provided as no-ops and similar io-like-0.3.0/MANIFEST0000644000175000017500000000013413323132033014353 0ustar mujipackmujipackCONTRIBUTORS GPL HACKING LEGAL LICENSE LICENSE.rubyspec MANIFEST NEWS README lib/io/like.rb io-like-0.3.0/README0000644000175000017500000000760513323132033014114 0ustar mujipackmujipack= 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 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. io-like-0.3.0/lib/0000755000175000017500000000000013323132033013772 5ustar mujipackmujipackio-like-0.3.0/lib/io/0000755000175000017500000000000013323132033014401 5ustar mujipackmujipackio-like-0.3.0/lib/io/like.rb0000644000175000017500000015340213323132033015657 0ustar mujipackmujipackclass IO # :nodoc: # IO::Like is a module which provides most of the basic input and output # functions of IO objects using methods named _unbuffered_read_, # _unbuffered_write_, and _unbuffered_seek_. # # == Readers # # In order to use this module to provide input methods, a class which # includes it must provide the _unbuffered_read_ method which takes one # argument, a length, as follows: # # def unbuffered_read(length) # ... # end # # This method must return at most _length_ bytes as a String, raise EOFError # if reading begins at the end of data, and raise SystemCallError on error. # Errno::EAGAIN should be raised if there is no data to return immediately and # the read operation should not block. Errno::EINTR should be raised if the # read operation is interrupted before any data is read. # # == Writers # # In order to use this module to provide output methods, a class which # includes it must provide the _unbuffered_write_ method which takes a single # string argument as follows: # # def unbuffered_write(string) # ... # end # # This method must either return the number of bytes written to the stream, # which may be less than the length of _string_ in bytes, OR must raise an # instance of SystemCallError. Errno::EAGAIN should be raised if no data can # be written immediately and the write operation should not block. # Errno::EINTR should be raised if the write operation is interrupted before # any data is written. # # == Seekers # # In order to use this module to provide seeking methods, a class which # includes it must provide the _unbuffered_seek_ method which takes two # required arguments, an offset and a start position, as follows: # # def unbuffered_seek(offset, whence) # ... # end # # This method must return the new position within the data stream relative to # the beginning of the stream and should raise SystemCallError on error. # _offset_ can be any integer and _whence_ can be any of IO::SEEK_SET, # IO::SEEK_CUR, or IO::SEEK_END. They are interpreted together as follows: # # whence | resulting position # -------------+------------------------------------------------------------ # IO::SEEK_SET | Add offset to the position of the beginning of the stream. # -------------+------------------------------------------------------------ # IO::SEEK_CUR | Add offset to the current position of the stream. # -------------+------------------------------------------------------------ # IO::SEEK_END | Add offset to the position of the end of the stream. # # == Duplexed Streams # # In order to create a duplexed stream where writing and reading happen # independently of each other, override the #duplexed? method to return # +true+ and then provide the _unbuffered_read_ and _unbuffered_write_ # methods. Do *NOT* provide an _unbuffered_seek_ method or the contents of # the internal read and write buffers may be lost unexpectedly. # --- # NOTE: Due to limitations of Ruby's finalizer, IO::Like#close is not # automatically called when the object is garbage collected, so it must be # explicitly called when the object is no longer needed or risk losing # whatever data remains in the internal write buffer. module Like include Enumerable # call-seq: # ios << obj -> ios # # Writes _obj_ to the stream using #write and returns _ios_. _obj_ is # converted to a String using _to_s_. def <<(obj) write(obj) self end # call-seq: # ios.binmode -> ios # # Returns +self+. Just for compatibility with IO. def binmode self end # call-seq: # ios.close -> nil # # Arranges for #closed? to return +true+. Raises IOError if #closed? # already returns +true+. For duplexed objects, calls #close_read and # #close_write. For non-duplexed objects, calls #flush if #writable? # returns +true+ and then sets a flag so that #closed? will return +true+. def close raise IOError, 'closed stream' if closed? __io_like__close_read flush if writable? __io_like__close_write nil end # call-seq: # ios.close_read -> nil # # Closes the read end of a duplexed object or the whole object if the object # is read-only. # # Raises IOError if #closed? returns +true+. Raises IOError for duplexed # objects if called more than once. Raises IOError for non-duplexed objects # if #writable? returns +true+. def close_read raise IOError, 'closed stream' if closed? if __io_like__closed_read? || ! duplexed? && writable? then raise IOError, 'closing non-duplex IO for reading' end if duplexed? then __io_like__close_read else close end nil end # call-seq: # ios.close_write -> nil # # Closes the write end of a duplexed object or the whole object if the # object is write-only. # # Raises IOError if #closed? returns +true+. Raises IOError for duplexed # objects if called more than once. Raises IOError for non-duplexed objects # if #readable? returns +true+. def close_write raise IOError, 'closed stream' if closed? if __io_like__closed_write? || ! duplexed? && readable? then raise IOError, 'closing non-duplex IO for reading' end if duplexed? then flush __io_like__close_write else close end nil end # call-seq: # ios.closed? -> true or false # # Returns +true+ if this object is closed or otherwise unusable for read and # write operations. def closed? (__io_like__closed_read? || ! readable?) && (__io_like__closed_write? || ! writable?) end # call-seq: # ios.duplexed? -> true or false # # Returns +false+. Override this to return +true+ when creating duplexed # IO objects. def duplexed? false end # call-seq: # ios.each_byte { |byte| block } -> ios # # Reads each byte (0..255) from the stream using #getc and calls the given # block once for each byte, passing the byte as an argument. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_read. Therefore, this method always blocks. Aside from that # exception and the conversion of EOFError results into +nil+ results, this # method will also raise the same errors and block at the same times as # #unbuffered_read. def each_byte while (byte = getc) do yield(byte) end self end # call-seq: # ios.each_line(sep_string = $/) { |line| block } -> ios # ios.each(sep_string = $/) { |line| block } -> ios # # Reads each line from the stream using #gets and calls the given block once # for each line, passing the line as an argument. # # NOTE: When _sep_string_ is not +nil+, this method ignores # Errno::EAGAIN and Errno::EINTR raised by #unbuffered_read. Therefore, # this method always blocks. Aside from that exception and the conversion # of EOFError results into +nil+ results, this method will also raise the # same errors and block at the same times as #unbuffered_read. def each_line(sep_string = $/) while (line = gets(sep_string)) do yield(line) end self end alias :each :each_line # call-seq: # ios.eof? -> true or false # ios.eof -> true or false # # Returns +true+ if there is no more data to read. # # This works by using #getc to fetch the next character and using #ungetc to # put the character back if one was fetched. It may be a good idea to # replace this implementation in derivative classes. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_read. Therefore, this method always blocks. Aside from that # exception and the conversion of EOFError results into +nil+ results, this # method will also raise the same errors and block at the same times as # #unbuffered_read. def eof? if (char = getc) then ungetc(char) return false end true end alias :eof :eof? # call-seq: # ios.fcntl # # Raises NotImplementedError. def fcntl(*args) raise NotImplementedError, 'not implemented' end # call-seq: # ios.fileno -> nil # # Returns +nil+. Just for compatibility with IO. def fileno nil end # call-seq: # ios.fill_size -> integer # # Returns the number of bytes to read as a block whenever the internal # buffer needs to be refilled. Unless set explicitly via #fill_size=, this # defaults to 4096. # # Raises IOError if #closed? returns +true+. Raises IOError if the # stream is not opened for reading. def fill_size raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? @__io_like__fill_size ||= 4096 end # call-seq: # ios.fill_size = integer -> integer # # Sets the number of bytes to read as a block whenever the internal read # buffer needs to be refilled. The new value must be a number greater than # or equal to 0. Setting this to 0 effectively disables buffering. # # Raises IOError if #closed? returns +true+. Raises IOError if the # stream is not opened for reading. def fill_size=(fill_size) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? unless fill_size >= 0 then raise ArgumentError, "non-positive fill_size #{fill_size} given" end @__io_like__fill_size = fill_size end # call-seq: # ios.flush -> ios # # Flushes the internal write buffer to the underlying data stream. # # Regardless of the blocking status of the data stream or interruptions # during writing, this method will block until either all the data is # flushed or until an error is raised. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # flush the internal write buffer. Aside from that exception, this # method will also raise the same errors and block at the same times as # #unbuffered_write. def flush begin __io_like__buffered_flush rescue Errno::EAGAIN, Errno::EINTR retry if write_ready? end self end # call-seq: # ios.flush_size -> integer # # Returns the number of bytes at which the internal write buffer is flushed # automatically to the data stream. Unless set explicitly via #flush_size=, # this defaults to 4096. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. def flush_size raise IOError, 'closed stream' if closed? raise IOError, 'not opened for writing' unless writable? @__io_like__flush_size ||= 4096 end # call-seq: # ios.flush_size = integer -> integer # # Sets the number of bytes at which the internal write buffer is flushed # automatically to the data stream. The new value must be a number greater # than or equal to 0. Setting this to 0 effectively disables buffering. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. def flush_size=(flush_size) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for writing' unless writable? unless flush_size >= 0 then raise ArgumentError, "non-positive flush_size #{flush_size} given" end @__io_like__flush_size = flush_size end # call-seq: # ios.getc -> nil or integer # # Calls #readchar and either returns the result or +nil+ if #readchar raises # EOFError. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. Raises all errors raised by #unbuffered_read # except for EOFError. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_read. Therefore, this method always blocks. Aside from that # exception and the conversion of EOFError results into +nil+ results, this # method will also raise the same errors and block at the same times as # #unbuffered_read. def getc readchar rescue EOFError nil end # call-seq: # ios.gets(sep_string = $/) -> nil or string # # Calls #readline with _sep_string_ as an argument and either returns the # result or +nil+ if #readline raises EOFError. If #readline returns some # data, $. is set to the value of #lineno. # # NOTE: Due to limitations of MRI up to version 1.9.x when running # managed (Ruby) code, this method fails to set $_ to the returned # data; however, other implementations may allow it. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. Raises all errors raised by #unbuffered_read # except for EOFError. # # NOTE: When _sep_string_ is not +nil+, this method ignores # Errno::EAGAIN and Errno::EINTR raised by #unbuffered_read. Therefore, # this method will always block in that case. Aside from that exception, # this method will raise the same errors and block at the same times as # #unbuffered_read. def gets(sep_string = $/) # Set the last read line in the global. $_ = readline(sep_string) # Set the last line number in the global. $. = lineno # Return the last read line. $_ rescue EOFError nil end # call-seq: # ios.isatty -> false # # Returns +false+. Just for compatibility with IO. # # Raises IOError if #closed? returns +true+. def isatty raise IOError, 'closed stream' if closed? false end alias :tty? :isatty # call-seq: # ios.lineno -> integer # # Returns the number of times #gets was called and returned non-+nil+ data. # By default this is the number of lines read, but calling #gets or any of # the other line-based reading methods with a non-default value for # _sep_string_ or after changing $/ will affect this. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. def lineno raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? @__io_like__lineno ||= 0 end # call-seq: # ios.lineno = lineno -> lineno # # Sets the current line number to the given value. $. is updated # by the _next_ call to #gets. If the object given is not an integer, it is # converted to one using its to_int method. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. def lineno=(integer) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? if integer.nil? then raise TypeError, 'no implicit conversion from nil to integer' elsif ! integer.respond_to?(:to_int) then raise TypeError, "can't convert #{integer.class} into Integer" end @__io_like__lineno = integer.to_int end # call-seq: # ios.path -> nil # # Returns +nil+. Just for compatibility with IO. def path nil end # call-seq: # ios.pos = position -> position # # Sets the data position to _position_ by calling #seek. # # As a side effect, the internal read and write buffers are flushed. # # Raises IOError if #closed? returns +true+. Raises Errno::ESPIPE unless # #seekable? returns +true+. # # NOTE: Because this method relies on #unbuffered_seek and # #unbuffered_write (when the internal write buffer is not empty), it will # also raise the same errors and block at the same times as those functions. def pos=(position) seek(position, IO::SEEK_SET) position end # call-seq: # ios.pos -> integer # # Returns the current offest of ios. # # Raises IOError if #closed? returns +true+. Raises Errno::ESPIPE unless # #seekable? returns +true+. # # As a side effect, the internal write buffer is flushed unless this is # a writable, non-duplexed object. This is for compatibility with the # behavior of IO#pos. # # NOTE: Because this method relies on #unbuffered_seek and # #unbuffered_write (when the internal write buffer is not empty), it will # also raise the same errors and block at the same times as those functions. def pos # Flush the internal write buffer for writable, non-duplexed objects. __io_like__buffered_flush if writable? && ! duplexed? __io_like__buffered_seek(0, IO::SEEK_CUR) end alias :tell :pos # call-seq: # ios.print([obj, ...]) -> nil # # Writes the given object(s), if any, to the stream using #write after # converting them to strings by calling their _to_s_ methods. If no # objects are given, $_ is used. The field separator ($,) # is written between successive objects if it is not +nil+. The output # record separator ($\\) is written after all other data if it is # not nil. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # immediately write +[obj, ...]+ completely. Aside from that exception, # this method will also raise the same errors and block at the same times as # #unbuffered_write. def print(*args) args << $_ if args.empty? first_arg = true args.each do |arg| # Write a field separator before writing each argument after the first # one unless no field separator is specified. if first_arg then first_arg = false elsif ! $,.nil? then write($,) end # If the argument is nil, write 'nil'; otherwise, write the stringified # form of the argument. if arg.nil? then write('nil') else write(arg) end end # Write the output record separator if one is specified. write($\) unless $\.nil? nil end # call-seq: # ios.printf(format_string [, obj, ...]) -> nil # # Writes the String returned by calling Kernel.sprintf using the given # arguments. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # immediately write its arguments completely. Aside from that exception, # this method will also raise the same errors and block at the same times as # #unbuffered_write. def printf(*args) write(sprintf(*args)) nil end # call-seq: # ios.putc(obj) -> obj # # If _obj_ is a String, write the first byte; otherwise, convert _obj_ to a # integer using its _to_int_ method and write the low order byte. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # immediately write _obj_ completely. Aside from that exception, this # method will also raise the same errors and block at the same times as # #unbuffered_write. def putc(obj) char = case obj when String obj[0].chr else [obj.to_int].pack('V')[0].chr end write(char) obj end # call-seq: # ios.puts([obj, ...]) -> nil # # Writes the given object(s), if any, to the stream using #write after # converting them to strings using their _to_s_ methods. Unlike #print, # Array instances are recursively processed. A record separator character # is written after each object which does not end with the record separator # already. If no objects are given, a single record separator is written. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # immediately write +[obj, ...]+ completely. Aside from that exception, # this method will also raise the same errors and block at the same times as # #unbuffered_write. # # NOTE: In order to be compatible with IO#puts, the record separator # is currently hardcoded to be a single newline ("\n") even though # the documentation implies that the output record separator ($\\) # should be used. def puts(*args) # Set the output record separator such that this method is compatible with # IO#puts. ors = "\n" # Write only the record separator if no arguments are given. if args.length == 0 then write(ors) return end # Write each argument followed by the record separator. Recursively # process arguments which are Array instances. args.each do |arg| line = arg.nil? ? 'nil' : arg.kind_of?(Array) ? __io_like__array_join(arg, ors) : arg.to_s line += ors if line.index(ors, -ors.length).nil? write(line) end nil end # call-seq: # ios.read([length[, buffer]]) -> nil, buffer, or string # # If _length_ is specified and is a positive integer, at most length bytes # are returned. Truncated data will occur if there is insufficient data # left to fulfill the request. If the read starts at the end of data, +nil+ # is returned. # # If _length_ is unspecified or +nil+, an attempt to return all remaining # data is made. Partial data will be returned if a low-level error is # raised after some data is retrieved. If no data would be returned at all, # an empty String is returned. # # If _buffer_ is specified, it will be converted to a String using its # +to_str+ method if necessary and will be filled with the returned data if # any. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. # # NOTE: Because this method relies on #unbuffered_read, it will also # raise the same errors and block at the same times as that function. def read(length = nil, buffer = nil) # Check the validity of the method arguments. unless length.nil? || length >= 0 then raise ArgumentError, "negative length #{length} given" end buffer = buffer.nil? ? '' : buffer.to_str buffer.slice!(0..-1) unless buffer.empty? if length.nil? then # Read and return everything. begin loop do buffer << __io_like__buffered_read(4096) end rescue EOFError # Ignore this. rescue SystemCallError # Reraise the error if there is nothing to return. raise if buffer.empty? end else # Read and return up to length bytes. begin buffer << __io_like__buffered_read(length) rescue EOFError # Return nil to the caller at end of file when requesting a specific # amount of data. return nil end end buffer end # call-seq: # ios.read_ready? -> true or false # # Returns +true+ when the stream may be read without error, +false+ # otherwise. This method will block until one of the conditions is known. # # This default implementation of #read_ready? is a hack which should be able # to work for both real IO objects and IO-like objects; however, it is # inefficient since it merely sleeps for 1 second and then returns +true+ as # long as #closed? returns +false+. IO.select should be used for real IO # objects to wait for a readable condition on platforms with support for # IO.select. Other solutions should be found as necessary to improve this # implementation on a case by case basis. # # Basically, this method should be overridden in derivative classes. def read_ready? return false unless readable? sleep(1) true end # call-seq: # ios.readable? -> true or false # # Returns +true+ if the stream is both open and readable, +false+ otherwise. # # This implementation checks to see if #unbuffered_read is defined in order # to make its determination. Override this if the implementing class always # provides the #unbuffered_read method but may not always be open in a # readable mode. def readable? ! __io_like__closed_read? && respond_to?(:unbuffered_read, true) end # call-seq: # ios.readbytes(length) -> string # # Reads and returns _length_ bytes from the data stream. # # Raises EOFError if reading begins at the end of the stream. Raises # IOError if #closed? returns +true+. Raises IOError unless #readable? # returns +true+. Raises TruncatedDataError if insufficient data is # immediately available to satisfy the request. # # In the case of TruncatedDataError being raised, the retrieved data can be # fetched from the _data_ attribute of the exception. # # This method is basically copied from IO#readbytes. # # NOTE: Because this method relies on #unbuffered_read, it will also # raise the same errors and block at the same times as that function. def readbytes(length) buffer = read(length) if buffer.nil? then raise EOFError, "end of file reached" end if buffer.length < length then raise TruncatedDataError.new("data truncated", buffer) end buffer end # call-seq: # ios.readchar -> integer # # Returns the next 8-bit byte (0..255) from the stream. # # Raises EOFError when there is no more data in the stream. Raises IOError # if #closed? returns +true+. Raises IOError unless #readable? returns # +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_read. Therefore, this method always blocks. Aside from that # exception, this method will also raise the same errors and block at the # same times as #unbuffered_read. def readchar __io_like__buffered_read(1)[0] rescue Errno::EAGAIN, Errno::EINTR retry if read_ready? end # call-seq: # ios.readline(sep_string = $/) -> string # # Returns the next line from the stream, where lines are separated by # _sep_string_. Increments #lineno by 1 for each call regardless # of the value of _sep_string_. # # If _sep_string_ is not +nil+ and not a String, it is first converted to a # String using its +to_str+ method and processing continues as follows. # # If _sep_string_ is +nil+, a line is defined as the remaining contents of # the stream. Partial data will be returned if a low-level error of any # kind is raised after some data is retrieved. This is equivalent to # calling #read without any arguments except that this method will raise an # EOFError if called at the end of the stream. # # If _sep_string_ is an empty String, a paragraph is returned, where a # paragraph is defined as data followed by 2 or more successive newline # characters. A maximum of 2 newlines are returned at the end of the # returned data. Fewer may be returned if the stream ends before at least 2 # successive newlines are seen. # # Any other value for _sep_string_ is used as a delimiter to mark the end of # a line. The returned data includes this delimiter unless the stream ends # before the delimiter is seen. # # In any case, the end of the stream terminates the current line. # # Raises EOFError when there is no more data in the stream. Raises IOError # if #closed? returns +true+. Raises IOError unless #readable? returns # +true+. # # NOTE: When _sep_string_ is not +nil+, this method ignores # Errno::EAGAIN and Errno::EINTR raised by #unbuffered_read. Therefore, # this method will always block in that case. Aside from that exception, # this method will raise the same errors and block at the same times as # #unbuffered_read. def readline(sep_string = $/) # Ensure that sep_string is either nil or a String. unless sep_string.nil? || sep_string.kind_of?(String) then sep_string = sep_string.to_str end buffer = '' begin if sep_string.nil? then # A nil line separator means that the user wants to capture all the # remaining input. loop do buffer << __io_like__buffered_read(4096) end else begin # Record if the user requested paragraphs rather than lines. paragraph_requested = sep_string.empty? # An empty line separator string indicates that the user wants to # return paragraphs. A pair of newlines in the stream is used to # mark this. sep_string = "\n\n" if paragraph_requested # Add each character from the input to the buffer until either the # buffer has the right ending or the end of the input is reached. while buffer.index(sep_string, -sep_string.length).nil? && (char = __io_like__buffered_read(1)) do buffer << char end if paragraph_requested then # If the user requested paragraphs instead of lines, we need to # consume and discard all newlines remaining at the front of the # input. while char == "\n" && (char = __io_like__buffered_read(1)) do nil end # Put back the last character. ungetc(char[0]) end rescue Errno::EAGAIN, Errno::EINTR retry if read_ready? end end rescue EOFError, SystemCallError # Reraise the error if there is nothing to return. raise if buffer.empty? end # Increment the number of times this method has returned a "line". self.lineno += 1 buffer end # call-seq: # ios.readlines(sep_string = $/) -> array # # Returns an Array containing the lines in the stream using #each_line. # # If _sep_string_ is +nil+, a line is defined as the remaining contents of # the stream. If _sep_string_ is not a String, it is converted to one using # its +to_str+ method. If _sep_string_ is empty, a paragraph is returned, # where a paragraph is defined as data followed by 2 or more successive # newline characters (only 2 newlines are returned at the end of the # returned data). # # In any case, the end of the stream terminates the current line. # # Raises EOFError when there is no more data in the stream. Raises IOError # if #closed? returns +true+. Raises IOError unless #readable? returns # +true+. # # NOTE: When _sep_string_ is not +nil+, this method ignores # Errno::EAGAIN and Errno::EINTR raised by #unbuffered_read. Therefore, # this method always blocks. Aside from that exception, this method will # also raise the same errors and block at the same times as # #unbuffered_read. def readlines(sep_string = $/) lines = [] each_line(sep_string) { |line| lines << line } lines end # call-seq: # ios.readpartial(length[, buffer]) -> string or buffer # # Returns at most _length_ bytes from the data stream using only the # internal read buffer if the buffer is not empty. Falls back to reading # from the stream if the buffer is empty. Blocks if no data is available # from either the internal read buffer or the data stream regardless of # whether or not the data stream would block. # # Raises EOFError when there is no more data in the stream. Raises IOError # if #closed? returns +true+. Raises IOError unless #readable? returns # +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_read. Therefore, this method always blocks if unable to # immediately return _length_ bytes. Aside from that exception, this method # will also raise the same errors and block at the same times as # #unbuffered_read. def readpartial(length, buffer = nil) # Check the validity of the method arguments. unless length >= 0 then raise ArgumentError, "negative length #{length} given" end buffer = '' if buffer.nil? # Flush the buffer. buffer.slice!(0..-1) # Read and return up to length bytes. if __io_like__internal_read_buffer.empty? then begin buffer << __io_like__buffered_read(length) rescue Errno::EAGAIN, Errno::EINTR retry if read_ready? end else raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? buffer << __io_like__internal_read_buffer.slice!(0, length) end buffer end # call-seq: # ios.rewind -> 0 # # Sets the position of the file pointer to the beginning of the stream and # returns 0 when complete. The lineno attribute is reset to 0 if # successful and the stream is readable according to #readable?. # # As a side effect, the internal read and write buffers are flushed. # # Raises IOError if #closed? returns +true+. Raises Errno::ESPIPE unless # #seekable? returns +true+. # # NOTE: Because this method relies on #unbuffered_seek and # #unbuffered_write (when the internal write buffer is not empty), it will # also raise the same errors and block at the same times as those functions. def rewind seek(0, IO::SEEK_SET) self.lineno = 0 if readable? 0 end # call-seq: # seek(offset[, whence]) -> 0 # # Sets the current data position to _offset_ based on the setting of # _whence_. If _whence_ is unspecified or IO::SEEK_SET, _offset_ counts # from the beginning of the data. If _whence_ is IO::SEEK_END, _offset_ # counts from the end of the data (_offset_ should be negative here). If # _whence_ is IO::SEEK_CUR, _offset_ is relative to the current position. # # As a side effect, the internal read and write buffers are flushed except # when seeking relative to the current position (whence is IO::SEEK_CUR) to # a location within the internal read buffer. # # Raises IOError if #closed? returns +true+. Raises Errno::ESPIPE unless # #seekable? returns +true+. # # NOTE: Because this method relies on #unbuffered_seek and # #unbuffered_write (when the internal write buffer is not empty), it will # also raise the same errors and block at the same times as those functions. def seek(offset, whence = IO::SEEK_SET) __io_like__buffered_seek(offset, whence) 0 end # call-seq: # ios.seekable? -> true or false # # Returns +true+ if the stream is seekable, +false+ otherwise. # # This implementation always returns +false+ for duplexed objects and # checks to see if #unbuffered_seek is defined in order to make its # determination otherwise. Override this if the implementing class always # provides the #unbuffered_seek method but may not always be seekable. def seekable? ! duplexed? && respond_to?(:unbuffered_seek, true) end # call-seq: # ios.sync -> true or false # # Returns true if the internal write buffer is currently being bypassed, # false otherwise. # # Raises IOError if #closed? returns +true+. def sync raise IOError, 'closed stream' if closed? @__io_like__sync ||= false end # call-seq: # ios.sync = boolean -> boolean # # When set to +true+ the internal write buffer will be bypassed. Any data # currently in the buffer will be flushed prior to the next output # operation. When set to +false+, the internal write buffer will be # enabled. # # Raises IOError if #closed? returns +true+. def sync=(sync) raise IOError, 'closed stream' if closed? @__io_like__sync = sync ? true : false end # call-seq: # ios.sysread(length) -> string # # Reads and returns up to _length_ bytes directly from the data stream, # bypassing the internal read buffer. # # Returns "" if _length_ is 0 regardless of the status of the data # stream. This is for compatibility with IO#sysread. # # Raises EOFError if reading begins at the end of the stream. Raises # IOError if the internal read buffer is not empty. Raises IOError if # #closed? returns +true+. # # NOTE: Because this method relies on #unbuffered_read, it will also # raise the same errors and block at the same times as that function. def sysread(length, buffer = nil) buffer = buffer.nil? ? '' : buffer.to_str buffer.slice!(0..-1) unless buffer.empty? return buffer if length == 0 raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? unless __io_like__internal_read_buffer.empty? then raise IOError, 'sysread on buffered IO' end # Flush the internal write buffer for writable, non-duplexed objects. __io_like__buffered_flush if writable? && ! duplexed? buffer << unbuffered_read(length) end # call-seq: # ios.sysseek(offset[, whence]) -> integer # # Sets the current data position to _offset_ based on the setting of # _whence_. If _whence_ is unspecified or IO::SEEK_SET, _offset_ counts # from the beginning of the data. If _whence_ is IO::SEEK_END, _offset_ # counts from the end of the data (_offset_ should be negative here). If # _whence_ is IO::SEEK_CUR, _offset_ is relative to the current position. # # Raises IOError if the internal read buffer is not empty. Raises IOError # if #closed? returns +true+. Raises Errno::ESPIPE unless #seekable? # returns +true+. # # NOTE: Because this method relies on #unbuffered_seek, it will also # raise the same errors and block at the same times as that function. def sysseek(offset, whence = IO::SEEK_SET) raise IOError, 'closed stream' if closed? raise Errno::ESPIPE unless seekable? unless __io_like__internal_read_buffer.empty? then raise IOError, 'sysseek on buffered IO' end unless __io_like__internal_write_buffer.empty? then warn('warning: sysseek on buffered IO') end unbuffered_seek(offset, whence) end # call-seq: # ios.syswrite(string) -> integer # # Writes _string_ directly to the data stream, bypassing the internal write # buffer and returns the number of bytes written. # # As a side effect for non-duplex objects, the internal read buffer is # flushed. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: Because this method relies on #unbuffered_write, it will also # raise the same errors and block at the same times as that function. def syswrite(string) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for writing' unless writable? unless __io_like__internal_write_buffer.empty? then warn('warning: syswrite on buffered IO') end # Flush the internal read buffer and set the unbuffered position to the # buffered position when dealing with non-duplexed objects. unless duplexed? || __io_like__internal_read_buffer.empty? then unbuffered_seek(-__io_like__internal_read_buffer.length, IO::SEEK_CUR) __io_like__internal_read_buffer.slice!(0..-1) end unbuffered_write(string) end # call-seq: # ios.to_io -> ios # # Returns _ios_. def to_io self end # call-seq: # ios.ungetc(integer) -> nil # # Calls #unread with integer.chr as an argument. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. def ungetc(integer) unread(integer.chr) end # call-seq: # ios.unread(string) -> nil # # Pushes the given string onto the front of the internal read buffer and # returns +nil+. If _string_ is not a String, it is converted to one using # its +to_s+ method. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #readable? returns +true+. def unread(string) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? __io_like__internal_read_buffer.insert(0, string.to_s) nil end # call-seq: # ios.write_ready? -> true or false # # Returns +true+ when the stream may be written without error, +false+ # otherwise. This method will block until one of the conditions is known. # # This default implementation of #write_ready? is a hack which should be # able to work for both real IO objects and IO-like objects; however, it is # inefficient since it merely sleeps for 1 second and then returns +true+ as # long as #closed? returns +false+. IO.select should be used for real # IO objects to wait for a writeable condition on platforms with support for # IO.select. Other solutions should be found as necessary to improve this # implementation on a case by case basis. # # Basically, this method should be overridden in derivative classes. def write_ready? return false unless writable? sleep(1) true end # call-seq: # ios.writable? -> true or false # # Returns +true+ if the stream is both open and writable, +false+ otherwise. # # This implementation checks to see if #unbuffered_write is defined in order # to make its determination. Override this if the implementing class always # provides the #unbuffered_write method but may not always be open in a # writable mode. def writable? ! __io_like__closed_write? && respond_to?(:unbuffered_write, true) end # call-seq: # ios.write(string) -> integer # # Writes the given string to the stream and returns the number of bytes # written. If _string_ is not a String, its +to_s+ method is used to # convert it into one. The entire contents of _string_ are written, # blocking as necessary even if the data stream does not block. # # Raises IOError if #closed? returns +true+. Raises IOError unless # #writable? returns +true+. # # NOTE: This method ignores Errno::EAGAIN and Errno::EINTR raised by # #unbuffered_write. Therefore, this method always blocks if unable to # immediately write _string_ completely. Aside from that exception, this # method will also raise the same errors and block at the same times as # #unbuffered_write. def write(string) string = string.to_s return 0 if string.empty? bytes_written = 0 while bytes_written < string.length do begin bytes_written += __io_like__buffered_write(string.to_s.slice(bytes_written..-1)) rescue Errno::EAGAIN, Errno::EINTR retry if write_ready? end end bytes_written end private # call-seq: # ios.__io_like__buffered_flush -> 0 # # Attempts to completely flush the internal write buffer to the data stream. # # Raises IOError unless #writable? returns +true+. # # NOTE: Because this method relies on #unbuffered_write, it raises # all errors raised by #unbuffered_write and blocks when #unbuffered_write # blocks. def __io_like__buffered_flush raise IOError, 'closed stream' if closed? raise IOError, 'not opened for writing' unless writable? until __io_like__internal_write_buffer.empty? do __io_like__internal_write_buffer.slice!( 0, unbuffered_write(__io_like__internal_write_buffer) ) end 0 end # call-seq: # ios.__io_like__buffered_read(length) -> string # # Reads at most _length_ bytes first from an internal read buffer followed # by the underlying stream if necessary and returns the resulting buffer. # # Raises EOFError if the internal read buffer is empty and reading begins at # the end of the stream. Raises IOError unless #readable? returns +true+. # # NOTE: Because this method relies on #unbuffered_read, it raises all # errors raised by #unbuffered_read and blocks when #unbuffered_read blocks # whenever the internal read buffer is unable to fulfill the request. def __io_like__buffered_read(length) # Check the validity of the method arguments. raise ArgumentError, "non-positive length #{length} given" if length < 0 raise IOError, 'closed stream' if closed? raise IOError, 'not opened for reading' unless readable? # Flush the internal write buffer for writable, non-duplexed objects. __io_like__buffered_flush if writable? && ! duplexed? # Ensure that the internal read buffer has at least enough data to satisfy # the request. if __io_like__internal_read_buffer.length < length then unbuffered_length = length - __io_like__internal_read_buffer.length unbuffered_length = fill_size if unbuffered_length < fill_size begin __io_like__internal_read_buffer << unbuffered_read(unbuffered_length) rescue EOFError, SystemCallError # Reraise the error if there is no data to return. raise if __io_like__internal_read_buffer.empty? end end # Read from the internal read buffer. buffer = __io_like__internal_read_buffer.slice!(0, length) buffer end # call-seq: # ios.__io_like__buffered_seek(offset[, whence]) -> integer # # Sets the current data position to _offset_ based on the setting of # _whence_. If _whence_ is unspecified or IO::SEEK_SET, _offset_ counts # from the beginning of the data. If _whence_ is IO::SEEK_END, _offset_ # counts from the end of the data (_offset_ should be negative here). If # _whence_ is IO::SEEK_CUR, _offset_ is relative to the current position. # # As a side effect, the internal read and write buffers are flushed except # when seeking relative to the current position (whence is IO::SEEK_CUR) to # a location within the internal read buffer. # # Raises Errno::ESPIPE unless #seekable? returns +true+. # # See #seek for the usage of _offset_ and _whence_. # # NOTE: Because this method relies on #unbuffered_seek and # #unbuffered_write (when the internal write buffer is not empty), it will # raise the same errors and block at the same times as those functions. def __io_like__buffered_seek(offset, whence = IO::SEEK_SET) raise IOError, 'closed stream' if closed? raise Errno::ESPIPE unless seekable? if whence == IO::SEEK_CUR && offset == 0 then # The seek is only determining the current position, so return the # buffered position based on the read buffer if it's not empty and the # write buffer otherwise. __io_like__internal_read_buffer.empty? ? unbuffered_seek(0, IO::SEEK_CUR) + __io_like__internal_write_buffer.length : unbuffered_seek(0, IO::SEEK_CUR) - __io_like__internal_read_buffer.length elsif whence == IO::SEEK_CUR && offset > 0 && __io_like__internal_write_buffer.empty? && offset <= __io_like__internal_read_buffer.length then # The seek is within the read buffer, so just discard a sufficient # amount of the buffer and report the new buffered position. __io_like__internal_read_buffer.slice!(0, offset) unbuffered_seek(0, IO::SEEK_CUR) - __io_like__internal_read_buffer.length else # The seek target is outside of the buffers, so flush the buffers and # jump to the new position. if whence == IO::SEEK_CUR then # Adjust relative offsets based on the current buffered offset. offset += __io_like__internal_read_buffer.empty? ? __io_like__internal_write_buffer.length : -__io_like__internal_read_buffer.length end # Flush the internal buffers. __io_like__internal_read_buffer.slice!(0..-1) __io_like__buffered_flush if writable? # Move the data stream's position as requested. unbuffered_seek(offset, whence) end end # call-seq: # ios.__io_like__buffered_write(string) -> integer # # Writes _string_ to the internal write buffer and returns the number of # bytes written. If the internal write buffer is overfilled by _string_, it # is repeatedly flushed until that last of _string_ is consumed. A partial # write will occur if part of _string_ fills the internal write buffer but # the internal write buffer cannot be immediately flushed due to the # underlying stream not blocking when unable to accept more data. # # NOTE: Because this method relies on #unbuffered_write, it raises # all errors raised by #unbuffered_write and blocks when #unbuffered_write # blocks whenever the internal write buffer is unable to fulfill the # request. def __io_like__buffered_write(string) raise IOError, 'closed stream' if closed? raise IOError, 'not opened for writing' unless writable? # Flush the internal read buffer and set the unbuffered position to the # buffered position when dealing with non-duplexed objects. unless duplexed? || __io_like__internal_read_buffer.empty? then unbuffered_seek(-__io_like__internal_read_buffer.length, IO::SEEK_CUR) __io_like__internal_read_buffer.slice!(0..-1) end bytes_written = 0 if sync then # Flush the internal write buffer and then bypass it when in synchronous # mode. __io_like__buffered_flush bytes_written = unbuffered_write(string) else if __io_like__internal_write_buffer.length + string.length >= flush_size then # The tipping point for the write buffer would be surpassed by this # request, so flush everything. __io_like__buffered_flush bytes_written = unbuffered_write(string) else # The buffer can absorb the entire request. __io_like__internal_write_buffer << string bytes_written = string.length end end return bytes_written end # Returns a reference to the internal read buffer. def __io_like__internal_read_buffer @__io_like__read_buffer ||= '' end # Returns a reference to the internal write buffer. def __io_like__internal_write_buffer @__io_like__write_buffer ||= '' end # Returns +true+ if this object has been closed for reading; otherwise, # returns +false+. def __io_like__closed_read? @__io_like__closed_read ||= false end # Arranges for #__io_like__closed_read? to return +true+. def __io_like__close_read @__io_like__closed_read = true nil end # Returns +true+ if this object has been closed for writing; otherwise, # returns +false+. def __io_like__closed_write? @__io_like__closed_write ||= false end # Arranges for #__io_like__closed_write? to return +true+. def __io_like__close_write @__io_like__closed_write = true nil end # This method joins the elements of _array_ together with _separator_ # between each element and returns the result. _seen_ is a list of object # IDs representing arrays which have already started processing. # # This method exists only because Array#join apparently behaves in an # implementation dependent manner when joining recursive arrays and so does # not always produce the expected results. Specifically, MRI 1.8.6 and # 1.8.7 behave as follows: # # x = [] # x << 1 << x << 2 # x.join(', ') => "1, 1, [...], 2, 2" # # The expected and necessary result for use with #puts is: # # "1, [...], 2" # # Things get progressively worse as the nesting and recursion become more # convoluted. def __io_like__array_join(array, separator, seen = []) seen.push(array.object_id) need_separator = false result = array.inject('') do |memo, item| memo << separator if need_separator need_separator = true memo << if item.kind_of?(Array) then if seen.include?(item.object_id) then '[...]' else __io_like__array_join(item, separator, seen) end else item.to_s end end seen.pop result end end end # vim: ts=2 sw=2 et io-like-0.3.0/LEGAL0000644000175000017500000000241613323132033013776 0ustar mujipackmujipack= 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 io-like-0.3.0/LICENSE.rubyspec0000644000175000017500000000207213323132033016065 0ustar mujipackmujipackCopyright (c) 2008 Engine Yard, Inc. All rights reserved. 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.