seven_zip_ruby 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fc520a330afc1504a227c21446eaa410dc2b130c
-  data.tar.gz: faa164047f17bec951a944433a6c9d7276a9fa92
+SHA256:
+  metadata.gz: 5825d6fc6003666a0e46c7f7d04b02166df43dedfcce9c1321c585bdb572aa83
+  data.tar.gz: a1c55155547c4f190d5265adb38306d433b620c15b7dfd503e995577560b3708
 SHA512:
-  metadata.gz: 5bb85502e25cc0146b8e0238bdf853549a3b62ce1b8a2e9d7ac4485ad2fbd1a900fe66fd2a116cc1b6192194f067b73dc1cfb3be36af5971c92ed75fc2c7167c
-  data.tar.gz: b32b40db99b37c8fcf39beca6f47ffb363f2fcab3a5bdd8f8aa6ccedd13b6f1c7abbf22d3bf55aec30ae68877579095cf9790618d46ec99df33ec21afbac781d
+  metadata.gz: 143dfc6e36e05dc5697b90129f135beb67752425564fa761d973d4635b10c62ec2719ad2daab5076afc85301dd365c0c0e8ed5b35e9fa4934d3bc8672816ba14
+  data.tar.gz: 164fb272a9179e26ac2d0ee1f56c189047254ccd85e93ffc6bd1f4f6e56b399611f8dd3d655d6e816a35fd09615803354b54f4dbffee3bdd6bf58dc3f841727f

data/.travis.yml

@@ -1,19 +1,35 @@
 language: ruby
 rvm:
-  - "2.0.0"
-  - "2.1.0"
-  - "rbx"
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.3.0"
+  - "2.3"
+  - "rbx-2.2.7"
   - "ruby-head"
 matrix:
   allow_failures:
-    - rvm: "rbx"
+    - rvm: "rbx-2.2.7"
     - rvm: "ruby-head"
+  include:
+    - rvm: 2.3.1
+      os: osx
+      osx_image: xcode7.3
 notifications:
   email: false
 cache:
   - apt
 before_install:
+  - gem update bundler
   - bundle install --path=vendor/bundle
-  - sudo apt-get install p7zip-full
+  - case $TRAVIS_OS_NAME in
+      linux)
+        sudo apt-get install p7zip-full
+        ;;
+      osx)
+        brew update && brew tap wk8/p7zip9.20 && brew install p7zip920
+        ;;
+    esac
+
 install: bundle exec rake build_local
 script: bundle exec rspec spec/seven_zip_ruby_spec.rb

data/README.md

