zipr 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59ff464e79a2fcb648409fa45f1732713f282b34
-  data.tar.gz: 3fad749fa16e837f55419322237e945da88e6156
+SHA256:
+  metadata.gz: c1cb5647f8410511bd09812946a161adacdc465363420c634d739c862a84b5dc
+  data.tar.gz: 1ba4bab69bc9c06b4662b32cb1d74f41810819cf3f0326a424c88caafff5ed4c
 SHA512:
-  metadata.gz: c16b81553150ba9eb0953136387c2fbd9f6d31e57f630a3501005a7eb0dd4d80bc77fbfbdaa8124ccc4e538cfc429361c7ab5cf77b1d82e1018bf0b09e17977c
-  data.tar.gz: 548670732186cf43020dd5f47a5d147b6868669da7be05da055967d76ffd1b55c32e23921fcdb40f12d7d9b2a92e325c535944ace9cff2fef02d4bdaf9e6f45f
+  metadata.gz: b823246639b77616bc82dddd9c7018a671f159d0df8777520136a7328db96daff199a926b417d84b2489d3b1faed9b8fa93bb4edbe25eb38192ab96142196b78
+  data.tar.gz: 7aa3d47e4e7dcd7f8ef8e8e676569cffe33eeec5cf2b60e4a0416947edc85f1fc4c1a91854395f031e9b81109fd0a7c297b4ef366db387e819a47ba564dc9e7a

data/lib/zipr.rb

@@ -21,7 +21,7 @@ require 'easy_io'
 require 'json'
 require 'tmpdir'
 require 'fileutils'
-require 'seven_zip_ruby_am'
+require 'seven_zip_ruby'
 require 'os'
 
 require_relative 'zipr/config'

data/lib/zipr/archive.rb

@@ -14,6 +14,7 @@ module Zipr
     #     :archive_type - The type of archive - :seven_zip or :zip - Can be omitted if the archive exists or using default. Default: :zip
     #     :exclude_files - Array of files to be excluded from archiving/extracting - Can be relative or exact paths.
     #     :exclude_unless_missing - Array of files to be excluded from archiving/extracting only if they already exist - Can be relative or exact paths.
+    #     :exclude_unless_archive_changed - Array of files to be excluded from extracting only if the archive hasn't changed and they already exist - Use relative paths.
     #     :password - the archive password - currently :seven_zip is the only supported archive_type for encrypted archives.
     #     :silent - [true/false] No info messages if flagged
     #   checksums: A hash of checksums of the archived files. If you checked one of the determine_files methods for idempotency first, pass the result to this parameter to avoid duplicate processing.
@@ -208,9 +209,9 @@ module Zipr
 
       unless ::File.exist?(@path)
         # If the archive doesn't exist but checksums were provided, check for files to extract based off of checksums
-        return @checksums.select { |entry_name, checksum| _extract_file?(entry_name, checksum == 'directory', destination_folder, files_to_check) }.keys if @checksums.nil? || @checksums.empty?
-        # If the archive doesn't exist and no checksums were found, extract all files_to_check or :all files
-        return files_to_check || :all
+        return @checksums.select { |entry_name, checksum| _extract_file?(entry_name, checksum == 'directory', destination_folder, files_to_check) }.keys unless @checksums.nil? || @checksums.empty?
+        # If the archive doesn't exist and no checksums were found, extract all files_to_check
+        return files_to_check
       end
 
       files_to_extract = case @options[:archive_type]
@@ -233,13 +234,22 @@ module Zipr
     #   An array of files to be added (or the :all symbol).
     # Parameters:
     #   source_folder: The filesystem directory where files are being added from.
-    #   files_to_check: Array of files intended to be added to an archive. Can be exact names/paths or names/paths with wildcards (glob style).
+    #   files_to_check: Array of files intended to be added to an archive. Can be exact names/paths or names/paths with wildcards (glob style) or a Regexp.
     #     default: All files and folders under the source_folder.
     def determine_files_to_add(source_folder, files_to_check: nil)
       files_to_check ||= Dir.glob("#{source_folder}/**/*".tr('\\', '/')) if files_to_check.nil?
       files_to_add = []
+      source_folder_glob = nil
       files_to_check.each do |target_search|
-        files = Dir.glob(Zipr.prepend_source_folder(source_folder, target_search))
+        files = if target_search.is_a?(Regexp)
+                  source_folder_glob ||= Dir.glob("#{source_folder.tr('\\', '/')}/**/*")
+                  source_folder_glob.select do |path|
+                    path =~ target_search
+                  end
+                  source_folder_glob.select { |path| path.to_s =~ target_search }
+                else
+                  Dir.glob(Zipr.prepend_source_folder(source_folder, target_search))
+                end
         files.each do |source_file|
           relative_path = Zipr.slice_source_folder(source_folder, source_file)
           exists_in_zip = !!@checksums[relative_path]
