reading 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e30d2e08f85d4ecb58352862165f63b62dbcbeb436103cf0761f318592359571
-  data.tar.gz: 7991e2a241345bd8f5b8fe268c462b721d610157d2c2652aec16882d3833c65f
+  metadata.gz: 45b4a37abfdadf33aafc7cd1af59affdd341ebc006d07797c38fcde27d1f2198
+  data.tar.gz: 6214d4783c4b861e162d6df141c991a324072b1ad749bc1370d400c6b6d860f1
 SHA512:
-  metadata.gz: 1357b2ecd226209ff58e5fa7215ca073bfda99225a9d1623b111417d9bf01ecc9ec61406b2bde9fb3a26f1c7ce6a24e9495eb2bedca403a45d029d9e94e83c0e
-  data.tar.gz: 10285aa58757b8fa07e94945811a9195f6e5015e06ace666c963885b5a5eb19839bae855013a54a76fb4d2a038a9dd1fc53611b2ea0d28a4385073811064cb46
+  metadata.gz: 999323aac5ada251e74eec14107200e570fa52bf829ef35c52101647b81b1245888b0d50dca3c7eec0c1b1bcd3442f320085d46b28fcff3b1c3e0e8953fe797d
+  data.tar.gz: fcfd05d49225306a73ad3f3dbdae29aa311d9b2e29a05118e2b0cbd02ac7948a6b8781849d5680ceb4ea7a2e219bffc410cbd771d07e27d3b81621e0db6e67d9

data/bin/reading

@@ -13,12 +13,12 @@
 #   reading '3|📕Trying|Little Library 1970147288'
 #   reading '📕Trying|Little Library 1970147288' 'head, sources'
 
-require_relative '../lib/reading'
-require_relative '../lib/reading/stats/terminal_result_formatters'
-require 'debug'
-require 'amazing_print'
-require 'readline'
-require 'pastel'
+require_relative "../lib/reading"
+require_relative "../lib/reading/stats/result_formatters"
+require "debug"
+require "amazing_print"
+require "readline"
+require "pastel"
 
 EXIT_COMMANDS = %w[exit e quit q]
 PASTEL = Pastel.new
@@ -72,7 +72,7 @@ if ARGV[1]
   Reading::Config.build(enabled_columns:)
 end
 
-input_is_csv_path = input.end_with?('.csv')
+input_is_csv_path = input.end_with?(".csv") || input.end_with?(".txt")
 
 if input_is_csv_path
   error_handler = ->(e) { puts "Skipped a row due to a parsing error: #{e}" }

data/lib/reading/config.rb

@@ -1,4 +1,4 @@
-require_relative 'errors'
+require_relative "errors"
 
 module Reading
   # Builds a singleton hash config.

data/lib/reading/item/time_length.rb

@@ -18,7 +18,7 @@ module Reading
       def self.parse(string)
         return nil unless string.match? /\A\d+:\d\d\z/
 
-        hours, minutes = string.split(':').map(&:to_i)
+        hours, minutes = string.split(":").map(&:to_i)
         new((hours * 60) + minutes)
       end
 
@@ -51,7 +51,7 @@ module Reading
       # A string in "h:mm" format.
       # @return [String]
       def to_s
-        "#{hours}:#{minutes.round.to_s.rjust(2, '0')} or #{(value / 60.0 * Config.hash.fetch(:pages_per_hour)).round} pages"
+        "#{hours}:#{minutes.round.to_s.rjust(2, "0")} or #{(value / 60.0 * Config.hash.fetch(:pages_per_hour)).round} pages"
       end
 
       # To pages.

data/lib/reading/item/view.rb