@@ -4,15 +4,18 @@
 
 This is a Ruby gem library to extract/compress [7-Zip](http://www.7-zip.org) archives.
 
-This extension calls the native library, 7z.dll or 7z.so, internally and it is included in this gem.
+This extension calls the native library, 7z.dll or 7z.so, internally and these libraries are included in this gem.
 
 ## Features
-* Use official DLL, 7z.dll, internally.
-* Support extracting data into memory.
+* Uses official DLL, 7z.dll, internally.
+* Supports extracting data into memory.
+
+## Document
+[RDoc](http://rubydoc.info/gems/seven_zip_ruby/frames) shows you the details.
 
 ## Examples
 
-### Extract archive
+### Extract archives
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -22,7 +25,7 @@ File.open("filename.7z", "rb") do |file|
 end
 ```
 
-You can also use handy method.
+You can also use simpler method.
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -30,7 +33,7 @@ File.open("filename.7z", "rb") do |file|
 end
 ```
 
-### Show entries in archive
+### Show the entries in the archive
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -42,7 +45,7 @@ File.open("filename.7z", "rb") do |file|
 end
 ```
 
-### Extract encrypted archive
+### Extract encrypted archives
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -60,7 +63,7 @@ end
 ```
 
 
-### Verify archive
+### Verify archives
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -114,7 +117,7 @@ File.open("filename.7z", "rb") do |file|
 end
 ```
 
-### Get data from archive
+### Get data from archives
 
 Extract data into memory.
 
@@ -130,7 +133,7 @@ p data
 #  => File content is shown.
 ```
 
-### Create archive manually
+### Create an archive manually
 
 ```ruby
 File.open("filename.7z", "rb") do |file|
@@ -145,6 +148,17 @@ File.open("filename.7z", "rb") do |file|
 end
 ```
 
+You can also create a self extracting archive for Windows.
+
+```ruby
+File.open("filename.exe", "rb") do |file|
+  # :gui and :console can be specified as :sfx parameter.
+  SevenZipRuby::Writer.open(file, sfx: :gui) do |szr|
+    szr.add_data "file content", "file.txt"
+  end
+end
+```
+
 ### Set compression mode
 
 7zip supports LZMA, LZMA2, PPMD, BZIP2, DEFLATE and COPY.  
@@ -178,8 +192,8 @@ p(Time.now - start)
 ## TODO
 
 * Support file attributes on Linux and Mac OSX.
-* Support updating archive.
-* Support extracting rar archive.
+* Support update of an archive.
+* Support extract of a rar archive.
 
 
 ## License
@@ -187,8 +201,10 @@ LGPL and unRAR license. Please refer to LICENSE.txt.
 
 ## Releases
 
+* 1.2.*  
+  - Fixed cosmetic bugs.
 * 1.1.0  
-  Raise error when wrong password is specified.
+  - Fixed a bug. Raises an exception when wrong password is specified.
 * 1.0.0  
-  Initial release.
+  - Initial release.
 

data/Rakefile

@@ -9,7 +9,15 @@ task :build_platform => [ :pre_platform, :build, :post_platform ]
 
 task :pre_platform do
   FileUtils.mv("seven_zip_ruby.gemspec", "seven_zip_ruby.gemspec.bak")
-  FileUtils.cp("resources/seven_zip_ruby.gemspec.platform", "seven_zip_ruby.gemspec")
+
+  versions = Dir.glob("lib/seven_zip_ruby/*").select{ |i| File.directory?(i) }.map{ |i| i.split("/").last }.sort_by{ |i| i.split(".").map(&:to_i) }
+  min_version = versions.first + ".0"
+  max_version = versions.last.split(".").first + "." + (versions.last.split(".").last.to_i + 1).to_s + ".0"
+  gemspec = File.open("resources/seven_zip_ruby.gemspec.platform", "r", &:read)
+    .gsub("SPEC_REQUIRED_RUBY_VERSION"){ "spec.required_ruby_version = [ '>= #{min_version}', '< #{max_version}' ]" }
+  File.open("seven_zip_ruby.gemspec", "w") do |f|
+    f.write(gemspec)
+  end
 end
 
 task :post_platform do

data/ext/seven_zip_ruby/extconf.rb

@@ -59,6 +59,7 @@ def sample_cpp_source
   #  - lambda
   #  - std::function
   #  - std::array
+  #  - memset_s defined, on Darwin and BSD
   return <<'EOS'
 #include <functional>
 #include <algorithm>
@@ -67,6 +68,11 @@ def sample_cpp_source
 
 #include <ruby.h>
 
+// see the test on memset_s below, which is a purely BSD thing
+#if defined(__APPLE__) || defined(BSD)
+#include <string.h>
+#endif
+
 void test()
 {
     int array[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
@@ -84,6 +90,11 @@ void test()
     });
 
     std::for_each(var_list.begin(), var_list.end(), [](int num){ std::cout << num << std::endl; });
+
+#if defined(__APPLE__) || defined(BSD)
+    char str[] = "imareallycoolstringright";
+    memset_s(str, sizeof str, 'b', 5);
+#endif
 }
 EOS
 end
@@ -130,24 +141,35 @@ def main
   if (RUBY_PLATFORM.include?("mswin"))
     # mswin32
     $LIBS = "oleaut32.lib"
-    $CPPFLAGS = "/I.. /EHsc /DNDEBUG /DUSE_WIN32_FILE_API #{base_flag} "
+    $CPPFLAGS = "/I.. /EHsc /DNDEBUG /DUSE_WIN32_FILE_API #{base_flag} #{$CPPFLAGS} "
   elsif (RUBY_PLATFORM.include?("mingw"))
     # MinGW
     $LIBS = "-loleaut32 -static-libgcc -static-libstdc++"
 
-    cpp0x_flag = [ "", "-std=c++11", "-std=gnu++11", "-std=c++0x", "-std=gnu++0x" ].find do |opt|
-      next try_compile(sample_cpp_source, "#{opt} -x c++ ")
+    cpp0x_flag = [ "", "-std=gnu++11", "-std=c++11", "-std=gnu++0x", "-std=c++0x" ].find do |opt|
+      try_compile(sample_cpp_source, "#{opt} -x c++ ")
     end
     raise "C++11 is not supported by the compiler." unless (cpp0x_flag)
 
-    $CPPFLAGS = "-I.. #{cpp0x_flag} -DNDEBUG -DUSE_WIN32_FILE_API #{base_flag} "
+    $CPPFLAGS = "-I.. #{cpp0x_flag} -DNDEBUG -DUSE_WIN32_FILE_API #{base_flag} #{$CPPFLAGS} "
   else
-    cpp0x_flag = [ "", "-std=c++11", "-std=gnu++11", "-std=c++0x", "-std=gnu++0x" ].find do |opt|
-      next (try_compile(sample_cpp_source, "#{opt} -x c++ ") || try_compile(sample_cpp_source, "#{opt} "))
+    removed_flags = [ /\-mmacosx\-version\-min=[.0-9]+\b/ ]
+    removed_flags.each do |flag|
+      begin
+        $CFLAGS[flag] = ""
+      rescue
+      end
+    end
+
+    possible_cpp0x_flags = [ "", "-std=gnu++11", "-std=c++11", "-std=gnu++0x", "-std=c++0x" ].map do |opt|
+      ["#{opt} -x c++ ", "#{opt} "]
+    end.flatten
+    cpp0x_flag = possible_cpp0x_flags.find do |opt|
+      try_compile(sample_cpp_source, opt)
     end
     raise "C++11 is not supported by the compiler." unless (cpp0x_flag)
 
-    $CPPFLAGS = "-I.. -I../CPP/include_windows -I../CPP #{cpp0x_flag} -DNDEBUG #{base_flag} "
+    $CPPFLAGS = "-I.. -I../CPP/include_windows -I../CPP #{cpp0x_flag} -DNDEBUG #{base_flag} #{$CPPFLAGS} "
 
 
     ostype = check_ostype

data/ext/seven_zip_ruby/seven_zip_archive.cpp

@@ -2,6 +2,7 @@
 #include <array>
 #include <vector>
 #include <cassert>
+#include <string>
 
 #ifndef _WIN32
 #include <dlfcn.h>
@@ -13,6 +14,10 @@
 
 #define INTERN(const_str) rb_intern2(const_str, sizeof(const_str) - 1)
 
+// For https://bugs.ruby-lang.org/issues/11962
+#ifndef RARRAY_CONST_PTR
+#define RARRAY_CONST_PTR(index_list) RARRAY_PTR(index_list)
+#endif
 
 ////////////////////////////////////////////////////////////////
 namespace SevenZip
@@ -505,7 +510,7 @@ VALUE ArchiveReader::extractFiles(VALUE index_list, VALUE callback_proc)
     fillEntryInfo();
 
     std::vector<UInt32> list(RARRAY_LEN(index_list));
-    std::transform(RARRAY_PTR(index_list), RARRAY_PTR(index_list) + RARRAY_LEN(index_list),
+    std::transform(RARRAY_CONST_PTR(index_list), RARRAY_CONST_PTR(index_list) + RARRAY_LEN(index_list),
                    list.begin(), [](VALUE num){ return NUM2ULONG(num); });
 
     HRESULT ret;
@@ -1220,14 +1225,13 @@ STDMETHODIMP ArchiveExtractCallback::GetStream(UInt32 index, ISequentialOutStrea
     bool ret = m_archive->runRubyAction([&](){
         rb_stream = rb_funcall(proc, INTERN("call"), 2,
                                ID2SYM(INTERN("stream")), m_archive->entryInfo(index));
+        m_archive->setProcessingStream(rb_stream, index, askExtractMode);
     });
     if (!ret){
         m_archive->clearProcessingStream();
         return E_FAIL;
     }
 
-    m_archive->setProcessingStream(rb_stream, index, askExtractMode);
-
     OutStream *stream = new OutStream(rb_stream, m_archive);
     CMyComPtr<OutStream> ptr(stream);
     *outStream = ptr.Detach();
@@ -1434,14 +1438,14 @@ STDMETHODIMP ArchiveUpdateCallback::GetStream(UInt32 index, ISequentialInStream
         }else{
             rb_stream = rb_ary_entry(ret_array, 1);
         }
+
+        m_archive->setProcessingStream(rb_stream, index);
     });
     if (!ret){
         m_archive->clearProcessingStream();
         return E_FAIL;
     }
 
-    m_archive->setProcessingStream(rb_stream, index);
-
     if (NIL_P(rb_stream) && !(filepath.empty())){
         FileInStream *stream = new FileInStream(filepath, m_archive);
         CMyComPtr<FileInStream> ptr(stream);
@@ -1533,7 +1537,7 @@ STDMETHODIMP InStream::Read(void *data, UInt32 size, UInt32 *processedSize)
     bool ret = m_archive->runRubyAction([&](){
         VALUE str = rb_funcall(m_stream, INTERN("read"), 1, ULONG2NUM(size));
         if (!NIL_P(str) && data){
-            std::memcpy(data, RSTRING_PTR(str), RSTRING_LEN(str));
+            memcpy(data, RSTRING_PTR(str), RSTRING_LEN(str));
         }
 
         if (processedSize){
@@ -1763,13 +1767,33 @@ extern "C" void Init_seven_zip_archive(void)
     using namespace SevenZip;
     using namespace RubyCppUtil;
 
+    VALUE mod = rb_define_module("SevenZipRuby");
+    gSevenZipModule = mod;
+
+    VALUE external_lib_dir = rb_const_get(mod, INTERN("EXTERNAL_LIB_DIR"));
+    std::string external_lib_dir_str(RSTRING_PTR(external_lib_dir), RSTRING_LEN(external_lib_dir));
+
 #ifdef _WIN32
-    gSevenZipHandle = LoadLibrary("./7z.dll");
+    const int len = MultiByteToWideChar(CP_UTF8, 0, external_lib_dir_str.c_str(), external_lib_dir_str.length(),
+                                        NULL, 0);
+    if (len == 0) {
+        rb_warning("MultiByteToWideChar error.");
+        return;
+    }
+    std::vector<wchar_t> external_lib_dir_vec(len);
+    MultiByteToWideChar(CP_UTF8, 0, external_lib_dir_str.c_str(), external_lib_dir_str.length(),
+                        &external_lib_dir_vec[0], external_lib_dir_vec.size());
+    const std::wstring external_lib_dir_wstr(&external_lib_dir_vec[0], len);
+
+    const std::wstring dll_path = external_lib_dir_wstr + L"/7z.dll";
+    gSevenZipHandle = LoadLibraryW(dll_path.c_str());
     if (!gSevenZipHandle){
-        gSevenZipHandle = LoadLibrary("./7z64.dll");
+        const std::wstring dll_path2 = external_lib_dir_wstr + L"/7z64.dll";
+        gSevenZipHandle = LoadLibraryW(dll_path2.c_str());
     }
 #else
-    gSevenZipHandle = dlopen("./7z.so", RTLD_NOW);
+    std::string dll_path = external_lib_dir_str + "/7z.so";
+    gSevenZipHandle = dlopen(dll_path.c_str(), RTLD_NOW);
 #endif
     if (!gSevenZipHandle){
         rb_warning("7z library is not found.");
@@ -1787,9 +1811,6 @@ extern "C" void Init_seven_zip_archive(void)
     }
 
 
-    VALUE mod = rb_define_module("SevenZipRuby");
-    gSevenZipModule = mod;
-
     VALUE cls;
 
 // arg_count is needed by MSVC 2010...

data/ext/seven_zip_ruby/seven_zip_archive.h

@@ -385,6 +385,7 @@ class ArchiveOpenCallback : public IArchiveOpenCallback, public ICryptoGetTextPa
   public:
     ArchiveOpenCallback(ArchiveReader *archive);
     ArchiveOpenCallback(ArchiveReader *archive, const std::string &password);
+    virtual ~ArchiveOpenCallback() {}
 
     MY_UNKNOWN_IMP2(IArchiveOpenCallback, ICryptoGetTextPassword)
 
@@ -408,6 +409,7 @@ class ArchiveExtractCallback : public IArchiveExtractCallback, public ICryptoGet
   public:
     ArchiveExtractCallback(ArchiveReader *archive);
     ArchiveExtractCallback(ArchiveReader *archive, const std::string &password);
+    virtual ~ArchiveExtractCallback() {}
 
     MY_UNKNOWN_IMP2(IArchiveExtractCallback, ICryptoGetTextPassword)
 
@@ -436,6 +438,7 @@ class ArchiveUpdateCallback : public IArchiveUpdateCallback, public ICryptoGetTe
   public:
     ArchiveUpdateCallback(ArchiveWriter *archive);
     ArchiveUpdateCallback(ArchiveWriter *archive, const std::string &password);
+    virtual ~ArchiveUpdateCallback() {}
 
     MY_UNKNOWN_IMP2(IArchiveUpdateCallback, ICryptoGetTextPassword2)
 
@@ -466,6 +469,7 @@ class InStream : public IInStream, public CMyUnknownImp
 {
   public:
     InStream(VALUE stream, ArchiveBase *archive);
+    virtual ~InStream() {}
 
     MY_UNKNOWN_IMP1(IInStream)
 
@@ -481,7 +485,7 @@ class FileInStream : public IInStream, public CMyUnknownImp
 {
   public:
     FileInStream(const std::string &filename, ArchiveBase *archive);
-    ~FileInStream();
+    virtual ~FileInStream();
 
     MY_UNKNOWN_IMP1(IInStream)
 
@@ -502,6 +506,7 @@ class OutStream : public IOutStream, public CMyUnknownImp
 {
   public:
     OutStream(VALUE stream, ArchiveBase *archive);
+    virtual ~OutStream() {}
 
     MY_UNKNOWN_IMP1(IOutStream)
 
@@ -520,6 +525,7 @@ class FileOutStream : public IOutStream, public CMyUnknownImp
 {
   public:
     FileOutStream(const std::string &filename, ArchiveBase *archive);
+    virtual ~FileOutStream() {}
 
     MY_UNKNOWN_IMP1(IOutStream)
 

data/lib/seven_zip_ruby.rb

@@ -2,19 +2,26 @@
 
 require("seven_zip_ruby/version")
 
-external_lib = (RUBY_PLATFORM.downcase.match(/mswin|mingw/) ? "7z.dll" : "7z.so")
-dir = $:.find do |i|
-  next File.file?(File.join(i, "seven_zip_ruby", external_lib))
-end
-raise "Failed to find 7z.dll or 7z.so" unless (dir)
+module SevenZipRuby
+  def self.find_external_lib_dir
+    external_lib = (RUBY_PLATFORM.downcase.match(/mswin|mingw/) ? "7z.dll" : "7z.so")
+    dir = $LOAD_PATH.find do |i|
+      path = File.expand_path(File.join(i, "seven_zip_ruby", external_lib))
+      next File.file?(path)
+    end
+    raise "Failed to find 7z.dll or 7z.so" unless dir
 
-Dir.chdir(File.join(dir, "seven_zip_ruby"))do
-  begin
-    version = RUBY_VERSION.match(/\d+\.\d+/)
-    require("seven_zip_ruby/#{version}/seven_zip_archive")
-  rescue LoadError
-    require("seven_zip_ruby/seven_zip_archive")
+    return File.join(dir, "seven_zip_ruby")
   end
+
+  EXTERNAL_LIB_DIR = self.find_external_lib_dir.encode(Encoding::UTF_8)
+end
+
+begin
+  version = RUBY_VERSION.match(/\d+\.\d+/)
+  require("seven_zip_ruby/#{version}/seven_zip_archive")
+rescue LoadError
+  require("seven_zip_ruby/seven_zip_archive")
 end
 raise "Failed to initialize SevenZipRuby" unless (defined?(SevenZipRuby::SevenZipReader))
 

data/lib/seven_zip_ruby/seven_zip_reader.rb

@@ -102,8 +102,12 @@ module SevenZipRuby
         szr = self.new
         szr.open(stream, param)
         if (block)
-          block.call(szr)
-          szr.close
+          begin
+            block.call(szr)
+            szr.close
+          ensure
+            szr.close_file
+          end
         else
           szr
         end
@@ -135,8 +139,12 @@ module SevenZipRuby
         szr = self.new
         szr.open_file(filename, param)
         if (block)
-          block.call(szr)
-          szr.close
+          begin
+            block.call(szr)
+            szr.close
+          ensure
+            szr.close_file
+          end
         else
           szr
         end
@@ -200,9 +208,14 @@ module SevenZipRuby
       #     # => true/false
       #   end
       def verify(stream, opt = {})
-        szr = self.open(stream, opt)
-        ret = szr.verify
-        szr.close
+        ret = false
+        begin
+          self.open(stream, opt) do |szr|
+            ret = szr.verify
+          end
+        rescue
+          ret = false
+        end
         return ret
       end
     end
@@ -223,6 +236,7 @@ module SevenZipRuby
     #     szr.close
     #   end
     def open(stream, param = {})
+      param = param.clone
       param[:password] = param[:password].to_s if (param[:password])
       stream.set_encoding(Encoding::ASCII_8BIT)
       open_impl(stream, param)
@@ -248,8 +262,12 @@ module SevenZipRuby
 
     def close
       close_impl
+      close_file
+    end
+
+    def close_file  # :nodoc:
       if (@stream)
-        @stream.close
+        @stream.close rescue nil
         @stream = nil
       end
     end
@@ -459,7 +477,7 @@ module SevenZipRuby
             path = arg_path.expand_path(base_dir)
             path.mkpath
             set_file_attribute(path.to_s, arg.attrib) if (arg.attrib)
-            path.utime(arg.atime || path.atime, arg.mtime || path.mtime)
+            path.utime(arg.atime || path.atime, arg.mtime || path.mtime) rescue nil
           end
           next ret
 
@@ -470,7 +488,7 @@ module SevenZipRuby
           unless (arg[:info].anti?)
             path = Pathname(arg[:info].path).expand_path(base_dir)
             set_file_attribute(path.to_s, arg[:info].attrib) if (arg[:info].attrib)
-            path.utime(arg[:info].atime || path.atime, arg[:info].mtime || path.mtime)
+            path.utime(arg[:info].atime || path.atime, arg[:info].mtime || path.mtime) rescue nil
           end
         end
       end

data/lib/seven_zip_ruby/seven_zip_writer.rb

@@ -51,10 +51,26 @@ module SevenZipRuby
   #       szw.add_directory("test_dir")
   #     end
   #   end
+  #
+  # === Create a sfx, a self extracting archive for Windows executable binary.
+  #   File.open("filename.exe", "wb") do |file|
+  #     SevenZipRuby::SevenZipWriter.open(file, sfx: true) do |szw|
+  #       szw.add_directory("test_dir")
+  #     end
+  #   end
   class SevenZipWriter
     # Encoding used for path string in 7zip archive.
     PATH_ENCODING = Encoding::UTF_8
 
+    # Files for self extraction.
+    SFX_FILE_LIST = {
+      default: File.expand_path("../7z.sfx", __FILE__),
+      gui:     File.expand_path("../7z.sfx", __FILE__),
+      console: File.expand_path("../7zCon.sfx", __FILE__)
+    }  # :nodoc:
+
+    OPEN_PARAM_LIST = [ :password, :sfx ]  # :nodoc:
+
     @use_native_input_file_stream = true
 
     class << self
@@ -64,10 +80,12 @@ module SevenZipRuby
       #
       # ==== Args
       # +stream+ :: Output stream to write 7zip archive. <tt>stream.write</tt> is needed.
-      # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+      # +param+ :: Optional hash parameter.  
+      #            <tt>:password</tt> key specifies password of this archive.  
+      #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
       #
       # ==== Examples
-      #   # Open archive
+      #   # Open an archive
       #   File.open("filename.7z", "wb") do |file|
       #     SevenZipRuby::SevenZipWriter.open(file) do |szw|
       #       # Create archive.
@@ -84,6 +102,14 @@ module SevenZipRuby
       #     szw.compress  # Compress must be called in this case.
       #     szw.close
       #   end
+      #
+      #   # Create a self extracting archive. <tt>:gui</tt> and <tt>:console</tt> can be used.
+      #   File.open("filename.7z", "wb") do |file|
+      #     szw = SevenZipRuby::SevenZipWriter.open(file, sfx: :gui)
+      #     # Create archive.
+      #     szw.compress  # Compress must be called in this case.
+      #     szw.close
+      #   end
       def open(stream, param = {}, &block)  # :yield: szw
         szw = self.new
         szw.open(stream, param)
@@ -104,7 +130,9 @@ module SevenZipRuby
       #
       # ==== Args
       # +filename+ :: 7zip archive filename.
-      # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+      # +param+ :: Optional hash parameter.  
+      #            <tt>:password</tt> key specifies password of this archive.  
+      #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
       #
       # ==== Examples
       #   # Open archive
@@ -141,7 +169,9 @@ module SevenZipRuby
       # ==== Args
       # +stream+ :: Output stream to write 7zip archive. <tt>stream.write</tt> is needed.
       # +dir+ :: Directory to be added to the 7zip archive. <b><tt>dir</tt></b> must be a <b>relative path</b>.
-      # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+      # +param+ :: Optional hash parameter.  
+      #            <tt>:password</tt> key specifies password of this archive.  
+      #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
       #
       # ==== Examples
       #   # Create 7zip archive which includes 'dir'.
@@ -149,9 +179,11 @@ module SevenZipRuby
       #     SevenZipRuby::SevenZipWriter.add_directory(file, 'dir')
       #   end
       def add_directory(stream, dir, param = {})
-        open_param = {
-          password: param.delete(:password)
-        }
+        param = param.clone
+        open_param = {}
+        OPEN_PARAM_LIST.each do |key|
+          open_param[key] = param.delete(key) if param.key?(key)
+        end
         self.open(stream, open_param) do |szw|
           szw.add_directory(dir, param)
         end
@@ -163,7 +195,9 @@ module SevenZipRuby
       # ==== Args
       # +stream+ :: Output stream to write 7zip archive. <tt>stream.write</tt> is needed.
       # +file+ :: File to be added to the 7zip archive. <b><tt>file</tt></b> must be a <b>relative path</b>.
-      # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+      # +param+ :: Optional hash parameter.  
+      #            <tt>:password</tt> key specifies password of this archive.  
+      #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
       #
       # ==== Examples
       #   # Create 7zip archive which includes 'file.txt'.
@@ -171,9 +205,11 @@ module SevenZipRuby
       #     SevenZipRuby::SevenZipWriter.add_file(file, 'file.txt')
       #   end
       def add_file(stream, filename, param = {})
-        open_param = {
-          password: param.delete(:password)
-        }
+        param = param.clone
+        open_param = {}
+        OPEN_PARAM_LIST.each do |key|
+          open_param[key] = param.delete(key) if param.key?(key)
+        end
         self.open(stream, open_param) do |szw|
           szw.add_file(filename, param)
         end
@@ -186,7 +222,9 @@ module SevenZipRuby
     #
     # ==== Args
     # +stream+ :: Output stream to write 7zip archive. <tt>stream.write</tt> is needed.
-    # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+    # +param+ :: Optional hash parameter.  
+    #            <tt>:password</tt> key specifies password of this archive.  
+    #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
     #
     # ==== Examples
     #   File.open("filename.7z", "wb") do |file|
@@ -197,16 +235,25 @@ module SevenZipRuby
     #     szw.close
     #   end
     def open(stream, param = {})
+      param = param.clone
+      param[:password] = param[:password].to_s if (param[:password])
       stream.set_encoding(Encoding::ASCII_8BIT)
+
+      add_sfx(stream, param[:sfx]) if param[:sfx]
+
       open_impl(stream, param)
       return self
     end
 
     # Open 7zip archive file to create.
     #
+    # <tt>close</tt> method must be called later.
+    #
     # ==== Args
     # +filename+ :: 7zip archive filename.
-    # +param+ :: Optional hash parameter. <tt>:password</tt> key represents password of this archive.
+    # +param+ :: Optional hash parameter.  
+    #            <tt>:password</tt> key specifies password of this archive.  
+    #            <tt>:sfx</tt> key specifies Self Extracting mode. <tt>:gui</tt> and <tt>:console</tt> can be used. <tt>true</tt> is same as <tt>:gui</tt>.
     #
     # ==== Examples
     #   szw = SevenZipRuby::SevenZipWriter.new
@@ -425,6 +472,17 @@ module SevenZipRuby
     end
     private :compress_proc
 
+    def add_sfx(stream, sfx)
+      sfx = :default if sfx == true
+      sfx_file = SFX_FILE_LIST[sfx]
+      raise ArgumentError.new("invalid option: :sfx") unless sfx_file
+
+      File.open(sfx_file, "rb") do |input|
+        IO.copy_stream(input, stream)
+      end
+    end
+    private :add_sfx
+
     COMPRESS_GUARD = Mutex.new  # :nodoc:
     def synchronize  # :nodoc:
       if (COMPRESS_GUARD)

data/lib/seven_zip_ruby/version.rb

@@ -1,3 +1,3 @@
 module SevenZipRuby
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/seven_zip_ruby.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = SevenZipRuby::VERSION
   spec.authors       = ["Masamitsu MURASE"]
   spec.email         = ["masamitsu.murase@gmail.com"]
-  spec.description   = %q{SevenZipRuby is a gem library to read and write 7zip archives. This gem library calls official 7z.dll internally.}
-  spec.summary       = %q{This is a gem library to read and write 7-Zip files.}
+  spec.description   = %q{SevenZipRuby (seven_zip_ruby) is a ruby gem library to read and write 7zip archives. This gem library calls official 7z.dll internally.}
+  spec.summary       = %q{This is a ruby gem library to read and write 7zip files.}
   spec.homepage      = "https://github.com/masamitsu-murase/seven_zip_ruby"
   spec.license       = "LGPL + unRAR"
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   if (RUBY_ENGINE == "rbx")

data/spec/seven_zip_ruby_spec.rb

@@ -54,7 +54,7 @@ describe SevenZipRuby do
           expect(info.header_size).to be < file.size
           expect(info.method).to eq "LZMA"
           expect(info.phy_size).to be file.size
-          expect(info.solid?).to be_true
+          expect(info.solid?).to be true
         end
       end
     end
@@ -139,6 +139,11 @@ describe SevenZipRuby do
 
       expect(SevenZipRuby::SevenZipReader.verify(StringIO.new(data))).to eq true
 
+      data_org = data[-1]
+      data[-1] = 0x01.chr  # This highly dependes on the current test binary.
+      expect(SevenZipRuby::SevenZipReader.verify(StringIO.new(data))).to eq false
+      data[-1] = data_org
+
       data[0x27] = 0xEB.chr  # This highly dependes on the current test binary.
       expected = [ :DataError, :DataError, :DataError, :DataError, :DataError, :DataError, :DataError, true, true, true, true, true ]
       SevenZipRuby::SevenZipReader.open(StringIO.new(data)) do |szr|
@@ -179,9 +184,7 @@ describe SevenZipRuby do
         end
         th_list.push(th)
       end
-      th_list.each do |t|
-        t.join
-      end
+      th_list.each(&:join)
     end
 
 
@@ -203,7 +206,7 @@ describe SevenZipRuby do
       example "invalid index" do
         File.open(SevenZipRubySpecHelper::SEVEN_ZIP_FILE, "rb") do |file|
           SevenZipRuby::SevenZipReader.open(file) do |szr|
-            expect{ szr.extract_data(nil) }.to raise_error (ArgumentError)
+            expect{ szr.extract_data(nil) }.to raise_error(ArgumentError)
           end
         end
       end
@@ -211,18 +214,22 @@ describe SevenZipRuby do
       example "invalid index for entry" do
         File.open(SevenZipRubySpecHelper::SEVEN_ZIP_FILE, "rb") do |file|
           SevenZipRuby::SevenZipReader.open(file) do |szr|
-            expect{ szr.entry("a") }.to raise_error
+            expect{ szr.entry("a") }.to raise_error(TypeError)
           end
         end
       end
 
       example "invalid password" do
         File.open(SevenZipRubySpecHelper::SEVEN_ZIP_PASSWORD_FILE, "rb") do |file|
-          expect{ SevenZipRuby::Reader.open(file){ |szr| szr.extract_data(1) } }.to raise_error
+          expect{ SevenZipRuby::Reader.open(file){ |szr| szr.extract_data(1) } }.to raise_error(StandardError)
+        end
+
+        File.open(SevenZipRubySpecHelper::SEVEN_ZIP_PASSWORD_FILE, "rb") do |file|
+          expect{ SevenZipRuby::Reader.open(file, password: "a"){ |szr| szr.extract_data(1) } }.to raise_error(SevenZipRuby::InvalidArchive)
         end
 
         File.open(SevenZipRubySpecHelper::SEVEN_ZIP_PASSWORD_FILE, "rb") do |file|
-          expect{ SevenZipRuby::Reader.open(file, password: "a"){ |szr| szr.extract_data(1) } }.to raise_error
+          expect{ SevenZipRuby::Reader.open(file, password: :InvalidType){ |szr| szr.extract_data(1) } }.to raise_error(SevenZipRuby::InvalidArchive)
         end
       end
 
@@ -296,8 +303,8 @@ describe SevenZipRuby do
       end
 
       example "clone and dup cannot be called." do
-        expect{ SevenZipRuby::SevenZipReader.new.clone }.to raise_error
-        expect{ SevenZipRuby::SevenZipReader.new.dup }.to raise_error
+        expect{ SevenZipRuby::SevenZipReader.new.clone }.to raise_error(NoMethodError)
+        expect{ SevenZipRuby::SevenZipReader.new.dup }.to raise_error(NoMethodError)
       end
 
     end
@@ -366,6 +373,70 @@ describe SevenZipRuby do
       end
     end
 
+    example "set password" do
+      sample_data = "Sample Data"
+      sample_password = "sample password"
+
+      output = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output, { password: sample_password }) do |szw|
+        szw.add_data(sample_data, "hoge.txt")
+      end
+
+      output.rewind
+      SevenZipRuby::SevenZipReader.open(output, { password: sample_password }) do |szr|
+        expect(szr.extract_data(0)).to eq sample_data
+      end
+
+      output.rewind
+      expect{
+        SevenZipRuby::SevenZipReader.open(output, { password: "invalid password" }) do |szr|
+          szr.extract_data(0)
+        end
+      }.to raise_error(SevenZipRuby::InvalidArchive)
+
+
+      output = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output, { password: sample_password.to_sym }) do |szw|
+        szw.add_data(sample_data, "hoge.txt")
+      end
+
+      output.rewind
+      SevenZipRuby::SevenZipReader.open(output, { password: sample_password }) do |szr|
+        expect(szr.extract_data(0)).to eq sample_data
+      end
+    end
+
+    example "create a sfx archive" do
+      time = Time.now
+
+      output = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output) do |szw|
+        szw.add_data("hogehoge", "hoge.txt", ctime: time, atime: time, mtime: time)
+      end
+
+      output1 = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output1, sfx: true) do |szw|
+        szw.add_data("hogehoge", "hoge.txt", ctime: time, atime: time, mtime: time)
+      end
+
+      output2 = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output2, sfx: :gui) do |szw|
+        szw.add_data("hogehoge", "hoge.txt", ctime: time, atime: time, mtime: time)
+      end
+
+      output3 = StringIO.new("")
+      SevenZipRuby::SevenZipWriter.open(output3, sfx: :console) do |szw|
+        szw.add_data("hogehoge", "hoge.txt", ctime: time, atime: time, mtime: time)
+      end
+
+      gui = File.open(SevenZipRuby::SevenZipWriter::SFX_FILE_LIST[:gui], "rb", &:read)
+      console = File.open(SevenZipRuby::SevenZipWriter::SFX_FILE_LIST[:console], "rb", &:read)
+
+      expect(output1.string).to eq gui + output.string
+      expect(output2.string).to eq gui + output.string
+      expect(output3.string).to eq console + output.string
+    end
+
     [ true, false ].each do |use_native_input_file_stream|
       example "add_directory: use_native_input_file_stream=#{use_native_input_file_stream}" do
         SevenZipRuby::SevenZipWriter.use_native_input_file_stream = use_native_input_file_stream
@@ -512,7 +583,6 @@ describe SevenZipRuby do
 
     example "run in multi threads" do
       th_list = []
-      mutex = Mutex.new
       100.times do
         th = Thread.new do
           stream = StringIO.new
@@ -523,9 +593,7 @@ describe SevenZipRuby do
         end
         th_list.push(th)
       end
-      th_list.each do |t|
-        t.join
-      end
+      th_list.each(&:join)
     end
 
     if (SevenZipRubySpecHelper.processor_count && SevenZipRubySpecHelper.processor_count > 1)
@@ -562,11 +630,11 @@ describe SevenZipRuby do
       end
 
       example "invalid method" do
-        expect{ SevenZipRuby::SevenZipWriter.open(StringIO.new("")).method = "Unknown" }.to raise_error
+        expect{ SevenZipRuby::SevenZipWriter.open(StringIO.new("")).method = "Unknown" }.to raise_error(ArgumentError)
       end
 
       example "invalid level" do
-        expect{ SevenZipRuby::SevenZipWriter.open(StringIO.new("")).level = 2 }.to raise_error
+        expect{ SevenZipRuby::SevenZipWriter.open(StringIO.new("")).level = 2 }.to raise_error(ArgumentError)
       end
 
       example "add_data/mkdir/compress/close before open" do
@@ -592,8 +660,8 @@ describe SevenZipRuby do
       end
 
       example "clone and dup cannot be called." do
-        expect{ SevenZipRuby::SevenZipWriter.new.clone }.to raise_error
-        expect{ SevenZipRuby::SevenZipWriter.new.dup }.to raise_error
+        expect{ SevenZipRuby::SevenZipWriter.new.clone }.to raise_error(NoMethodError)
+        expect{ SevenZipRuby::SevenZipWriter.new.dup }.to raise_error(NoMethodError)
       end
 
       if (false && RUBY_ENGINE == "ruby")
@@ -616,11 +684,11 @@ describe SevenZipRuby do
             th.join
             diff = Time.now - start
 
-            10.times do
+            20.times do
+              kill_time = rand * diff
               th = Thread.start{ prc.call }
-              sleep(rand * diff)
+              sleep(kill_time)
               expect{ th.kill }.not_to raise_error   # Thread can be killed.
-              sleep diff*2  # Workaround. When some threads of SZR are running and killed, SEGV sometimes occurs...
             end
           end
         end

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: seven_zip_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Masamitsu MURASE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: SevenZipRuby is a gem library to read and write 7zip archives. This gem
-  library calls official 7z.dll internally.
+description: SevenZipRuby (seven_zip_ruby) is a ruby gem library to read and write
+  7zip archives. This gem library calls official 7z.dll internally.
 email:
 - masamitsu.murase@gmail.com
 executables: []
@@ -61,8 +61,8 @@ extensions:
 - ext/seven_zip_ruby/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -780,7 +780,9 @@ files:
 - ext/seven_zip_ruby/win32/mutex.h
 - lib/seven_zip_ruby.rb
 - lib/seven_zip_ruby/7z.dll
+- lib/seven_zip_ruby/7z.sfx
 - lib/seven_zip_ruby/7z64.dll
+- lib/seven_zip_ruby/7zCon.sfx
 - lib/seven_zip_ruby/archive_info.rb
 - lib/seven_zip_ruby/entry_info.rb
 - lib/seven_zip_ruby/exception.rb
@@ -801,20 +803,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: This is a gem library to read and write 7-Zip files.
+summary: This is a ruby gem library to read and write 7zip files.
 test_files:
 - spec/seven_zip_ruby_spec.rb
 - spec/seven_zip_ruby_spec_helper.rb