@@ -441,20 +451,30 @@ module Zipr
     def _excluded_file?(file_path, destination_path: '', exists_in_zip: false)
       @options[:exclude_files] ||= []
       @options[:exclude_unless_missing] ||= []
-      return true if @options[:exclude_files].any? { |e| file_path.tr('\\', '/') =~ /^#{Zipr.wildcard_to_regex(e.tr('\\', '/'))}$/i }
-      return true if ::File.exist?(destination_path) && @options[:exclude_unless_missing].any? { |e| file_path.tr('\\', '/') =~ /^#{Zipr.wildcard_to_regex(e.tr('\\', '/'))}$/i }
-      return true if exists_in_zip && @options[:exclude_unless_missing].any? { |e| file_path.tr('\\', '/') =~ /^#{Zipr.wildcard_to_regex(e.tr('\\', '/'))}$/i }
+      @options[:exclude_unless_archive_changed] ||= []
+      return true if @options[:exclude_files].any? { |e| file_path.tr('\\', '/') =~ _convert_backslashes_and_cast_to_regexp(e) }
+      return true if ::File.exist?(destination_path) && @options[:exclude_unless_missing].any? { |e| file_path.tr('\\', '/') =~ _convert_backslashes_and_cast_to_regexp(e) }
+      return true if exists_in_zip && @options[:exclude_unless_missing].any? { |e| file_path.tr('\\', '/') =~ _convert_backslashes_and_cast_to_regexp(e) }
+      return true if !@archive_changed && ::File.exist?(destination_path) && @options[:exclude_unless_archive_changed].any? { |e| file_path.tr('\\', '/') =~ _convert_backslashes_and_cast_to_regexp(e) }
       false
     end
 
+    def _convert_backslashes_and_cast_to_regexp(path)
+      return path if path.is_a?(Regexp) # If it's already a regexp, leave it alone
+      path = path.tr('\\', '/')
+      /^#{Zipr.wildcard_to_regexp(path)}$/i
+    end
+
     def _assign_common_accessors(options: nil, checksums: nil, mode: nil)
+      _assign_checksums(checksums)
       @options = options || @options || {}
-      @checksums = checksums || @checksums || {}
       @mode = mode || @mode || :idempotent
+      @archive_changed = (::File.exist?(@path) && @checksums['archive_checksum'] != Digest::SHA256.file(@path).hexdigest) || !::File.exist?(@checksum_path)
+    end
 
-      archive_changed = ::File.exist?(@path) && @checksums['archive_checksum'] != Digest::SHA256.file(@path).hexdigest
-      outdated_checksums = @checksums.empty? || archive_changed
-      load_checksum_file if outdated_checksums # Read the checksums file if it hasn't been read yet
+    def _assign_checksums(checksums)
+      return load_checksum_file if checksums.nil? || checksums.empty? # Read the checksums file if it hasn't been read yet
+      @checksums = checksums || {}
     end
 
     # TODO: Add delete method to remove something from an archive

data/lib/zipr/helper.rb

@@ -21,21 +21,30 @@ module Zipr
   def flattened_paths(source_folder, files)
     return files if source_folder.nil? || source_folder.empty?
     result = []
+    source_folder_glob = nil
     files.each do |entry|
+      if entry.is_a?(Regexp)
+        source_folder_glob ||= Dir.glob("#{source_folder.tr('\\', '/')}/**/*")
+        matched_files = source_folder_glob.select { |path| path =~ entry }
+        result += matched_files.map { |f| slice_source_folder(source_folder, f) }
+        next
+      end
+
       standardized_entry = "#{source_folder.tr('\\', '/')}/#{slice_source_folder(source_folder, entry)}"
       files_found = Dir.glob(standardized_entry)
       if files_found.empty?
         result.push(entry)
       else
-        result += files_found.map { |e| slice_source_folder(source_folder, e) }
+        result += files_found.map { |f| slice_source_folder(source_folder, f) }
       end
     end
     result
   end
 
-  def wildcard_to_regex(entry)
-    entry.gsub(/([^\.\]])\*/, '\1.*') # convert any asterisk wildcard not preceded by a period or square bracket to .*
-         .sub(/^\*/, '.*') # convert a string that starts with an asterisk to .* (not preceded by anything)
+  def wildcard_to_regexp(entry)
+    return entry if entry.is_a?(Regexp)
+    escaped_entry = Regexp.escape(entry).gsub(/\\\*/, '.*') # Convert asterisks to .*
+    /#{escaped_entry}/
   end
 
   def prepend_source_folder(source_folder, entry)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipr
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Alex Munoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_io
@@ -53,25 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: seven_zip_ruby_am
+  name: seven_zip_ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5.4
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5.4
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -134,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby library for easily extracting and creating 7zip and zip archives idempotently.