imapcli 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee39530d31868e3c8f3c90a1ad9957552ee91f51e7ed05c57fb9a3724a297ef7
-  data.tar.gz: 3d6484ebcce956fc9425447786daaf6d7bce486e0b787d5be9e817cba4517dab
+  metadata.gz: 0736f0dbe2cb473770fb5f92f0f37546b9f26a6e892bbca3c69b072c1f06db9f
+  data.tar.gz: '0609a383ac74799eb2aade3d52fa0c5c811fc5cb4b253f1607e0b6f2dbe7cf01'
 SHA512:
-  metadata.gz: 0e6fab7ebd5c9e58b432323e7ee974c8880785ccf969139966ac2bc9bc7f1034db51678e95c35d7fb53a7df434790340c03aedd40bf2d1bfb6308b2d6b6d4614
-  data.tar.gz: 44801f7d7aa3311683b7e2370b39b9738d4de629e080f32f034b6ae6ac65bda0882dfc15d3731af3929421757a350217f8e4a74ec2127f35d543215cf8aef84e
+  metadata.gz: 69d818a1780fda1549bbd83581c2d0abbc4ecda7274cb411bedd450a8365e322153263c1f5b490b03a183e7c8cb02e5d382c82c8628ee43e1c1c1294f6e76afa
+  data.tar.gz: e664577a0949609bebd90a7bc08b94e4559001fcb7b26429958fe38801acd835089b030cad3d3b1fa09a95ccc51b400f6cb8f66befc4903ebe1cb9b4bb56746d

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Version 2.1.0 (2025-03-16)][v2.1.0]
+
+### Added
+
+- New command-line flag `-l`/`--limit` to limit the statistics output to
+  a given number of mailboxes (folders).
+
 ## [Version 2.0.1 (2025-03-11)][v2.0.1]
 
 ### Fixed
@@ -72,6 +79,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix: Docker image.
 - Fix: Options error message.
 
+[v2.1.0]: https://github.com/bovender/imapcli/releases/tag/v2.1.0
 [v2.0.1]: https://github.com/bovender/imapcli/releases/tag/v2.0.1
 [v2.0.0]: https://github.com/bovender/imapcli/releases/tag/v2.0.0
 [v1.0.7]: https://github.com/bovender/imapcli/releases/tag/v1.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    imapcli (2.0.0)
+    imapcli (2.0.1)
       activesupport (~> 8.0)
       csv
       descriptive_statistics (~> 2.5)
@@ -16,7 +16,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -83,7 +83,7 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.10.1)
+    json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
     listen (3.9.0)
@@ -92,7 +92,7 @@ GEM
     logger (1.6.6)
     lumberjack (1.2.10)
     method_source (1.1.0)
-    minitest (5.25.4)
+    minitest (5.25.5)
     nenv (0.3.0)
     net-imap (0.5.6)
       date
@@ -142,7 +142,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.73.2)
+    rubocop (1.74.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -153,7 +153,7 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.1)
+    rubocop-ast (1.39.0)
       parser (>= 3.3.1.0)
     rubocop-performance (1.24.0)
       lint_roller (~> 1.1)

data/README.md

@@ -263,7 +263,18 @@ keyword, as shown below.
 
 Example:
 
-    bundle exec -it bin/imapcli -s yourserver.example.com -u myusername -P stats -r -o max_size Archive
+    docker run -it bin/imapcli -s yourserver.example.com -u myusername -P stats -r -o max_size Archive
+
+#### Limiting the number of mailboxes
+
+You can limit the number of mailboxes (folders) in the output table with the
+`-l`/`--limit` flag. This flag takes an argument that indicates the maximum
+number of mailboxes. THe default value for this argument is 10.
+
+Use case: Say you have a very large IMAP account, and you would like to know the
+5 folders that contain the largest messages. The command should be:
+
+    imapcli -s yourserver.example.com -u myusername -P stats -o max_size --limit 5 
 
 #### Obtaining comma-separated values (CSV)
 

data/lib/imapcli/cli.rb

@@ -74,6 +74,10 @@ module Imapcli
         default: 'total_size'
       c.switch %i[reverse], desc: 'Reverse sort order (largest first)', negatable: false
       c.switch [:csv], desc: 'Output comma-separated values (CSV)'
+      c.flag %i[l limit],
+        desc: 'Limit the results to n folders (IMAP mailboxes)',
+        arg_name: 'max_lines',
+        default: 10
 
       c.action do |_global_options, options, args| # rubocop:disable Metrics/BlockLength
         raise unless @validator.stats_options_valid?(options, args)

data/lib/imapcli/command.rb

@@ -68,7 +68,12 @@ module Imapcli
             yield current_count if block_given?
           end
         end
-        output = sorted_list(list, options).map do |mailbox|
+
+        output = if options[:limit]
+          sorted_list(list, options).last(options[:limit].to_i)
+        else
+          sorted_list(list, options)
+        end.map do |mailbox|
           stats_to_table(mailbox.full_name, mailbox.stats)
         end
         output << stats_to_table('Total', total_stats) if list.length > 1

data/lib/imapcli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imapcli
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/spec/lib/imapcli/command_spec.rb

@@ -133,6 +133,11 @@ RSpec.describe Imapcli::Command do
         expect(output).to be_a Array
         expect(output[0][0]).to eq 'Inbox/Smallest/Messages'
       end
+
+      it 'returns only the first n mailboxes' do
+        output = command.stats('Inbox', depth: -1, limit: 2)
+        expect(output.length).to eq 3 # including summary line
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imapcli
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Kraus (bovender)
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport