imap_mogura 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14cd28606dbecabfd04544f634f81cf8378412f64a4af268b97300e754d9c55
-  data.tar.gz: 3b3f86b413c84f8d4bfc6a889bf197a54793210b212d9db794a5a40717f6ba1a
+  metadata.gz: 1098d9f2efbc9c5217d93bb2cc3577f90cd64884ccea587163166abfb5160275
+  data.tar.gz: 1a9c668019cb0da2093aab3ff88e03956bf43b83c359947085808c10ee2735c8
 SHA512:
-  metadata.gz: 717b2e6eee24de47f2219cc6331a0bcf78476505b45ee28f7b2b8ff453bc8c63792e14926e7530563dea2f8b1c8240b30342e08b30beb9457ab71cb47d74a957
-  data.tar.gz: f5ef0e70a29a0d5c10277a153ee1989614b1b697418deda0a9d4fa9bee6a9f75a331cdd892dcd4d88f3c83cc78f63c91f73a50aa2ed2966b69a49d9c70a955d7
+  metadata.gz: 0fcf8a3ba59e7d38d88be956308697b278d5db988bfb26544ffaf35f7ccd70292fc1665b6746d763980a1e281c225edbd557d41870d33514d28cad20e90e3100
+  data.tar.gz: cf92e40b912996ec5a395ad9722a12f8f303b569354a87911b855d44308cdf69fada23fabbd655eacf65ac3bcc04edb8505e4f86a148b31cd8467b401ed5e376

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)]
 
@@ -77,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]
@@ -91,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

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
@@ -23,13 +39,15 @@ module ImapMogura
 
   class AndOperator < LogicalOperator
     def match?(mail)
-      @operands.all? { |elm| elm.match?(mail) }
+      debug_out_before_trying_rule("All of the operands match the rule")
+      debug_out_if_it_matches_rule(@operands.all? { |elm| elm.match?(mail) })
     end
   end
 
   class OrOperator < LogicalOperator
     def match?(mail)
-      @operands.any? { |elm| elm.match?(mail) }
+      debug_out_before_trying_rule("Any of the operands matches the rule")
+      debug_out_if_it_matches_rule(@operands.any? { |elm| elm.match?(mail) })
     end
   end
 
@@ -47,46 +65,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 +134,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.3.1"
+  VERSION = "0.4.1"
 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.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - ysk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-01-07 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: []