archive-zip 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59daa5f87eab1ea370009ef382698306f6e7640d
-  data.tar.gz: dc0a201e3f195cd5e4e2cd3ee969a3714b8269b9
+  metadata.gz: 392506a75d8d411a81f373e7615de05e8e253007
+  data.tar.gz: 6d099f03a5b075ab68265eb3918ad8d657d6ee5e
 SHA512:
-  metadata.gz: 2ce65d15084aa253f08de57da4d766df70aeffcc4f97d093f1ef3ea94b9291c93dd99fc2472216ac601d1341d134a8af43baf0646224cce4a65bcc22fce0617b
-  data.tar.gz: 2f9e2aeb4b470d880ecb8e1ade69fd5a9b2ea0eb2cf74cc7dccef5275ba224b1e0cae74b3784c8cec1ce306707fa587226174da0141f8a5bc382d5aee68e18a6
+  metadata.gz: fa9900725853cb1ee4a92a9484696e39091128403f0d6bd887bd54313769ce623fd25f1a82d7a151066c0613e1280da041b8ca0800fb6e203ca660a05c8e7f85
+  data.tar.gz: 2b7e98ea155628cbd446f36c2e2894242a472176ef8f4ed8e8bcbdbf8562a2dcd5814d2a72a018e2563264e8514dfa23d9b374b37683b757c191ec63a70dab21

data/.yardopts

@@ -0,0 +1 @@
+--protected --private --plugin redcarpet-ext --main README.md lib/**/*.rb - NEWS.md LICENSE

data/LICENSE

@@ -1,57 +1,22 @@
-LICENSE text follows:
-
-  Archive::Zip is copyrighted free software by Jeremy Bopp
-  <jeremy at bopp dot net>.  You can redistribute it and/or modify it under
-  either the terms of the GPL (see the included GPL file), or the conditions
-  below:
-
-    1. You may make and give away verbatim copies of the source form of the
-       software without restriction, provided that you duplicate all of the
-       original copyright notices and associated disclaimers.
-
-    2. You may modify your copy of the software in any way, provided that
-       you do at least ONE of the following:
-
-         a) place your modifications in the Public Domain or otherwise
-            make them Freely Available, such as by posting said
-            modifications to Usenet or an equivalent medium, or by allowing
-            the author to include your modifications in the software.
-
-         b) use the modified software only within your corporation or
-            organization.
-
-         c) rename any non-standard executables so the names do not conflict
-            with standard executables, which must also be provided.
-
-         d) make other distribution arrangements with the author.
-
-    3. You may distribute the software in object code or executable
-       form, provided that you do at least ONE of the following:
-
-         a) distribute the executables and library files of the software,
-            together with instructions (in the manual page or equivalent)
-            on where to get the original distribution.
-
-         b) accompany the distribution with the machine-readable source of
-            the software.
-
-         c) give non-standard executables non-standard names, with
-            instructions on where to get the original software distribution.
-
-         d) make other distribution arrangements with the author.
-
-    4. You may modify and include the covered part of the software into any
-       other software (possibly commercial).  But some files in the
-       distribution may not be written by the author, such that they are not
-       under these terms.  (See the file LEGAL for a listing and conditions)
-
-    5. The scripts and library files supplied as input to or produced as
-       output from the software do not automatically fall under the
-       copyright of the software, but belong to whomever generated them,
-       and may be sold commercially, and may be aggregated with this
-       software.
-
-    6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-       IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-       PURPOSE.
+(The MIT License)
+
+Copyright (c) 2014 Jeremy Bopp
+
+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.

data/{NEWS → NEWS.md}

@@ -1,14 +1,27 @@
-= News and Notifications by Version
+# News and Notifications by Version
 
 This file lists noteworthy changes which may affect users of this project.  More
 detailed information is available in the rest of the documentation.
 
-<b>NOTE:</b> Date stamps in the following entries are in YYYY/MM/DD format.
+**NOTE:** Date stamps in the following entries are in YYYY/MM/DD format.
 
 
-== v0.6.0 (2013/03/24)
+## v0.7.0 (2014/08/18)
 
-=== Fixes
+### Fixes
+
+* Avoid corrupting the archive when storing entries that have multibyte names.
+
+### Notes
+
+* Ruby 1.8.6 support has been dropped.
+  * This may come back if demand warrants it.
+* Switched to the MIT license.
+* Now using minitest instead of mspec for tests.
+
+## v0.6.0 (2013/03/24)
+
+### Fixes
 
 * Only define Zlib constants when they are not already defined.
   * Fixes constant redefinition warnings under MRI 2.0.0-p0.
@@ -18,27 +31,27 @@ detailed information is available in the rest of the documentation.
     #adler methods appear inconsistent for raw streams and really aren't
     necessary in this case anyway.
 
-=== Notes
+### Notes
 
 * Broke backward compatibility with the behavior of Zlib::ZWriter#checksum and
   Zlib::ZReader#checksum when working with raw streams.
   * This should not affect direct users of Archive::Zip because the checksum
     methods of those classes are never used.
 
