imap_mogura 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 993c63cfc198ecb1bf303676897fe03825ebd959b84b80f543c3e9268dd418de
-  data.tar.gz: a67fa16f14228240da1eecdf806bd9208d9019dfa98bcd13a20d3ed1aeaeacf5
+  metadata.gz: 3889ab4ffaf619e936cb0a0dcf3aa0dd8eb7b5613866028c75ccc10c274f933e
+  data.tar.gz: e3c626aba3ffab681a53e9ccb8b8f436ba86ee3d790c373ba486b81e26daf6c1
 SHA512:
-  metadata.gz: 8530a54d7aa22e3267f31eec06f7f5c125b1d908b1b6a2677fa7a6699f3ec3c343fdc0bc5003d7f7be26a05ddcadc0bf5c947c0d38e445faee86e3a90081dc64
-  data.tar.gz: 50cce8e16ee1f23bd198da3fcb984c33d537800a84bc0d41a48a0a3b0c252d738051b140cb22646d5f7344c3ac1d87bffaa51895cae542e58cfc2c5d1138b170
+  metadata.gz: d4c0fe1d4db3a23912e681cbd17a1bf13ba8b02f961a04ce44497659ec672b22b166a737bb6a258e5c6c10c7d067810064833e595063b56ba1aea25967da9378
+  data.tar.gz: 30a8d4e087f2c3d0aba2ca58237afba9c9fc1e6da17fef7006822dbbecce1c80164cbf7c3f02b0b95d451303e0e8003346c93bc33bf5989bb5ceee5765986302

data/lib/imap_mogura/cli.rb

@@ -3,6 +3,8 @@
 require "thor"
 require "base64"
 
+require_relative "debug_util"
+
 module ImapMogura
   class CustomOptionError < Thor::Error
     def initialize(msg = "Custom option error message")
@@ -29,6 +31,7 @@ module ImapMogura
     option :filter_unseen, type: :boolean, default: true
     option :create_directory, type: :boolean, default: true
     option :dry_run, type: :boolean, default: false
+    option :debug, type: :boolean, default: false
     def start(host)
       port = options[:port]
       starttls = options[:starttls]
@@ -41,6 +44,9 @@ module ImapMogura
       filter_unseen = options[:filter_unseen]
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
+      debug = options[:debug]
+
+      DebugUtil.enable_debug if debug
 
       search_keys = ["RECENT", *(["UNSEEN"] if filter_unseen)]
 
@@ -53,9 +59,11 @@ module ImapMogura
         monitor_recents_on_mailbox(imap_handler, target_mailbox) do
           # find mails with search keys on the target mailbox and handle them
           imap_handler.find_and_handle_mails(target_mailbox, search_keys) do |message_id|
-            warn "mail (id = #{message_id} on \"#{target_mailbox}\") is recent"
+            warn "a mail is recent on \"#{target_mailbox}\""
 
             filter_mail(imap_handler, rules, target_mailbox, message_id, dry_run: dry_run)
+
+            imap_handler.close_operation_for_mailbox(target_mailbox)
           end
         end
       end
@@ -75,6 +83,7 @@ module ImapMogura
     option :filter_only_unseen, type: :boolean, default: false
     option :create_directory, type: :boolean, default: true
     option :dry_run, type: :boolean, default: false
+    option :debug, type: :boolean, default: false
     def filter(host)
       port = options[:port]
       starttls = options[:starttls]
@@ -89,9 +98,12 @@ module ImapMogura
       filter_only_unseen = options[:filter_only_unseen]
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
+      debug = options[:debug]
 
       raise CustomOptionError, "--all-mailbox (-a) or --target-mailbox (-b) is required" if !all_mailbox && target_mailbox.nil?
 
+      DebugUtil.enable_debug if debug
+
       search_keys = if filter_only_unseen
                       ["UNSEEN"]
                     else
@@ -219,7 +231,7 @@ module ImapMogura
       handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
 
       # retry monitor recents on mailbox itself with retry count to be incremented
-      warn "retry monitoring mails on #{e.mailbox}..."
+      warn "retry monitoring mails on \"#{e.mailbox}\"..."
 
       monitor_recents_on_mailbox(imap_handler, mailbox, retry_count + 1)
     end
@@ -228,43 +240,32 @@ module ImapMogura
       imap_handler.find_and_handle_mails(mailbox, search_keys) do |message_id|
         filter_mail(imap_handler, rules, mailbox, message_id, dry_run: dry_run)
       end
+
+      imap_handler.close_operation_for_mailbox(mailbox)
     rescue IMAPHandler::MailFetchError => e
       handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
 
       # retry filter all mails itself with retry count to be incremented
-      warn "retry filtering all mails on #{e.mailbox}"
+      warn "retry filtering all mails on \"#{e.mailbox}\""
 
       filter_mails(imap_handler, rules, mailbox, search_keys, retry_count + 1, dry_run: dry_run)
     end
 
-    def handle_mail_fetch_error_and_preprocess_retrying(error, retry_count)
-      warn "failed to fetch mail (id = #{error.message_id} on mailbox #{error.mailbox}): #{error.bad_response_error_message}"
-
-      # if retry_count is over the threshold, abort processing
-      raise Thor::Error, "retry count is over the threshold, stop processing" unless retry_count < 3
-
-      warn "wait a moment..."
-
-      sleep 10
-    end
-
     def filter_mail(imap_handler, rules, mailbox, message_id, dry_run: false)
       mail = imap_handler.fetch_header(mailbox, message_id)
 
       warn "# filtering mail on \"#{mailbox}\" of subject \"#{mail.subject}\"..."
 
       rules.each do |rule_set|
