pax_global_header 0000666 0000000 0000000 00000000064 12704363361 0014517 g ustar 00root root 0000000 0000000 52 comment=48640e3010c1dc72594dcf31b4eb4c32ae88e5a5
syncache-1.4/ 0000775 0000000 0000000 00000000000 12704363361 0013160 5 ustar 00root root 0000000 0000000 syncache-1.4/.travis.yml 0000664 0000000 0000000 00000000036 12704363361 0015270 0 ustar 00root root 0000000 0000000 language: ruby
rvm:
- 2.3.0
syncache-1.4/COPYING 0000664 0000000 0000000 00000104374 12704363361 0014224 0 ustar 00root root 0000000 0000000
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
.
syncache-1.4/ChangeLog.mtn 0000664 0000000 0000000 00000011417 12704363361 0015533 0 ustar 00root root 0000000 0000000 -----------------------------------------------------------------
Revision: 8bc8efa1310743cf39e14bdf69d4429cadebcb61
Ancestor: 6f9a39297f610f7095473ac34f68674963561d9c
Author: angdraug@debian.org
Date: 25/12/09 19:56:53
Branch: syncache-head
Modified files:
bin/syncache-drb man/syncache-drb.1
ChangeLog:
man page updated for new options
-----------------------------------------------------------------
Revision: 6f9a39297f610f7095473ac34f68674963561d9c
Ancestor: 57f2c6cd4fbe8a04750aebeff72b094dc4d24476
Author: angdraug@debian.org
Date: 25/12/09 19:46:42
Branch: syncache-head
Modified files:
bin/syncache-drb
ChangeLog:
New options: --user, --error-log
* Redirect STDERR to an error log when specified.
* Allow to specify any to run as user instead of just nobody.
* Create the pidfile under /var/run/syncache-drb to solve the
undeletable pidfile problem.
-----------------------------------------------------------------
Revision: 57f2c6cd4fbe8a04750aebeff72b094dc4d24476
Ancestor: 0b3852cfbf276589043a4bb87c37ab024df694cc
Author: angdraug@debian.org
Date: 26/10/09 20:08:45
Branch: syncache-head
Modified files:
bin/syncache-drb
ChangeLog:
untaint URI supplied on command line; report exception backtraces to syslog
-----------------------------------------------------------------
Revision: 0b3852cfbf276589043a4bb87c37ab024df694cc
Ancestor: 69d9bb2d250a211e52baab031e5f840032fdee74
Author: angdraug@debian.org
Date: 07/08/09 14:08:50
Branch: syncache-head
Modified files:
lib/syncache.rb lib/syncache_sync_patch.rb
ChangeLog:
expand syncache_sync_patch to fix the same bug in Ruby 1.9.0, move RUBY_VERSION condition into the patch file
-----------------------------------------------------------------
Revision: 69d9bb2d250a211e52baab031e5f840032fdee74
Ancestor: de7c67553a07c221dc2064cc19a64c32286c72ae
Author: angdraug@debian.org
Date: 28/07/09 17:45:55
Branch: syncache-head
Added files:
test/ts_syncache.rb
Added directories:
test
ChangeLog:
unit test re-added from Samizdat::Cache
-----------------------------------------------------------------
Revision: de7c67553a07c221dc2064cc19a64c32286c72ae
Ancestor: f95d143aed0ae773800a96cafb4e1b9eb87cc407
Author: angdraug@debian.org
Date: 28/07/09 17:29:16
Branch: syncache-head
Modified files:
bin/syncache-drb
ChangeLog:
fixes in handling of syncache-drb options
-----------------------------------------------------------------
Revision: f95d143aed0ae773800a96cafb4e1b9eb87cc407
Ancestor: ed2cc574a6324a95a69f81c4a3ed3e04bd26ade4
Author: angdraug@debian.org
Date: 27/07/09 17:50:10
Branch: syncache-head
Modified files:
README.rdoc
ChangeLog:
updated README.rdoc to reflect renamed DRb server script
-----------------------------------------------------------------
Revision: ed2cc574a6324a95a69f81c4a3ed3e04bd26ade4
Ancestor: e9c480978fdb812474c40a785d7b4cae8aa77c58
Author: angdraug@debian.org
Date: 27/07/09 17:32:17
Branch: syncache-head
Renamed entries:
man/syncache-drb-server.1 to man/syncache-drb.1
Modified files:
man/syncache-drb.1
ChangeLog:
renamed the samizdat-drb-server.1 manpage along with the script
-----------------------------------------------------------------
Revision: e9c480978fdb812474c40a785d7b4cae8aa77c58
Ancestor: e6c0480854ee7af7f7f9956d9c6489452ec99a65
Author: angdraug@debian.org
Date: 27/07/09 17:16:05
Branch: syncache-head
Renamed entries:
bin/syncache-drb-server to bin/syncache-drb
Modified files:
bin/syncache-drb
ChangeLog:
renamed syncache-drb-server to syncache-drb to make it fit within 15 character limit
-----------------------------------------------------------------
Revision: e6c0480854ee7af7f7f9956d9c6489452ec99a65
Ancestor: 6818ae15675fa101beb33c7fc21635e404a09fbe
Author: angdraug@debian.org
Date: 27/07/09 16:37:53
Branch: syncache-head
Modified files:
lib/syncache.rb
ChangeLog:
conditionally load monkey patch for the sync.rb bug only for Ruby versions < 1.8.7p173
-----------------------------------------------------------------
Revision: 6818ae15675fa101beb33c7fc21635e404a09fbe
Ancestor: 56a8b045280179815127c312f703c55bc63d7081
Author: angdraug@debian.org
Date: 27/07/09 15:57:09
Branch: syncache-head
Modified files:
bin/syncache-drb-server
ChangeLog:
fixed Samizdat legacy: cache -> @cache
-----------------------------------------------------------------
Revision: 56a8b045280179815127c312f703c55bc63d7081
Ancestor:
Author: angdraug@debian.org
Date: 27/07/09 15:40:15
Branch: syncache-head
Added files:
COPYING README.rdoc bin/syncache-drb-server lib/syncache.rb
lib/syncache_sync_patch.rb man/syncache-drb-server.1
setup.rb
Added directories:
. bin lib man
ChangeLog:
initial checkin: SynCache is a spin-off of cache.rb from Samizdat project
syncache-1.4/README.rdoc 0000664 0000000 0000000 00000007165 12704363361 0014777 0 ustar 00root root 0000000 0000000 = SynCache - thread-safe time-limited cache with flexible replacement policy
== Synopsys
require 'syncache'
@cache = SynCache::Cache.new
@cache.fetch_or_add('key:1') do
# expensive operation
end
@cache.flush(/^key:/)
== Description
SynCache::Cache stores cached objects in a Hash that is protected by an
advanced two-level locking mechanism. Two-level locking ensures that:
* Multiple threads can add and fetch objects in parallel without
stepping on each other's toes.
* While one thread is working on a cache entry, other threads can access
the rest of the cache with no waiting on the global lock, no race
conditions nor deadlock or livelock situations.
* While one thread is performing a long and resource-intensive
operation, other threads that request the same data with #fetch_or_add
method will be put on hold, and as soon as the first thread completes
the operation, the result will be returned to all threads. Without
this feature, a steady stream of requests with less time between them
than it takes to complete one request can easily bury a server under
an avalanche of threads all wasting resources on the same expensive
operation.
When number of cache entries exceeds the size limit, the least recently
accessed entries are replaced with new data. This replacement strategy
is controlled by the SynCache::CacheEntry class and can be changed by
overriding its #replacement_index method.
Cache entries are automatically invalidated when their +ttl+ (time to
live) is exceeded. Entries can be explicitly invalidated by #flush
method. The method can use === operator to compare cache keys
against flush base (so that base can be e.g. a Regexp). When invoked
without the +base+ parameter, it invalidates all entries.
The +flush_delay+ initialization option allows to limit cache's flush
rate. When this option is set, SynCache will make sure that at least
this many seconds (it can also be a fraction) pass between two flushes.
When extra flushes are requested, invalidation of flushed entries is
postponed until earliest time when next flush is allowed.
== SynCache DRb Server
SynCache::Cache object can be shared between multiple Ruby processes,
even across different computers. All you need is the
syncache-drb script shipped with this module. This script will
start a daemon that serves a SynCache::Cache object over dRuby protocol,
with $SAFE set to 1 for security.
To access a remote cache, you will need to use DRb library:
require 'drb'
# connect to the remote cache
@cache = DRbObject.new_with_uri('druby://localhost:9000')
# allow remote cache to access local objects from fetch_or_add blocks
DRb.start_service('druby://localhost:0')
For the above to work properly, all your fetch_or_add blocks should be
thread-safe, because DRb will run them in their own threads. Also, if a
Ruby process crashes is the middle of such block, the key will remain
locked in the remote cache until its +ttl+ runs out.
To work around these limitations, you can wrap access to a remote cache
using a SynCache::RemoteCache object:
require 'syncache'
# connect to the remote cache
@cache = SynCache::RemoteCache.new('druby://localhost:9000')
SynCache::RemoteCache implements its own version of fetch_or_add that
runs the supplied block locally in the current thread and would give up
and take over a locked key if the client that originally locked it takes
too long to free it up.
== Copying
Copyright (c) 2002-2011 Dmitry Borodaenko
This program is free software.
You can distribute/modify this program under the terms of the GNU
General Public License version 3 or later.
syncache-1.4/Rakefile 0000664 0000000 0000000 00000000715 12704363361 0014630 0 ustar 00root root 0000000 0000000 # SynCache dRuby object cache server
# (originally written for Samizdat project)
#
# Copyright (c) 2002-2012, 2016 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require "rake"
task :default => :test
task :test do
sh %{#{FileUtils::RUBY} -I. -Ilib test/ts_syncache.rb}
end
syncache-1.4/bin/ 0000775 0000000 0000000 00000000000 12704363361 0013730 5 ustar 00root root 0000000 0000000 syncache-1.4/bin/syncache-drb 0000664 0000000 0000000 00000012115 12704363361 0016215 0 ustar 00root root 0000000 0000000 #!/usr/bin/env ruby
#
# SynCache dRuby object cache server
# (originally written for Samizdat project)
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'getoptlong'
require 'etc'
require 'syslog'
require 'drb'
require 'syncache'
class SynCacheDRb
PNAME = 'syncache-drb'
def usage
puts %{
Usage: #{PNAME} [ options ] [ URI ]
Options:
URI
URI with druby: schema that DRb server binds to, default is
druby://*:9000
--help
display this message and quit
--ttl SECONDS
time-to-live value for cache entries, default is 24 hours
--size ENTRIES
maximum number of objects in cache, default is 10000
--flush-delay SECONDS
rate-limit flush operations: if less than that number of seconds
has passed since last flush, next flush will be delayed; default
is no rate limit
--user USER
Run as USER if started as root. Default is nobody.
--error-log ERROR_LOG_PATH
File to write errors to. Default is /dev/null. When run as root,
the file is chowned to USER:adm.
--debug
Enable debug mode. If an error log is specified with --error-log,
all messages will be sent there instead of syslog.
--pidfile PATH
Path to the pidfile. By default, pidfile is created under
/var/run/#{PNAME}/ when run as root, or under $TMPDIR
otherwise. Location should be writeable by USER.
--foreground
Do not daemonize, switch to a different user, create pidfile,
redirect output, or log to syslog.
}
exit
end
def set_options
opts = GetoptLong.new(
[ '--help', '-h', GetoptLong::NO_ARGUMENT ],
[ '--ttl', '-t', GetoptLong::REQUIRED_ARGUMENT ],
[ '--size', '-s', GetoptLong::REQUIRED_ARGUMENT ],
[ '--flush-delay', '-f', GetoptLong::REQUIRED_ARGUMENT ],
[ '--user', '-u', GetoptLong::REQUIRED_ARGUMENT ],
[ '--error-log', '-e', GetoptLong::REQUIRED_ARGUMENT ],
[ '--debug', '-d', GetoptLong::NO_ARGUMENT ],
[ '--pidfile', '-p', GetoptLong::REQUIRED_ARGUMENT ],
[ '--foreground', GetoptLong::NO_ARGUMENT ]
)
@uri = 'druby://*:9000'
@ttl = 24*60*60
@size = 10000
@flush_delay = nil
@user = 'nobody'
@error_log = '/dev/null'
@debug = false
@pidfile = (0 == Process.uid) ?
"/var/run/#{PNAME}/#{PNAME}.pid" :
File.join((ENV.has_key?('TMPDIR') ? ENV['TMPDIR'].dup.untaint : '/tmp'),
"#{PNAME}.pid")
@foreground = false
opts.each do |opt, arg|
case opt
when '--help'
usage
when '--ttl'
@ttl = arg.to_i
when '--size'
@size = arg.to_i
when '--flush-delay'
@flush_delay = arg.to_i
when '--user'
@user = arg.dup.untaint
when '--error-log'
@error_log = arg.dup.untaint
when '--debug'
@debug = true
when '--pidfile'
@pidfile = arg.dup.untaint
when '--foreground'
@foreground = true
end
end
@uri = ARGV[0].dup.untaint if ARGV[0]
@user = Etc.getpwnam(@user)
end
def log(message, level = :info)
if @log.respond_to? level
@log.send(level, message)
else
STDERR << 'syncache: ' + message + "\n"
STDERR.flush
end
end
def daemonize
$0 = PNAME
ENV.clear
exit if fork
Process.setsid
exit if fork
Dir.chdir '/'
File.umask 0022
STDIN.reopen '/dev/null'
STDOUT.reopen '/dev/null', 'a'
STDERR.reopen @error_log, 'a'
if 0 == Process.uid
if @error_log != '/dev/null'
File.chown(@user.uid, Etc.getgrnam('adm').gid, @error_log)
File.chmod(0640, @error_log)
end
# drop root priviledge
Process::Sys.setgid(@user.gid)
Process::Sys.setuid(@user.uid)
end
File.open(@pidfile, 'w') {|f| f.puts Process.pid }
end
def open_syslog
@log = Syslog.open PNAME
end
def ready
@cache = SynCache::Cache.new(@ttl, @size, @flush_delay) # initialize cache
@cache.debug = true if @debug
end
def trap_signals
shutdown = lambda do |sig|
Thread.new do
sleep 0.01
DRb.stop_service
end
end
Signal.trap('INT', shutdown)
Signal.trap('TERM', shutdown)
Signal.trap('HUP') do |sig| # kill -HUP to flush cache
Thread.new do
sleep 0.01
@cache.flush
log 'cache flushed'
end
end
end
def start_service
$SAFE = 1
DRb.start_service(@uri, @cache)
log 'started'
end
def wait_for_shutdown
DRb.thread.join
File.delete @pidfile unless @foreground
log 'shut down'
end
def run
set_options
unless @foreground
daemonize
open_syslog unless @debug and @error_log
end
begin
ready
trap_signals
start_service
wait_for_shutdown
rescue => error
log "#{error.class.to_s}: #{error.to_s}", :err
error.backtrace.each {|line| log(' ' + line, :err) }
raise
end
end
end
SynCacheDRb.new.run
syncache-1.4/lib/ 0000775 0000000 0000000 00000000000 12704363361 0013726 5 ustar 00root root 0000000 0000000 syncache-1.4/lib/syncache.rb 0000664 0000000 0000000 00000000661 12704363361 0016053 0 ustar 00root root 0000000 0000000 # SynCache: thread-safe time-limited cache with flexible replacement policy
# (originally written for Samizdat project)
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'syncache/syncache'
require 'syncache/remote'
syncache-1.4/lib/syncache/ 0000775 0000000 0000000 00000000000 12704363361 0015523 5 ustar 00root root 0000000 0000000 syncache-1.4/lib/syncache/remote.rb 0000664 0000000 0000000 00000004732 12704363361 0017351 0 ustar 00root root 0000000 0000000 # SynCache: thread-safe time-limited cache with flexible replacement policy
# (originally written for Samizdat project)
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'drb'
require 'delegate'
module SynCache
REMOTE_TIMEOUT = 60 * 5 # 5 minutes
REMOTE_FIRST_DELAY = 0.1 # 100 ms
class Placeholder
def initialize
@id = rand(9223372036854775808)
@timestamp = Time.now
end
attr_reader :id, :timestamp
def ===(other)
other.kind_of?(Placeholder) and other.id == @id
end
end
# Connects to a remote SynCache instance over DRb at the provided URI and
# replaces the remote fetch_or_add method with a slightly less bullet-proof
# version that invokes the supplied block locally (instead of sending it over
# DRb to the cache and then back to a different local thread via a local DRb
# service).
#
# If another RemoteCache client is already working on the same key, this client
# will wait, using randomly increasing intervals. When a configured timeout
# runs out (counting from the time the other client has put a placeholder in
# the cache), the client will give up, discard the other client's placeholder
# and start working on the key itself.
#
# Mixing access to the same cache entries from direct and RemoteCache clients
# is not recommended.
#
class RemoteCache
def initialize(uri, timeout=REMOTE_TIMEOUT, first_delay=REMOTE_FIRST_DELAY)
@timeout = timeout
@first_delay = first_delay
@cache = DRbObject.new_with_uri(uri)
end
def method_missing(method, *args)
@cache.send(method, *args)
end
def fetch_or_add(key)
placeholder = Placeholder.new
value = @cache.fetch_or_add(key) { placeholder }
case value
when placeholder
# our placeholder
value = @cache[key] = yield
when Placeholder
# someone else's placeholder
delay = @first_delay
while value.kind_of?(Placeholder) and Time.now < value.timestamp + @timeout
sleep(delay)
delay *= 1 + rand
value = @cache[key]
end
if value.kind_of?(Placeholder) or value.nil?
# the other client timed out or got flushed;
# reset the placeholder ttl and do it ourselves
@cache[key] = Placeholder.new
value = @cache[key] = yield
end
end
value
end
end
end # module SynCache
syncache-1.4/lib/syncache/syncache.rb 0000664 0000000 0000000 00000014133 12704363361 0017647 0 ustar 00root root 0000000 0000000 # SynCache: thread-safe time-limited cache with flexible replacement policy
# (originally written for Samizdat project)
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
module SynCache
FOREVER = 60 * 60 * 24 * 365 * 5 # 5 years
class CacheError < RuntimeError; end
class CacheEntry
def initialize(ttl = nil, value = nil)
@value = value
@ttl = ttl
@dirty = false
record_access
@sync = Mutex.new
end
# stores the value object
attr_accessor :value
# change this to make the entry expire sooner
attr_accessor :ttl
# use this to synchronize access to +value+
attr_reader :sync
# record the fact that the entry was accessed
#
def record_access
return if @dirty
@expires = Time.now + (@ttl or FOREVER)
end
# entries with lowest index will be replaced first
#
def replacement_index
@expires
end
# check if entry is stale
#
def stale?
@expires < Time.now
end
# mark entry as dirty and schedule it to expire at given time
#
def expire_at(time)
@expires = time if @expires > time
@dirty = true
end
end
class Cache
# a float number of seconds to sleep when a race condition is detected
# (actual delay is randomized to avoid live lock situation)
#
LOCK_SLEEP = 0.2
# _ttl_ (time to live) is time in seconds from the last access until cache
# entry is expired (set to _nil_ to disable time limit)
#
# _max_size_ is max number of objects in cache
#
# _flush_delay_ is used to rate-limit flush operations: if less than that
# number of seconds has passed since last flush, next flush will be delayed;
# default is no rate limit
#
def initialize(ttl = 60*60, max_size = 5000, flush_delay = nil)
@ttl = ttl
@max_size = max_size
@debug = false
if @flush_delay = flush_delay
@last_flush = Time.now
end
@sync = Mutex.new
@cache = {}
end
# set to _true_ to report every single cache operation
#
attr_accessor :debug
# remove all values from cache
#
# if _base_ is given, only values with keys matching the base (using
# === operator) are removed
#
def flush(base = nil)
debug { 'flush ' << base.to_s }
@sync.synchronize do
if @flush_delay
next_flush = @last_flush + @flush_delay
if next_flush > Time.now
flush_at(next_flush, base)
else
flush_now(base)
@last_flush = Time.now
end
else
flush_now(base)
end
end
end
# remove single value from cache
#
def delete(key)
debug { 'delete ' << key.to_s }
@sync.synchronize do
@cache.delete(key)
end
end
# store new value in cache
#
# see also Cache#fetch_or_add
#
def []=(key, value)
debug { '[]= ' << key.to_s }
entry = get_locked_entry(key)
begin
return entry.value = value
ensure
entry.sync.unlock
end
end
# retrieve value from cache if it's still fresh
#
# see also Cache#fetch_or_add
#
def [](key)
debug { '[] ' << key.to_s }
entry = get_locked_entry(key, false)
unless entry.nil?
begin
return entry.value
ensure
entry.sync.unlock
end
end
end
# initialize missing cache entry from supplied block
#
# this is the preferred method of adding values to the cache as it locks the
# key for the duration of computation of the supplied block to prevent
# parallel execution of resource-intensive actions
#
def fetch_or_add(key)
debug { 'fetch_or_add ' << key.to_s }
entry = get_locked_entry(key)
begin
if entry.value.nil?
entry.value = yield
end
return entry.value
ensure
entry.sync.unlock
end
end
private
# immediate flush (delete all entries matching _base_)
#
# must be run from inside global lock, see #flush
#
def flush_now(base = nil)
if base
@cache.delete_if {|key, entry| base === key }
else
@cache = {}
end
end
# delayed flush (ensure all entries matching _base_ expire no later than _next_flush_)
#
# must be run from inside global lock, see #flush
#
def flush_at(next_flush, base = nil)
@cache.each do |key, entry|
next if base and not base === key
entry.expire_at(next_flush)
end
end
def add_blank_entry(key)
@sync.locked? or raise CacheError,
'add_entry called while @sync is not locked'
had_same_key = @cache.has_key?(key)
entry = @cache[key] = CacheEntry.new(@ttl)
check_size unless had_same_key
entry
end
def get_locked_entry(key, add_if_missing=true)
debug { "get_locked_entry #{key}, #{add_if_missing}" }
entry = nil # scope fix
entry_locked = false
until entry_locked do
@sync.synchronize do
entry = @cache[key]
if entry.nil? or entry.stale?
if add_if_missing
entry = add_blank_entry(key)
else
@cache.delete(key) unless entry.nil?
return nil
end
end
entry_locked = entry.sync.try_lock
end
sleep(rand * LOCK_SLEEP) unless entry_locked
end
entry.record_access
entry
end
# remove oldest item from cache if size limit reached
#
def check_size
debug { 'check_size' }
return unless @max_size.kind_of? Numeric
if @sync.locked?
check_size_internal
else
@sync.synchronize { check_size_internal }
end
end
def check_size_internal
while @cache.size > @max_size do
# optimize: supplement hash with queue
oldest = @cache.keys.min {|a, b| @cache[a].replacement_index <=> @cache[b].replacement_index }
@cache.delete(oldest)
end
end
# send debug output to syslog if enabled
#
def debug
return unless @debug
message = Thread.current.to_s + ' ' + yield
if defined?(Syslog) and Syslog.opened?
Syslog.debug(message)
else
STDERR << 'syncache: ' + message + "\n"
STDERR.flush
end
end
end
end # module SynCache
syncache-1.4/man/ 0000775 0000000 0000000 00000000000 12704363361 0013733 5 ustar 00root root 0000000 0000000 syncache-1.4/man/syncache-drb.1 0000664 0000000 0000000 00000003370 12704363361 0016362 0 ustar 00root root 0000000 0000000 .TH "SYNCACHE-DRB" "1"
.SH "NAME"
syncache-drb - SynCache dRuby object cache server
.SH "SYNOPSIS"
.PP
\fBsyncache-drb\fP [ \fBoptions\fP ] [ \fBURI\fP ]
.SH "DESCRIPTION"
.PP
\fBsyncache-drb\fP starts a Distributed Ruby server providing a
SynCache::Cache object.
.PP
SynCache::Cache is a thread-safe time-limited object cache with flexible
replacement strategy.
.SH "OPTIONS"
.IP "\fBURI\fP" 4
A URI with druby: schema that the DRb server binds to, default is
\fBdruby://*:9000\fP
.IP "\fB--help\fP" 4
Display usage information and quit.
.IP "\fB--ttl\fP SECONDS" 4
Time-to-live value for cache entries, default is 24 hours.
.IP "\fB--size\fP ENTRIES" 4
Maximum number of objects in cache, default is 10000.
.IP "\fB--flush-delay\fP SECONDS" 4
Rate-limit flush operations. If less than that number of seconds has passed
since last flush, next flush will be delayed. Default is no rate limit.
.IP "\fB--user\fP USER" 4
Run as USER if started as root. Default is nobody.
.IP "\fB--error-log\fP ERROR_LOG_PATH" 4
File to write errors to. Default is /dev/null. When run as root,
the file is chowned to USER:adm.
.IP "\fB--debug\fP" 4
Enable debug mode. If an error log is specified with --error-log, all
messages will be sent there instead of syslog.
.IP "\fB--pidfile\fP PATH" 4
Path to pidfile. By default, pidfile is created under /var/run/syncache-drb/
when run as root, or under $TMPDIR otherwise. Location should be writeable by
USER.
.IP "\fB--foreground\fP" 4
Do not daemonize, switch to a different user, create pidfile, redirect output,
or log to syslog.
.SH "AUTHOR"
.PP
This manual page was written by Dmitry Borodaenko .
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU GPL version 3 or later.
syncache-1.4/setup.rb 0000664 0000000 0000000 00000071104 12704363361 0014650 0 ustar 00root root 0000000 0000000 #
# setup.rb
#
# Copyright (c) 2000-2004 Minero Aoki
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU LGPL, Lesser General Public License version 2.1.
#
unless Enumerable.method_defined?(:map) # Ruby 1.4.6
module Enumerable
alias map collect
end
end
unless File.respond_to?(:read) # Ruby 1.6
def File.read(fname)
open(fname) {|f|
return f.read
}
end
end
def File.binread(fname)
open(fname, 'rb') {|f|
return f.read
}
end
# for corrupted windows stat(2)
def File.dir?(path)
File.directory?((path[-1,1] == '/') ? path : path + '/')
end
class SetupError < StandardError; end
def setup_rb_error(msg)
raise SetupError, msg
end
#
# Config
#
if arg = ARGV.detect {|arg| /\A--rbconfig=/ =~ arg }
ARGV.delete(arg)
require arg.split(/=/, 2)[1]
$".push 'rbconfig.rb'
else
require 'rbconfig'
end
def multipackage_install?
FileTest.directory?(File.dirname($0) + '/packages')
end
class ConfigItem
def initialize(name, template, default, desc)
@name = name.freeze
@template = template
@value = default
@default = default.dup.freeze
@description = desc
end
attr_reader :name
attr_reader :description
attr_accessor :default
alias help_default default
def help_opt
"--#{@name}=#{@template}"
end
def value
@value
end
def eval(table)
@value.gsub(%r<\$([^/]+)>) { table[$1] }
end
def set(val)
@value = check(val)
end
private
def check(val)
setup_rb_error "config: --#{name} requires argument" unless val
val
end
end
class BoolItem < ConfigItem
def config_type
'bool'
end
def help_opt
"--#{@name}"
end
private
def check(val)
return 'yes' unless val
unless /\A(y(es)?|n(o)?|t(rue)?|f(alse))\z/i =~ val
setup_rb_error "config: --#{@name} accepts only yes/no for argument"
end
(/\Ay(es)?|\At(rue)/i =~ value) ? 'yes' : 'no'
end
end
class PathItem < ConfigItem
def config_type
'path'
end
private
def check(path)
setup_rb_error "config: --#{@name} requires argument" unless path
path[0,1] == '$' ? path : File.expand_path(path)
end
end
class ProgramItem < ConfigItem
def config_type
'program'
end
end
class SelectItem < ConfigItem
def initialize(name, template, default, desc)
super
@ok = template.split('/')
end
def config_type
'select'
end
private
def check(val)
unless @ok.include?(val.strip)
setup_rb_error "config: use --#{@name}=#{@template} (#{val})"
end
val.strip
end
end
class PackageSelectionItem < ConfigItem
def initialize(name, template, default, help_default, desc)
super name, template, default, desc
@help_default = help_default
end
attr_reader :help_default
def config_type
'package'
end
private
def check(val)
unless File.dir?("packages/#{val}")
setup_rb_error "config: no such package: #{val}"
end
val
end
end
class ConfigTable_class
def initialize(items)
@items = items
@table = {}
items.each do |i|
@table[i.name] = i
end
ALIASES.each do |ali, name|
@table[ali] = @table[name]
end
end
include Enumerable
def each(&block)
@items.each(&block)
end
def key?(name)
@table.key?(name)
end
def lookup(name)
@table[name] or raise ArgumentError, "no such config item: #{name}"
end
def add(item)
@items.push item
@table[item.name] = item
end
def remove(name)
item = lookup(name)
@items.delete_if {|i| i.name == name }
@table.delete_if {|name, i| i.name == name }
item
end
def new
dup()
end
def savefile
'.config'
end
def load
begin
t = dup()
File.foreach(savefile()) do |line|
k, v = *line.split(/=/, 2)
t[k] = v.strip
end
t
rescue Errno::ENOENT
setup_rb_error $!.message + "#{File.basename($0)} config first"
end
end
def save
@items.each {|i| i.value }
File.open(savefile(), 'w') {|f|
@items.each do |i|
f.printf "%s=%s\n", i.name, i.value if i.value
end
}
end
def [](key)
lookup(key).eval(self)
end
def []=(key, val)
lookup(key).set val
end
end
c = ::Config::CONFIG
rubypath = c['bindir'] + '/' + c['ruby_install_name']
major = c['MAJOR'].to_i
minor = c['MINOR'].to_i
teeny = c['TEENY'].to_i
version = "#{major}.#{minor}"
# ruby ver. >= 1.4.4?
newpath_p = ((major >= 2) or
((major == 1) and
((minor >= 5) or
((minor == 4) and (teeny >= 4)))))
if c['rubylibdir']
# V < 1.6.3
_stdruby = c['rubylibdir']
_siteruby = c['sitedir']
_siterubyver = c['sitelibdir']
_siterubyverarch = c['sitearchdir']
elsif newpath_p
# 1.4.4 <= V <= 1.6.3
_stdruby = "$prefix/lib/ruby/#{version}"
_siteruby = c['sitedir']
_siterubyver = "$siteruby/#{version}"
_siterubyverarch = "$siterubyver/#{c['arch']}"
else
# V < 1.4.4
_stdruby = "$prefix/lib/ruby/#{version}"
_siteruby = "$prefix/lib/ruby/#{version}/site_ruby"
_siterubyver = _siteruby
_siterubyverarch = "$siterubyver/#{c['arch']}"
end
libdir = '-* dummy libdir *-'
stdruby = '-* dummy rubylibdir *-'
siteruby = '-* dummy site_ruby *-'
siterubyver = '-* dummy site_ruby version *-'
parameterize = lambda {|path|
path.sub(/\A#{Regexp.quote(c['prefix'])}/, '$prefix')\
.sub(/\A#{Regexp.quote(libdir)}/, '$libdir')\
.sub(/\A#{Regexp.quote(stdruby)}/, '$stdruby')\
.sub(/\A#{Regexp.quote(siteruby)}/, '$siteruby')\
.sub(/\A#{Regexp.quote(siterubyver)}/, '$siterubyver')
}
libdir = parameterize.call(c['libdir'])
stdruby = parameterize.call(_stdruby)
siteruby = parameterize.call(_siteruby)
siterubyver = parameterize.call(_siterubyver)
siterubyverarch = parameterize.call(_siterubyverarch)
if arg = c['configure_args'].split.detect {|arg| /--with-make-prog=/ =~ arg }
makeprog = arg.sub(/'/, '').split(/=/, 2)[1]
else
makeprog = 'make'
end
common_conf = [
PathItem.new('prefix', 'path', c['prefix'],
'path prefix of target environment'),
PathItem.new('bindir', 'path', parameterize.call(c['bindir']),
'the directory for commands'),
PathItem.new('libdir', 'path', libdir,
'the directory for libraries'),
PathItem.new('datadir', 'path', parameterize.call(c['datadir']),
'the directory for shared data'),
PathItem.new('mandir', 'path', parameterize.call(c['mandir']),
'the directory for man pages'),
PathItem.new('sysconfdir', 'path', parameterize.call(c['sysconfdir']),
'the directory for man pages'),
PathItem.new('stdruby', 'path', stdruby,
'the directory for standard ruby libraries'),
PathItem.new('siteruby', 'path', siteruby,
'the directory for version-independent aux ruby libraries'),
PathItem.new('siterubyver', 'path', siterubyver,
'the directory for aux ruby libraries'),
PathItem.new('siterubyverarch', 'path', siterubyverarch,
'the directory for aux ruby binaries'),
PathItem.new('rbdir', 'path', '$siterubyver',
'the directory for ruby scripts'),
PathItem.new('sodir', 'path', '$siterubyverarch',
'the directory for ruby extentions'),
PathItem.new('rubypath', 'path', rubypath,
'the path to set to #! line'),
ProgramItem.new('rubyprog', 'name', rubypath,
'the ruby program using for installation'),
ProgramItem.new('makeprog', 'name', makeprog,
'the make program to compile ruby extentions'),
SelectItem.new('shebang', 'all/ruby/never', 'ruby',
'shebang line (#!) editing mode'),
BoolItem.new('without-ext', 'yes/no', 'no',
'does not compile/install ruby extentions')
]
class ConfigTable_class # open again
ALIASES = {
'std-ruby' => 'stdruby',
'site-ruby-common' => 'siteruby', # For backward compatibility
'site-ruby' => 'siterubyver', # For backward compatibility
'bin-dir' => 'bindir',
'bin-dir' => 'bindir',
'rb-dir' => 'rbdir',
'so-dir' => 'sodir',
'data-dir' => 'datadir',
'ruby-path' => 'rubypath',
'ruby-prog' => 'rubyprog',
'ruby' => 'rubyprog',
'make-prog' => 'makeprog',
'make' => 'makeprog'
}
end
multipackage_conf = [
PackageSelectionItem.new('with', 'name,name...', '', 'ALL',
'package names that you want to install'),
PackageSelectionItem.new('without', 'name,name...', '', 'NONE',
'package names that you do not want to install')
]
if multipackage_install?
ConfigTable = ConfigTable_class.new(common_conf + multipackage_conf)
else
ConfigTable = ConfigTable_class.new(common_conf)
end
module MetaConfigAPI
def eval_file_ifexist(fname)
instance_eval File.read(fname), fname, 1 if File.file?(fname)
end
def config_names
ConfigTable.map {|i| i.name }
end
def config?(name)
ConfigTable.key?(name)
end
def bool_config?(name)
ConfigTable.lookup(name).config_type == 'bool'
end
def path_config?(name)
ConfigTable.lookup(name).config_type == 'path'
end
def value_config?(name)
case ConfigTable.lookup(name).config_type
when 'bool', 'path'
true
else
false
end
end
def add_config(item)
ConfigTable.add item
end
def add_bool_config(name, default, desc)
ConfigTable.add BoolItem.new(name, 'yes/no', default ? 'yes' : 'no', desc)
end
def add_path_config(name, default, desc)
ConfigTable.add PathItem.new(name, 'path', default, desc)
end
def set_config_default(name, default)
ConfigTable.lookup(name).default = default
end
def remove_config(name)
ConfigTable.remove(name)
end
end
#
# File Operations
#
module FileOperations
def mkdir_p(dirname, prefix = nil)
dirname = prefix + File.expand_path(dirname) if prefix
$stderr.puts "mkdir -p #{dirname}" if verbose?
return if no_harm?
# does not check '/'... it's too abnormal case
dirs = File.expand_path(dirname).split(%r<(?=/)>)
if /\A[a-z]:\z/i =~ dirs[0]
disk = dirs.shift
dirs[0] = disk + dirs[0]
end
dirs.each_index do |idx|
path = dirs[0..idx].join('')
Dir.mkdir path unless File.dir?(path)
end
end
def rm_f(fname)
$stderr.puts "rm -f #{fname}" if verbose?
return if no_harm?
if File.exist?(fname) or File.symlink?(fname)
File.chmod 0777, fname
File.unlink fname
end
end
def rm_rf(dn)
$stderr.puts "rm -rf #{dn}" if verbose?
return if no_harm?
Dir.chdir dn
Dir.foreach('.') do |fn|
next if fn == '.'
next if fn == '..'
if File.dir?(fn)
verbose_off {
rm_rf fn
}
else
verbose_off {
rm_f fn
}
end
end
Dir.chdir '..'
Dir.rmdir dn
end
def move_file(src, dest)
File.unlink dest if File.exist?(dest)
begin
File.rename src, dest
rescue
File.open(dest, 'wb') {|f| f.write File.binread(src) }
File.chmod File.stat(src).mode, dest
File.unlink src
end
end
def install(from, dest, mode, prefix = nil)
$stderr.puts "install #{from} #{dest}" if verbose?
return if no_harm?
realdest = prefix ? prefix + File.expand_path(dest) : dest
realdest = File.join(realdest, File.basename(from)) if File.dir?(realdest)
str = File.binread(from)
if diff?(str, realdest)
verbose_off {
rm_f realdest if File.exist?(realdest)
}
File.open(realdest, 'wb') {|f|
f.write str
}
File.chmod mode, realdest
File.open("#{objdir_root()}/InstalledFiles", 'a') {|f|
if prefix
f.puts realdest.sub(prefix, '')
else
f.puts realdest
end
}
end
end
def diff?(new_content, path)
return true unless File.exist?(path)
new_content != File.binread(path)
end
def command(str)
$stderr.puts str if verbose?
system str or raise RuntimeError, "'system #{str}' failed"
end
def ruby(str)
command config('rubyprog') + ' ' + str
end
def make(task = '')
command config('makeprog') + ' ' + task
end
def extdir?(dir)
File.exist?(dir + '/MANIFEST')
end
def all_files_in(dirname)
Dir.open(dirname) {|d|
return d.select {|ent| File.file?("#{dirname}/#{ent}") }
}
end
REJECT_DIRS = %w(
CVS SCCS RCS CVS.adm .svn
)
def all_dirs_in(dirname)
Dir.open(dirname) {|d|
return d.select {|n| File.dir?("#{dirname}/#{n}") } - %w(. ..) - REJECT_DIRS
}
end
end
#
# Main Installer
#
module HookUtils
def run_hook(name)
try_run_hook "#{curr_srcdir()}/#{name}" or
try_run_hook "#{curr_srcdir()}/#{name}.rb"
end
def try_run_hook(fname)
return false unless File.file?(fname)
begin
instance_eval File.read(fname), fname, 1
rescue
setup_rb_error "hook #{fname} failed:\n" + $!.message
end
true
end
end
module HookScriptAPI
def get_config(key)
@config[key]
end
alias config get_config
def set_config(key, val)
@config[key] = val
end
#
# srcdir/objdir (works only in the package directory)
#
#abstract srcdir_root
#abstract objdir_root
#abstract relpath
def curr_srcdir
"#{srcdir_root()}/#{relpath()}"
end
def curr_objdir
"#{objdir_root()}/#{relpath()}"
end
def srcfile(path)
"#{curr_srcdir()}/#{path}"
end
def srcexist?(path)
File.exist?(srcfile(path))
end
def srcdirectory?(path)
File.dir?(srcfile(path))
end
def srcfile?(path)
File.file? srcfile(path)
end
def srcentries(path = '.')
Dir.open("#{curr_srcdir()}/#{path}") {|d|
return d.to_a - %w(. ..)
}
end
def srcfiles(path = '.')
srcentries(path).select {|fname|
File.file?(File.join(curr_srcdir(), path, fname))
}
end
def srcdirectories(path = '.')
srcentries(path).select {|fname|
File.dir?(File.join(curr_srcdir(), path, fname))
}
end
end
class ToplevelInstaller
Version = '3.3.1'
Copyright = 'Copyright (c) 2000-2004 Minero Aoki'
TASKS = [
[ 'all', 'do config, setup, then install' ],
[ 'config', 'saves your configurations' ],
[ 'show', 'shows current configuration' ],
[ 'setup', 'compiles ruby extentions and others' ],
[ 'install', 'installs files' ],
[ 'clean', "does `make clean' for each extention" ],
[ 'distclean',"does `make distclean' for each extention" ]
]
def ToplevelInstaller.invoke
instance().invoke
end
@singleton = nil
def ToplevelInstaller.instance
@singleton ||= new(File.dirname($0))
@singleton
end
include MetaConfigAPI
def initialize(ardir_root)
@config = nil
@options = { 'verbose' => true }
@ardir = File.expand_path(ardir_root)
end
def inspect
"#<#{self.class} #{__id__()}>"
end
def invoke
run_metaconfigs
case task = parsearg_global()
when nil, 'all'
@config = load_config('config')
parsearg_config
init_installers
exec_config
exec_setup
exec_install
else
@config = load_config(task)
__send__ "parsearg_#{task}"
init_installers
__send__ "exec_#{task}"
end
end
def run_metaconfigs
eval_file_ifexist "#{@ardir}/metaconfig"
end
def load_config(task)
case task
when 'config'
ConfigTable.new
when 'clean', 'distclean'
if File.exist?(ConfigTable.savefile)
then ConfigTable.load
else ConfigTable.new
end
else
ConfigTable.load
end
end
def init_installers
@installer = Installer.new(@config, @options, @ardir, File.expand_path('.'))
end
#
# Hook Script API bases
#
def srcdir_root
@ardir
end
def objdir_root
'.'
end
def relpath
'.'
end
#
# Option Parsing
#
def parsearg_global
valid_task = /\A(?:#{TASKS.map {|task,desc| task }.join '|'})\z/
while arg = ARGV.shift
case arg
when /\A\w+\z/
setup_rb_error "invalid task: #{arg}" unless valid_task =~ arg
return arg
when '-q', '--quiet'
@options['verbose'] = false
when '--verbose'
@options['verbose'] = true
when '-h', '--help'
print_usage $stdout
exit 0
when '-v', '--version'
puts "#{File.basename($0)} version #{Version}"
exit 0
when '--copyright'
puts Copyright
exit 0
else
setup_rb_error "unknown global option '#{arg}'"
end
end
nil
end
def parsearg_no_options
unless ARGV.empty?
setup_rb_error "#{task}: unknown options: #{ARGV.join ' '}"
end
end
alias parsearg_show parsearg_no_options
alias parsearg_setup parsearg_no_options
alias parsearg_clean parsearg_no_options
alias parsearg_distclean parsearg_no_options
def parsearg_config
re = /\A--(#{ConfigTable.map {|i| i.name }.join('|')})(?:=(.*))?\z/
@options['config-opt'] = []
while i = ARGV.shift
if /\A--?\z/ =~ i
@options['config-opt'] = ARGV.dup
break
end
m = re.match(i) or setup_rb_error "config: unknown option #{i}"
name, value = *m.to_a[1,2]
@config[name] = value
end
end
def parsearg_install
@options['no-harm'] = false
@options['install-prefix'] = ''
while a = ARGV.shift
case a
when /\A--no-harm\z/
@options['no-harm'] = true
when /\A--prefix=(.*)\z/
path = $1
path = File.expand_path(path) unless path[0,1] == '/'
@options['install-prefix'] = path
else
setup_rb_error "install: unknown option #{a}"
end
end
end
def print_usage(out)
out.puts 'Typical Installation Procedure:'
out.puts " $ ruby #{File.basename $0} config"
out.puts " $ ruby #{File.basename $0} setup"
out.puts " # ruby #{File.basename $0} install (may require root privilege)"
out.puts
out.puts 'Detailed Usage:'
out.puts " ruby #{File.basename $0} "
out.puts " ruby #{File.basename $0} [] []"
fmt = " %-24s %s\n"
out.puts
out.puts 'Global options:'
out.printf fmt, '-q,--quiet', 'suppress message outputs'
out.printf fmt, ' --verbose', 'output messages verbosely'
out.printf fmt, '-h,--help', 'print this message'
out.printf fmt, '-v,--version', 'print version and quit'
out.printf fmt, ' --copyright', 'print copyright and quit'
out.puts
out.puts 'Tasks:'
TASKS.each do |name, desc|
out.printf fmt, name, desc
end
fmt = " %-24s %s [%s]\n"
out.puts
out.puts 'Options for CONFIG or ALL:'
ConfigTable.each do |item|
out.printf fmt, item.help_opt, item.description, item.help_default
end
out.printf fmt, '--rbconfig=path', 'rbconfig.rb to load',"running ruby's"
out.puts
out.puts 'Options for INSTALL:'
out.printf fmt, '--no-harm', 'only display what to do if given', 'off'
out.printf fmt, '--prefix=path', 'install path prefix', '$prefix'
out.puts
end
#
# Task Handlers
#
def exec_config
@installer.exec_config
@config.save # must be final
end
def exec_setup
@installer.exec_setup
end
def exec_install
@installer.exec_install
end
def exec_show
ConfigTable.each do |i|
printf "%-20s %s\n", i.name, i.value
end
end
def exec_clean
@installer.exec_clean
end
def exec_distclean
@installer.exec_distclean
end
end
class ToplevelInstallerMulti < ToplevelInstaller
include HookUtils
include HookScriptAPI
include FileOperations
def initialize(ardir)
super
@packages = all_dirs_in("#{@ardir}/packages")
raise 'no package exists' if @packages.empty?
end
def run_metaconfigs
eval_file_ifexist "#{@ardir}/metaconfig"
@packages.each do |name|
eval_file_ifexist "#{@ardir}/packages/#{name}/metaconfig"
end
end
def init_installers
@installers = {}
@packages.each do |pack|
@installers[pack] = Installer.new(@config, @options,
"#{@ardir}/packages/#{pack}",
"packages/#{pack}")
end
with = extract_selection(config('with'))
without = extract_selection(config('without'))
@selected = @installers.keys.select {|name|
(with.empty? or with.include?(name)) \
and not without.include?(name)
}
end
def extract_selection(list)
a = list.split(/,/)
a.each do |name|
setup_rb_error "no such package: #{name}" unless @installers.key?(name)
end
a
end
def print_usage(f)
super
f.puts 'Inluded packages:'
f.puts ' ' + @packages.sort.join(' ')
f.puts
end
#
# multi-package metaconfig API
#
attr_reader :packages
def declare_packages(list)
raise 'package list is empty' if list.empty?
list.each do |name|
raise "directory packages/#{name} does not exist"\
unless File.dir?("#{@ardir}/packages/#{name}")
end
@packages = list
end
#
# Task Handlers
#
def exec_config
run_hook 'pre-config'
each_selected_installers {|inst| inst.exec_config }
run_hook 'post-config'
@config.save # must be final
end
def exec_setup
run_hook 'pre-setup'
each_selected_installers {|inst| inst.exec_setup }
run_hook 'post-setup'
end
def exec_install
run_hook 'pre-install'
each_selected_installers {|inst| inst.exec_install }
run_hook 'post-install'
end
def exec_clean
rm_f ConfigTable.savefile
run_hook 'pre-clean'
each_selected_installers {|inst| inst.exec_clean }
run_hook 'post-clean'
end
def exec_distclean
rm_f ConfigTable.savefile
run_hook 'pre-distclean'
each_selected_installers {|inst| inst.exec_distclean }
run_hook 'post-distclean'
end
#
# lib
#
def each_selected_installers
Dir.mkdir 'packages' unless File.dir?('packages')
@selected.each do |pack|
$stderr.puts "Processing the package `#{pack}' ..." if @options['verbose']
Dir.mkdir "packages/#{pack}" unless File.dir?("packages/#{pack}")
Dir.chdir "packages/#{pack}"
yield @installers[pack]
Dir.chdir '../..'
end
end
def verbose?
@options['verbose']
end
def no_harm?
@options['no-harm']
end
end
class Installer
FILETYPES = %w( bin lib ext data )
include HookScriptAPI
include HookUtils
include FileOperations
def initialize(config, opt, srcroot, objroot)
@config = config
@options = opt
@srcdir = File.expand_path(srcroot)
@objdir = File.expand_path(objroot)
@currdir = '.'
end
def inspect
"#<#{self.class} #{File.basename(@srcdir)}>"
end
#
# Hook Script API base methods
#
def srcdir_root
@srcdir
end
def objdir_root
@objdir
end
def relpath
@currdir
end
#
# configs/options
#
def no_harm?
@options['no-harm']
end
def verbose?
@options['verbose']
end
def verbose_off
begin
save, @options['verbose'] = @options['verbose'], false
yield
ensure
@options['verbose'] = save
end
end
#
# TASK config
#
def exec_config
exec_task_traverse 'config'
end
def config_dir_bin(rel)
end
def config_dir_lib(rel)
end
def config_dir_ext(rel)
extconf if extdir?(curr_srcdir())
end
def extconf
opt = @options['config-opt'].join(' ')
command "#{config('rubyprog')} #{curr_srcdir()}/extconf.rb #{opt}"
end
def config_dir_data(rel)
end
#
# TASK setup
#
def exec_setup
exec_task_traverse 'setup'
end
def setup_dir_bin(rel)
all_files_in(curr_srcdir()).each do |fname|
adjust_shebang "#{curr_srcdir()}/#{fname}"
end
end
def adjust_shebang(path)
return if no_harm?
tmpfile = File.basename(path) + '.tmp'
begin
File.open(path, 'rb') {|r|
first = r.gets
return unless File.basename(config('rubypath')) == 'ruby'
return unless File.basename(first.sub(/\A\#!/, '').split[0]) == 'ruby'
$stderr.puts "adjusting shebang: #{File.basename(path)}" if verbose?
File.open(tmpfile, 'wb') {|w|
w.print first.sub(/\A\#!\s*\S+/, '#! ' + config('rubypath'))
w.write r.read
}
move_file tmpfile, File.basename(path)
}
ensure
File.unlink tmpfile if File.exist?(tmpfile)
end
end
def setup_dir_lib(rel)
end
def setup_dir_ext(rel)
make if extdir?(curr_srcdir())
end
def setup_dir_data(rel)
end
#
# TASK install
#
def exec_install
rm_f 'InstalledFiles'
exec_task_traverse 'install'
end
def install_dir_bin(rel)
install_files collect_filenames_auto(), "#{config('bindir')}/#{rel}", 0755
end
def install_dir_lib(rel)
install_files ruby_scripts(), "#{config('rbdir')}/#{rel}", 0644
end
def install_dir_ext(rel)
return unless extdir?(curr_srcdir())
install_files ruby_extentions('.'),
"#{config('sodir')}/#{File.dirname(rel)}",
0555
end
def install_dir_data(rel)
install_files collect_filenames_auto(), "#{config('datadir')}/#{rel}", 0644
end
def install_files(list, dest, mode)
mkdir_p dest, @options['install-prefix']
list.each do |fname|
install fname, dest, mode, @options['install-prefix']
end
end
def ruby_scripts
collect_filenames_auto().select {|n| /\.rb\z/ =~ n }
end
# picked up many entries from cvs-1.11.1/src/ignore.c
reject_patterns = %w(
core RCSLOG tags TAGS .make.state
.nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
*~ *.old *.bak *.BAK *.orig *.rej _$* *$
*.org *.in .*
)
mapping = {
'.' => '\.',
'$' => '\$',
'#' => '\#',
'*' => '.*'
}
REJECT_PATTERNS = Regexp.new('\A(?:' +
reject_patterns.map {|pat|
pat.gsub(/[\.\$\#\*]/) {|ch| mapping[ch] }
}.join('|') +
')\z')
def collect_filenames_auto
mapdir((existfiles() - hookfiles()).reject {|fname|
REJECT_PATTERNS =~ fname
})
end
def existfiles
all_files_in(curr_srcdir()) | all_files_in('.')
end
def hookfiles
%w( pre-%s post-%s pre-%s.rb post-%s.rb ).map {|fmt|
%w( config setup install clean ).map {|t| sprintf(fmt, t) }
}.flatten
end
def mapdir(filelist)
filelist.map {|fname|
if File.exist?(fname) # objdir
fname
else # srcdir
File.join(curr_srcdir(), fname)
end
}
end
def ruby_extentions(dir)
Dir.open(dir) {|d|
ents = d.select {|fname| /\.#{::Config::CONFIG['DLEXT']}\z/ =~ fname }
if ents.empty?
setup_rb_error "no ruby extention exists: 'ruby #{$0} setup' first"
end
return ents
}
end
#
# TASK clean
#
def exec_clean
exec_task_traverse 'clean'
rm_f ConfigTable.savefile
rm_f 'InstalledFiles'
end
def clean_dir_bin(rel)
end
def clean_dir_lib(rel)
end
def clean_dir_ext(rel)
return unless extdir?(curr_srcdir())
make 'clean' if File.file?('Makefile')
end
def clean_dir_data(rel)
end
#
# TASK distclean
#
def exec_distclean
exec_task_traverse 'distclean'
rm_f ConfigTable.savefile
rm_f 'InstalledFiles'
end
def distclean_dir_bin(rel)
end
def distclean_dir_lib(rel)
end
def distclean_dir_ext(rel)
return unless extdir?(curr_srcdir())
make 'distclean' if File.file?('Makefile')
end
#
# lib
#
def exec_task_traverse(task)
run_hook "pre-#{task}"
FILETYPES.each do |type|
if config('without-ext') == 'yes' and type == 'ext'
$stderr.puts 'skipping ext/* by user option' if verbose?
next
end
traverse task, type, "#{task}_dir_#{type}"
end
run_hook "post-#{task}"
end
def traverse(task, rel, mid)
dive_into(rel) {
run_hook "pre-#{task}"
__send__ mid, rel.sub(%r[\A.*?(?:/|\z)], '')
all_dirs_in(curr_srcdir()).each do |d|
traverse task, "#{rel}/#{d}", mid
end
run_hook "post-#{task}"
}
end
def dive_into(rel)
return unless File.dir?("#{@srcdir}/#{rel}")
dir = File.basename(rel)
Dir.mkdir dir unless File.dir?(dir)
prevdir = Dir.pwd
Dir.chdir dir
$stderr.puts '---> ' + rel if verbose?
@currdir = rel
yield
Dir.chdir prevdir
$stderr.puts '<--- ' + rel if verbose?
@currdir = File.dirname(rel)
end
end
if $0 == __FILE__
begin
if multipackage_install?
ToplevelInstallerMulti.invoke
else
ToplevelInstaller.invoke
end
rescue SetupError
raise if $DEBUG
$stderr.puts $!.message
$stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
exit 1
end
end
syncache-1.4/syncache.gemspec 0000664 0000000 0000000 00000002236 12704363361 0016325 0 ustar 00root root 0000000 0000000 Gem::Specification.new do |spec|
spec.name = 'syncache'
spec.version = '1.4'
spec.author = 'Dmitry Borodaenko'
spec.email = 'angdraug@debian.org'
spec.homepage = 'https://github.com/angdraug/syncache'
spec.summary = 'Thread-safe time-limited cache with flexible replacement policy'
spec.description = <<-EOF
SynCache stores cached objects in a Hash that is protected by an advanced
two-level locking mechanism which ensures that:
* Multiple threads can add and fetch objects in parallel.
* While one thread is working on a cache entry, other threads can access
the rest of the cache with no waiting on the global lock, no race
conditions nor deadlock or livelock situations.
* While one thread is performing a long and resource-intensive
operation, other threads that request the same data will be put on hold,
and as soon as the first thread completes the operation, the result will be
returned to all threads.
EOF
spec.files = `git ls-files`.split "\n"
spec.test_files = Dir['test/ts_*.rb']
spec.executables = spec.files.map{|p| p =~ /^bin\/(.*)/ ? $1 : nil }.compact
spec.license = 'GPL3+'
end
syncache-1.4/test/ 0000775 0000000 0000000 00000000000 12704363361 0014137 5 ustar 00root root 0000000 0000000 syncache-1.4/test/tc_remote.rb 0000664 0000000 0000000 00000003350 12704363361 0016446 0 ustar 00root root 0000000 0000000 #!/usr/bin/env ruby
#
# SynCache tests
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'test/unit'
require 'syncache'
include SynCache
class TC_RemoteCache < Test::Unit::TestCase
def setup
@server = ::DRb.start_service(nil, Cache.new(0.1, 5))
@cache = RemoteCache.new(@server.uri, 0.1, 0.01)
end
def teardown
::DRb.stop_service
end
def test_flush
@cache['t'] = 'test'
@cache.flush
assert_equal nil, @cache['t']
end
def test_add_fetch
@cache['t'] = 'test'
assert_equal 'test', @cache['t']
end
def test_fetch_or_add
assert_equal nil, @cache['t']
@cache.fetch_or_add('t') { 'test' }
assert_equal 'test', @cache['t']
end
def test_size
1.upto(5) {|i| @cache[i] = i }
1.upto(5) do |i|
assert_equal i, @cache[i]
end
6.upto(10) {|i| @cache[i] = i }
1.upto(5) do |i|
assert_equal nil, @cache[i]
end
end
def test_ttl
1.upto(5) {|i| @cache[i] = i }
1.upto(5) do |i|
assert_equal i, @cache[i]
end
sleep(0.2)
1.upto(5) do |i|
assert_equal nil, @cache[i]
end
end
def test_timeout
slow = Thread.new do
@cache.fetch_or_add('t') { sleep 0.2; 'slow' }
end
sleep 0.01
@cache.fetch_or_add('t') { 'fast' }
assert_equal 'fast', @cache['t']
slow.join
@cache.delete('t')
decent = Thread.new do
@cache.fetch_or_add('t') { sleep 0.03; 'decent' }
end
sleep 0.01
@cache.fetch_or_add('t') { 'fast' }
assert_equal 'decent', @cache['t']
decent.join
end
end
syncache-1.4/test/tc_syncache.rb 0000664 0000000 0000000 00000002371 12704363361 0016752 0 ustar 00root root 0000000 0000000 #!/usr/bin/env ruby
#
# SynCache tests
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'test/unit'
require 'syncache'
include SynCache
class TC_Cache < Test::Unit::TestCase
def test_flush
cache = Cache.new(3, 5)
cache['t'] = 'test'
cache.flush
assert_equal nil, cache['t']
end
def test_add_fetch
cache = Cache.new(3, 5)
cache['t'] = 'test'
assert_equal 'test', cache['t']
end
def test_fetch_or_add
cache = Cache.new(3, 5)
assert_equal nil, cache['t']
cache.fetch_or_add('t') { 'test' }
assert_equal 'test', cache['t']
end
def test_size
cache = Cache.new(3, 5)
1.upto(5) {|i| cache[i] = i }
1.upto(5) do |i|
assert_equal i, cache[i]
end
6.upto(10) {|i| cache[i] = i }
1.upto(5) do |i|
assert_equal nil, cache[i]
end
end
def test_ttl
cache = Cache.new(0.01, 5)
1.upto(5) {|i| cache[i] = i }
1.upto(5) do |i|
assert_equal i, cache[i]
end
sleep(0.02)
1.upto(5) do |i|
assert_equal nil, cache[i]
end
end
end
syncache-1.4/test/ts_syncache.rb 0000664 0000000 0000000 00000000536 12704363361 0016773 0 ustar 00root root 0000000 0000000 #!/usr/bin/env ruby
#
# SynCache tests
#
# Copyright (c) 2002-2011 Dmitry Borodaenko
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU General Public License version 3 or later.
#
# vim: et sw=2 sts=2 ts=8 tw=0
require 'test/tc_syncache'
require 'test/tc_remote'