-== v0.5.0 (2012/03/01)
+## v0.5.0 (2012/03/01)
 
-=== Fixes
+### Fixes
 
 * Avoid timezone discrepancies in encryption tests.
 * Moved the DOSTime class to the Archive namespace (Chris Schneider).
 
-=== Notes
+### Notes
 
 * Broke backward compatibility of the DOSTime class.
 
-== v0.4.0 (2011/08/29)
+## v0.4.0 (2011/08/29)
 
-=== Features
+### Features
 
 * Added Ruby 1.9 support.
 * Simplified arguments for Archive::Zip.new.
@@ -48,27 +61,27 @@ detailed information is available in the rest of the documentation.
 * Updated and simplified rake tasks.
 * Created a standalone gemspec file.
 
-=== Fixes
+### Fixes
 
 * Fixed a potential data loss bug in Zlib::ZReader.
 * Archives larger than the maximum Fixnum for the platform don't falsely raise a
   "non-integer windows position given" error.
 
-=== Notes
+### Notes
 
 * Broke backward compatibility for Archive::Zip.new.
   * Wrapper class methods continue to work as before.
 * Broke backward compatibility for Archive::Zip::ExtraField.
   * Allows separate handling of extra fields in central and local records.
 
-== v0.3.0 (2009/01/23)
+## v0.3.0 (2009/01/23)
 
 * Made a significant performance improvement for the extraction of compressed
   entries for performance on par with InfoZIP's unzip.  Parsing archives with
   many entries is still a bit subpar however.
 
 
-== v0.2.0 (2008/08/06)
+## v0.2.0 (2008/08/06)
 
 * Traditional (weak) encryption is now supported.
 * Adding new encryption methods should be easier now.
@@ -78,14 +91,14 @@ detailed information is available in the rest of the documentation.
   the _codec_ attribute to access the compression codec of the entry.
 
 
-== v0.1.1 (2008/07/11)
+## v0.1.1 (2008/07/11)
 
 * Archive files are now closed when the Archive::Zip object is closed even when
   no changes were made to the archive, a problem on Windows if you want to
   delete the archive after extracting it within the same script.
 
 
-== v0.1.0 (2008/07/10)
+## v0.1.0 (2008/07/10)
 
 * Initial release.
 * Archive creation and extraction is supported with only a few lines of code.

data/README.md

