From dcbb2017c8ab5a8ad31799a3e1985039282329f9 Mon Sep 17 00:00:00 2001 From: Austin Ziegler Date: Thu, 17 Mar 2011 21:15:25 -0400 Subject: [PATCH] Documentation clean-up and license change. --- COPYING | 272 ------------------------------------ Contributors.rdoc | 21 +++ Hacking.rdoc | 9 +- History.txt => History.rdoc | 56 ++++---- LICENSE | 56 -------- License.rdoc | 24 ++++ README.rdoc | 43 ++++++ README.txt | 70 ---------- Rakefile | 103 +++++++------- 9 files changed, 175 insertions(+), 479 deletions(-) delete mode 100644 COPYING create mode 100644 Contributors.rdoc rename History.txt => History.rdoc (75%) delete mode 100644 LICENSE create mode 100644 License.rdoc create mode 100644 README.rdoc delete mode 100644 README.txt diff --git a/COPYING b/COPYING deleted file mode 100644 index 2ff629a..0000000 --- a/COPYING +++ /dev/null @@ -1,272 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - -Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, -Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and -distribute verbatim copies of this license document, but changing it is not -allowed. - - Preamble - -The licenses for most software are designed to take away your freedom to -share and change it. By contrast, the GNU General Public License is -intended to guarantee your freedom to share and change free software--to -make sure the software is free for all its users. This General Public -License applies to most of the Free Software Foundation's software and to -any other program whose authors commit to using it. (Some other Free -Software Foundation software is covered by the GNU Lesser General Public -License instead.) 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 this service 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 make restrictions that forbid anyone to -deny you these rights or to ask you to surrender the rights. These -restrictions translate to certain responsibilities for you if you distribute -copies of the software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis or -for a fee, you must give the recipients all the rights that you have. 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. - -We protect your rights with two steps: (1) copyright the software, and (2) -offer you this license which gives you legal permission to copy, distribute -and/or modify the software. - -Also, for each author's protection and ours, we want to make certain that -everyone understands that there is no warranty for this free software. If -the software is modified by someone else and passed on, we want its -recipients to know that what they have is not the original, so that any -problems introduced by others will not reflect on the original authors' -reputations. - -Finally, any free program is threatened constantly by software patents. We -wish to avoid the danger that redistributors of a free program will -individually obtain patent licenses, in effect making the program -proprietary. To prevent this, we have made it clear that any patent must be -licensed for everyone's free use or not licensed at all. - -The precise terms and conditions for copying, distribution and modification -follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - -0. This License applies to any program or other work which contains a notice - placed by the copyright holder saying it may be distributed under the - terms of this General Public License. The "Program", below, refers to - any such program or work, and a "work based on the Program" means either - the Program or any derivative work under copyright law: that is to say, a - work containing the Program or a portion of it, either verbatim or with - modifications and/or translated into another language. (Hereinafter, - translation is included without limitation in the term "modification".) - Each licensee is addressed as "you". - - Activities other than copying, distribution and modification are not - covered by this License; they are outside its scope. The act of running - the Program is not restricted, and the output from the Program is covered - only if its contents constitute a work based on the Program (independent - of having been made by running the Program). Whether that is true depends - on what the Program does. - -1. You may copy and distribute 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 and - disclaimer of warranty; keep intact all the notices that refer to this - License and to the absence of any warranty; and give any other recipients - of the Program a copy of this License along with the Program. - - You may charge a fee for the physical act of transferring a copy, and you - may at your option offer warranty protection in exchange for a fee. - -2. You may modify your copy or copies of the Program or any portion of it, - thus forming a work based on the Program, and copy and distribute such - modifications or work under the terms of Section 1 above, provided that - you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices stating - that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in whole - or in part contains or is derived from the Program or any part - thereof, to be licensed as a whole at no charge to all third parties - under the terms of this License. - - c) If the modified program normally reads commands interactively when - run, you must cause it, when started running for such interactive use - in the most ordinary way, to print or display an announcement - including an appropriate copyright notice and a notice that there is - no warranty (or else, saying that you provide a warranty) and that - users may redistribute the program under these conditions, and telling - the user how to view a copy of this License. (Exception: if the - Program itself is interactive but does not normally print such an - announcement, your work based on the Program is not required to print - an announcement.) - - These requirements apply to the modified work as a whole. If - identifiable sections of that work are not derived from the Program, and - can be reasonably considered independent and separate works in - themselves, then this License, and its terms, do not apply to those - sections when you distribute them as separate works. But when you - distribute the same sections as part of a whole which is a work based on - the Program, the distribution of the whole must be on the terms of this - License, whose permissions for other licensees extend to the entire - whole, and thus to each and every part regardless of who wrote it. - - Thus, it is not the intent of this section to claim rights or contest - your rights to work written entirely by you; rather, the intent is to - exercise the right to control the distribution of derivative or - collective works based on the Program. - - In addition, mere aggregation of another work not based on the Program - with the Program (or with a work based on the Program) on a volume of a - storage or distribution medium does not bring the other work under the - scope of this License. - -3. You may copy and distribute the Program (or a work based on it, under - Section 2) in object code or executable form under the terms of Sections - 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable source - code, which must be distributed under the terms of Sections 1 and 2 - above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three years, to - give any third party, for a charge no more than your cost of - physically performing source distribution, a complete machine-readable - copy of the corresponding source code, to be distributed under the - terms of Sections 1 and 2 above on a medium customarily used for - software interchange; or, - - c) Accompany it with the information you received as to the offer to - distribute corresponding source code. (This alternative is allowed - only for noncommercial distribution and only if you received the - program in object code or executable form with such an offer, in - accord with Subsection b above.) - - The source code for a work means the preferred form of the work for - making modifications to it. For an executable work, complete source code - means all the source code for all modules it contains, plus any - associated interface definition files, plus the scripts used to control - compilation and installation of the executable. However, as a special - exception, the source code distributed need not include anything that is - normally distributed (in either source or binary form) with the major - components (compiler, kernel, and so on) of the operating system on which - the executable runs, unless that component itself accompanies the - executable. - - If distribution of executable or object code is made by offering access - to copy from a designated place, then offering equivalent access to copy - the source code from the same place counts as distribution of the source - code, even though third parties are not compelled to copy the source - along with the object code. - -4. You may not copy, modify, sublicense, or distribute the Program except as - expressly provided under this License. Any attempt otherwise to copy, - modify, sublicense or distribute the Program is void, and will - automatically terminate your rights under this License. However, parties - who have received copies, or rights, from you under this License will not - have their licenses terminated so long as such parties remain in full - compliance. - -5. You are not required to accept this License, since you have not signed - it. However, nothing else grants you permission to modify or distribute - the Program or its derivative works. These actions are prohibited by law - if you do not accept this License. Therefore, by modifying or - distributing the Program (or any work based on the Program), you indicate - your acceptance of this License to do so, and all its terms and - conditions for copying, distributing or modifying the Program or works - based on it. - -6. Each time you redistribute the Program (or any work based on the - Program), the recipient automatically receives a license from the - original licensor to copy, distribute or modify the Program subject to - these terms and conditions. You may not impose any further restrictions - on the recipients' exercise of the rights granted herein. You are not - responsible for enforcing compliance by third parties to this License. - -7. If, as a consequence of a court judgment or allegation of patent - infringement or for any other reason (not limited to patent issues), - 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 distribute - so as to satisfy simultaneously your obligations under this License and - any other pertinent obligations, then as a consequence you may not - distribute the Program at all. For example, if a patent license would - not permit royalty-free redistribution of the Program by all those who - receive copies directly or indirectly through you, then the only way you - could satisfy both it and this License would be to refrain entirely from - distribution of the Program. - - If any portion of this section is held invalid or unenforceable under any - particular circumstance, the balance of the section is intended to apply - and the section as a whole is intended to apply in other circumstances. - - It is not the purpose of this section to induce you to infringe any - patents or other property right claims or to contest validity of any such - claims; this section has the sole purpose of protecting the integrity of - the free software distribution system, which is implemented by public - license practices. Many people have made generous contributions to the - wide range of software distributed through that system in reliance on - consistent application of that system; it is up to the author/donor to - decide if he or she is willing to distribute software through any other - system and a licensee cannot impose that choice. - - This section is intended to make thoroughly clear what is believed to be - a consequence of the rest of this License. - -8. If the distribution and/or use of the Program is restricted in certain - countries either by patents or by copyrighted interfaces, the original - copyright holder who places the Program under this License may add an - explicit geographical distribution limitation excluding those countries, - so that distribution is permitted only in or among countries not thus - excluded. In such case, this License incorporates the limitation as if - written in the body of this License. - -9. The Free Software Foundation may publish revised and/or new versions of - the 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 a version number of this License which applies to it and "any - later version", you have the option of following the terms and conditions - either of that version or of any later version published by the Free - Software Foundation. If the Program does not specify a version number of - this License, you may choose any version ever published by the Free - Software Foundation. - -10. If you wish to incorporate parts of the Program into other free programs - whose distribution conditions are different, write to the author to ask - for permission. For software which is copyrighted by the Free Software - Foundation, write to the Free Software Foundation; we sometimes make - exceptions for this. Our decision will be guided by the two goals of - preserving the free status of all derivatives of our free software and - of promoting the sharing and reuse of software generally. - - NO WARRANTY - -11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - -12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING - WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR - REDISTRIBUTE 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. diff --git a/Contributors.rdoc b/Contributors.rdoc new file mode 100644 index 0000000..a169b5b --- /dev/null +++ b/Contributors.rdoc @@ -0,0 +1,21 @@ +== Contributors + +Net::LDAP was originally developed by: + +* Francis Cianfrocca (garbagecat) + +Contributions since: + +* Emiel van de Laar (emiel) +* Rory O'Connell (roryo) +* Kaspar Schiess (kschiess) +* Austin Ziegler (halostatue) +* Dimitrij Denissenko (dim) +* James Hewitt (jamstah) +* Kouhei Sutou (kou) +* Lars Tobias Skjong-Børsting (larstobi) +* Rory O'Connell (roryo) +* Tony Headford (tonyheadford) +* Derek Harmel (derekharmel) +* Erik Hetzner (egh) +* nowhereman diff --git a/Hacking.rdoc b/Hacking.rdoc index d17f1ca..072cf01 100644 --- a/Hacking.rdoc +++ b/Hacking.rdoc @@ -1,4 +1,4 @@ -= Hacking Net::LDAP += Hacking on Net::LDAP We welcome your contributions to Net::LDAP. To increase the chances of your patches being accepted, we recommend that you follow the guidelines below: @@ -8,9 +8,12 @@ patches being accepted, we recommend that you follow the guidelines below: Operators should have spaces around them, method definitions should have parentheses around arguments. Keep the indentation as flat as possible. 2. Your changes should be well-documented and described. -3. You must provide rspec tests for any new or changed features. Rspec has - been chosen as the way forward for tests. +3. You must provide Rspec tests for any new or changed features. 4. You should provide LDIF data for importing into LDAP servers so that the changes can be tested in situ with more than one real LDAP server. 5. You should have tested your changes against a real LDAP server. +6. Your patch should include modifications to History.rdoc summarizing the + change. +7. If you're a first-time contributor, your patch should include modifications + to Contributors.rdoc. diff --git a/History.txt b/History.rdoc similarity index 75% rename from History.txt rename to History.rdoc index b066a73..f69832c 100644 --- a/History.txt +++ b/History.rdoc @@ -1,29 +1,30 @@ -=== Net::LDAP NEXT / 2010-__-__ -* SSL capabilities will be enabled or disabled based on whether we can load - OpenSSL successfully or not. -* Moved the core class extensions extensions from being in the Net::LDAP - hierarchy to the Net::BER hierarchy as most of the methods therein are - related to BER-encoding values. This will make extracting Net::BER from - Net::LDAP easier in the future. -* Net::LDAP::Filter changes: - * Filters can only be constructed using our custom constructors (eq, ge, - etc.). Cleaned up the code to reflect the private new. - * Fixed #to_ber to output a BER representation for :ne filters. Simplified - * the BER construction for substring matching. - * Added Filter.join(left, right), Filter.intersect(left, right), and - Filter.negate(filter) to match Filter#&, Filter#|, and Filter#~@ to prevent - those operators from having problems with the private new. - * Added Filter.present and Filter.present? aliases for the method previously - only known as Filter.pres. - * Cleaned up Net::LDAP::Filter::FilterParser to handle branches better. Fixed - some of the regular expressions to be more canonically defined. - * Cleaned up the string representation of Filter objects. - * Added experimental support for RFC4515 extensible matching (e.g., - "(cn:caseExactMatch:=Fred Flintstone)"); provided by "nowhereman". -* Added or revised documentation: - * Core class extension methods under Net::BER. -* Extended unit testing: +=== Net::LDAP 0.2.0 / 2011-__-__ +* Major Enhancements: + * Net::LDAP::Filter changes: + * Filters can only be constructed using our custom constructors (eq, ge, + etc.). Cleaned up the code to reflect the private new. + * Fixed #to_ber to output a BER representation for :ne filters. Simplified + the BER construction for substring matching. + * Added Filter.join(left, right), Filter.intersect(left, right), and + Filter.negate(filter) to match Filter#&, Filter#|, and Filter#~@ to + prevent those operators from having problems with the private new. + * Added Filter.present and Filter.present? aliases for the method + previously only known as Filter.pres. + * Cleaned up Net::LDAP::Filter::FilterParser to handle branches better. + Fixed some of the regular expressions to be more canonically defined. + * Cleaned up the string representation of Filter objects. + * Added experimental support for RFC4515 extensible matching (e.g., + * "(cn:caseExactMatch:=Fred Flintstone)"); provided by "nowhereman". +* Minor Enhancements: + * SSL capabilities will be enabled or disabled based on whether we can load + OpenSSL successfully or not. + * Moved the core class extensions extensions from being in the Net::LDAP + hierarchy to the Net::BER hierarchy as most of the methods therein are + related to BER-encoding values. This will make extracting Net::BER from + Net::LDAP easier in the future. * Added some unit tests for the BER core extensions. +* Documentation Changes: + * Core class extension methods under Net::BER. * Code clean-up: * Made the formatting of code consistent across all files. * Removed Net::BER::BERParser::TagClasses as it does not appear to be used. @@ -34,6 +35,11 @@ Pdu#result. This may be changed in Net::LDAP 1.0 to return the full Pdu#result, but if we do so, it will be that way for all LDAP calls involving Pdu objects. +* Project Management: + * Changed the license from Ruby + GPL to MIT with the agreement of the + original author (Francis Cianfrocca) and the named contributors. Versions + prior to 0.2.0 are still available under the Ruby + GPL license. + * Added a hacking document and a contributors document. === Net::LDAP 0.1.1 / 2010-03-18 * Fixing a critical problem with sockets. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index ecc8f91..0000000 --- a/LICENSE +++ /dev/null @@ -1,56 +0,0 @@ -Net::LDAP is copyrighted free software by Francis Cianfrocca - and other contributors. You can redistribute it and/or -modify it under either the terms of the GPL (see the file COPYING), or the -conditions below: - -1. You may make and give away verbatim copies of the source form of the - software without restriction, provided that you duplicate all of the - original copyright notices and associated disclaimers. - -2. You may modify your copy of the software in any way, provided that you do - at least ONE of the following: - - a) place your modifications in the Public Domain or otherwise make them - Freely Available, such as by posting said modifications to Usenet or - an equivalent medium, or by allowing the author to include your - modifications in the software. - - b) use the modified software only within your corporation or - organization. - - c) rename any non-standard executables so the names do not conflict with - standard executables, which must also be provided. - - d) make other distribution arrangements with the author. - -3. You may distribute the software in object code or executable form, - provided that you do at least ONE of the following: - - a) distribute the executables and library files of the software, together - with instructions (in the manual page or equivalent) on where to get - the original distribution. - - b) accompany the distribution with the machine-readable source of the - software. - - c) give non-standard executables non-standard names, with instructions on - where to get the original software distribution. - - d) make other distribution arrangements with the author. - -4. You may modify and include the part of the software into any other - software (possibly commercial). But some files in the distribution are - not written by the author, so that they are not under this terms. - - They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some - files under the ./missing directory. See each file for the copying - condition. - -5. The scripts and library files supplied as input to or produced as output - from the software do not automatically fall under the copyright of the - software, but belong to whomever generated them, and may be sold - commercially, and may be aggregated with this software. - -6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED - WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF - MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. diff --git a/License.rdoc b/License.rdoc new file mode 100644 index 0000000..03b6036 --- /dev/null +++ b/License.rdoc @@ -0,0 +1,24 @@ +== License + +This software is available under the terms of the MIT license. + +Copyright 2006–2011 by Francis Cianfrocca and other contributors. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000..e881bad --- /dev/null +++ b/README.rdoc @@ -0,0 +1,43 @@ += Net::LDAP for Ruby + +== Description + +Net::LDAP for Ruby implements client access for the Lightweight Directory +Access Protocol (LDAP), an IETF standard protocol for accessing distributed +directory services. Net::LDAP is written completely in Ruby with no external +dependencies. It supports most LDAP client features and a subset of server +features as well. + +Net::LDAP strives for standards-conformity ({RFC +4511}[http://www.rfc-editor.org/rfc/rfc4511.txt]), but it also provides support +for features in popular non-conforming LDAP servers. + +== Where + +* {RubyForge}[http://rubyforge.org/projects/net-ldap] +* {GitHub}[https://github.com/ruby-ldap/ruby-net-ldap] + +The Net::LDAP for Ruby documentation, project description, and main downloads +can currently be found on {RubyForge}[http://rubyforge.org/projects/net-ldap]. + +== Synopsis + +See Net::LDAP for documentation and usage samples. + +== Requirements + +Net::LDAP requires a Ruby 1.8.7 interpreter or better. + +== Install + +Net::LDAP is a pure Ruby library. It does not require any external libraries. +You can install the RubyGems version of Net::LDAP available from the usual +sources. + +* gem install net-ldap + +Simply require 'net/ldap'. + +:include: Contributors.rdoc + +:include: License.rdoc diff --git a/README.txt b/README.txt deleted file mode 100644 index c598633..0000000 --- a/README.txt +++ /dev/null @@ -1,70 +0,0 @@ -= Net::LDAP for Ruby - -== Description - -Pure Ruby LDAP library. - -== Where - -=== Issues & Project Homepage - -http://rubyforge.org/projects/net-ldap - -=== Code - -http://github.com/RoryO/ruby-net-ldap/ - -== FEATURES/PROBLEMS - -The Lightweight Directory Access Protocol (LDAP) is an Internet protocol for -accessing distributed directory services. - -Net::LDAP is an LDAP support library written in pure Ruby. It supports most -LDAP client features and a subset of server features as well. - -* Standards-based (going for RFC 4511) -* Portable: 100% Ruby - -== SYNOPSIS - -See Net::LDAP for documentation and usage samples. - -== REQUIREMENTS - -Net::LDAP requires Ruby 1.8.7-compliant interpreter or better. - -== INSTALL - -Net::LDAP is a pure Ruby library. It does not require any external libraries. -You can install the RubyGems version of Net::LDAP available from the usual -sources. - -* gem install net-ldap - -Simply require 'net/ldap'. - -== CREDITS - -Net::LDAP was originally developed by: - -* Francis Cianfrocca blackhedd@rubyforge.org - -Contributions since: - -* Emiel van de Laar emiel@rubyforge.org -* Rory O'Connell roryo@rubyforge.org -* Kaspar Schiess eule@rubyforge.org -* Austin Ziegler austin@rubyforge.org -* Dimitrij Denissenko dimdenis@rubyforge.org -* "nowhereman" on GitHub - -== LICENSE - -Copyright (C) 2006 - 2010 by Francis Cianfrocca and other contributors. - -Please read the file LICENSE for licensing restrictions on this library. In -the simplest terms, this library is available under the same terms as Ruby -itself. - -Available under the same terms as Ruby. See LICENSE in the main distribution -for full licensing information. diff --git a/Rakefile b/Rakefile index 027f12b..f08297d 100644 --- a/Rakefile +++ b/Rakefile @@ -1,76 +1,73 @@ +# -*- ruby encoding: utf-8 -*- + require "rubygems" require 'hoe' -$LOAD_PATH.unshift('lib') - -require 'net/ldap' - -PKG_NAME = 'net-ldap' -PKG_VERSION = Net::LDAP::VERSION -PKG_DIST = "#{PKG_NAME}-#{PKG_VERSION}" -MANIFEST = File.read("Manifest.txt").split -MINRUBY = "1.8.7" - +Hoe.plugin :doofus Hoe.plugin :git Hoe.plugin :gemspec -Hoe.spec PKG_NAME do - self.version = PKG_VERSION - self.rubyforge_name = PKG_NAME +Hoe.spec 'net-ldap' do + self.rubyforge_name = 'net-ldap' - developer "Francis Cianfrocca", "blackhedd@rubyforge.org" - developer "Emiel van de Laar", "gemiel@gmail.com" - developer "Rory O'Connell", "rory.ocon@gmail.com" - developer "Kaspar Schiess", "kaspar.schiess@absurd.li" - developer "Austin Ziegler", "austin@rubyforge.org" + self.developer("Francis Cianfrocca", "blackhedd@rubyforge.org") + self.developer("Emiel van de Laar", "gemiel@gmail.com") + self.developer("Rory O'Connell", "rory.ocon@gmail.com") + self.developer("Kaspar Schiess", "kaspar.schiess@absurd.li") + self.developer("Austin Ziegler", "austin@rubyforge.org") self.remote_rdoc_dir = '' - rsync_args << ' --exclude=statsvn/' + self.rsync_args << ' --exclude=statsvn/' - self.url = %W(http://net-ldap.rubyforge.org/ https://github.com/RoryO/ruby-net-ldap) + self.url = %W(http://net-ldap.rubyforge.org/ https://github.com/ruby-ldap/ruby-net-ldap) - self.summary = "Pure Ruby LDAP support library with most client features and some server features." - self.changes = paragraphs_of(self.history_file, 0..1).join("\n\n") - self.description = paragraphs_of(self.readme_file, 2..2).join("\n\n") + self.history_file = 'History.rdoc' + self.readme_file = 'README.rdoc' - extra_rdoc_files << "Hacking.rdoc" + self.extra_rdoc_files = FileList["*.rdoc"].to_a - extra_dev_deps << [ "hoe-git", "~> 1" ] - extra_dev_deps << [ "hoe-gemspec", "~> 1" ] - extra_dev_deps << [ "metaid", "~> 1" ] - extra_dev_deps << [ "flexmock", "~> 0.9.0" ] - extra_dev_deps << [ "rspec", "~> 2.0" ] - clean_globs << "coverage" + self.extra_dev_deps << [ "hoe-git", "~> 1" ] + self.extra_dev_deps << [ "hoe-gemspec", "~> 1" ] + self.extra_dev_deps << [ "metaid", "~> 1" ] + self.extra_dev_deps << [ "flexmock", "~> 0.9.0" ] + self.extra_dev_deps << [ "rspec", "~> 2.0" ] + self.clean_globs << "coverage" - spec_extras[:required_ruby_version] = ">= #{MINRUBY}" - multiruby_skip << "1.8.6" - multiruby_skip << "1_8_6" + self.spec_extras[:required_ruby_version] = ">= 1.8.7" + self.multiruby_skip << "1.8.6" + self.multiruby_skip << "1_8_6" self.need_tar = true end -desc "Build the manifest file from the current set of files." -task :build_manifest do |t| - require 'find' - - paths = [] - Find.find(".") do |path| - next if File.directory?(path) - next if path =~ /\.svn/ - next if path =~ /\.git/ - next if path =~ /\.hoerc/ - next if path =~ /\.swp$/ - next if path =~ %r{coverage/} - next if path =~ /~$/ - paths << path.sub(%r{^\./}, '') +# I'm not quite ready to get rid of this, but I think "rake git:manifest" is +# sufficient. +namespace :old do + desc "Build the manifest file from the current set of files." + task :build_manifest do |t| + require 'find' + + paths = [] + Find.find(".") do |path| + next if File.directory?(path) + next if path =~ /\.svn/ + next if path =~ /\.git/ + next if path =~ /\.hoerc/ + next if path =~ /\.swp$/ + next if path =~ %r{coverage/} + next if path =~ /~$/ + paths << path.sub(%r{^\./}, '') + end + + File.open("Manifest.txt", "w") do |f| + f.puts paths.sort.join("\n") + end + + puts paths.sort.join("\n") end - - File.open("Manifest.txt", "w") do |f| - f.puts paths.sort.join("\n") - end - - puts paths.sort.join("\n") end desc "Run a full set of integration and unit tests" task :cruise => [:test, :spec] + +# vim: syntax=ruby