reading 0.9.0 → 1.0.0

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/attributes/shared.rb

@@ -9,13 +9,16 @@ module Reading
         # Extracts the :progress sub-attribute (percent, pages, or time) from
         # the given hash.
         # @param hash [Hash] any parsed hash that contains progress.
+        # @param no_end_date [Boolean] for start and end dates (as opposed to
+        #   the History column), whether an end date is present.
         # @return [Float, Integer, Item::TimeLength]
-        def self.progress(hash)
+        def self.progress(hash, no_end_date: nil)
           hash[:progress_percent]&.to_f&./(100) ||
             hash[:progress_pages]&.to_i ||
             hash[:progress_time]&.then { Item::TimeLength.parse(_1) } ||
             (0 if hash[:progress_dnf]) ||
             (1.0 if hash[:progress_done]) ||
+            (0.0 if no_end_date) ||
             nil
         end
 

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/rows/regular_columns/sources.rb

@@ -91,7 +91,7 @@ module Reading
 
           private
 
-          ISBN_REGEX = /(\d{3}[-\s]?)?\d{10}/
+          ISBN_REGEX = /(\d{3}[-\s]?)?(\d{10}|\d{9}X)/
           ASIN_REGEX = /B0[A-Z\d]{8}/
         end
       end

data/lib/reading/parsing/rows/regular_columns/start_dates.rb

@@ -16,7 +16,11 @@ module Reading
                 (\s+|\z)
               )?
               (
-                (?<date>\d{4}/\d\d?/\d\d?)
+                (
+                  (?<date>\d{4}/\d\d?/\d\d?)
+                  |
+                  (?<planned>\?\?)
+                )
                 (\s+|\z)
               )?
               (

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
@@ -119,7 +119,9 @@ module Reading
               .compact
               .max
 
-            year_ranges = (begin_date.year..end_date.year).flat_map { |year|
+            end_year = [Date.today.year, end_date.year].min
+
+            year_ranges = (begin_date.year..end_year).flat_map { |year|
               beginning_of_year = Date.new(year, 1, 1)
               end_of_year = Date.new(year + 1, 1, 1).prev_day
 
@@ -191,7 +193,7 @@ module Reading
             groups
           end
         },
-        genre: proc { |items|
+        eachgenre: proc { |items|
           groups = Hash.new { |h, k| h[k] = [] }
 
           items.each do |item|
@@ -200,6 +202,18 @@ module Reading
 
           groups.sort.to_h
         },
+        genre: proc { |items|
+          groups = Hash.new { |h, k| h[k] = [] }
+
+          items.each do |item|
+            if item.genres.any?
+              genre_combination = item.genres.sort.join(", ")
+              groups[genre_combination] << item
+            end
+          end
+
+          groups.sort.to_h
+        },
         length: proc { |items|
           boundaries = Config.hash.fetch(:length_group_boundaries)