@@ -0,0 +1,250 @@
+# Archive::Zip - ZIP Archival Made Easy
+
+Simple, extensible, pure Ruby ZIP archive support.
+
+Basic archive creation and extraction can be handled using only a few methods.
+More complex operations involving the manipulation of existing archives in place
+(adding, removing, and modifying entries) are also possible with a little more
+work.  Even adding advanced features such as new compression codecs are
+supported with a moderate amount of effort.
+
+## LINKS
+
+* Homepage :: http://github.com/javanthropus/archive-zip
+* Documentation :: http://rdoc.info/gems/archive-zip/frames
+* Source :: http://github.com/javanthropus/archive-zip
+
+## DESCRIPTION
+
+Archive::Zip provides a simple Ruby-esque interface to creating, extracting, and
+updating ZIP archives.  This implementation is 100% Ruby and loosely modeled on
+the archive creation and extraction capabilities of InfoZip's zip and unzip
+tools.
+
+## FEATURES
+
+* 100% native Ruby.  (Well, almost... depends on zlib.)
+* Archive creation and extraction is supported with only a few lines of code.
+* Archives can be updated "in place" or dumped out to other files or pipes.
+* Files, symlinks, and directories are supported within archives.
+* Unix permission/mode bits are supported.
+* Unix user and group ownerships are supported.
+* Unix last accessed and last modified times are supported.
+* Entry extension (AKA extra field) implementations can be added on the fly.
+* Unknown entry extension types are preserved during archive processing.
+* The Deflate and Store compression codecs are supported out of the box.
+* More compression codecs can be added on the fly.
+* Traditional (weak) encryption is supported out of the box.
+
+## KNOWN BUGS/LIMITATIONS
+
+* More testcases are needed.
+* All file entries are archived and extracted in binary mode.  No attempt is
+  made to normalize text files to the line ending convention of any target
+  system.
+* Hard links and device files are not currently supported within archives.
+* Reading archives from non-seekable IO, such as pipes and sockets, is not
+  supported.
+* MSDOS permission attributes are not supported.
+* Strong encryption is not supported.
+* Zip64 is not supported.
+* Digital signatures are not supported.
+
+## SYNOPSIS
+
+More examples can be found in the `examples` directory of the source
+distribution.
+
+Create a few archives:
+
+```ruby
+require 'archive/zip'
+
+# Add a_directory and its contents to example1.zip.
+Archive::Zip.archive('example1.zip', 'a_directory')
+
+# Add the contents of a_directory to example2.zip.
+Archive::Zip.archive('example2.zip', 'a_directory/.')
+
+# Add a_file and a_directory and its contents to example3.zip.
+Archive::Zip.archive('example3.zip', ['a_directory', 'a_file'])
+
+# Add only the files and symlinks contained in a_directory under the path
+# a/b/c/a_directory in example4.zip.
+Archive::Zip.archive(
+  'example4.zip',
+  'a_directory',
+  :directories => false,
+  :path_prefix => 'a/b/c'
+)
+
+# Add the contents of a_directory to example5.zip and encrypt Ruby source
+# files.
+require 'archive/zip/codec/null_encryption'
+require 'archive/zip/codec/traditional_encryption'
+Archive::Zip.archive(
+  'example5.zip',
+  'a_directory/.',
+  :encryption_codec => lambda do |entry|
+    if entry.file? and entry.zip_path =~ /\.rb$/ then
+      Archive::Zip::Codec::TraditionalEncryption
+    else
+      Archive::Zip::Codec::NullEncryption
+    end
+  end,
+  :password => 'seakrit'
+)
+
+# Create a new archive which will be written to a pipe.
+# Assume $stdout is the write end a pipe.
+# (ruby example.rb | cat >example.zip)
+Archive::Zip.open($stdout, :w) do |z|
+  z.archive('a_directory')
+end
+```
+
+Now extract those archives:
+
+```ruby
+require 'archive/zip'
+
+# Extract example1.zip to a_destination.
+Archive::Zip.extract('example1.zip', 'a_destination')
+
+# Extract example2.zip to a_destination, skipping directory entries.
+Archive::Zip.extract(
+  'example2.zip',
+  'a_destination',
+  :directories => false
+)
+
+# Extract example3.zip to a_destination, skipping symlinks.
+Archive::Zip.extract(
+  'example3.zip',
+  'a_destination',
+  :symlinks => false
+)
+
+# Extract example4.zip to a_destination, skipping entries for which files
+# already exist but are newer or for which files do not exist at all.
+Archive::Zip.extract(
+  'example4.zip',
+  'a_destination',
+  :create => false,
+  :overwrite => :older
+)
+
+# Extract example5.zip to a_destination, decrypting the contents.
+Archive::Zip.extract(
+  'example5.zip',
+  'a_destination',
+  :password => 'seakrit'
+)
+```
+
+## FUTURE WORK ITEMS (in no particular order):
+
+* Add test cases for all classes.
+* Add support for using non-seekable IO objects as archive sources.
+* Add support for 0x5855 and 0x7855 extra fields.
+
+## REQUIREMENTS
+
+* io-like
+
+## INSTALL
+
+Download the GEM file and install it with:
+
+    $ gem install archive-zip-VERSION.gem
+
+or directly with:
+
+    $ gem install archive-zip
+
+Removal is the same in either case:
+
+    $ gem uninstall archive-zip
+
+## DEVELOPERS
+
+After checking out the source, run:
+
+    $ bundle install
+    $ bundle exec rake test yard
+
+This will install all dependencies, run the tests/specs, and generate the
+documentation.
+
+## AUTHORS and CONTRIBUTORS
+
+Thanks to all contributors.  Without your help this project would not exist.
+
+* Jeremy Bopp :: jeremy@bopp.net
+
+## CONTRIBUTING
+
+Contributions for bug fixes, documentation, extensions, tests, etc. are
+encouraged.
+
+1. Clone the repository.
+2. Fix a bug or add a feature.
+3. Add tests for the fix or feature.
+4. Make a pull request.
+
+### CODING STYLE
+
+The following points are not necessarily set in stone but should rather be used
+as a good guideline.  Consistency is the goal of coding style, and changes will
+be more easily accepted if they are consistent with the rest of the code.
+
+* **File Encoding**
+  * UTF-8
+* **Indentation**
+  * Two spaces; no tabs
+* **Line length**
+  * Limit lines to a maximum of 80 characters
+* **Comments**
+  * Document classes, attributes, methods, and code
+* **Method Calls with Arguments**
+  * Use `a_method(arg, arg, etc)`; **not** `a_method( arg, arg, etc )`,
+    `a_method arg, arg, etc`, or any other variation
+* **Method Calls without Arguments**
+  * Use `a_method`; avoid parenthesis
+* **String Literals**
+  * Use single quotes by default
+  * Use double quotes when interpolation is necessary
+  * Use `%{...}` and similar when embedding the quoting character is cumbersome
+* **Blocks**
+  * `do ... end` for multi-line blocks and `{ ... }` for single-line blocks
+* **Boolean Operators**
+  * Use `&&` and `||` for boolean tests; avoid `and` and `or`
+* **In General**
+  * Try to follow the flow and style of the rest of the code
+
+## LICENSE
+
+```
+(The MIT License)
+
+Copyright (c) 2014 Jeremy Bopp
+
+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.
+```