imap_guard 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99df3a5c8af846514e4270323a001ad4033f602f197965f6eec76dbf9cb999a0
-  data.tar.gz: 2be62429ce40e9b3e5edd27c8ff166fd5e62193c37cad995019958cf0997b7da
+  metadata.gz: 25df25da92ea0dae5ec4d6aaf9484049aa9713cc358ad43e6fce41628e2007a3
+  data.tar.gz: '0028b947283d027fa80184fbcbc211e922539644a452e4ed859c4ea3822ec832'
 SHA512:
-  metadata.gz: 7d777c406347aff9d485111676a39ce14ea3348e8c17daa5ce343db7a91b1c6a6a4dd57504fecde6a4fa719501f4d1cd848119e6820bc085c3a7fd33382b9c5c
-  data.tar.gz: eda7c841a6b0b6e86d4c4d3ab62f5f7992bff53d0510cd303afd46b29d5780e00f8b3769f0386e0baf70908a53a048799104d46c11629d46eaa88c9b4f2f41cf
+  metadata.gz: 87d43bcba3020e0d2ec1b4a7e5d589abff5fa842ce83ab3405c2216818cfd43c877003613a4d65cb42abe190ab75d72435ab577efdd1dc914ebc77b87f46d74a
+  data.tar.gz: 4279c2dd1877d4f83508094d0725298d8e08ea1940c0c925c89a4842ffd196465b0cb3186555f73dbf15e50cafbda2b884d8982df0b3162dd1740a608316765a

data/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: ruby:latest
+
+before_script:
+  - ruby -v
+  - bundle install -j $(nproc)
+
+rspec:
+  script: rspec spec
+
+rubocop:
+  script: rubocop
+
+yard:
+  script: yard stats --list-undoc

data/.rubocop.yml

@@ -1,5 +1,10 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
+  NewCops: enable
 
 Metrics:
   Enabled: false
@@ -7,14 +12,8 @@ Metrics:
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Style/FormatStringToken:
-  Enabled: false
-
-Style/SafeNavigation:
-  Enabled: false
-
-Style/SpecialGlobalVars:
-  Enabled: false
+Layout/LineLength:
+  Enabled: 100
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -24,3 +23,24 @@ Style/TrailingCommaInArguments:
 
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/ExpectOutput:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false # TODO: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/Gemfile

@@ -2,5 +2,15 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in imap_guard.gemspec
+# Specify your gem's runtime dependencies in imap_guard.gemspec
 gemspec
