mail-jdec 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b79e3c592167bea0b81f1f92959a728b253f27b9a4ac84cbfca9c24af70bf44
-  data.tar.gz: 5c2205ef8533ade4e48367f0b72cea2a7c39b41e470aa6925bda3122cf8da0b6
+  metadata.gz: 930bf110db56ac82ae59462cb3fb161220eea62a665702ea2b7b57ca3510db32
+  data.tar.gz: a9558c10bc88225de7539146d358274ee068d30c1f25eeede12e6ceab5c0ad13
 SHA512:
-  metadata.gz: a900a989980cd0d098dd5376ddd0c58f02e51b8b781194978d34e6b5febaf4b144ce0c0a2dea4269dad77d27c870780ad901e4e4d9c205d70e806dd525716571
-  data.tar.gz: 200f37329d5a89d19a8690f13f07dac5eb96d32aba0ee5a4e4f893c75c5ff7dcdfdb3a0b58fcf4cea2077ae83c1dcc4d991861592a3ff10fb580499f8b3e6da9
+  metadata.gz: 7e3e301ac8d7aae79297a96c857fd766472e2734872e90347429f78b6cab1026ba3846e46841f016e9564d4917db6c1a24ff03b6912c97d322354bb69d6359a6
+  data.tar.gz: 7fad9f6987f65bed5821e5e83bb53381138246058a3157583ad24de9263a93a105781543bf32546c62fce2f86ae3e20634aca451bd7ccb95e371b7176d087911

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.2.0
+
+* Add current config which enables specified configs only in a block.
+* Add `keep_field_order` config.
+
 ## 1.1.2
 
 * Remove tab characters in references header.

data/README.md

@@ -26,10 +26,10 @@ Use mail as usual. You can enable/disable patched features as follows:
 
 ```ruby
 # disable patch
-Mail::Jdec.disable
+Mail::Jdec.disable!
 
 # enable patch
-Mail::Jdec.enable
+Mail::Jdec.enable!
 ```
 
 ## Contributing

data/lib/mail/jdec/body_patch.rb

@@ -16,6 +16,4 @@ module Mail
   end
 end
 
-unless Mail::Body.included_modules.include?(Mail::Jdec::BodyPatch)
-  Mail::Body.prepend Mail::Jdec::BodyPatch
-end
+Mail::Body.prepend Mail::Jdec::BodyPatch

data/lib/mail/jdec/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mail
+  module Jdec
+    class Config
+      NAMES = [
+        :enabled,
+        :autodetect_confidence, :autodetect_skip_charsets, :mime_types_for_autodetect,
+        :preferred_charsets, :keep_field_order
+      ]
+      NAMES.each do |name|
+        attr_accessor name
+      end
+
+      def initialize(attrs = {})
+        attrs.each do |key, val|
+          send("#{key}=", val)
+        end
+      end
+
+      def attributes
+        NAMES.each_with_object({}) do |name, hash|
+          hash[name] = send(name)
+        end
+      end
+    end
+  end
+end

data/lib/mail/jdec/detector.rb

@@ -22,8 +22,8 @@ module Mail
         def trusty?(detected)
           detected.key?(:type) &&
             detected.key?(:encoding) &&
-            detected[:confidence].to_i >= Jdec.autodetect_confidence &&
-            !Jdec.autodetect_skip_charsets.include?(detected[:encoding].downcase)
+            detected[:confidence].to_i >= Jdec.config.autodetect_confidence &&
+            !Jdec.config.autodetect_skip_charsets.include?(detected[:encoding].downcase)
         end
       end
     end

data/lib/mail/jdec/elements/content_disposition_element_patch.rb

@@ -38,6 +38,4 @@ module Mail
   end
 end
 
-unless Mail::ContentDispositionElement.included_modules.include?(Mail::Jdec::ContentDispositionElementPatch)
-  Mail::ContentDispositionElement.prepend Mail::Jdec::ContentDispositionElementPatch
-end
+Mail::ContentDispositionElement.prepend Mail::Jdec::ContentDispositionElementPatch

data/lib/mail/jdec/elements/content_type_element_patch.rb

@@ -33,6 +33,4 @@ module Mail
   end
 end
 