-        try_to_filter_mail_for_rule_set(imap_handler, rule_set, mailbox, message_id, mail, dry_run: dry_run)
+        break if try_to_filter_mail_for_rule_set(imap_handler, rule_set, mailbox, message_id, mail, dry_run: dry_run)
       end
-
-      imap_handler.close_operation_for_mailbox(mailbox)
     end
 
     def try_to_filter_mail_for_rule_set(imap_handler, rule_set, mailbox, message_id, mail, dry_run: false)
       dst_mailbox = rule_set.destination
       rule = rule_set.rule
 
-      return unless rule.match?(mail)
+      return nil unless rule.match?(mail)
 
       warn "the mail matches for the rule of the destination \"#{dst_mailbox}\""
       warn "moving the mail..."
@@ -279,6 +280,19 @@ module ImapMogura
           warn "moving skipped because the destination is the same with the current mailbox \"#{mailbox}\""
         end
       end
+
+      dst_mailbox
+    end
+
+    def handle_mail_fetch_error_and_preprocess_retrying(error, retry_count)
+      warn "failed to fetch the mail on \"#{error.mailbox}\": #{error.bad_response_error_message}"
+
+      # if retry_count is over the threshold, abort processing
+      raise Thor::Error, "retry count is over the threshold, stop processing" unless retry_count < 3
+
+      warn "wait a moment..."
+
+      sleep 10
     end
   end
 end

data/lib/imap_mogura/debug_util.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ImapMogura
+  module DebugUtil
+    class << self
+      def enable_debug
+        $DEBUG = true
+      end
+
+      def debug(msg)
+        warn msg if $DEBUG
+      end
+    end
+  end
+end

data/lib/imap_mogura/rules_parser/rule_elements.rb

@@ -1,10 +1,26 @@
 # frozen_string_literal: true
 
+require_relative "../debug_util"
+
 module ImapMogura
   class RuleElement
     def match?(mail)
       raise NotImplementedError
     end
+
+    private
+
+    def debug_out_before_trying_rule(msg)
+      DebugUtil.debug "## checking if it matches the rule: #{msg}"
+    end
+
+    def debug_out_if_it_matches_rule(match_result)
+      if match_result
+        DebugUtil.debug "## it matches the rule"
+      else
+        DebugUtil.debug "## it doesn't match"
+      end
+    end
   end
 
   class LogicalOperator < RuleElement
@@ -47,46 +63,57 @@ module ImapMogura
 
   class FromMatcher < SpecialFieldMatcher
     def match?(mail)
-      case mail.from
-      when Enumerable
-        mail.from.any? { |address| address&.match?(@regexp) }
-      else
-        mail.from&.match?(@regexp)
-      end
+      debug_out_before_trying_rule("From #{mail.from.inspect} matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(
+        case mail.from
+        when Enumerable
+          mail.from.any? { |address| address&.match?(@regexp) }
+        else
+          mail.from&.match?(@regexp)
+        end
+      )
     end
   end
 
   class SenderMatcher < SpecialFieldMatcher
     def match?(mail)
-      mail.sender&.match?(@regexp)
+      debug_out_before_trying_rule("Sender #{mail.sender.inspect} matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(mail.sender&.match?(@regexp))
     end
   end
 
   class ToMatcher < SpecialFieldMatcher
     def match?(mail)
-      case mail.to
-      when Enumerable
-        mail.to.any? { |address| address&.match?(@regexp) }
-      else
-        mail.to&.match?(@regexp)
-      end
+      debug_out_before_trying_rule("To #{mail.to.inspect} matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(
+        case mail.to
+        when Enumerable
+          mail.to.any? { |address| address&.match?(@regexp) }
+        else
+          mail.to&.match?(@regexp)
+        end
+      )
     end
   end
 
   class CcMatcher < SpecialFieldMatcher
     def match?(mail)
-      case mail.cc
-      when Enumerable
-        mail.cc.any? { |address| address&.match?(@regexp) }
-      else
-        mail.cc&.match?(@regexp)
-      end
+      debug_out_before_trying_rule("Cc #{mail.cc.inspect} matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(
+        case mail.cc
+        when Enumerable
+          mail.cc.any? { |address| address&.match?(@regexp) }
+        else
+          mail.cc&.match?(@regexp)
+        end
+      )
     end
   end
 
   class SubjectMatcher < SpecialFieldMatcher
     def match?(mail)
-      mail.subject&.match?(@regexp)
+      debug_out_before_trying_rule("Subject \"#{mail.subject}\" matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(mail.subject&.match?(@regexp))
     end
   end
 
@@ -105,7 +132,8 @@ module ImapMogura
     end
 
     def match?(mail)
-      mail.headers[@field_name]&.value&.match?(@regexp)
+      debug_out_before_trying_rule("header field \"#{@field_name}\" with value \"#{mail.headers[@field_name]&.value}\" matches the regexp #{@regexp}")
+      debug_out_if_it_matches_rule(mail.headers[@field_name]&.value&.match?(@regexp))
     end
   end
 end

data/lib/imap_mogura/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImapMogura
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/lib/imap_mogura.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "imap_mogura/debug_util"
 require_relative "imap_mogura/config_parser"
 require_relative "imap_mogura/imap_handler"
 require_relative "imap_mogura/rules_parser"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap_mogura
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - ysk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -84,6 +84,7 @@ files:
 - lib/imap_mogura/cli.rb
 - lib/imap_mogura/config_parser.rb
 - lib/imap_mogura/config_parser/errors.rb
+- lib/imap_mogura/debug_util.rb
 - lib/imap_mogura/imap_handler.rb
 - lib/imap_mogura/rules_parser.rb
 - lib/imap_mogura/rules_parser/errors.rb
@@ -97,7 +98,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/yskuniv/imap_mogura
   source_code_uri: https://github.com/yskuniv/mogura
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A mail filtering tool for IMAP.
 test_files: []