reading 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a081fbab3e05154fcd493884223c2eedcc0c60dd4be99d56f2373ef5689d337
-  data.tar.gz: e7f4dfef59413ce4ade78d2452193bec233482700cecee699655a1ea72a5e499
+  metadata.gz: cdad0247655e1e44060d3f939edc7ca5d9357d0eae4c845ad171a3320e8e2dea
+  data.tar.gz: 0a3545801b0dc6a5852cd4e48c77c3a70f980cebd8bbf25ee56127bc3881fbf1
 SHA512:
-  metadata.gz: 45e98e729dd0422b5e0e2abe014f8bab41190b5bd4d3df6969097a60c5738dace9c190bea8e82476c8de880a5d1c34772caf0d9957a975ce417c663190128b11
-  data.tar.gz: f5a9e4645ccc2b6b9a076197c1df92efb6f2219f51de1c7b8d746d08c98b4457aef143702cfabdf0b86eac4ac80bab56324814badae9bf739e56bcf4d49cd64f
+  metadata.gz: 573bccb558e477adec37c63d489975d076e9006590eda7ccaae1a5e733c096df6a152a799b67bbf1119409a4a4b0e19ba71a6b4bea4f3879a8edab331e67db37
+  data.tar.gz: f182929326660d98d72d56b46b290d8da12f216c77ba5eb9b373d9adb19e20693bb15d41bacfd70e4feef9ff12d700c615bf7f09ca3f06c92f71681c57cb724d

data/bin/reading

@@ -65,7 +65,7 @@ def run_query(file_path:, query:, enabled_columns_str:)
 
   items = Reading.parse(path: file_path, item_view: false, error_handler:)
   results = Reading.stats(
-    input: query,
+    query,
     items:,
     result_formatters: Reading::Stats::ResultFormatters::TERMINAL,
   )

data/lib/reading/filter.rb

@@ -72,7 +72,7 @@ module Reading
         return items unless minimum_previous_rating
 
         items.select! do |item|
-          max_previous_rating = item.notes.map { it.rating_change.first }.compact.max
+          max_previous_rating = item.notes.reject(&:private?).map { it.rating_change.first }.compact.max
           max_previous_rating && max_previous_rating >= minimum_previous_rating &&
             item.rating && item.rating < minimum_previous_rating
         end

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

@@ -17,6 +17,7 @@ module Reading
               content: note[:content],
             }
           }.then { distribute_dates_to_rating_changes!(it, parsed_row) }
+          .then { capitalize_content_of_rating_changes!(it, parsed_row) }
         end
 
         private
@@ -48,6 +49,15 @@ module Reading
             note[:date] = last_experience[:spans].last[:dates]&.end || last_experience[:spans].first[:dates]&.begin
           end
         end
+
+        def capitalize_content_of_rating_changes!(transformed_notes, parsed_row)
+          return unless transformed_notes
+
+          transformed_notes.each do |note|
+            next if note[:rating_change].empty? || note[:content].nil?
+            note[:content].capitalize!
+          end
+        end
       end
     end
   end

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

@@ -5,19 +5,31 @@ module Reading
         # See https://github.com/fpsvogel/reading/blob/main/doc/csv-format.md#notes-column
         # and https://github.com/fpsvogel/reading/blob/main/doc/csv-format.md#notes-column-special-notes
         class Notes < Column