-unless Mail::ContentTypeElement.included_modules.include?(Mail::Jdec::ContentTypeElementPatch)
-  Mail::ContentTypeElement.prepend Mail::Jdec::ContentTypeElementPatch
-end
+Mail::ContentTypeElement.prepend Mail::Jdec::ContentTypeElementPatch

data/lib/mail/jdec/elements/message_ids_element_patch.rb

@@ -15,6 +15,4 @@ module Mail
   end
 end
 
-unless Mail::MessageIdsElement.included_modules.include?(Mail::Jdec::MessageIdsElementPatch)
-  Mail::MessageIdsElement.prepend Mail::Jdec::MessageIdsElementPatch
-end
+Mail::MessageIdsElement.prepend Mail::Jdec::MessageIdsElementPatch

data/lib/mail/jdec/encodings_patch.rb

@@ -14,6 +14,4 @@ module Mail
   end
 end
 
-unless Mail::Encodings.singleton_class.included_modules.include?(Mail::Jdec::EncodingsPatch)
-  Mail::Encodings.singleton_class.prepend Mail::Jdec::EncodingsPatch
-end
+Mail::Encodings.singleton_class.prepend Mail::Jdec::EncodingsPatch

data/lib/mail/jdec/field_list_patch.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mail
+  module Jdec
+    module FieldListPatch
+      def insert_field(field)
+        if Mail::Jdec.enabled? && Mail::Jdec.config.keep_field_order
+          push field
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+Mail::FieldList.prepend Mail::Jdec::FieldListPatch

data/lib/mail/jdec/fields/common_address_field_patch.rb

@@ -27,7 +27,5 @@ end
 
 klasses = ObjectSpace.each_object(Class).select { |klass| klass < Mail::CommonAddressField }
 klasses.each do |klass|
-  unless klass.included_modules.include?(Mail::Jdec::CommonAddressFieldPatch)
-    klass.prepend Mail::Jdec::CommonAddressFieldPatch
-  end
+  klass.prepend Mail::Jdec::CommonAddressFieldPatch
 end

data/lib/mail/jdec/fields/common_date_field_patch.rb

@@ -40,7 +40,5 @@ end
 
 klasses = ObjectSpace.each_object(Class).select { |klass| klass < Mail::CommonDateField }
 klasses.each do |klass|
-  unless klass.included_modules.include?(Mail::Jdec::CommonDateFieldPatch)
-    klass.prepend Mail::Jdec::CommonDateFieldPatch
-  end
+  klass.prepend Mail::Jdec::CommonDateFieldPatch
 end

data/lib/mail/jdec/fields/structured_field_patch.rb

@@ -11,6 +11,4 @@ module Mail
   end
 end
 
-unless Mail::StructuredField.included_modules.include?(Mail::Jdec::StructuredFieldPatch)
-  Mail::StructuredField.prepend Mail::Jdec::StructuredFieldPatch
-end
+Mail::StructuredField.prepend Mail::Jdec::StructuredFieldPatch

data/lib/mail/jdec/fields/unstructured_field_patch.rb

@@ -11,6 +11,4 @@ module Mail
   end
 end
 
-unless Mail::UnstructuredField.included_modules.include?(Mail::Jdec::UnstructuredFieldPatch)
-  Mail::UnstructuredField.prepend Mail::Jdec::UnstructuredFieldPatch
-end
+Mail::UnstructuredField.prepend Mail::Jdec::UnstructuredFieldPatch

data/lib/mail/jdec/message_patch.rb

@@ -28,7 +28,7 @@ module Mail
         end
 
         def mime_types_for_autodetect?(mime_type)
-          Jdec.mime_types_for_autodetect.any? do |type|
+          Jdec.config.mime_types_for_autodetect.any? do |type|
             if type.is_a?(Regexp)
               type.match?(mime_type)
             else
@@ -41,6 +41,4 @@ module Mail
   end
 end
 
-unless Mail::Message.included_modules.include?(Mail::Jdec::MessagePatch)
-  Mail::Message.prepend Mail::Jdec::MessagePatch
-end
+Mail::Message.prepend Mail::Jdec::MessagePatch

data/lib/mail/jdec/utilities_patch.rb

@@ -5,7 +5,7 @@ module Mail
     module UtilitiesPatch
       def pick_encoding(charset)
         if Jdec.enabled?
