reading 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2895207e57d29e0056fac8eca5ddecf39853916bb3691df1c6adb2d657d9c709
-  data.tar.gz: 115aa06d704b41f03aeaf8b39fcfcc2bc4dc3f3ee49c232e644903a5b098bd8c
+  metadata.gz: 4bf09fbcc2e77924a371eade404c83ad4fd5c3d7576eac45d0c1236c3db479f6
+  data.tar.gz: f854509f8ae88553df964428d18098fceeb3c885093728c2f54bba530199c8cb
 SHA512:
-  metadata.gz: 865dd1537a65a89e253f8b98ad82e6e15e3f21bd76467db5c06297575004ecc9f5a63cf766c339e61b143c478c1a2e7a6873bd370a57ef609469b070e243214f
-  data.tar.gz: 4ca3fe68262114c9791973c9b843fe2c33c6f96d99f0e2566f58ac5ca97c3196a772f84eaebc2db5665010ef11aa10d500f430a4496ab7b204cc8554f8826312
+  metadata.gz: a285b194b566697bd586628d1266ed5582e1cfab48dc3023e243635e4b21b3f31f100cf4b41a1777358b70175c15a8b2d57d7589859697c917e1914f452e492e
+  data.tar.gz: 6aa82f83175a22cd652b545aa46935ba5ef72009d33b8bbcd35a6667e1c2081cbe708fce40703503027aaf5938c5020a475fea9575d6e5d45fe75bef49233b4e

data/lib/reading/item/time_length.rb

@@ -2,7 +2,7 @@ module Reading
   class Item
     # The length of an item when it is a time, as opposed to pages. (Pages are
     # represented simply with an Integer or Float.)
-    class Item::TimeLength
+    class TimeLength
       include Comparable
 
       attr_reader :value # in total minutes
@@ -12,17 +12,17 @@ module Reading
         @value = value
       end
 
-      # Builds an Item::TimeLength from a string.
+      # Builds a TimeLength from a string.
       # @param string [String] a time duration in "h:mm" format.
       # @return [TimeLength, nil]
       def self.parse(string)
-        return nil unless string.match? /\A\d+:\d\d\z/
+        return nil unless string.match?(/\A\d+:\d\d\z/)
 
         hours, minutes = string.split(":").map(&:to_i)
         new((hours * 60) + minutes)
       end
 
-      # Builds an Item::TimeLength based on a page count.
+      # Builds a TimeLength based on a page count.
       # @param pages [Integer, Float]
       # @return [TimeLength]
       def self.from_pages(pages)
@@ -99,24 +99,24 @@ module Reading
       # @param other [TimeLength, Numeric]
       # @return [TimeLength]
       def +(other)
-        if other.is_a? Item::TimeLength
+        if other.is_a? TimeLength
           self.class.new(value + other.value)
         elsif other.is_a? Numeric
           self.class.new(value + self.class.pages_to_minutes(other))
         else
-          raise TypeError, "#{other.class} can't be added to Item::TimeLength."
+          raise TypeError, "#{other.class} can't be added to TimeLength."
         end
       end
 
       # @param other [TimeLength, Numeric]
       # @return [TimeLength]
       def -(other)
-        if other.is_a? Item::TimeLength
+        if other.is_a? TimeLength
           self.class.new(value - other.value)
         elsif other.is_a? Numeric
           self.class.new(value - self.class.pages_to_minutes(other))
         else
-          raise TypeError, "#{other.class} can't be subtracted from Item::TimeLength."
+          raise TypeError, "#{other.class} can't be subtracted from TimeLength."
         end
       end
 
@@ -140,6 +140,17 @@ module Reading
         end
       end
 
+      # For relativizing progress to a percentage of amount.
+      # @param other [TimeLength, Numeric]
+      # @return [TimeLength]
+      def percentage_of(other)
+        if other.is_a? TimeLength
+          value.to_f / other.value
+        else
+          raise TypeError, "TimeLength can't be percent-divided by #{other.class}."
+        end
+      end
+
       # See https://web.archive.org/web/20221206095821/https://www.mutuallyhuman.com/blog/class-coercion-in-ruby/
       # @param other [Numeric]
       def coerce(other)
@@ -159,7 +170,7 @@ module Reading
           other = self.class.from_pages(other)
         end
 
-        unless other.is_a? Item::TimeLength
+        unless other.is_a? TimeLength
           raise TypeError, "TimeLength can't be compared to #{other.class} #{other}."
         end
 

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

@@ -90,14 +90,28 @@ module Reading
               Attributes::Shared.length(parsed_row[:length], format:)
             no_end_date = !dates.end if dates &&
               Config.hash.fetch(:enabled_columns).include?(:end_dates)
+            progress = Attributes::Shared.progress(start_entry, no_end_date:) ||
+              Attributes::Shared.progress(parsed_row[:head][head_index]) ||
+              (1.0 if end_entry)
+            amount =
+              if dates && length
+                length
+              elsif !progress.is_a?(Float)
+                progress
+              end
+
+            # Change progress from absolute to relative (percentage) if amount is given.
+            if amount && progress && !progress.is_a?(Float)
+              amount_time = amount.is_a?(Item::TimeLength) ? amount : Item::TimeLength.from_pages(amount)
+              progress_time = progress.is_a?(Item::TimeLength) ? progress : Item::TimeLength.from_pages(progress)
+              progress = progress_time.percentage_of(amount_time)
+            end
 
             [
               {
-                dates: dates,
-                amount: (length if dates),
-                progress: Attributes::Shared.progress(start_entry, no_end_date:) ||
-                  Attributes::Shared.progress(parsed_row[:head][head_index]) ||
-                  (1.0 if end_entry),
+                dates:,
+                amount:,
+                progress:,
                 name: span_template.fetch(:name),
                 favorite?: span_template.fetch(:favorite?),
               }.map { |k, v| [k, v || span_template.fetch(k)] }.to_h

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

@@ -212,15 +212,22 @@ module Reading
             # is when tracking fixed-length items such as books. See
             # https://github.com/fpsvogel/reading/blob/main/doc/csv-format.md#history-pages-and-stopping-points-books
             if !amount && progress
-              if progress.is_a? Float
+              if progress.is_a?(Float)
                 total_length = Attributes::Shared.length(parsed_row[:length], format:)
-                amount = total_length * progress
+                amount = total_length * progress if total_length
               else
                 amount = progress
               end
               amount_from_progress = true
             end
 
+            # Change progress from absolute to relative (percentage) if amount is given.
+            if amount && progress && !progress.is_a?(Float)
+              amount_time = amount.is_a?(Item::TimeLength) ? amount : Item::TimeLength.from_pages(amount)
+              progress_time = progress.is_a?(Item::TimeLength) ? progress : Item::TimeLength.from_pages(progress)
+              progress = progress_time.percentage_of(amount_time)
+            end
+
             repetitions = entry[:repetitions]&.to_i
             frequency = entry[:frequency]
 

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

@@ -16,7 +16,7 @@ module Reading
           hash[:progress_percent]&.to_f&./(100) ||
             hash[:progress_pages]&.to_i ||
             hash[:progress_time]&.then { Item::TimeLength.parse(_1) } ||
-            (0 if hash[:progress_dnf]) ||
+            (0.0 if hash[:progress_dnf]) ||
             (1.0 if hash[:progress_done]) ||
             (0.0 if no_end_date) ||
             nil

data/lib/reading/version.rb

@@ -1,3 +1,3 @@
 module Reading
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

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