@@ -47,7 +47,7 @@ module Reading
         item.variants.map { |variant|
           isbn = variant.isbn
           if isbn
-            url = Config.hash.deep_fetch(:item, :view, :url_from_isbn).sub('%{isbn}', isbn)
+            url = Config.hash.deep_fetch(:item, :view, :url_from_isbn).sub("%{isbn}", isbn)
           else
             url = variant.sources.map { |source| source.url }.compact.first
           end
@@ -108,7 +108,7 @@ module Reading
         if item.done?
           item.last_end_date&.strftime("%Y-%m-%d")
         else
-          item.status.to_s.gsub('_', ' ')
+          item.status.to_s.gsub("_", " ")
         end
       end
     end

data/lib/reading/item.rb

@@ -1,6 +1,6 @@
-require 'forwardable'
+require "forwardable"
 
-require_relative 'item/view'
+require_relative "item/view"
 
 module Reading
   # A wrapper for an item parsed from a CSV reading log, providing convenience

data/lib/reading/parsing/attributes/experiences/dates_and_head_transformer.rb

@@ -1,4 +1,4 @@
-require_relative 'spans_validator'
+require_relative "spans_validator"
 
 module Reading
   module Parsing

data/lib/reading/parsing/attributes/experiences/history_transformer.rb

@@ -1,4 +1,4 @@
-require_relative 'spans_validator'
+require_relative "spans_validator"
 
 # TODO Refactor! This entire file has become 🤢🤮 with the accumulation of new
 # features in the History column.

data/lib/reading/parsing/attributes/experiences.rb

@@ -1,6 +1,6 @@
-require 'date'
-require_relative 'experiences/history_transformer'
-require_relative 'experiences/dates_and_head_transformer'
+require "date"
+require_relative "experiences/history_transformer"
+require_relative "experiences/dates_and_head_transformer"
 
 module Reading
   module Parsing

data/lib/reading/parsing/csv.rb

@@ -1,7 +1,7 @@
-require 'pastel'
-require_relative '../item'
-require_relative 'parser'
-require_relative 'transformer'
+require "pastel"
+require_relative "../item"
+require_relative "parser"
+require_relative "transformer"
 
 module Reading
   module Parsing

data/lib/reading/parsing/parser.rb

@@ -1,8 +1,8 @@
-require_relative 'rows/blank'
-require_relative 'rows/regular'
-require_relative 'rows/compact_planned'
-require_relative 'rows/custom_config'
-require_relative 'rows/comment'
+require_relative "rows/blank"
+require_relative "rows/regular"
+require_relative "rows/compact_planned"
+require_relative "rows/custom_config"
+require_relative "rows/comment"
 
 module Reading
   module Parsing
@@ -145,7 +145,7 @@ module Reading
         # Parse each format-plus-string into an array of segments.
         heads = format_strings.map { |string|
           format_emoji = string[Config.hash.deep_fetch(:regex, :formats)]
-          string.sub!(format_emoji, '')
+          string.sub!(format_emoji, "")
           format = Config.hash.fetch(:formats).key(format_emoji)
 
           parse_segments(column_class, string)

data/lib/reading/parsing/rows/compact_planned.rb

@@ -1,7 +1,7 @@
-require_relative 'column'
-require_relative 'compact_planned_columns/head'
-require_relative 'regular_columns/sources'
-require_relative 'regular_columns/length'
+require_relative "column"
+require_relative "compact_planned_columns/head"
+require_relative "regular_columns/sources"
+require_relative "regular_columns/length"
 
 module Reading
   module Parsing

data/lib/reading/parsing/rows/regular.rb

@@ -1,13 +1,13 @@
-require_relative 'column'
-require_relative 'regular_columns/rating'
-require_relative 'regular_columns/head'
-require_relative 'regular_columns/sources'
-require_relative 'regular_columns/start_dates'
-require_relative 'regular_columns/end_dates'
-require_relative 'regular_columns/genres'
-require_relative 'regular_columns/length'
-require_relative 'regular_columns/notes'
-require_relative 'regular_columns/history'
+require_relative "column"
+require_relative "regular_columns/rating"
+require_relative "regular_columns/head"
+require_relative "regular_columns/sources"
+require_relative "regular_columns/start_dates"
+require_relative "regular_columns/end_dates"
+require_relative "regular_columns/genres"
+require_relative "regular_columns/length"
+require_relative "regular_columns/notes"
+require_relative "regular_columns/history"
 
 module Reading
   module Parsing

data/lib/reading/parsing/transformer.rb

@@ -1,12 +1,12 @@
-require_relative 'attributes/shared'
-require_relative 'attributes/attribute'
-require_relative 'attributes/rating'
-require_relative 'attributes/author'
-require_relative 'attributes/title'
-require_relative 'attributes/genres'
-require_relative 'attributes/variants'
-require_relative 'attributes/experiences'
-require_relative 'attributes/notes'
+require_relative "attributes/shared"
+require_relative "attributes/attribute"
+require_relative "attributes/rating"
+require_relative "attributes/author"
+require_relative "attributes/title"
+require_relative "attributes/genres"
+require_relative "attributes/variants"
+require_relative "attributes/experiences"
+require_relative "attributes/notes"
 
 module Reading
   module Parsing

data/lib/reading/stats/filter.rb

@@ -82,7 +82,7 @@ module Reading
             end
           }
 
-          positive_operator = operator == :'!=' ? :== : operator
+          positive_operator = operator == :"!=" ? :== : operator
 
           matches = items.select { |item|
             ratings.any? { |rating|
@@ -95,34 +95,39 @@ module Reading
           # Instead of using item.rating.send(operator, format) above, invert
           # the matches here to ensure multiple values after a negative operator
           # have an "and" relation: "not(x and y)", rather than "not(x or y)".
-          if operator == :'!='
+          if operator == :"!="
             matches = items - matches
           end
 
           matches
         },
-        done: proc { |values, operator, items|
-          done_progresses = values.map { |value|
-            (value.match(/\A(\d+)?%/).captures.first.to_f.clamp(0.0, 100.0) / 100) ||
+        progress: proc { |values, operator, items|
+          progresses = values.map { |value|
+            value = "0%" if value == "0"
+            match = value.match(/\A(\d+)?%/)
+
+            (match && match.captures.first.to_f.clamp(0.0, 100.0) / 100) ||
               (raise InputError, "Progress must be a percentage")
           }
 
           filtered_items = items.map { |item|
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
-            if operator == :'!='
-              item_done_progresses = item.experiences.map { |experience|
-                experience.spans.last.progress if experience.status == :done
+            if operator == :"!="
+              item_progresses = item.experiences.map { |experience|
+                experience.spans.last.progress || 0.0
               }
 
-              next if (item_done_progresses - done_progresses).empty?
+              next if (item_progresses - progresses).empty?
             end
 
             # Filter out non-matching experiences.
+            # TODO: Make this more accurate by calculating the average progress
+            # across spans? Currently it checks just the last span's progress.
             filtered_experiences = item.experiences.select { |experience|
-              done_progresses.any? { |done_progress|
-                experience.status == :done &&
-                  experience.spans.last.progress.send(operator, done_progress)
+              progresses.any? { |progress|
+                experience.spans.any? &&
+                  (experience.spans.last.progress || 0.0).send(operator, progress)
               }
             }
 
@@ -138,7 +143,7 @@ module Reading
           filtered_items = items.map { |item|
             # Treat empty variants as if they were a variant with a nil format.
             if item.variants.empty?
-              if operator == :'!='
+              if operator == :"!="
                 next item unless formats.include?(nil)
               else
                 next item if formats.include?(nil)
@@ -147,7 +152,7 @@ module Reading
 
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
-            if operator == :'!='
+            if operator == :"!="
               item_formats = item.variants.map(&:format)
 
               next if (item_formats - formats).empty?
@@ -169,14 +174,14 @@ module Reading
         author: proc { |values, operator, items|
           authors = values
             .map { _1.downcase if _1 }
-            .map { _1.gsub(/[^a-zA-Z ]/, '').gsub(/\s/, '') if _1 }
+            .map { _1.gsub(/[^a-zA-Z ]/, "").gsub(/\s/, "") if _1 }
 
           matches = items.select { |item|
             author = item
               &.author
               &.downcase
-              &.gsub(/[^a-zA-Z ]/, '')
-              &.gsub(/\s/, '')
+              &.gsub(/[^a-zA-Z ]/, "")
+              &.gsub(/\s/, "")
 
             if %i[include? exclude?].include? operator
               authors.any? {
@@ -200,7 +205,7 @@ module Reading
         title: proc { |values, operator, items|
           titles = values
             .map(&:downcase)
-            .map { _1.gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, '').gsub(/\s/, '') }
+            .map { _1.gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, "").gsub(/\s/, "") }
 
           matches = items.select { |item|
             next unless item.title
@@ -208,8 +213,8 @@ module Reading
             title = item
               .title
               .downcase
-              .gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, '')
-              .gsub(/\s/, '')
+              .gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, "")
+              .gsub(/\s/, "")
 
             if %i[include? exclude?].include? operator
               titles.any? { title.include? _1 }
@@ -228,8 +233,8 @@ module Reading
           format_name = ->(str) {
             str
               &.downcase
-              &.gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, '')
-              &.gsub(/\s/, '')
+              &.gsub(/[^a-zA-Z0-9 ]|\ba\b|\bthe\b/, "")
+              &.gsub(/\s/, "")
           }
 
           series_names = values.map { format_name.call(_1) }
@@ -251,7 +256,7 @@ module Reading
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
             if %i[!= exclude?].include? operator
-              next if operator == :'!=' && (item_series_names - series_names).empty?
+              next if operator == :"!=" && (item_series_names - series_names).empty?
               next if operator == :exclude? &&
                 item_series_names.all? { |item_series_name|
                   series_names.any? { |series_name|
@@ -280,7 +285,7 @@ module Reading
 
                 series_names.any? {
                   if _1.nil?
-                    nil_operator = { include?: :==, exclude?: :'!=' }[operator]
+                    nil_operator = { include?: :==, exclude?: :"!=" }[operator]
                   end
 
                   item_series_name.send(nil_operator || operator, _1)
@@ -322,7 +327,7 @@ module Reading
                   (url.nil? ? url_nil_match : sources.include?(url))
               }
 
-              next if operator == :'!=' && remainder_names_and_urls.empty?
+              next if operator == :"!=" && remainder_names_and_urls.empty?
               next if operator == :exclude? &&
                 item_source_names_and_urls.all? { |item_source_name_and_url|
                   sources.any? { |source|
@@ -347,7 +352,7 @@ module Reading
               variant.sources.any? { |source|
                 sources.any?  {
                   if _1.nil?
-                    nil_operator = { include?: :==, exclude?: :'!=' }[operator]
+                    nil_operator = { include?: :==, exclude?: :"!=" }[operator]
                   end
 
                   source.name&.downcase&.send(nil_operator || operator, _1) ||
@@ -362,7 +367,7 @@ module Reading
 
           filtered_items
         },
-        :'end-date' => proc { |values, operator, items|
+        :"end-date" => proc { |values, operator, items|
           end_date_ranges = values.map { |value|
             match = value.match(DATES_REGEX) ||
               (raise InputError,
@@ -396,7 +401,7 @@ module Reading
           filtered_items = items.map { |item|
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
-            if operator == :'!='
+            if operator == :"!="
               item_end_dates = item.experiences.map(&:last_end_date)
 
               next if item_end_dates.all? { |item_end_date|
@@ -468,7 +473,7 @@ module Reading
                 without_before_or_after
               }
               .compact
-            when :'!='
+            when :"!="
               split_item = item
 
               date_ranges.each do |date_range|
@@ -506,7 +511,7 @@ module Reading
               (raise InputError, "Experience count must be an integer")
           }
 
-          positive_operator = operator == :'!=' ? :== : operator
+          positive_operator = operator == :"!=" ? :== : operator
 
           matches = items.select { |item|
             experience_counts.any? { |experience_count|
@@ -514,19 +519,19 @@ module Reading
             }
           }
 
-          if operator == :'!='
+          if operator == :"!="
             matches = items - matches
           end
 
           matches
         },
         status: proc { |values, operator, items|
-          statuses = values.map { _1.squeeze(' ').gsub(' ', '_').to_sym }
+          statuses = values.map { _1.squeeze(" ").gsub(" ", "_").to_sym }
 
           filtered_items = items.map { |item|
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
-            if operator == :'!='
+            if operator == :"!="
               item_statuses = item.experiences.map(&:status).presence || [:planned]
 
               next unless (item_statuses - statuses).any?
@@ -550,7 +555,7 @@ module Reading
           filtered_items
         },
         genre: proc { |values, operator, items|
-          genres = values.map { _1 ? _1.split('+').map(&:strip) : [_1] }
+          genres = values.map { _1 ? _1.split("+").map(&:strip) : [_1] }
 
           matches = items.select { |item|
             genres.any? { |and_genres|
@@ -560,7 +565,7 @@ module Reading
             }
           }
 
-          if operator == :'!='
+          if operator == :"!="
             matches = items - matches
           end
 
@@ -578,7 +583,7 @@ module Reading
           filtered_items = items.map { |item|
             # Treat empty variants as if they were a variant with a nil length.
             if item.variants.empty?
-              if operator == :'!='
+              if operator == :"!="
                 next item unless lengths.include?(nil)
               else
                 next item if lengths.include?(nil)
@@ -587,7 +592,7 @@ module Reading
 
             # Ensure multiple values after a negative operator have an "and"
             # relation: "not(x and y)", rather than "not(x or y)".
-            if operator == :'!='
+            if operator == :"!="
               item_lengths = item.variants.map(&:length)
 
               next if (item_lengths - lengths).empty?
@@ -609,13 +614,13 @@ module Reading
         note: proc { |values, operator, items|
           notes = values
             .map { _1.downcase if _1 }
-            .map { _1.gsub(/[^a-zA-Z0-9 ]/, '') if _1 }
+            .map { _1.gsub(/[^a-zA-Z0-9 ]/, "") if _1 }
 
           matches = items.select { |item|
             item.notes.any? { |original_note|
               note = original_note
                 .downcase
-                .gsub(/[^a-zA-Z0-9 ]/, '')
+                .gsub(/[^a-zA-Z0-9 ]/, "")
 
               if %i[include? exclude?].include? operator
                 notes.any? { _1.nil? ? note == _1 : note.include?(_1) }
@@ -635,11 +640,10 @@ module Reading
 
       NUMERIC_OPERATORS = {
         rating: true,
-        done: true,
         progress: true,
         experience: true,
         date: true,
-        :'end-date' => true,
+        :"end-date" => true,
         length: true,
       }
 
@@ -650,18 +654,18 @@ module Reading
       }
 
       PROHIBIT_NONE_VALUE = {
-        done: true,
+        progress: true,
         title: true,
-        :'end-date' => true,
+        :"end-date" => true,
         date: true,
         experience: true,
         status: true,
       }
 
       PROHIBIT_MULTIPLE_VALUES_AFTER_NOT = {
-        done: true,
+        progress: true,
         title: true,
-        :'end-date' => true,
+        :"end-date" => true,
         date: true,
         experience: true,
         status: true,
@@ -699,20 +703,20 @@ module Reading
 
         unless allowed_operators.include? operator_str
           raise InputError, "Operator \"#{operator_str}\" not allowed in the " \
-            "\"#{key}\" filter, only #{allowed_operators.join(', ')} allowed"
+            "\"#{key}\" filter, only #{allowed_operators.join(", ")} allowed"
         end
 
         operator = operator_str.to_sym
-        operator = :== if operator == :'='
+        operator = :== if operator == :"="
         operator = :include? if operator == :~
-        operator = :exclude? if operator == :'!~'
+        operator = :exclude? if operator == :"!~"
 
         values = predicate
-          .split(',')
+          .split(",")
           .map(&:strip)
-          .map { _1.downcase == 'none' ? nil : _1 }
+          .map { _1.downcase == "none" ? nil : _1 }
 
-        # if values.count > 1 && operator == :'!=' && PROHIBIT_MULTIPLE_VALUES_AFTER_NOT[key]
+        # if values.count > 1 && operator == :"!=" && PROHIBIT_MULTIPLE_VALUES_AFTER_NOT[key]
         # end
 
         if values.count > 1 && %i[> < >= <=].include?(operator)

data/lib/reading/stats/grouping.rb

@@ -16,10 +16,10 @@ module Reading
 
         if match
           group_names = match[:groups]
-            .split(',')
+            .split(",")
             .tap { _1.last.sub!(/(\w)\s+\w+/, '\1') }
             .map(&:strip)
-            .map { _1.delete_suffix('s') }
+            .map { _1.delete_suffix("s") }
             .map(&:to_sym)
 
           if group_names.uniq.count < group_names.count

data/lib/reading/stats/operation.rb

@@ -1,3 +1,5 @@
+require "bigdecimal/util"
+
 module Reading
   module Stats
     # The beginning of a query which specifies what it does, e.g.
@@ -115,96 +117,145 @@ module Reading
           items.sum { |item|
             item.experiences.sum { |experience|
               experience.spans.sum { |span|
-                (span.amount * span.progress).to_i_if_whole
+                (span.amount * (span.progress || 0.0)).to_i_if_whole
               }
             }
           }
         },
         top_rating: proc { |items, number_arg|
           items
-            .max_by(number_arg || DEFAULT_NUMBER_ARG) { _1.rating || 0}
             .map { |item| [author_and_title(item), item.rating] }
+            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, rating|
+              rating || 0
+            }
         },
         top_length: proc { |items, number_arg|
           items
             .map { |item|
-              [
-                author_and_title(item),
-                # Longest length, or if undefined length then longest experience
-                # (code adapted from top_amount below).
-                item.variants.map(&:length).max ||
-                  item.experiences.map { |experience|
-                    experience.spans.sum { |span|
-                      (span.amount * span.progress).to_i_if_whole
-                    }
-                  }.max,
-              ]
+              # Longest length, or if undefined length then longest experience
+              # (code adapted from top_amount below).
+              length = item.variants.map(&:length).max ||
+                item.experiences.map { |experience|
+                  experience.spans.sum { |span|
+                    (span.amount * (span.progress || 0.0)).to_i_if_whole
+                  }
+                }.max
+
+              [author_and_title(item), length]
             }
             .reject { |_title, length| length.nil? }
-            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, length| length }
+            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, length|
+              length
+            }
         },
         top_amount: proc { |items, number_arg|
           items
             .map { |item|
               amount = item.experiences.sum { |experience|
                 experience.spans.sum { |span|
-                  (span.amount * span.progress).to_i_if_whole
+                  (span.amount * (span.progress || 0.0)).to_i_if_whole
                 }
               }
 
               [author_and_title(item), amount]
             }
             .reject { |_title, amount| amount.zero? }
-            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, amount| amount }
+            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, amount|
+              amount
+            }
         },
         top_speed: proc { |items, number_arg|
           items
-            .map { |item| calculate_speed(item) }
+            .map { |item|
+              speed = calculate_speed(item)
+              [author_and_title(item), speed] if speed
+            }
             .compact
             .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, speed_hash|
               speed_hash[:amount] / speed_hash[:days].to_f
             }
         },
+        top_experience: proc { |items, number_arg|
+          items
+            .map { |item|
+              experience_count = item
+                .experiences
+                .count { |experience|
+                  experience.spans.all? { _1.progress.to_d == "1.0".to_d }
+                }
+
+              [author_and_title(item), [experience_count, item.rating || 0]]
+            }
+            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, experience_count_and_rating|
+              experience_count_and_rating
+            }
+            .map { |title, (experience_count, _rating)|
+              [title, experience_count]
+            }
+        },
+        top_note: proc { |items, number_arg|
+          items
+            .map { |item|
+              notes_word_count = item
+                .notes
+                .sum { |note|
+                  note.content.scan(/[\w[:punct:]]+/).count
+                }
+
+              [author_and_title(item), notes_word_count]
+            }
+            .max_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, notes_word_count|
+              notes_word_count
+            }
+        },
         bottom_rating: proc { |items, number_arg|
           items
-            .min_by(number_arg || DEFAULT_NUMBER_ARG) { _1.rating || 0}
             .map { |item| [author_and_title(item), item.rating] }
+            .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, rating|
+              rating || 0
+            }
         },
         bottom_length: proc { |items, number_arg|
           items
             .map { |item|
-              [
-                author_and_title(item),
-                # Longest length, or if undefined length then longest experience
-                # (code adapted from bottom_amount below).
-                item.variants.map(&:length).max ||
-                  item.experiences.map { |experience|
-                    experience.spans.sum { |span|
-                      (span.amount * span.progress).to_i_if_whole
-                    }
-                  }.max,
-              ]
+              # Longest length, or if undefined length then longest experience
+              # (code adapted from bottom_amount below).
+              length = item.variants.map(&:length).max ||
+                item.experiences.map { |experience|
+                  experience.spans.sum { |span|
+                    (span.amount * (span.progress || 0.0)).to_i_if_whole
+                  }
+                }.max
+
+              [author_and_title(item), length]
             }
             .reject { |_title, length| length.nil? }
-            .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, length| length }
+            .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, length|
+              length
+            }
         },
         bottom_amount: proc { |items, number_arg|
           items
             .map { |item|
               amount = item.experiences.sum { |experience|
                 experience.spans.sum { |span|
-                  (span.amount * span.progress).to_i_if_whole
+                  (span.amount * (span.progress || 0.0)).to_i_if_whole
                 }
               }
 
               [author_and_title(item), amount]
             }
             .reject { |_title, amount| amount.zero? }
-            .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, amount| amount }
+            .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, amount|
+              amount
+            }
         },
         bottom_speed: proc { |items, number_arg|
           items
-            .map { |item| calculate_speed(item) }
+            .map { |item|
+              speed = calculate_speed(item)
+              [author_and_title(item), speed] if speed
+            }
             .compact
             .min_by(number_arg || DEFAULT_NUMBER_ARG) { |_title, speed_hash|
               speed_hash[:amount] / speed_hash[:days].to_f
@@ -227,6 +278,8 @@ module Reading
         top_length: %w[tl],
         top_amount: %w[ta],
         top_speed: %w[ts],
+        top_experience: %w[te],
+        top_note: %w[tn],
         bottom_rating: %w[br],
         bottom_length: %w[bl],
         bottom_amount: %w[ba],
@@ -235,7 +288,7 @@ module Reading
       }
 
       REGEXES = ACTIONS.map { |key, _action|
-        first_word, second_word = key.to_s.split('_')
+        first_word, second_word = key.to_s.split("_")
         aliases = ALIASES.fetch(key)
 
         regex =
@@ -260,7 +313,7 @@ module Reading
             (
               \A
               \s*
-              (#{aliases.join('|')})
+              (#{aliases.join("|")})
               s?
               \s*
               (?<number_arg>
@@ -328,10 +381,7 @@ module Reading
 
         return nil unless speeds.any?
 
-        speed = speeds
-          .max_by { |hash| hash[:amount] / hash[:days].to_f }
-
-        [author_and_title(item), speed]
+        speeds.max_by { |hash| hash[:amount] / hash[:days].to_f }
       end
 
       # A shorter version of Item::View#name.

data/lib/reading/stats/query.rb

@@ -1,7 +1,8 @@
-require 'pastel'
-require_relative 'operation'
-require_relative 'filter'
-require_relative 'grouping'
+require "pastel"
+require_relative "operation"
+require_relative "filter"
+require_relative "grouping"
+require_relative "result_formatters"
 
 module Reading
   module Stats
@@ -13,9 +14,8 @@ module Reading
       # @param items [Array<Item>] the Items to be queried.
       # @param result_formatters [Boolean, Hash{Symbol => Proc}] to alter the
       #   appearance of results; keys should be from among the keys of
-      #   Operation::ACTIONS. Pre-made formatters for terminal output are in
-      #   terminal_result_formatters.rb.
-      def initialize(input:, items:, result_formatters: {})
+      #   Operation::ACTIONS. Pre-made formatters are in result_formatters.rb.
+      def initialize(input:, items:, result_formatters: Reading::Stats::ResultFormatters::TRUNCATED_TITLES)
         @input = input
         @items = items
         @result_formatters = result_formatters

data/lib/reading/stats/result_formatters.rb

@@ -0,0 +1,140 @@
+require "pastel"
+
+module Reading
+  module Stats
+    module ResultFormatters
+      TRUNCATED_TITLES = {
+        top_length: ->(result) { with_truncated_title(result) },
+        top_amount: ->(result) { with_truncated_title(result) },
+        top_speed: ->(result) { with_truncated_title(result) },
+        top_experience: ->(result) { with_truncated_title(result) },
+        top_note: ->(result) { with_truncated_title(result) },
+        bottom_length: ->(result) { with_truncated_title(result) },
+        botom_amount: ->(result) { with_truncated_title(result) },
+        bottom_speed: ->(result) { with_truncated_title(result) },
+      }
+
+      TERMINAL = {
+        average_length: ->(result) { length_to_s(result) },
+        average_amount: ->(result) { length_to_s(result) },
+        :"average_daily-amount" => ->(result) { "#{length_to_s(result)} per day" },
+        total_item: ->(result) {
+          if result.zero?
+            PASTEL.bright_black("none")
+          else
+            color("#{result} #{result == 1 ? "item" : "items"}")
+          end
+        },
+        total_amount: ->(result) { length_to_s(result) },
+        top_rating: ->(result) { top_or_bottom_numbers_string(result, noun: "star") },
+        top_length: ->(result) { top_or_bottom_lengths_string(result) },
+        top_amount: ->(result) { top_or_bottom_lengths_string(result) },
+        top_speed: ->(result) { top_or_bottom_speeds_string(result) },
+        top_experience: ->(result) { top_or_bottom_numbers_string(result, noun: "experience") },
+        top_note: ->(result) { top_or_bottom_numbers_string(result, noun: "word") },
+        bottom_rating: ->(result) { top_or_bottom_numbers_string(result, noun: "star") },
+        bottom_length: ->(result) { top_or_bottom_lengths_string(result) },
+        botom_amount: ->(result) { top_or_bottom_lengths_string(result) },
+        bottom_speed: ->(result) { top_or_bottom_speeds_string(result) },
+      }
+
+      private
+
+      PASTEL = Pastel.new
+
+      # Applies a terminal color.
+      # @param string [String]
+      # @return [String]
+      private_class_method def self.color(string)
+        PASTEL.bright_blue(string)
+      end
+
+      # Converts a length/amount (pages or time) into a string.
+      # @param length [Numeric, Reading::Item::TimeLength]
+      # @param color [Boolean] whether a terminal color should be applied.
+      # @return [String]
+      private_class_method def self.length_to_s(length, color: true)
+        if length.is_a?(Numeric)
+          length_string = "#{length.round} pages"
+        else
+          length_string = length.to_s
+        end
+
+        color ? color(length_string) : length_string
+      end
+
+      # Formats a list of top/bottom length results as a string.
+      # @param result [Array]
+      # @return [String]
+      private_class_method def self.top_or_bottom_lengths_string(result)
+        offset = result.count.digits.count
+
+        result
+          .map.with_index { |(title, length), index|
+            pad = " " * (offset - (index + 1).digits.count)
+
+            title_line = "#{index + 1}. #{pad}#{title}"
+            indent = "    #{" " * offset}"
+
+            "#{title_line}\n#{indent}#{length_to_s(length)}"
+          }
+          .join("\n")
+      end
+
+      # Formats a list of top/bottom speed results as a string.
+      # @param result [Array]
+      # @return [String]
+      private_class_method def self.top_or_bottom_speeds_string(result)
+        offset = result.count.digits.count
+
+        result
+          .map.with_index { |(title, hash), index|
+            amount = length_to_s(hash[:amount], color: false)
+            days = "#{hash[:days]} #{hash[:days] == 1 ? "day" : "days"}"
+            pad = " " * (offset - (index + 1).digits.count)
+
+            title_line = "#{index + 1}. #{pad}#{title}"
+            indent = "    #{" " * offset}"
+            colored_speed = color("#{amount} in #{days}")
+
+            "#{title_line}\n#{indent}#{colored_speed}"
+          }
+          .join("\n")
+      end
+
+      # Formats a list of top/bottom number results as a string.
+      private_class_method def self.top_or_bottom_numbers_string(result, noun:)
+        offset = result.count.digits.count
+
+        result
+          .map.with_index { |(title, number), index|
+            pad = " " * (offset - (index + 1).digits.count)
+
+            title_line = "#{index + 1}. #{pad}#{title}"
+            indent = "    #{" " * offset}"
+            number_string = color("#{number} #{number == 1 ? noun : "#{noun}s"}")
+
+            "#{title_line}\n#{indent}#{number_string}"
+          }
+          .join("\n")
+      end
+
+      # Truncates the title of each result to a specified length.
+      # @param result [Array]
+      # @param length [Integer] the maximum length of the title.
+      # @return [Array]
+      private_class_method def self.with_truncated_title(result, length: 45)
+        result.map do |title, value|
+          truncated_title =
+            if title.length + 1 > length
+              "#{title[0...length]}…"
+            else
+              title
+            end
+
+          [truncated_title, value]
+        end
+      end
+    end
+  end
+end

data/lib/reading/version.rb

@@ -1,3 +1,3 @@
 module Reading
-  VERSION = '0.9.1'
+  VERSION = "1.0.0"
 end

data/lib/reading.rb

@@ -1,10 +1,10 @@
-Dir[File.join(__dir__, 'reading', 'util', '*.rb')].each { |file| require file }
-require_relative 'reading/errors'
-require_relative 'reading/config'
-require_relative 'reading/parsing/csv'
-require_relative 'reading/filter'
-require_relative 'reading/stats/query'
-require_relative 'reading/item/time_length.rb'
+Dir[File.join(__dir__, "reading", "util", "*.rb")].each { |file| require file }
+require_relative "reading/errors"
+require_relative "reading/config"
+require_relative "reading/parsing/csv"
+require_relative "reading/filter"
+require_relative "reading/stats/query"
+require_relative "reading/item/time_length.rb"
 
 # The gem's public API. See https://github.com/fpsvogel/reading#usage
 #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reading
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Felipe Vogel
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -30,56 +29,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
@@ -108,21 +121,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
-description: 
+        version: '4.0'
 email:
 - fps.vogel@gmail.com
 executables:
@@ -173,7 +199,7 @@ files:
 - lib/reading/stats/grouping.rb
 - lib/reading/stats/operation.rb
 - lib/reading/stats/query.rb
-- lib/reading/stats/terminal_result_formatters.rb
+- lib/reading/stats/result_formatters.rb
 - lib/reading/util/blank.rb
 - lib/reading/util/exclude.rb
 - lib/reading/util/hash_array_deep_fetch.rb
@@ -190,7 +216,6 @@ metadata:
   homepage_uri: https://github.com/fpsvogel/reading
   source_code_uri: https://github.com/fpsvogel/reading
   changelog_uri: https://github.com/fpsvogel/reading/blob/main/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -198,15 +223,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Parses a CSV reading log.
 test_files: []

data/lib/reading/stats/terminal_result_formatters.rb

@@ -1,91 +0,0 @@
-require 'pastel'
-
-module Reading
-  module Stats
-    module ResultFormatters
-      TERMINAL = {
-        average_length: ->(result) { length_to_s(result) },
-        average_amount: ->(result) { length_to_s(result) },
-        :'average_daily-amount' => ->(result) { "#{length_to_s(result)} per day" },
-        total_item: ->(result) {
-          if result.zero?
-            PASTEL.bright_black("none")
-          else
-            color("#{result} #{result == 1 ? "item" : "items"}")
-          end
-        },
-        total_amount: ->(result) { length_to_s(result) },
-        top_length: ->(result) { top_or_bottom_lengths(result) },
-        top_amount: ->(result) { top_or_bottom_lengths(result) },
-        top_speed: ->(result) { top_or_bottom_speeds(result) },
-        bottom_length: ->(result) { top_or_bottom_lengths(result) },
-        botom_amount: ->(result) { top_or_bottom_lengths(result) },
-        bottom_speed: ->(result) { top_or_bottom_speeds(result) },
-      }
-
-      private
-
-      PASTEL = Pastel.new
-
-      # Applies a terminal color.
-      # @param string [String]
-      # @return [String]
-      private_class_method def self.color(string)
-        PASTEL.bright_blue(string)
-      end
-
-      # Converts a length/amount (pages or time) into a string.
-      # @param length [Numeric, Reading::Item::TimeLength]
-      # @param color [Boolean] whether a terminal color should be applied.
-      # @return [String]
-      private_class_method def self.length_to_s(length, color: true)
-        if length.is_a?(Numeric)
-          length_string = "#{length.round} pages"
-        else
-          length_string = length.to_s
-        end
-
-        color ? color(length_string) : length_string
-      end
-
-      # Formats a list of top/bottom length results as a string.
-      # @param result [Array]
-      # @return [String]
-      private_class_method def self.top_or_bottom_lengths(result)
-        offset = result.count.digits.count
-
-        result
-          .map.with_index { |(title, length), index|
-            pad = ' ' * (offset - (index + 1).digits.count)
-
-            title_line = "#{index + 1}. #{pad}#{title}"
-            indent = "    #{' ' * offset}"
-
-            "#{title_line}\n#{indent}#{length_to_s(length)}"
-          }
-          .join("\n")
-      end
-
-      # Formats a list of top/bottom speed results as a string.
-      # @param result [Array]
-      # @return [String]
-      private_class_method def self.top_or_bottom_speeds(result)
-        offset = result.count.digits.count
-
-        result
-          .map.with_index { |(title, hash), index|
-            amount = length_to_s(hash[:amount], color: false)
-            days = "#{hash[:days]} #{hash[:days] == 1 ? "day" : "days"}"
-            pad = ' ' * (offset - (index + 1).digits.count)
-
-            title_line = "#{index + 1}. #{pad}#{title}"
-            indent = "    #{' ' * offset}"
-            colored_speed = color("#{amount} in #{days}")
-
-            "#{title_line}\n#{indent}#{colored_speed}"
-          }
-          .join("\n")
-      end
-    end
-  end
-end