-          Jdec.preferred_charsets.each do |from, to|
+          Jdec.config.preferred_charsets.each do |from, to|
             if charset.to_s.downcase == from
               return Encoding.find(to)
             end
@@ -35,6 +35,4 @@ module Mail
   end
 end
 
-unless Mail::Utilities.singleton_class.included_modules.include?(Mail::Jdec::UtilitiesPatch)
-  Mail::Utilities.singleton_class.prepend Mail::Jdec::UtilitiesPatch
-end
+Mail::Utilities.singleton_class.prepend Mail::Jdec::UtilitiesPatch

data/lib/mail/jdec/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Jdec
-    VERSION = '1.1.2'
+    VERSION = '1.2.0'
   end
 end

data/lib/mail/jdec.rb

@@ -10,39 +10,54 @@ end
 module Mail
   module Jdec
     class << self
-      attr_reader :enabled
-      attr_accessor :autodetect_confidence
-      attr_accessor :autodetect_skip_charsets
-      attr_accessor :mime_types_for_autodetect
-      attr_accessor :preferred_charsets
+      @@config = Config.new(
+        enabled: true,
+        autodetect_confidence: 50,
+        autodetect_skip_charsets: %w(),
+        mime_types_for_autodetect: [%r{^text/}, 'message/delivery-status', 'message/disposition-notification'],
+        preferred_charsets: {
+          'iso-2022-jp' => 'cp50221',
+          'iso-2022-jp-1' => 'cp50221',
+          'iso-2022-jp-2' => 'cp50221',
+          'iso-2022-jp-3' => 'cp50221',
+          'iso-2022-jp-2004' => 'cp50221',
+          'shift_jis' => 'cp932',
+          'shift-jis' => 'cp932',
+          'x_sjis' => 'cp932',
+          'x-sjis' => 'cp932'
+        },
+        keep_field_order: false
+      )
+
+      def configure
+        yield @@config
+      end
+
+      THREAD_KEY = :_mail_jdec
+
+      def config
+        Thread.current[THREAD_KEY] || @@config
+      end
+
+      def with_config(hash = {})
+        old = Thread.current[THREAD_KEY]
+        Thread.current[THREAD_KEY] = Config.new(config.attributes.merge(hash))
+        yield
+      ensure
+        Thread.current[THREAD_KEY] = old
+      end
 
       def enabled?
-        @@enabled
+        config.enabled
       end
 
-      def enable
-        @@enabled = true
+      def enable!
+        config.enabled = true
       end
 
-      def disable
-        @@enabled = false
+      def disable!
+        config.enabled = false
       end
     end
-
-    self.enable
-    self.autodetect_confidence = 50
-    self.autodetect_skip_charsets = %w()
-    self.mime_types_for_autodetect = [%r{^text/}, 'message/delivery-status', 'message/disposition-notification']
-    self.preferred_charsets = {
-      'iso-2022-jp' => 'cp50221',
-      'iso-2022-jp-1' => 'cp50221',
-      'iso-2022-jp-2' => 'cp50221',
-      'iso-2022-jp-3' => 'cp50221',
-      'iso-2022-jp-2004' => 'cp50221',
-      'shift_jis' => 'cp932',
-      'shift-jis' => 'cp932',
-      'x_sjis' => 'cp932',
-      'x-sjis' => 'cp932'
-    }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-jdec
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -100,12 +100,14 @@ files:
 - gemfiles/mail28.gemfile
 - lib/mail/jdec.rb
 - lib/mail/jdec/body_patch.rb
+- lib/mail/jdec/config.rb
 - lib/mail/jdec/decoder.rb
 - lib/mail/jdec/detector.rb
 - lib/mail/jdec/elements/content_disposition_element_patch.rb
 - lib/mail/jdec/elements/content_type_element_patch.rb
 - lib/mail/jdec/elements/message_ids_element_patch.rb
 - lib/mail/jdec/encodings_patch.rb
+- lib/mail/jdec/field_list_patch.rb
 - lib/mail/jdec/fields/common_address_field_patch.rb
 - lib/mail/jdec/fields/common_date_field_patch.rb
 - lib/mail/jdec/fields/parameter_hash_patch.rb
@@ -118,7 +120,7 @@ files:
 homepage: https://github.com/kanety/mail-jdec
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A mail patch for decoding some improper mails
 test_files: []