shrine-zip-guard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08688c20b1b8190ce44c95079e5d71a302b42f18f635876f1f8265381650e086'
-  data.tar.gz: 3c5fa541d7cfe9620b405e33ce7457ede9df3f37503583492a0e0089e7ee0f35
+  metadata.gz: 9359699bdaf1bf53ba7b23a7c271880166360df60bf26d78ef5b874cd8e605e2
+  data.tar.gz: d353357a3022c8f981501e735ca40f1a3264cdb8bc0d42c5093be2a369609d81
 SHA512:
-  metadata.gz: d5571ca6c940dc80e911a826bc4231aa6fbb712841d5038a355a4fa8ed0664caf0fa6e506e27d90e73784e77ee690f60d44e5e0904560c7a3ff1d8d8a8fa0252
-  data.tar.gz: 3228249ed0d1246cc04976fd2a7fb7b600bdfe3b20ca5ea343c8c60bda85a540ea1b42808445c2cc4b7a663e8e4908aa91ef3d579128f827f13314888bd0c1e0
+  metadata.gz: 0c170879388c9bb5c29a50d25d74a3ce50718f30ae315b318151333b4c5e9424213ab6172254bf63302ff94ea32c456006ba4cd4334e3be3659998ed0578595c
+  data.tar.gz: 82c23d6223bfe1c618471cf62c06b44d86a93f17779bf149bc1272b120cfc9bed557927416ca47a1b9adc3313f99bbcb5e837d0ed9665aa581da01680adbe47d

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [0.2.0] - 2026-08-06
+
+### Added
+- Per-uploader custom I18n messages via `shrine.zip_guard.errors.<uploader_name>`.
+- Custom messages are supported for `password_protected`, `missing_file`, and `processing_failed` keys.
+- `error_message_key` helper that resolves a custom key based on the uploader class name.
+
+### Changed
+- Custom message lookup no longer depends on ActiveSupport `String#underscore`.
+
 ## [0.1.0] - 2026-08-06
 
 ### Added

data/README.md

@@ -30,18 +30,28 @@ the plugin with `required_files`:
 ```ruby
 class XmlUploader < Shrine
   plugin :derivatives
-  plugin :zip_guard, required_files: ["**/*.xml"]
+  plugin :zip_guard, required_files: ["*.xml"]
 end
 ```
 
-This will automatically check that the ZIP is not password-protected and that it
-contains at least one file matching each glob pattern.
+This checks that the ZIP is not password-protected and that it contains at least
+one file matching each glob pattern. Patterns are matched against the root of the
+archive only. If you want to allow nested files, use a recursive pattern:
+
+```ruby
+plugin :zip_guard, required_files: ["**/*.xml"]
+```
+
+For a specific subdirectory, include the path in the pattern:
+
+```ruby
+plugin :zip_guard, required_files: ["data/*.xml"]
+```
 
 ### Custom processing with `with_zip`
 
-If you need to run your own logic (for example extracting files, checking
-specific paths, or adding custom error rules), use the `with_zip` helper inside
-your `Attacher.derivatives` block:
+If you need to run your own logic (for example extracting files or checking
+specific paths), use the `with_zip` helper inside your `Attacher.derivatives` block:
 
 ```ruby
 class XmlUploader < Shrine
@@ -49,12 +59,9 @@ class XmlUploader < Shrine
   plugin :zip_guard
 
   Attacher.derivatives do |original|
-    Shrine::Plugins::ZipGuard.with_zip(original, required_files: ["**/*.xml"]) do |zip_file|
+    Shrine::Plugins::ZipGuard.with_zip(original, required_files: ["*.xml"]) do |zip_file|
       xmls = zip_file.glob("*.xml")
 
-      # Your custom rule — for example requiring the file to be at the root level
-      raise ZipUploadErrors::NestedFileError if xmls.empty? && zip_file.glob("**/*.xml").any?
-
       if xmls.size == 1
         extracted = Tempfile.new(["extracted", ".xml"], binmode: true)
         extracted.write(xmls.first.get_input_stream.read)
@@ -68,10 +75,13 @@ class XmlUploader < Shrine
 end
 ```
 
+Note that `with_zip` performs its own `required_files` check, so you should not also
+pass `required_files` to the plugin when you provide a custom `derivatives` block.
+
 ## Error messages
 
 All user-facing errors are translated via I18n. The gem ships with English
-defaults. Add your own translations under the `shrine.zip_guard` key:
+defaults under the `shrine.zip_guard` key:
 
 ```yaml
 en:
@@ -82,6 +92,27 @@ en:
       processing_failed: "File could not be processed. Please try again or contact support."
 ```
 
+### Per-uploader custom messages
+
+You can override any message for a specific uploader by adding a key under
+`shrine.zip_guard.errors.<uploader_name>`:
+
+```yaml
+en:
+  shrine:
+    zip_guard:
+      missing_file: "Archive does not contain required file matching '%{pattern}'."
+      errors:
+        digital_box_rd_uploader:
+          missing_file: "XML file must be at the root level of the ZIP archive."
+          password_protected: "This ZIP is password protected."
+          processing_failed: "Could not process this XML ZIP."
+```
+
+If the per-uploader key exists, it is used; otherwise the default key is used.
+The class name is converted with `underscore`, so `MyUploaders::XmlUploader`
+would become `my_uploaders/xml_uploader`.
+
 ## Custom fallback for unexpected errors
 
 By default, unexpected `ZipGuard::Error` subclasses are reported to the Rails error
@@ -90,7 +121,7 @@ reporter (if available) and a generic `processing_failed` message is added to
 
 ```ruby
 plugin :zip_guard,
-       required_files: ["**/*.xml"],
+       required_files: ["*.xml"],
        fallback: lambda { |error, attacher|
          Sentry.capture_exception(error)
          attacher.errors << "Custom processing error: #{error.message}"

data/lib/shrine/plugins/zip_guard.rb

@@ -48,18 +48,32 @@ class Shrine
         def create_derivatives(*args, **options, &)
           super
         rescue ZipGuard::EncryptedZipError
-          errors << I18n.t("shrine.zip_guard.password_protected")
-          {}
+          errors << I18n.t(error_message_key("password_protected"))
         rescue ZipGuard::MissingFileError => e
-          errors << I18n.t("shrine.zip_guard.missing_file", pattern: e.pattern)
-          {}
+          errors << I18n.t(error_message_key("missing_file"), pattern: e.pattern)
         rescue ZipGuard::Error => e
           handle_zip_guard_error(e)
-          {}
         end
 
         private
 
+        def error_message_key(base_key)
+          uploader_name = shrine_class.name
+          return "shrine.zip_guard.#{base_key}" unless uploader_name
+
+          custom_key = "shrine.zip_guard.errors.#{underscore(uploader_name)}.#{base_key}"
+          I18n.t(custom_key, default: nil) ? custom_key : "shrine.zip_guard.#{base_key}"
+        end
+
+        def underscore(class_name)
+          class_name
+            .gsub("::", "/")
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr("-", "_")
+            .downcase
+        end
+
         def handle_zip_guard_error(error)
           fallback = shrine_class.opts[:zip_guard][:fallback]
 
@@ -67,7 +81,7 @@ class Shrine
             fallback.call(error, self)
           else
             report_fallback(error)
-            errors << I18n.t("shrine.zip_guard.processing_failed")
+            errors << I18n.t(error_message_key("processing_failed"))
           end
         end
 

data/lib/shrine-zip-guard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShrineZipGuard
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shrine-zip-guard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Dobrovodský