+
+# Specify your gem's development dependencies below:
+gem "bundler", ">= 1.3"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "yard"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2019 Cédric Félizard
+Copyright (c) 2013-2022 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -1,7 +1,7 @@
 # ImapGuard
 
 [![Gem Version](https://badge.fury.io/rb/imap_guard.svg)](https://badge.fury.io/rb/imap_guard)
-[![Build Status](https://secure.travis-ci.org/infertux/imap_guard.png?branch=master)](https://travis-ci.org/infertux/imap_guard)
+[![Build Status](https://gitlab.com/infertux/imap_guard/badges/master/pipeline.svg)](https://gitlab.com/infertux/imap_guard/-/pipelines)
 [![Code Climate](https://codeclimate.com/github/infertux/imap_guard.png)](https://codeclimate.com/github/infertux/imap_guard)
 [![Inline docs](http://inch-ci.org/github/infertux/imap_guard.svg)](http://inch-ci.org/github/infertux/imap_guard)
 

data/imap_guard.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "imap_guard"
-  spec.version       = "1.2.0"
+  spec.version       = "2.0.0"
   spec.authors       = ["Cédric Félizard"]
   spec.email         = ["cedric@felizard.fr"]
   spec.description   = "A guard for your IMAP server"
@@ -13,20 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/infertux/imap_guard"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/) # rubocop:disable Style/SpecialGlobalVars
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "mail", ">= 2.5.3"
-  spec.add_dependency "term-ansicolor", ">= 1.2.2"
+  spec.required_ruby_version = ">= 3.0.5"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.add_development_dependency "bundler", ">= 1.3"
-  spec.add_development_dependency "cane"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "redcarpet" # for yardoc
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "yard"
+  spec.add_dependency "mail", ">= 2.7.1"
+  spec.add_dependency "net-imap"
+  spec.add_dependency "term-ansicolor", ">= 1.2.2"
 end

data/lib/imap_guard/guard.rb

@@ -5,8 +5,8 @@ require "ostruct"
 require "mail"
 require "term/ansicolor"
 
-String.send(:include, Term::ANSIColor)
-Term::ANSIColor.coloring = STDOUT.isatty
+String.include Term::ANSIColor
+Term::ANSIColor.coloring = $stdout.isatty
 
 module ImapGuard
   # Guard allows you to process your mailboxes.
@@ -17,11 +17,13 @@ module ImapGuard
     # List of optional settings
     OPTIONAL_SETTINGS = %i[read_only verbose].freeze
 
+    Settings = Struct.new("Settings", *(REQUIRED_SETTINGS + OPTIONAL_SETTINGS))
+
     # @return [Proc, nil] Matched emails are passed to this debug lambda if present
     attr_accessor :debug
 
     # @note The settings are frozen
-    # @return [OpenStruct] ImapGuard settings
+    # @return [Struct::Settings] ImapGuard settings
     attr_reader :settings
 
     # @return [String, nil] Currently selected mailbox
@@ -86,7 +88,7 @@ module ImapGuard
     # @param opration Lambda to call on each message
     # @return [void]
     def each(query)
-      operation = ->(message_id) { yield message_id }
+      operation = ->(message_id) { yield message_id } # rubocop:disable Style/ExplicitBlockArgument
       process query, operation
     end
 
@@ -137,7 +139,7 @@ module ImapGuard
         if block_given? || debug
           mail = fetch_mail message_id
 
-          debug.call(mail) if debug
+          debug.call(mail) if debug # rubocop:disable Style/SafeNavigation
 
           if block_given?
             result = yield(mail)
@@ -152,7 +154,9 @@ module ImapGuard
     end
 
     def search(query)
-      raise TypeError, "Query must be either a string holding the entire search string, or a single-dimension array of search keywords and arguments." unless [Array, String].any? { |type| query.is_a? type }
+      unless [Array, String].any? { |type| query.is_a? type }
+        raise TypeError, "Query must be either a string holding the entire search string, or a single-dimension array of search keywords and arguments."
+      end
 
       messages = @imap.search query
       puts "Query on #{mailbox}: #{query.inspect}: #{messages.count} results".cyan
@@ -178,7 +182,8 @@ module ImapGuard
       unknown = settings.keys - REQUIRED_SETTINGS - OPTIONAL_SETTINGS
       raise ArgumentError, "Unknown settings: #{unknown}" unless unknown.empty?
 
-      @settings = OpenStruct.new(settings).freeze
+      struct = Settings.members.map { |member| settings.fetch(member, false) }
+      @settings = Settings.new(*struct).freeze
       puts "DRY-RUN MODE ENABLED".yellow.bold.negative if @settings.read_only
     end
   end

data/spec/imap_guard/guard_spec.rb

@@ -20,7 +20,7 @@ module ImapGuard
     end
 
     let(:imap) do
-      double("Net::IMAP", search: [7, 28], expunge: nil, select: nil, list: [])
+      instance_double(Net::IMAP, search: [7, 28], expunge: nil, select: nil, list: [])
     end
 
     def guard_instance(custom_settings = {})
@@ -80,13 +80,13 @@ module ImapGuard
       it "accepts arrays" do
         expect do
           guard_instance.send(:search, ["ALL"])
-        end.to_not raise_error
+        end.not_to raise_error
       end
 
       it "accepts strings" do
         expect do
           guard_instance.send(:search, "ALL")
-        end.to_not raise_error
+        end.not_to raise_error
       end
 
       it "returns results" do
@@ -128,10 +128,10 @@ module ImapGuard
         it "executes the filter block" do
           expect(guard).to receive(:fetch_mail).twice
 
-          guard.send(:process, "ALL", opeartion) {}
+          guard.send(:process, "ALL", opeartion) { nil }
         end
 
-        context "returning false" do
+        context "when returning false" do
           it "does not perform the operation" do
             expect(opeartion).not_to receive(:call)
 
@@ -139,7 +139,7 @@ module ImapGuard
           end
         end
 
-        context "returning true" do
+        context "when returning true" do
           it "does perform the operation" do
             expect(opeartion).to receive(:call).twice
 
@@ -173,9 +173,11 @@ module ImapGuard
 
     describe "#each" do
       it "iterates over messages without errors" do
-        guard_instance.each "ALL" do |message_id|
-          # noop
-        end
+        expect do
+          guard_instance.each "ALL" do |message_id|
+            # noop
+          end
+        end.not_to raise_error
       end
     end
 
@@ -222,7 +224,7 @@ module ImapGuard
 
     describe "#settings=" do
       it "freezes the settings" do
-        guard = Guard.new(settings)
+        guard = described_class.new(settings)
 
         exception = (RUBY_VERSION >= "2.1.0" ? RuntimeError : TypeError)
 
@@ -233,13 +235,13 @@ module ImapGuard
 
       it "raises ArgumentError if any required key is missing" do
         expect do
-          Guard.new({})
+          described_class.new({})
         end.to raise_error ArgumentError, /missing/i
       end
 
       it "raises ArgumentError if any key is unknown" do
         expect do
-          Guard.new(settings.merge(coffee: true))
+          described_class.new(settings.merge(coffee: true))
         end.to raise_error ArgumentError, /unknown/i
       end
     end

data/spec/imap_guard/query_spec.rb

@@ -3,7 +3,7 @@
 module ImapGuard
   describe Query do
     describe "#initialize" do
-      it { should be_empty }
+      it { is_expected.to be_empty }
     end
 
     describe "#seen" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap_guard
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cédric Félizard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-20 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -16,120 +16,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.3
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.3
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
-  name: term-ansicolor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: cane
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: net-imap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -137,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.2.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.2
 description: A guard for your IMAP server
 email:
 - cedric@felizard.fr
@@ -158,9 +60,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -177,8 +79,9 @@ files:
 homepage: https://github.com/infertux/imap_guard
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,18 +89,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A guard for your IMAP server
-test_files:
-- spec/imap_guard/guard_spec.rb
-- spec/imap_guard/query_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-after_script:
-  - cane
-  - yard stats --list-undoc
-rvm:
-  - 2.6.0
-  - 2.5.3
-  - 2.4.5