+          RATING_CHANGED_WORDS = %w[
+            changed
+            updated
+            revised
+            downgraded
+            demoted
+            lowered
+            upgraded
+            promoted
+            raised
+          ]
+
           def self.segment_separator
             /\s*--\s*/
           end
 
           def self.regexes(segment_index)
             [%r{\A
-              (?:(?<blurb>💬)|(?<private>🔒))?
+              (?:(?<blurb>💬)|(?<private>🔒))?\s*
               (?<date>\d{4}/\d\d?/\d\d?)?:?\s*
               (?:
                 (?:
-                  (?:downgraded|upgraded|updated|changed)?\s*rating
+                  (?:#{RATING_CHANGED_WORDS.join("|")})?\s*rating
                   |
-                  rating\s*(?:downgraded|upgraded|updated|changed)?
+                  rating\s*(?:#{RATING_CHANGED_WORDS.join("|")})?
                 )?
                 (?:\s+from\s+)?
                 (?:

data/lib/reading/stats/filter.rb

@@ -113,7 +113,7 @@ module Reading
           positive_operator = operator == :"!=" ? :== : operator
 
           matches = items.select { |item|
-            actual_previous_ratings = item.notes.map { it.rating_change.first }.compact
+            actual_previous_ratings = item.notes.reject(&:private?).map { it.rating_change.first }.compact
 
             previous_ratings.any? { |previous_rating|
               if !actual_previous_ratings.empty? || %i[== !=].include?(operator)
@@ -140,24 +140,34 @@ module Reading
               (raise InputError, "Progress must be a percentage")
           }
 
+          # Also implemented in Stats::Operation::ACTIONS[:average_progress]
+          calculate_progress = lambda { |item, experience|
+            amount = experience.spans.sum { |span|
+              span.amount * (span.progress || 0.0)
+            }.to_i
+            length = item.variants[experience.variant_index].length
+            return nil unless length
+            amount.to_f / length.to_i
+          }
+
           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_progresses = item.experiences.map { |experience|
-                experience.spans.last.progress || 0.0
-              }
+                calculate_progress.call(item, experience)
+              }.compact
 
               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|
               progresses.any? { |progress|
-                experience.spans.any? &&
-                  (experience.spans.last.progress || 0.0).send(operator, progress)
+                next if experience.spans.empty?
+                item_progress = calculate_progress.call(item, experience)
+                next unless item_progress
+                item_progress.send(operator, progress)
               }
             }
 

data/lib/reading/stats/operation.rb

@@ -107,6 +107,22 @@ module Reading
             amounts_by_date.values.sum / amounts_by_date.count
           end
         },
+        average_progress: proc { |items|
+          experiences_with_progress = 0
+          total_progress = items.sum { |item|
+            item.experiences.sum { |experience|
+              amount = experience.spans.sum { |span|
+                span.amount * (span.progress || 0.0)
+              }.to_i
+              length = item.variants[experience.variant_index].length
+              next 0 unless length
+              experiences_with_progress += 1
+              amount.to_f / length.to_i
+            }
+          }
+
+          total_progress / experiences_with_progress
+        },
         list_item: proc { |items|
           items.map { |item| author_and_title(item) }
         },
@@ -269,8 +285,9 @@ module Reading
       ALIASES = {
         average_rating: %w[ar],
         average_length: %w[al],
-        average_amount: %w[aia ai],
+        average_amount: %w[aa],
         :"average_daily-amount" => %w[ada ad],
+        average_progress: %w[ap],
         list_item: %w[li list],
         total_item: %w[item count],
         total_amount: %w[amount],

data/lib/reading/stats/query.rb

@@ -15,7 +15,7 @@ module Reading
       # @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 are in result_formatters.rb.
-      def initialize(input:, items:, result_formatters: Reading::Stats::ResultFormatters::TRUNCATED_TITLES)
+      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

@@ -18,6 +18,7 @@ module Reading
         average_length: ->(result) { length_to_s(result) },
         average_amount: ->(result) { length_to_s(result) },
         :"average_daily-amount" => ->(result) { "#{length_to_s(result)} per day" },
+        average_progress: ->(result) { "#{(result * 100).round(1)}%" },
         total_item: ->(result) {
           if result.zero?
             "none"
@@ -106,4 +107,4 @@ module Reading
       end
     end
   end
-end
+end

data/lib/reading/version.rb

@@ -1,3 +1,3 @@
 module Reading
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reading
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Felipe Vogel