Skip to content
Browse files

Initial commit.

  • Loading branch information...
0 parents commit ef82664aeea4ec57bcdadc50d42ead637dc60f69 @blackwinter committed Jan 18, 2012
5 .gitignore
@@ -0,0 +1,5 @@
+doc
+doc.local
+pkg
+tmp
+.gh-pages
1 .rspec
@@ -0,0 +1 @@
+--colour
663 COPYING
@@ -0,0 +1,663 @@
+= License for libcdb-ruby
+
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+ software and other kinds of works, specifically designed to ensure
+ cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+ to take away your freedom to share and change the works. By contrast,
+ our General Public Licenses are 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.
+
+ 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.
+
+ Developers that use our General Public Licenses protect your rights
+ with two steps: (1) assert copyright on the software, and (2) offer
+ you this License which gives you legal permission to copy, distribute
+ and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+ improvements made in alternate versions of the program, if they
+ receive widespread use, become available for other developers to
+ incorporate. Many developers of free software are heartened and
+ encouraged by the resulting cooperation. However, in the case of
+ software used on network servers, this result may fail to come about.
+ The GNU General Public License permits making a modified version and
+ letting the public access it on a server without ever releasing its
+ source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ ensure that, in such cases, the modified source code becomes available
+ to the community. It requires the operator of a network server to
+ provide the source code of the modified version running there to the
+ users of that server. Therefore, public use of a modified version, on
+ a publicly accessible server, gives the public access to the source
+ code of the modified version.
+
+ An older license, called the Affero General Public License and
+ published by Affero, was designed to accomplish similar goals. This is
+ a different license, not a version of the Affero GPL, but Affero has
+ released a new version of the Affero GPL which permits relicensing under
+ this license.
+
+ 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+ Program, your modified version must prominently offer all users
+ interacting with it remotely through a computer network (if your version
+ supports such interaction) an opportunity to receive the Corresponding
+ Source of your version by providing access to the Corresponding Source
+ from a network server at no charge, through some standard or customary
+ means of facilitating copying of software. This Corresponding Source
+ shall include the Corresponding Source for any work covered by version 3
+ of the GNU General Public License that is incorporated pursuant to the
+ following paragraph.
+
+ 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 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 work with which it is combined will remain governed by version
+ 3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+ the GNU Affero 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 Affero 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 Affero 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 Affero 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+ network, you should also make sure that it provides a way for users to
+ get its source. For example, if your program is a web application, its
+ interface could display a "Source" link that leads users to an archive
+ of the code. There are many ways you could offer source, and different
+ solutions will be better for different programs; see section 13 for the
+ specific requirements.
+
+ 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 AGPL, see
+ <http://www.gnu.org/licenses/>.
5 ChangeLog
@@ -0,0 +1,5 @@
+= Revision history for libcdb-ruby
+
+== 0.0.1 [2012-01-12]
+
+* Birthday :-)
96 README
@@ -0,0 +1,96 @@
+= libcdb-ruby - Ruby bindings for CDB Constant Databases.
+
+== VERSION
+
+This documentation refers to libcdb-ruby version 0.0.1
+
+
+== DESCRIPTION
+
+The libcdb-ruby library provides Ruby bindings for the
+TinyCDB[http://corpit.ru/mjt/tinycdb.html] package for
+creating and reading {constant databases}[http://cr.yp.to/cdb.html].
+
+ require 'libcdb'
+
+ # creating
+ LibCDB::CDB.open('foo.cdb', 'w') { |cdb|
+ cdb['a'] = 'one'
+ cdb['b'] = '123'
+ }
+
+ # reading
+ LibCDB::CDB.open('foo.cdb') { |cdb|
+ cdb['a'] #=> "one"
+ cdb['b'] #=> "123"
+ cdb['c'] #=> nil
+ }
+
+ # hybrid
+ LibCDB::CDB.open('foo.cdb', 'w+') { |cdb|
+ cdb['a'] = 'one'
+ cdb['b'] = '123'
+
+ cdb['a'] #=> "one"
+ cdb['b'] #=> "123"
+ cdb['c'] #=> nil
+
+ cdb['a'] = 'two'
+ cdb['c'] = 'xyz'
+
+ cdb['a'] #=> "two"
+ cdb['b'] #=> nil
+ cdb['c'] #=> "xyz"
+ }
+
+ # update existing database
+ LibCDB::CDB.open('foo.cdb', 'r+') { |cdb|
+ cdb.store(cdb.to_h)
+
+ cdb['d'] = '42'
+
+ cdb['a'] #=> "two"
+ cdb['b'] #=> nil
+ cdb['c'] #=> "xyz"
+ cdb['d'] #=> "42"
+ }
+
+
+== SUPPORTED PLATFORMS
+
+Linux:: 1.8 & 1.9
+Windows:: 1.9 only
+
+
+== LINKS
+
+<b></b>
+Documentation:: http://blackwinter.github.com/libcdb-ruby
+Source code:: http://github.com/blackwinter/libcdb-ruby
+RubyGem:: http://rubygems.org/gems/libcdb-ruby
+TinyCDB:: http://corpit.ru/mjt/tinycdb.html
+CDB:: http://cr.yp.to/cdb.html
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2012 University of Cologne,
+Albertus-Magnus-Platz, 50923 Cologne, Germany
+
+libcdb-ruby is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+libcdb-ruby 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 Affero General Public
+License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with libcdb-ruby. If not, see <http://www.gnu.org/licenses/>.
30 Rakefile
@@ -0,0 +1,30 @@
+require File.expand_path(%q{../lib/libcdb/version}, __FILE__)
+
+begin
+ require 'hen'
+
+ cco = []
+
+ if dir = ENV['TINYCDB']
+ cco << "--with-cdb-include=#{dir}"
+ cco << "--with-cdb-lib=#{dir}"
+ end
+
+ if dir = ENV['MINGW32']
+ cco << "--with-cflags=\"-I#{dir}/include -L#{dir}/lib\""
+ end
+
+ Hen.lay! {{
+ :gem => {
+ :name => %q{libcdb-ruby},
+ :version => LibCDB::CDB::VERSION,
+ :summary => %q{Ruby bindings for CDB Constant Databases.},
+ :author => %q{Jens Wille},
+ :email => %q{jens.wille@uni-koeln.de},
+ :homepage => :blackwinter,
+ :extension => { :cross_config_options => cco }
+ }
+ }}
+rescue LoadError => err
+ warn "Please install the `hen' gem. (#{err})"
+end
4 TODO
@@ -0,0 +1,4 @@
+* More specs!!
+* More Documentation!
+* Atomic updates? (rename after create)
+* Benchmarks?
11 ext/libcdb/extconf.rb
@@ -0,0 +1,11 @@
+require 'mkmf'
+
+dir_config('cdb')
+
+if have_library('cdb', 'cdb_init') && have_header('cdb.h') && have_macro('TINYCDB_VERSION', 'cdb.h')
+ have_header('ruby/io.h')
+ have_header('ruby/st.h')
+ create_makefile('libcdb/libcdb_ruby')
+else
+ abort '*** ERROR: missing required library to compile this module'
+end
16 ext/libcdb/libcdb.c
@@ -0,0 +1,16 @@
+#include "ruby_libcdb.h"
+
+void
+Init_libcdb_ruby(void) {
+ char libcdb_version[8];
+ snprintf(libcdb_version, 7, "%g", TINYCDB_VERSION);
+
+ /*
+ * LibCDB namespace.
+ */
+ mLibCDB = rb_define_module("LibCDB");
+
+ rcdb_init_cdb();
+ rcdb_init_reader();
+ rcdb_init_writer();
+}
8 ext/libcdb/libcdb_ruby.def
@@ -0,0 +1,8 @@
+LIBRARY libcdb_ruby.so
+EXPORTS
+Init_libcdb_ruby
+
+cCDBReader DATA
+cCDBWriter DATA
+mLibCDB DATA
+cCDB DATA
15 ext/libcdb/ruby_cdb.c
@@ -0,0 +1,15 @@
+#include "ruby_libcdb.h"
+
+void
+rcdb_init_cdb(void) {
+ char libcdb_version[8];
+ snprintf(libcdb_version, 7, "%g", TINYCDB_VERSION);
+
+ /*
+ * See README.
+ */
+ cCDB = rb_define_class_under(mLibCDB, "CDB", rb_cObject);
+
+ /* The TinyCDB library version. */
+ rb_define_const(cCDB, "LIBCDB_VERSION", rb_str_new2(libcdb_version));
+}
13 ext/libcdb/ruby_cdb.h
@@ -0,0 +1,13 @@
+#ifndef __RUBY_CDB_H__
+#define __RUBY_CDB_H__
+
+#ifdef HAVE_RUBY_IO_H
+#define GetFileFD(fptr) (fptr)->fd
+#else
+#define GetFileFD(fptr) fileno((fptr)->f)
+#endif
+
+VALUE cCDB;
+void rcdb_init_cdb(void);
+
+#endif /* __RUBY_CDB_H__ */
677 ext/libcdb/ruby_cdb_reader.c
@@ -0,0 +1,677 @@
+#include "ruby_libcdb.h"
+
+static void
+rcdb_reader_free(void *ptr) {
+ free(ptr);
+}
+
+static VALUE
+rcdb_reader_alloc(VALUE klass) {
+ struct cdb *cdb = ALLOC_N(struct cdb, 1);
+ return Data_Wrap_Struct(klass, NULL, rcdb_reader_free, cdb);
+}
+
+/*
+ * call-seq:
+ * reader.closed? -> true | false
+ *
+ * Whether _reader_ is closed.
+ */
+static VALUE
+rcdb_reader_closed_p(VALUE self) {
+ return rb_attr_get(self, rb_intern("closed"));
+}
+
+/*
+ * call-seq:
+ * new(io) -> aReader
+ *
+ * Creates a new Reader instance to interface with +io+. +io+ must be opened
+ * for reading (+r+).
+ */
+static VALUE
+rcdb_reader_initialize(VALUE self, VALUE io) {
+ struct cdb *cdb = NULL;
+ rb_io_t *fptr;
+
+ Check_Type(io, T_FILE);
+ GetOpenFile(io, fptr);
+
+ rb_io_check_readable(fptr);
+ rb_iv_set(self, "@io", io);
+ rb_iv_set(self, "closed", Qfalse);
+
+ Get_CDB_Reader(self, cdb);
+
+ if (cdb_init(cdb, GetFileFD(fptr)) == -1) {
+ rb_sys_fail(0);
+ }
+
+ return self;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_read_key(struct cdb *cdb) {
+ size_t len;
+ VALUE key;
+
+ len = cdb_keylen(cdb);
+ key = rb_str_buf_new(len);
+
+ cdb_read(cdb, RSTRING_PTR(key), len, cdb_keypos(cdb));
+ rb_str_set_len(key, len);
+
+ return key;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_read_value(struct cdb *cdb) {
+ size_t len;
+ VALUE val;
+
+ len = cdb_datalen(cdb);
+ val = rb_str_buf_new(len);
+
+ cdb_read(cdb, RSTRING_PTR(val), len, cdb_datapos(cdb));
+ rb_str_set_len(val, len);
+
+ return val;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_iter_push(VALUE val, VALUE ary) {
+ return rb_ary_push(ary, val);
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_iter_aset(VALUE pair, VALUE hash) {
+ VALUE key = rb_ary_entry(pair, 0), val = rb_ary_entry(pair, 1), old;
+
+ if (!st_lookup(RHASH_TBL(hash), key, 0)) {
+ rb_hash_aset(hash, key, val);
+ }
+ else {
+ old = rb_hash_aref(hash, key);
+
+ switch (TYPE(old)) {
+ case T_ARRAY:
+ rb_ary_push(old, val);
+ break;
+ default:
+ rb_hash_aset(hash, key, rb_ary_new3(2, old, val));
+ break;
+ }
+ }
+
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_break_equal(VALUE val, VALUE ary) {
+ if (VALUE_EQUAL(val)) {
+ rb_ary_store(ary, 0, Qtrue);
+ rb_iter_break();
+ }
+
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_break_equal2(VALUE pair, VALUE ary) {
+ if (VALUE_EQUAL(rb_ary_entry(pair, 1))) {
+ rb_ary_store(ary, 0, rb_ary_entry(pair, 0));
+ rb_iter_break();
+ }
+
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_break_shift(VALUE val, VALUE ary) {
+ rb_ary_shift(ary);
+ rb_iter_break();
+
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_iter_inc(VALUE val, VALUE ary) {
+ rb_ary_store(ary, 0, rb_funcall(rb_ary_entry(ary, 0), rb_intern("succ"), 0));
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_iter_dump(VALUE val, VALUE ary) {
+ VALUE str = rb_ary_entry(ary, 0);
+
+ rb_str_append(str, val);
+ rb_str_cat2(str, "\n");
+
+ return Qnil;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_dump_pair(VALUE key, VALUE val) {
+ VALUE str = rb_str_new2("");
+
+ rb_str_cat2(str, "+");
+ rb_str_append(str, rb_fix2str(LONG2NUM(RSTRING_LEN(key)), 10));
+ rb_str_cat2(str, ",");
+ rb_str_append(str, rb_fix2str(LONG2NUM(RSTRING_LEN(val)), 10));
+ rb_str_cat2(str, ":");
+ rb_str_append(str, key);
+ rb_str_cat2(str, "->");
+ rb_str_append(str, val);
+
+ return str;
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_yield_dump(VALUE pair, VALUE ary) {
+ return rb_yield(rcdb_reader_dump_pair(
+ rb_ary_entry(pair, 0), rb_ary_entry(pair, 1)));
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_yield_dump2(VALUE val, VALUE ary) {
+ return rb_yield(rcdb_reader_dump_pair(rb_ary_entry(ary, 0), val));
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_call_each(VALUE args) {
+ CALL_ITERATOR("each")
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_call_each_key(VALUE args) {
+ CALL_ITERATOR("each_key")
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_call_each_value(VALUE args) {
+ CALL_ITERATOR("each_value")
+}
+
+/* Helper method */
+static VALUE
+rcdb_reader_call_each_dump(VALUE args) {
+ CALL_ITERATOR("each_dump")
+}
+
+/*
+ * call-seq:
+ * reader.each { |key, val| ... } -> reader
+ * reader.each(key) { |val| ... } -> reader
+ * reader.each([key]) -> anEnumerator
+ *
+ * Iterates over each key/value pair, or, if +key+ is given, each value
+ * for +key+. Returns _reader_, or, if no block is given, an enumerator.
+ */
+static VALUE
+rcdb_reader_each(int argc, VALUE *argv, VALUE self) {
+ struct cdb *cdb = NULL;
+ struct cdb_find cdbf;
+ unsigned cdbp;
+ VALUE key;
+
+ if (argc > 1) {
+ rb_raise(rb_eArgError, "wrong number of arguments (%d for 0-1)", argc);
+ }
+
+ RETURN_ENUMERATOR(self, argc, argv);
+
+ Get_CDB_Reader(self, cdb);
+
+ if (rb_scan_args(argc, argv, "01", &key) == 1 && !NIL_P(key)) {
+ StringValue(key);
+
+ if (cdb_findinit(&cdbf, cdb, RSTRING_PTR(key), RSTRING_LEN(key)) == -1) {
+ rb_sys_fail(0);
+ }
+
+ while (cdb_findnext(&cdbf) > 0) {
+ rb_yield(rcdb_reader_read_value(cdb));
+ }
+ }
+ else {
+ cdb_seqinit(&cdbp, cdb);
+
+ while (cdb_seqnext(&cdbp, cdb) > 0) {
+ rb_yield(rb_ary_new3(2,
+ rcdb_reader_read_key(cdb),
+ rcdb_reader_read_value(cdb)));
+ }
+ }
+
+ return self;
+}
+
+/*
+ * call-seq:
+ * reader.each_dump { |dump| ... } -> reader
+ * reader.each_dump(key) { |dump| ... } -> reader
+ * reader.each_dump([key]) -> anEnumerator
+ *
+ * Iterates over each record dump, or, if +key+ is given, each record dump
+ * for +key+. Returns _reader_, or, if no block is given, an enumerator.
+ */
+static VALUE
+rcdb_reader_each_dump(int argc, VALUE *argv, VALUE self) {
+ VALUE key, args = rb_ary_new3(1, self), ary = rb_ary_new();
+ VALUE (*block)(ANYARGS) = rcdb_reader_yield_dump;
+
+ if (argc > 1) {
+ rb_raise(rb_eArgError, "wrong number of arguments (%d for 0-1)", argc);
+ }
+
+ RETURN_ENUMERATOR(self, argc, argv);
+
+ if (rb_scan_args(argc, argv, "01", &key) == 1 && !NIL_P(key)) {
+ rb_ary_push(ary, key);
+ rb_ary_push(args, key);
+
+ block = rcdb_reader_yield_dump2;
+ }
+
+ rb_iterate(rcdb_reader_call_each, args, block, ary);
+
+ return self;
+}
+
+/*
+ * call-seq:
+ * reader.each_key { |key| ... } -> reader
+ * reader.each_key -> anEnumerator
+ *
+ * Iterates over each _unique_ key. Returns _reader_,
+ * or, if no block is given, an enumerator.
+ */
+static VALUE
+rcdb_reader_each_key(VALUE self) {
+ struct cdb *cdb = NULL;
+ unsigned cdbp;
+ VALUE key, hash = rb_hash_new();
+
+ Get_CDB_Reader(self, cdb);
+ cdb_seqinit(&cdbp, cdb);
+
+ while (cdb_seqnext(&cdbp, cdb) > 0) {
+ if (!st_lookup(RHASH_TBL(hash), key = rcdb_reader_read_key(cdb), 0)) {
+ rb_hash_aset(hash, key, Qtrue);
+ rb_yield(key);
+ }
+ }
+
+ return self;
+}
+
+/*
+ * call-seq:
+ * reader.each_value { |val| ... } -> reader
+ * reader.each_value -> anEnumerator
+ *
+ * Iterates over each value. Returns _reader_,
+ * or, if no block is given, an enumerator.
+ */
+static VALUE
+rcdb_reader_each_value(VALUE self) {
+ struct cdb *cdb = NULL;
+ unsigned cdbp;
+
+ Get_CDB_Reader(self, cdb);
+ cdb_seqinit(&cdbp, cdb);
+
+ while (cdb_seqnext(&cdbp, cdb) > 0) {
+ rb_yield(rcdb_reader_read_value(cdb));
+ }
+
+ return self;
+}
+
+/*
+ * call-seq:
+ * reader.fetch(key) -> anArray
+ *
+ * Fetch all values for +key+.
+ */
+static VALUE
+rcdb_reader_fetch(VALUE self, VALUE key) {
+ VALUE ary = rb_ary_new();
+
+ rb_iterate(rcdb_reader_call_each,
+ rb_ary_new3(2, self, key), rcdb_reader_iter_push, ary);
+
+ return ary;
+}
+
+/*
+ * call-seq:
+ * reader.fetch_first(key) -> aString | nil
+ *
+ * Fetch first value for +key+. Returns +nil+ if +key+ was not found.
+ */
+static VALUE
+rcdb_reader_fetch_first(VALUE self, VALUE key) {
+ struct cdb *cdb = NULL;
+ VALUE val = Qnil;
+
+ StringValue(key);
+ Get_CDB_Reader(self, cdb);
+
+ if (cdb_find(cdb, RSTRING_PTR(key), RSTRING_LEN(key)) > 0) {
+ val = rcdb_reader_read_value(cdb);
+ }
+
+ return val;
+}
+
+/*
+ * call-seq:
+ * reader.fetch_last(key) -> aString | nil
+ *
+ * Fetch last value for +key+. Returns +nil+ if +key+ was not found.
+ */
+static VALUE
+rcdb_reader_fetch_last(VALUE self, VALUE key) {
+ struct cdb *cdb = NULL;
+ struct cdb_find cdbf;
+ VALUE val = Qnil;
+ unsigned pos = 0;
+ size_t len = 0;
+
+ StringValue(key);
+ Get_CDB_Reader(self, cdb);
+
+ if (cdb_findinit(&cdbf, cdb, RSTRING_PTR(key), RSTRING_LEN(key)) == -1) {
+ rb_sys_fail(0);
+ }
+
+ while (cdb_findnext(&cdbf) > 0) {
+ pos = cdb_datapos(cdb);
+ len = cdb_datalen(cdb);
+ }
+
+ if (pos > 0) {
+ val = rb_str_buf_new(len);
+ cdb_read(cdb, RSTRING_PTR(val), len, pos);
+ rb_str_set_len(val, len);
+ }
+
+ return val;
+}
+
+/*
+ * call-seq:
+ * reader.keys -> anArray
+ *
+ * Returns an array of all _unique_ keys.
+ */
+static VALUE
+rcdb_reader_keys(VALUE self) {
+ VALUE ary = rb_ary_new();
+
+ rb_iterate(rcdb_reader_call_each_key,
+ rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
+
+ return ary;
+}
+
+/*
+ * call-seq:
+ * reader.values -> anArray
+ *
+ * Returns an array of all values.
+ */
+static VALUE
+rcdb_reader_values(VALUE self) {
+ VALUE ary = rb_ary_new();
+
+ rb_iterate(rcdb_reader_call_each_value,
+ rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
+
+ return ary;
+}
+
+/*
+ * call-seq:
+ * reader.values_at(key, ...) -> anArray
+ *
+ * Returns an array containing the values associated with the given keys.
+ */
+static VALUE
+rcdb_reader_values_at(int argc, VALUE *argv, VALUE self) {
+ VALUE ary = rb_ary_new();
+ long i;
+
+ for (i = 0; i < argc; i++) {
+ rb_ary_push(ary, rcdb_reader_fetch(self, argv[i]));
+ }
+
+ return ary;
+}
+
+/*
+ * call-seq:
+ * reader.has_key?(key) -> true | false
+ *
+ * Whether key +key+ exists in the database.
+ */
+static VALUE
+rcdb_reader_has_key_p(VALUE self, VALUE key) {
+ VALUE ary = rb_ary_new3(2, Qfalse, key);
+ ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_break_equal)
+}
+
+/*
+ * call-seq:
+ * reader.has_value?(val) -> true | false
+ *
+ * Whether value +val+ exists in the database.
+ */
+static VALUE
+rcdb_reader_has_value_p(VALUE self, VALUE val) {
+ VALUE ary = rb_ary_new3(2, Qfalse, val);
+ ITER_RESULT(rcdb_reader_call_each_value, rcdb_reader_break_equal)
+}
+
+/*
+ * call-seq:
+ * reader.key(val) -> aString | nil
+ *
+ * Returns the first key associated with value
+ * +val+, or +nil+ if +val+ was not found.
+ */
+static VALUE
+rcdb_reader_key(VALUE self, VALUE val) {
+ VALUE ary = rb_ary_new3(2, Qnil, val);
+ ITER_RESULT(rcdb_reader_call_each, rcdb_reader_break_equal2)
+}
+
+/*
+ * call-seq:
+ * reader.empty? -> true | false
+ *
+ * Whether the database is empty.
+ */
+static VALUE
+rcdb_reader_empty_p(VALUE self) {
+ VALUE ary = rb_ary_new3(2, Qtrue, Qfalse);
+ ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_break_shift)
+}
+
+/*
+ * call-seq:
+ * reader.size -> anInteger
+ *
+ * The number of _unique_ records in the database. Cf. #total.
+ */
+static VALUE
+rcdb_reader_size(VALUE self) {
+ VALUE ary = rb_ary_new3(1, INT2FIX(0));
+ ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_iter_inc)
+}
+
+/*
+ * call-seq:
+ * reader.total -> anInteger
+ *
+ * The number of _total_ records in the database. Cf. #size.
+ */
+static VALUE
+rcdb_reader_total(VALUE self) {
+ struct cdb *cdb = NULL;
+ unsigned cdbp;
+ long i = 0;
+
+ Get_CDB_Reader(self, cdb);
+ cdb_seqinit(&cdbp, cdb);
+
+ while (cdb_seqnext(&cdbp, cdb) > 0) {
+ i++;
+ }
+
+ return LONG2NUM(i);
+}
+
+/*
+ * call-seq:
+ * reader.dump -> aString
+ *
+ * Returns a dump of the database.
+ */
+static VALUE
+rcdb_reader_dump(VALUE self) {
+ VALUE ary = rb_ary_new3(1, rb_str_new2(""));
+ ITER_RESULT(rcdb_reader_call_each_dump, rcdb_reader_iter_dump)
+}
+
+/*
+ * call-seq:
+ * reader.to_h -> aHash
+ *
+ * Converts the database into a hash of #size keys associated with
+ * their value, or, if there are multiple, an array of their values.
+ *
+ * reader.to_h.size == reader.size
+ */
+static VALUE
+rcdb_reader_to_h(VALUE self) {
+ VALUE hash = rb_hash_new();
+
+ rb_iterate(rcdb_reader_call_each,
+ rb_ary_new3(1, self), rcdb_reader_iter_aset, hash);
+
+ return hash;
+}
+
+/*
+ * call-seq:
+ * reader.to_a -> anArray
+ *
+ * Converts the database into an array of #total key/value pairs.
+ *
+ * reader.to_a.size == reader.total
+ */
+static VALUE
+rcdb_reader_to_a(VALUE self) {
+ VALUE ary = rb_ary_new();
+
+ rb_iterate(rcdb_reader_call_each,
+ rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
+
+ return ary;
+}
+
+/*
+ * call-seq:
+ * reader.close -> nil
+ *
+ * Closes _reader_, as well as the underlying IO object.
+ */
+static VALUE
+rcdb_reader_close(VALUE self) {
+ struct cdb *cdb = NULL;
+
+ if (RTEST(rcdb_reader_closed_p(self))) {
+ return Qnil;
+ }
+
+ Get_CDB_Reader(self, cdb);
+ rb_iv_set(self, "closed", Qtrue);
+
+ rb_io_close(rb_iv_get(self, "@io"));
+
+ return Qnil;
+}
+
+/* :nodoc: */
+static VALUE
+rcdb_reader_inspect(VALUE self) {
+ VALUE str = rb_call_super(0, NULL);
+
+ if (RTEST(rcdb_reader_closed_p(self))) {
+ rb_funcall(str,
+ rb_intern("insert"), 2, INT2FIX(-2), rb_str_new2(" (closed)"));
+ }
+
+ return str;
+}
+
+void
+rcdb_init_reader(void) {
+ /*
+ * The reader for reading CDB files. See Writer for creating them.
+ */
+ cCDBReader = rb_define_class_under(cCDB, "Reader", rb_cObject);
+ rb_define_alloc_func(cCDBReader, rcdb_reader_alloc);
+ rb_include_module(cCDBReader, rb_mEnumerable);
+
+ rb_define_method(cCDBReader, "close", rcdb_reader_close, 0);
+ rb_define_method(cCDBReader, "closed?", rcdb_reader_closed_p, 0);
+ rb_define_method(cCDBReader, "dump", rcdb_reader_dump, 0);
+ rb_define_method(cCDBReader, "each", rcdb_reader_each, -1);
+ rb_define_method(cCDBReader, "each_dump", rcdb_reader_each_dump, -1);
+ rb_define_method(cCDBReader, "each_key", rcdb_reader_each_key, 0);
+ rb_define_method(cCDBReader, "each_value", rcdb_reader_each_value, 0);
+ rb_define_method(cCDBReader, "empty?", rcdb_reader_empty_p, 0);
+ rb_define_method(cCDBReader, "fetch", rcdb_reader_fetch, 1);
+ rb_define_method(cCDBReader, "fetch_first", rcdb_reader_fetch_first, 1);
+ rb_define_method(cCDBReader, "fetch_last", rcdb_reader_fetch_last, 1);
+ rb_define_method(cCDBReader, "has_key?", rcdb_reader_has_key_p, 1);
+ rb_define_method(cCDBReader, "has_value?", rcdb_reader_has_value_p, 1);
+ rb_define_method(cCDBReader, "initialize", rcdb_reader_initialize, 1);
+ rb_define_method(cCDBReader, "inspect", rcdb_reader_inspect, 0);
+ rb_define_method(cCDBReader, "key", rcdb_reader_key, 1);
+ rb_define_method(cCDBReader, "keys", rcdb_reader_keys, 0);
+ rb_define_method(cCDBReader, "size", rcdb_reader_size, 0);
+ rb_define_method(cCDBReader, "to_a", rcdb_reader_to_a, 0);
+ rb_define_method(cCDBReader, "to_h", rcdb_reader_to_h, 0);
+ rb_define_method(cCDBReader, "total", rcdb_reader_total, 0);
+ rb_define_method(cCDBReader, "values", rcdb_reader_values, 0);
+ rb_define_method(cCDBReader, "values_at", rcdb_reader_values_at, -1);
+
+ rb_define_alias(cCDBReader, "[]", "fetch_first");
+ rb_define_alias(cCDBReader, "fetch_all", "fetch");
+ rb_define_alias(cCDBReader, "get", "fetch_first");
+ rb_define_alias(cCDBReader, "include?", "has_key?");
+ rb_define_alias(cCDBReader, "key?", "has_key?");
+ rb_define_alias(cCDBReader, "length", "size");
+ rb_define_alias(cCDBReader, "member?", "has_key?");
+ rb_define_alias(cCDBReader, "rget", "fetch_last");
+ rb_define_alias(cCDBReader, "value?", "has_value?");
+}
30 ext/libcdb/ruby_cdb_reader.h
@@ -0,0 +1,30 @@
+#ifndef __RCDB_READER_H__
+#define __RCDB_READER_H__
+
+#define Get_CDB_Reader(obj, var) {\
+ if (RTEST(rcdb_reader_closed_p(obj))) {\
+ rb_raise(rb_eRuntimeError, "closed stream");\
+ }\
+ else {\
+ Data_Get_Struct((obj), struct cdb, (var));\
+ }\
+}
+
+#define CALL_ITERATOR(iter) {\
+ VALUE self = rb_ary_shift(args);\
+ return rb_funcall2(self, rb_intern(iter),\
+ RARRAY_LEN(args), RARRAY_PTR(args));\
+}
+
+#define ITER_RESULT(method, block) {\
+ rb_iterate(method, rb_ary_new3(1, self), block, ary);\
+ return rb_ary_entry(ary, 0);\
+}
+
+#define VALUE_EQUAL(val) \
+ RTEST(rb_funcall((val), rb_intern("=="), 1, rb_ary_entry(ary, 1)))
+
+VALUE cCDBReader;
+void rcdb_init_reader(void);
+
+#endif /* __RCDB_READER_H__ */
301 ext/libcdb/ruby_cdb_writer.c
@@ -0,0 +1,301 @@
+#include "ruby_libcdb.h"
+
+static void
+rcdb_writer_free(void *ptr) {
+ free(ptr);
+}
+
+static VALUE
+rcdb_writer_alloc(VALUE klass) {
+ struct cdb_make *cdbm = ALLOC_N(struct cdb_make, 1);
+ return Data_Wrap_Struct(klass, NULL, rcdb_writer_free, cdbm);
+}
+
+/*
+ * call-seq:
+ * writer.closed? -> true | false
+ *
+ * Whether _writer_ is closed.
+ */
+static VALUE
+rcdb_writer_closed_p(VALUE self) {
+ return rb_attr_get(self, rb_intern("closed"));
+}
+
+/*
+ * call-seq:
+ * new(io) -> aWriter
+ *
+ * Creates a new Writer instance to interface with +io+. +io+ must be opened
+ * for writing (+w+); in addition, it must be opened for read-write (<tt>w+</tt>)
+ * if #insert or #replace are to be used.
+ */
+static VALUE
+rcdb_writer_initialize(VALUE self, VALUE io) {
+ struct cdb_make *cdbm = NULL;
+ rb_io_t *fptr;
+
+ Check_Type(io, T_FILE);
+ GetOpenFile(io, fptr);
+
+ rb_io_check_writable(fptr);
+ rb_iv_set(self, "@io", io);
+ rb_iv_set(self, "closed", Qfalse);
+
+ Get_CDB_Writer(self, cdbm);
+
+ if (cdb_make_start(cdbm, GetFileFD(fptr)) == -1) {
+ rb_sys_fail(0);
+ }
+
+ if (lseek(cdb_fileno(cdbm), 0, SEEK_SET) == -1) {
+ rb_sys_fail(0);
+ }
+
+ return self;
+}
+
+/* Helper method */
+static int
+rcdb_writer_push_pair(st_data_t key, st_data_t val, st_data_t ary) {
+ rb_ary_push((VALUE)ary, rb_ary_new3(2, (VALUE)key, (VALUE)val));
+ return ST_CONTINUE;
+}
+
+/* Helper method */
+static void
+rcdb_writer_put_pair(struct cdb_make *cdbm, VALUE key, VALUE val, enum cdb_put_mode mode) {
+ StringValue(key);
+ StringValue(val);
+
+ if (cdb_make_put(cdbm,
+ RSTRING_PTR(key), RSTRING_LEN(key),
+ RSTRING_PTR(val), RSTRING_LEN(val),
+ mode) == -1) {
+ rb_sys_fail(0);
+ }
+}
+
+/* Helper method */
+static void
+rcdb_writer_put_value(struct cdb_make *cdbm, VALUE key, VALUE val, enum cdb_put_mode mode) {
+ long i;
+
+ switch (TYPE(val)) {
+ case T_ARRAY:
+ switch (mode) {
+ case CDB_PUT_REPLACE:
+ /* remove any existing record */
+ cdb_make_find(cdbm,
+ RSTRING_PTR(key),
+ RSTRING_LEN(key),
+ CDB_FIND_REMOVE);
+
+ /* add all */
+ mode = CDB_PUT_ADD;
+
+ break;
+ case CDB_PUT_INSERT:
+ /* see if key already exists */
+ switch (cdb_make_exists(cdbm,
+ RSTRING_PTR(key),
+ RSTRING_LEN(key))) {
+ case 0:
+ /* doesn't exist, add all */
+ mode = CDB_PUT_ADD;
+ break;
+ case -1:
+ /* error */
+ rb_sys_fail(0);
+ break;
+ default:
+ /* ignore, won't add any */
+ break;
+ }
+
+ break;
+ default:
+ /* no need to touch mode */
+ break;
+ }
+
+ for (i = 0; i < RARRAY_LEN(val); i++) {
+ rcdb_writer_put_pair(cdbm, key, RARRAY_PTR(val)[i], mode);
+ }
+
+ break;
+ default:
+ rcdb_writer_put_pair(cdbm, key, val, mode);
+ break;
+ }
+}
+
+/* Helper method */
+static VALUE
+rcdb_writer_put(int argc, VALUE *argv, VALUE self, enum cdb_put_mode mode) {
+ struct cdb_make *cdbm = NULL;
+ VALUE arg, val;
+ long i;
+
+ Get_CDB_Writer(self, cdbm);
+
+ switch (argc) {
+ case 1:
+ arg = argv[0];
+
+ switch (TYPE(arg)) {
+ case T_ARRAY:
+ val = rb_str_new2("");
+
+ for (i = 0; i < RARRAY_LEN(arg); i++) {
+ rcdb_writer_put_pair(cdbm, RARRAY_PTR(arg)[i], val, mode);
+ }
+
+ break;
+ case T_HASH:
+ val = rb_ary_new();
+ st_foreach(RHASH_TBL(arg), rcdb_writer_push_pair, val);
+
+ for (i = 0; i < RARRAY_LEN(val); i++) {
+ rcdb_writer_put_value(cdbm,
+ rb_ary_entry(RARRAY_PTR(val)[i], 0),
+ rb_ary_entry(RARRAY_PTR(val)[i], 1),
+ mode);
+ }
+
+ break;
+ default:
+ rb_raise(rb_eTypeError,
+ "wrong argument type %s (expected Array or Hash)",
+ rb_obj_classname(arg));
+
+ break;
+ }
+
+ break;
+ case 2:
+ rcdb_writer_put_value(cdbm, argv[0], argv[1], mode);
+ break;
+ default:
+ rb_raise(rb_eArgError, "wrong number of arguments (%d for 1-2)", argc);
+ break;
+ }
+
+ return self;
+}
+
+/*
+ * call-seq:
+ * writer.store(key, val) -> writer
+ * writer.store(key, [val, ...]) -> writer
+ * writer.store([key, ...]) -> writer
+ * writer.store({ key => val, ... }) -> writer
+ *
+ * Stores records in the database and returns _writer_. Records are stored
+ * unconditionally, so duplicate keys will produce multiple records.
+ *
+ * If a single key/value pair is given, a record with key +key+ and value
+ * +val+ is created; if +val+ is an array, one record per value is created
+ * for +key+. If an array of keys is given, one record per key with an empty
+ * value is created. If a hash of key/value pairs is given, one record per
+ * key/value pair is created; the same logic as for a single key/value pair
+ * applies.
+ */
+static VALUE
+rcdb_writer_store(int argc, VALUE *argv, VALUE self) {
+ return rcdb_writer_put(argc, argv, self, CDB_PUT_ADD);
+}
+
+/*
+ * call-seq:
+ * writer.replace(key, val) -> writer
+ * writer.replace(key, [val, ...]) -> writer
+ * writer.replace([key, ...]) -> writer
+ * writer.replace({ key => val, ... }) -> writer
+ *
+ * Stores records in the database and returns _writer_. Records with
+ * duplicate keys are replaced.
+ *
+ * The arguments are treated the same as in #store, so duplicate keys
+ * <em>in the arguments</em> will produce multiple records.
+ */
+static VALUE
+rcdb_writer_replace(int argc, VALUE *argv, VALUE self) {
+ return rcdb_writer_put(argc, argv, self, CDB_PUT_REPLACE);
+}
+
+/*
+ * call-seq:
+ * writer.insert(key, val) -> writer
+ * writer.insert(key, [val, ...]) -> writer
+ * writer.insert([key, ...]) -> writer
+ * writer.insert({ key => val, ... }) -> writer
+ *
+ * Stores records in the database and returns _writer_. Records will only
+ * be inserted if they don't already exist in the database.
+ *
+ * The arguments are treated the same as in #store, so duplicate keys
+ * <em>in the arguments</em> will produce multiple records.
+ */
+static VALUE
+rcdb_writer_insert(int argc, VALUE *argv, VALUE self) {
+ return rcdb_writer_put(argc, argv, self, CDB_PUT_INSERT);
+}
+
+/*
+ * call-seq:
+ * writer.close -> nil
+ *
+ * Closes _writer_, as well as the underlying IO object.
+ */
+static VALUE
+rcdb_writer_close(VALUE self) {
+ struct cdb_make *cdbm = NULL;
+
+ if (RTEST(rcdb_writer_closed_p(self))) {
+ return Qnil;
+ }
+
+ Get_CDB_Writer(self, cdbm);
+ rb_iv_set(self, "closed", Qtrue);
+
+ if (cdb_make_finish(cdbm) == -1) {
+ rb_sys_fail(0);
+ }
+
+ rb_io_close(rb_iv_get(self, "@io"));
+
+ return Qnil;
+}
+
+/* :nodoc: */
+static VALUE
+rcdb_writer_inspect(VALUE self) {
+ VALUE str = rb_call_super(0, NULL);
+
+ if (RTEST(rcdb_writer_closed_p(self))) {
+ rb_funcall(str,
+ rb_intern("insert"), 2, INT2FIX(-2), rb_str_new2(" (closed)"));
+ }
+
+ return str;
+}
+
+void rcdb_init_writer(void) {
+ /*
+ * The writer for creating CDB files. See Reader for reading them.
+ */
+ cCDBWriter = rb_define_class_under(cCDB, "Writer", rb_cObject);
+ rb_define_alloc_func(cCDBWriter, rcdb_writer_alloc);
+
+ rb_define_method(cCDBWriter, "close", rcdb_writer_close, 0);
+ rb_define_method(cCDBWriter, "closed?", rcdb_writer_closed_p, 0);
+ rb_define_method(cCDBWriter, "initialize", rcdb_writer_initialize, 1);
+ rb_define_method(cCDBWriter, "insert", rcdb_writer_insert, -1);
+ rb_define_method(cCDBWriter, "inspect", rcdb_writer_inspect, 0);
+ rb_define_method(cCDBWriter, "replace", rcdb_writer_replace, -1);
+ rb_define_method(cCDBWriter, "store", rcdb_writer_store, -1);
+
+ rb_define_alias(cCDBWriter, "[]=", "replace");
+ rb_define_alias(cCDBWriter, "add", "store");
+}
16 ext/libcdb/ruby_cdb_writer.h
@@ -0,0 +1,16 @@
+#ifndef __RCDB_WRITER_H__
+#define __RCDB_WRITER_H__
+
+#define Get_CDB_Writer(obj, var) {\
+ if (RTEST(rcdb_writer_closed_p(obj))) {\
+ rb_raise(rb_eRuntimeError, "closed stream");\
+ }\
+ else {\
+ Data_Get_Struct((obj), struct cdb_make, (var));\
+ }\
+}
+
+VALUE cCDBWriter;
+void rcdb_init_writer(void);
+
+#endif /* __RCDB_WRITER_H__ */
27 ext/libcdb/ruby_libcdb.h
@@ -0,0 +1,27 @@
+#ifndef __RUBY_LIBCDB_H__
+#define __RUBY_LIBCDB_H__
+
+#include <ruby.h>
+#if HAVE_RUBY_IO_H
+#include <ruby/io.h>
+#else
+#include <rubyio.h>
+#endif
+#if HAVE_RUBY_ST_H
+#include <ruby/st.h>
+#else
+#include <st.h>
+#endif
+#include <cdb.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <fcntl.h>
+
+#include "ruby_cdb.h"
+#include "ruby_cdb_reader.h"
+#include "ruby_cdb_writer.h"
+
+VALUE mLibCDB;
+
+#endif /* __RUBY_LIBCDB_H__ */
2 lib/cdb.rb
@@ -0,0 +1,2 @@
+require 'libcdb'
+include LibCDB
1 lib/libcdb-ruby.rb
@@ -0,0 +1 @@
+require 'libcdb'
256 lib/libcdb.rb
@@ -0,0 +1,256 @@
+begin
+ require "libcdb/#{RUBY_VERSION[/\d+.\d+/]}/libcdb_ruby"
+rescue LoadError
+ require 'libcdb/libcdb_ruby'
+end
+
+require 'libcdb/version'
+require 'forwardable'
+
+module LibCDB
+
+ class CDB
+
+ extend Forwardable
+
+ MODE_READ = 'r' # :nodoc:
+ MODE_WRITE = 'w' # :nodoc:
+
+ class << self
+
+ # call-seq:
+ # CDB.open(path[, mode]) -> aReader | aWriter | aCDB
+ # CDB.open(path[, mode]) { |cdb| ... }
+ #
+ # Opens +path+ with +mode+. If a block is given, yields a _cdb_ object
+ # according to +mode+ (see below) and returns the return value of the
+ # block; the object is closed afterwards. Otherwise just returns the
+ # object.
+ #
+ # <tt>r</tt>:: Reader
+ # <tt>w</tt>:: Writer
+ # <tt>r+</tt>:: CDB (initially opened for reading)
+ # <tt>w+</tt>:: CDB (initially opened for writing)
+ def open(path, mode = MODE_READ)
+ klass, args = self, []
+
+ case mode
+ when 'r+' then args = [mode = MODE_READ]
+ when 'w+' then args = [ MODE_WRITE]
+ when MODE_READ then klass = Reader
+ when MODE_WRITE then klass, mode = Writer, 'w+'
+ else raise ArgumentError, "illegal access mode #{mode}"
+ end
+
+ cdb = begin
+ klass.new(io = File.open(path, mode), *args)
+ rescue
+ io.close if io
+ raise
+ end
+
+ if block_given?
+ begin
+ yield cdb
+ ensure
+ cdb.close
+ end
+ else
+ cdb
+ end
+ end
+
+ # call-seq:
+ # CDB.foreach(path) { |key, val| ... }
+ # CDB.foreach(path, key) { |val| ... }
+ #
+ # Opens +path+ for reading and iterates over each key/value pair,
+ # or, if +key+ is given, each value for +key+.
+ def foreach(path, *key)
+ open(path) { |cdb| cdb.each(*key) { |val| yield val } }
+ end
+
+ # call-seq:
+ # CDB.dump(path[, target[, separator]]) -> target
+ #
+ # Opens +path+ for reading and shovels each record dump into +target+
+ # (followed by +separator+, if present). Returns +target+.
+ def dump(path, target = '', separator = $\ || $/)
+ open(path) { |cdb|
+ cdb.each_dump { |dump|
+ target << dump
+ target << separator if separator
+ }
+
+ target
+ }
+ end
+
+ end
+
+ # call-seq:
+ # CDB.new(io[, mode]) -> aCDB
+ #
+ # Creates a new CDB object to interface with +io+. +mode+ must be the same
+ # mode +io+ was opened in, either +r+ or +w+. Responds to both Reader and
+ # Writer methods interchangeably by reopening +io+ in the corresponding mode
+ # and instantiating a new Reader or Writer object with it. Note that +io+
+ # will be truncated each time it's opened for writing.
+ def initialize(io, mode = MODE_WRITE)
+ @io, @mode = io, mode
+
+ case mode
+ when MODE_READ then open_read
+ when MODE_WRITE then open_write
+ else raise ArgumentError, "illegal access mode #{mode}"
+ end
+ end
+
+ # The underlying IO object.
+ attr_reader :io
+
+ # The current IO mode, either +r+ or +w+.
+ attr_reader :mode
+
+ # call-seq:
+ # cdb.reader -> aReader
+ #
+ # The Reader object associated with _cdb_.
+ def reader
+ @reader ||= open_read
+ end
+
+ # call-seq:
+ # cdb.writer -> aWriter
+ #
+ # The Writer object associated with _cdb_.
+ def writer
+ @writer ||= open_write
+ end
+
+ def_delegators :reader, :[], :dump, :each, :each_dump, :each_key,
+ :each_value, :empty?, :fetch, :fetch_all,
+ :fetch_first, :fetch_last, :get, :has_key?,
+ :has_value?, :include?, :key, :key?, :keys,
+ :length, :member?, :rget, :size, :to_a,
+ :to_h, :value?, :values, :values_at
+
+ def_delegators :writer, :[]=, :add, :insert, :replace, :store
+
+ # call-seq:
+ # cdb.read? -> true | false
+ #
+ # Whether _cdb_ is currently opened for reading.
+ def read?
+ !!@reader
+ end
+
+ # call-seq:
+ # cdb.write? -> true | false
+ #
+ # Whether _cdb_ is currently opened for writing.
+ def write?
+ !!@writer
+ end
+
+ # call-seq:
+ # cdb.open_read -> aReader
+ #
+ # Opens _cdb_ for reading and reopens #io accordingly.
+ # Closes #writer if open.
+ def open_read
+ close_write(false)
+ @reader = Reader.new(reopen(MODE_READ))
+ end
+
+ # call-seq:
+ # cdb.open_write -> aWriter
+ #
+ # Opens _cdb_ for writing and reopens #io accordingly.
+ # Closes #reader if open. Note that #io will be truncated.
+ def open_write
+ close_read(false)
+ @writer = Writer.new(reopen(MODE_WRITE))
+ end
+
+ # call-seq:
+ # cdb.close_read([strict]) -> nil
+ #
+ # If _cdb_ is currently opened for reading, closes the #reader (and #io
+ # with it). Otherwise, if +strict+ is true, raises an IOError.
+ def close_read(strict = true)
+ if read?
+ @reader.close
+ @reader = nil
+ elsif strict
+ raise IOError, 'not opened for reading'
+ end
+ end
+
+ # call-seq:
+ # cdb.close_write([strict]) -> nil
+ #
+ # If _cdb_ is currently opened for writing, closes the #writer (and #io
+ # with it). Otherwise, if +strict+ is true, raises an IOError.
+ def close_write(strict = true)
+ if write?
+ @writer.close
+ @writer = nil
+ elsif strict
+ raise IOError, 'not opened for writing'
+ end
+ end
+
+ # call-seq:
+ # cdb.close -> nil
+ #
+ # Closes both the #reader and the #writer, as well as #io. Doesn't raise
+ # an IOError if either of them is already closed.
+ def close
+ close_read(false)
+ close_write(false)
+ io.close unless io.closed?
+ end
+
+ # call-seq:
+ # cdb.closed_read? -> true | false | nil
+ #
+ # Whether #reader is closed if _cdb_ is currently opened for reading.
+ def closed_read?
+ reader.closed? if read?
+ end
+
+ # call-seq:
+ # cdb.closed_write? -> true | false | nil
+ #
+ # Whether #writer is closed if _cdb_ is currently opened for writing.
+ def closed_write?
+ writer.closed? if write?
+ end
+
+ # call-seq:
+ # cdb.closed? -> true | false | nil
+ #
+ # Whether _cdb_ is closed. See #closed_read? and #closed_write?.
+ def closed?
+ read? ? closed_read? : write? ? closed_write? : nil
+ end
+
+ private
+
+ # call-seq:
+ # cdb.reopen([mode]) -> anIO
+ #
+ # Reopens #io in +mode+ and returns it.
+ def reopen(new_mode = MODE_READ)
+ return io if mode == new_mode
+
+ @mode = new_mode
+ new_mode += '+' if new_mode == MODE_WRITE
+
+ io.reopen(io.path, new_mode)
+ end
+
+ end
+
+end
31 lib/libcdb/version.rb
@@ -0,0 +1,31 @@
+module LibCDB
+
+ class CDB
+
+ module Version
+
+ MAJOR = 0
+ MINOR = 0
+ TINY = 1
+
+ class << self
+
+ # Returns array representation.
+ def to_a
+ [MAJOR, MINOR, TINY]
+ end
+
+ # Short-cut for version string.
+ def to_s
+ to_a.join('.')
+ end
+
+ end
+
+ end
+
+ VERSION = Version.to_s
+
+ end
+
+end
142 spec/libcdb/reader_spec.rb
@@ -0,0 +1,142 @@
+describe LibCDB::CDB::Reader do
+
+ before :all do
+ @temp = tempfile
+
+ db = LibCDB::CDB::Writer.new(@temp.to_io)
+ TEST_DATA.each { |k, v| v.each { |w| db.store(k, w) } }
+ db.close
+ end
+
+ after :all do
+ @temp.unlink
+ end
+
+ describe "#initialize" do
+
+ it "should not accept integers" do
+ lambda { LibCDB::CDB::Reader.new(12345) }.should raise_error(TypeError)
+ end
+
+ it "should not accept pipes" do
+ lambda { LibCDB::CDB::Reader.new(STDIN) }.should raise_error(SystemCallError)
+ end
+
+ end
+
+ describe "empty" do
+
+ before :all do
+ @empt = tempfile
+ LibCDB::CDB::Writer.new(@empt.to_io).close
+ end
+
+ after :all do
+ @empt.unlink
+ end
+
+ before :each do
+ @db = LibCDB::CDB::Reader.new(File.open(@empt.path))
+ end
+
+ after :each do
+ @db.close
+ end
+
+ it "should know that it's not closed" do
+ @db.should_not be_closed
+ end
+
+ it "should know that it's empty" do
+ @db.should be_empty
+ end
+
+ it "should know its size" do
+ @db.size.should == 0
+ end
+
+ it "should know if it doesn't have a key" do
+ @db.should_not have_key('key3')
+ end
+
+ it "should know if it doesn't have a value" do
+ @db.should_not have_value('value3.2')
+ end
+
+ end
+
+ describe "non-empty" do
+
+ before :each do
+ @db = LibCDB::CDB::Reader.new(File.open(@temp.path))
+ end
+
+ after :each do
+ @db.close
+ end
+
+ it "should know that it's not closed" do
+ @db.should_not be_closed
+ end
+
+ it "should know that it's not empty" do
+ @db.should_not be_empty
+ end
+
+ it "should know its size" do
+ @db.size.should == 11
+ end
+
+ it "should know if it has a key" do
+ @db.should have_key('key3')
+ end
+
+ it "should know if it doesn't have a key" do
+ @db.should_not have_key('key33')
+ end
+
+ it "should know if it has a value" do
+ @db.should have_value('value3.2')
+ end
+
+ it "should know if it doesn't have a value" do
+ @db.should_not have_value('value33.22')
+ end
+
+ it "should get a single value" do
+ @db['key1'].should == 'value1.1'
+ end
+
+ it "should not get non-existent value" do
+ @db['key33'].should be_nil
+ end
+
+ it "should get each value" do
+ TEST_DATA.each { |k, o|
+ r = []
+ @db.each(k) { |v| r << v }
+ r.should == o
+ }
+ end
+
+ it "should get all values" do
+ TEST_DATA.each { |k, o|
+ @db.fetch(k).should == o
+ }
+ end
+
+ it "should get last value" do
+ @db.fetch_last('key10').should == 'value10.10'
+ end
+
+ it "should find the key for a value" do
+ @db.key('value3.2').should == 'key3'
+ end
+
+ it "should not find the key for a non-existent value" do
+ @db.key('value33.22').should be_nil
+ end
+
+ end
+
+end
34 spec/libcdb/writer_spec.rb
@@ -0,0 +1,34 @@
+describe LibCDB::CDB::Writer do
+
+ describe "#initialize" do
+
+ it "should not accept strings" do
+ lambda { LibCDB::CDB::Writer.new('test') }.should raise_error(TypeError)
+ end
+
+ it "should not accept pipes" do
+ lambda { LibCDB::CDB::Writer.new(STDOUT) }.should raise_error(SystemCallError)
+ end
+
+ end
+
+ describe "#add" do
+
+ before :each do
+ @temp = tempfile
+ @db = LibCDB::CDB::Writer.new(@temp.to_io)
+ end
+
+ after :each do
+ @temp.unlink
+ end
+
+ it "should add data" do
+ TEST_DATA.each { |k, v| v.each { |w| @db.add(k, w) } }
+ @db.close
+ @db.should be_closed
+ end
+
+ end
+
+end
21 spec/spec_helper.rb
@@ -0,0 +1,21 @@
+$:.unshift('lib') unless $:.first == 'lib'
+
+require 'libcdb'
+require 'tempfile'
+
+RSpec.configure { |config|
+ config.include(Module.new {
+ TEST_DATA = {}
+
+ 1.upto(10) { |i|
+ val = TEST_DATA[key = "key#{i}"] = []
+ 1.upto(i) { |j| val << "value#{i}.#{j}" }
+ }
+
+ TEST_DATA['a' * 1024] = Array('b' * 1024 ** 2)
+
+ def tempfile
+ Tempfile.open("libcdb_spec_#{object_id}_temp")
+ end
+ })
+}

0 comments on commit ef82664

Please sign in to comment.
Something went wrong with that request. Please try again.