reading 0.6.0 → 0.7.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reading
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Felipe Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -28,119 +28,136 @@ dependencies:
   name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.18'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: pretty-diffs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
 description: 
 email:
 - fps.vogel@gmail.com
 executables:
 - reading
+- readingfile
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/reading
-- lib/reading/attribute/all_attributes.rb
-- lib/reading/attribute/attribute.rb
-- lib/reading/attribute/experiences/dates_validator.rb
-- lib/reading/attribute/experiences/experiences_attribute.rb
-- lib/reading/attribute/experiences/progress_subattribute.rb
-- lib/reading/attribute/experiences/spans_subattribute.rb
-- lib/reading/attribute/variants/extra_info_subattribute.rb
-- lib/reading/attribute/variants/length_subattribute.rb
-- lib/reading/attribute/variants/series_subattribute.rb
-- lib/reading/attribute/variants/sources_subattribute.rb
-- lib/reading/attribute/variants/variants_attribute.rb
+- bin/readingfile
+- lib/reading.rb
 - lib/reading/config.rb
-- lib/reading/csv.rb
 - lib/reading/errors.rb
-- lib/reading/line.rb
-- lib/reading/row/blank_row.rb
-- lib/reading/row/compact_planned_row.rb
-- lib/reading/row/regular_row.rb
-- lib/reading/row/row.rb
+- lib/reading/item/time_length.rb
+- lib/reading/parsing/attributes/attribute.rb
+- lib/reading/parsing/attributes/author.rb
+- lib/reading/parsing/attributes/experiences.rb
+- lib/reading/parsing/attributes/experiences/dates_and_head_transformer.rb
+- lib/reading/parsing/attributes/experiences/history_transformer.rb
+- lib/reading/parsing/attributes/experiences/spans_validator.rb
+- lib/reading/parsing/attributes/genres.rb
+- lib/reading/parsing/attributes/notes.rb
+- lib/reading/parsing/attributes/rating.rb
+- lib/reading/parsing/attributes/shared.rb
+- lib/reading/parsing/attributes/title.rb
+- lib/reading/parsing/attributes/variants.rb
+- lib/reading/parsing/csv.rb
+- lib/reading/parsing/parser.rb
+- lib/reading/parsing/rows/column.rb
+- lib/reading/parsing/rows/comment.rb
+- lib/reading/parsing/rows/compact_planned.rb
+- lib/reading/parsing/rows/compact_planned_columns/head.rb
+- lib/reading/parsing/rows/regular.rb
+- lib/reading/parsing/rows/regular_columns/end_dates.rb
+- lib/reading/parsing/rows/regular_columns/genres.rb
+- lib/reading/parsing/rows/regular_columns/head.rb
+- lib/reading/parsing/rows/regular_columns/history.rb
+- lib/reading/parsing/rows/regular_columns/length.rb
+- lib/reading/parsing/rows/regular_columns/notes.rb
+- lib/reading/parsing/rows/regular_columns/rating.rb
+- lib/reading/parsing/rows/regular_columns/sources.rb
+- lib/reading/parsing/rows/regular_columns/start_dates.rb
+- lib/reading/parsing/transformer.rb
 - lib/reading/util/blank.rb
 - lib/reading/util/hash_array_deep_fetch.rb
 - lib/reading/util/hash_compact_by_template.rb
 - lib/reading/util/hash_deep_merge.rb
 - lib/reading/util/hash_to_struct.rb
+- lib/reading/util/numeric_to_i_if_whole.rb
 - lib/reading/util/string_remove.rb
 - lib/reading/util/string_truncate.rb
 - lib/reading/version.rb
@@ -167,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
-summary: reading parses a CSV reading log.
+summary: Parses a CSV reading log.
 test_files: []

data/lib/reading/attribute/all_attributes.rb

@@ -1,83 +0,0 @@
-require_relative "attribute"
-require_relative "variants/variants_attribute"
-require_relative "experiences/experiences_attribute"
-
-module Reading
-  class Row
-    using Util::StringRemove
-    using Util::HashArrayDeepFetch
-
-    # The simpler attributes are collected below. The more complex attributes
-    # are separated into their own files.
-
-    class RatingAttribute < Attribute
-      def parse
-        return nil unless columns[:rating]
-
-        rating = columns[:rating].strip
-        return nil if rating.empty?
-
-        Integer(rating, exception: false) ||
-          Float(rating, exception: false) ||
-          (raise InvalidRatingError, "Invalid rating")
-      end
-    end
-
-    class AuthorAttribute < Attribute
-      def parse
-        item_head
-          .remove(/\A#{config.deep_fetch(:csv, :regex, :formats)}/)
-          .match(/.+(?=#{config.deep_fetch(:csv, :short_separator)})/)
-          &.to_s
-          &.strip
-      end
-    end
-
-    class TitleAttribute < Attribute
-      def parse
-        if item_head.end_with?(config.deep_fetch(:csv, :short_separator).rstrip)
-          raise InvalidHeadError, "Missing title? Head column ends in a separator"
-        end
-
-        item_head
-          .remove(/\A#{config.deep_fetch(:csv, :regex, :formats)}/)
-          .remove(/.+#{config.deep_fetch(:csv, :short_separator)}/)
-          .remove(/#{config.deep_fetch(:csv, :long_separator)}.+\z/)
-          .strip
-          .presence || (raise InvalidHeadError, "Missing title")
-      end
-    end
-
-    class GenresAttribute < Attribute
-      def parse
-        return nil unless columns[:genres]
-
-        columns[:genres]
-          .split(config.deep_fetch(:csv, :separator))
-          .map(&:strip)
-          .map(&:downcase)
-          .map(&:presence)
-          .compact.presence
-      end
-    end
-
-    class NotesAttribute < Attribute
-      def parse
-        return nil unless columns[:public_notes]
-
-        columns[:public_notes]
-          .presence
-          &.chomp
-          &.remove(/#{config.deep_fetch(:csv, :long_separator).rstrip}\s*\z/)
-          &.split(config.deep_fetch(:csv, :long_separator))
-          &.map { |string|
-            {
-              blurb?: !!string.delete!(config.deep_fetch(:csv, :blurb_emoji)),
-              private?: !!string.delete!(config.deep_fetch(:csv, :private_emoji)),
-              content: string.strip,
-            }
-          }
-      end
-    end
-  end
-end

data/lib/reading/attribute/attribute.rb

@@ -1,25 +0,0 @@
-module Reading
-  class Row
-    # A base class that contains behaviors common to ___Attribute classes.
-    class Attribute
-      private attr_reader :item_head, :columns, :config
-
-      # @param item_head [String] see Row#item_heads for a definition.
-      # @param columns [Array<String>] the CSV row split into columns.
-      # @param config [Hash]
-      def initialize(item_head: nil, columns: nil, config:)
-        unless item_head || columns
-          raise ArgumentError, "Either item_head or columns must be given to an Attribute."
-        end
-
-        @item_head = item_head
-        @columns = columns
-        @config = config
-      end
-
-      def parse
-        raise NotImplementedError, "#{self.class} should have implemented #{__method__}"
-      end
-    end
-  end
-end

data/lib/reading/attribute/experiences/dates_validator.rb

@@ -1,94 +0,0 @@
-module Reading
-  # Methods to validate dates. This does not cover all the ways dates can be
-  # invalid, just the ones not covered by ExperiencesAttribute during parsing.
-  module DatesValidator
-    using Util::HashArrayDeepFetch
-
-    class << self
-      # Checks the dates in the given experiences hash, and raises an error at
-      # the first invalid date found.
-      # @param experiences [Array<Hash>]
-      # @param config [Hash]
-      def validate(experiences, config)
-        validate_dates_started_are_in_order(experiences) if dates_started_column?(config)
-        validate_dates_finished_are_in_order(experiences) if dates_finished_column?(config)
-        validate_experiences_of_same_variant_do_not_overlap(experiences) if both_date_columns?(config)
-        validate_spans_are_in_order_and_not_overlapping(experiences)
-      end
-
-      private
-
-      def dates_started_column?(config)
-        config.deep_fetch(:csv, :enabled_columns).include?(:dates_started)
-      end
-
-      def dates_finished_column?(config)
-        config.deep_fetch(:csv, :enabled_columns).include?(:dates_finished)
-      end
-
-      def both_date_columns?(config)
-        dates_started_column?(config) && dates_finished_column?(config)
-      end
-
-      def validate_dates_started_are_in_order(experiences)
-        experiences
-          .filter { |exp| exp[:spans].any? }
-          .map { |exp| exp[:spans].first[:dates].begin }
-          .each_cons(2) do |a, b|
-            if (a.nil? && b.nil?) || (a && b && a > b )
-              raise InvalidDateError, "Dates started are not in order"
-            end
-          end
-      end
-
-      def validate_dates_finished_are_in_order(experiences)
-        experiences
-          .filter { |exp| exp[:spans].any? }
-          .map { |exp| exp[:spans].last[:dates].end }
-          .each_cons(2) do |a, b|
-            if (a.nil? && b.nil?) || (a && b && a > b )
-              raise InvalidDateError, "Dates finished are not in order"
-            end
-          end
-      end
-
-      def validate_experiences_of_same_variant_do_not_overlap(experiences)
-        experiences
-          .group_by { |exp| exp[:variant_index] }
-          .each do |_variant_index, exps|
-            exps.filter { |exp| exp[:spans].any? }.each_cons(2) do |a, b|
-              a_metaspan = a[:spans].first[:dates].begin..a[:spans].last[:dates].end
-              b_metaspan = b[:spans].first[:dates].begin..b[:spans].last[:dates].end
-              if a_metaspan.cover?(b_metaspan.begin || a_metaspan.begin || a_metaspan.end) ||
-                  b_metaspan.cover?(a_metaspan.begin || b_metaspan.begin || b_metaspan.end)
-                raise InvalidDateError, "Experiences are overlapping"
-              end
-            end
-          end
-      end
-
-      def validate_spans_are_in_order_and_not_overlapping(experiences)
-        experiences
-          .filter { |exp| exp[:spans].any? }
-          .each do |exp|
-            exp[:spans]
-              .map { |span| span[:dates] }
-              .each do |dates|
-                if dates.begin && dates.end && dates.begin > dates.end
-                  raise InvalidDateError, "A date range is backward"
-                end
-              end
-              .each_cons(2) do |a, b|
-                if a.begin > b.begin || a.end > b.end
-                  raise InvalidDateError, "Dates are not in order"
-                end
-                if a.cover?(b.begin || a.begin || a.end) ||
-                    b.cover?(a.begin || b.begin || b.end)
-                  raise InvalidDateError, "Dates are overlapping"
-                end
-              end
-          end
-      end
-    end
-  end
-end

data/lib/reading/attribute/experiences/experiences_attribute.rb

@@ -1,74 +0,0 @@
-require_relative "spans_subattribute"
-require_relative "progress_subattribute"
-require_relative "dates_validator"
-require "date"
-
-module Reading
-  class Row
-    class ExperiencesAttribute < Attribute
-      using Util::HashArrayDeepFetch
-      using Util::HashDeepMerge
-
-      def parse
-        started, finished = dates_split(columns)
-
-        experiences_with_dates = started.map.with_index { |entry, i|
-          variant_index = variant_index(entry)
-          spans_attr = SpansSubattribute.new(date_entry: entry, dates_finished: finished, date_index: i, variant_index:, columns:, config:)
-
-          {
-            spans: spans_attr.parse                       || template.fetch(:spans),
-            group: group(entry)                           || template.fetch(:group),
-            variant_index: variant_index                  || template.fetch(:variant_index)
-          }
-        }.presence
-
-        if experiences_with_dates
-          # Raises an error if any sequence of dates does not make sense.
-          DatesValidator.validate(experiences_with_dates, config)
-
-          return experiences_with_dates
-        else
-          if prog = ProgressSubattribute.new(columns:, config:).parse_head
-            return [template.deep_merge(spans: [{ progress: prog }] )]
-          else
-            return nil
-          end
-        end
-      end
-
-      private
-
-      def template
-        @template ||= config.deep_fetch(:item, :template, :experiences).first
-      end
-
-      def dates_split(columns)
-        dates_finished = columns[:dates_finished]&.presence
-                          &.split(config.deep_fetch(:csv, :separator))&.map(&:strip) || []
-        # Don't use #has_key? because simply checking for nil covers the
-        # case where dates_started is the last column and omitted.
-        started_column_exists = columns[:dates_started]&.presence
-
-        dates_started =
-          if started_column_exists
-            columns[:dates_started]&.presence&.split(config.deep_fetch(:csv, :separator))&.map(&:strip)
-          else
-            [""] * dates_finished.count
-          end
-
-        [dates_started, dates_finished]
-      end
-
-      def group(entry)
-        entry.match(config.deep_fetch(:csv, :regex, :group_experience))&.captures&.first
-      end
-
-      def variant_index(date_entry)
-        match = date_entry.match(config.deep_fetch(:csv, :regex, :variant_index))
-
-        (match&.captures&.first&.to_i || 1) - 1
-      end
-    end
-  end
-end

data/lib/reading/attribute/experiences/progress_subattribute.rb

@@ -1,48 +0,0 @@
-module Reading
-  class Row
-    class ProgressSubattribute
-      using Util::HashArrayDeepFetch
-
-      private attr_reader :date_entry, :variant_index, :columns, :config
-
-      # @param date_entry [String] the entry in Dates Started.
-      # @param variant_index [Integer] the variant index, for getting length for default amount.
-      # @param columns [Array<String>]
-      # @param config [Hash]
-      def initialize(date_entry: nil, variant_index: nil, columns:, config:)
-        @date_entry = date_entry
-        @variant_index = variant_index
-        @columns = columns
-        @config = config
-      end
-
-      def parse
-        progress(date_entry) || progress(columns[:head])
-      end
-
-      def parse_head
-        progress(columns[:head])
-      end
-
-      private
-
-      def progress(str)
-        prog = str.match(config.deep_fetch(:csv, :regex, :progress))
-
-        if prog
-          if prog_percent = prog[:percent]&.to_i
-            return prog_percent / 100.0
-          elsif prog_time = prog[:time]
-            return prog_time
-          elsif prog_pages = prog[:pages]&.to_i
-            return prog_pages
-          end
-        end
-
-        dnf = str.match(config.deep_fetch(:csv, :regex, :dnf))&.captures&.first
-        return 0 if dnf
-        nil
-      end
-    end
-  end
-end

data/lib/reading/attribute/experiences/spans_subattribute.rb

@@ -1,82 +0,0 @@
-module Reading
-  class Row
-    class SpansSubattribute
-      using Util::HashArrayDeepFetch
-
-      private attr_reader :date_entry, :dates_finished, :date_index, :variant_index, :columns, :config
-
-      # @param date_entry [String] the entry in Dates Started.
-      # @param dates_finished [Array<String>] the entries in Dates Finished.
-      # @param date_index [Integer] the index of the entry.
-      # @param variant_index [Integer] the variant index, for getting length for default amount.
-      # @param columns [Array<String>]
-      # @param config [Hash]
-      def initialize(date_entry:, dates_finished:, date_index:, variant_index:, columns:, config:)
-        @date_entry = date_entry
-        @dates_finished = dates_finished
-        @date_index = date_index
-        @variant_index = variant_index
-        @columns = columns
-        @config = config
-      end
-
-      def parse
-        started = date_started(date_entry)
-        finished = date_finished(dates_finished, date_index)
-        return [] if started.nil? && finished.nil?
-
-        progress_attr = ProgressSubattribute.new(date_entry:, variant_index:, columns:, config:)
-        progress = progress_attr.parse
-
-        [{
-          dates: started..finished                || template.fetch(:dates),
-          amount: length                          || template.fetch(:amount),
-          progress: progress || (1.0 if finished) || template.fetch(:progress),
-          name:                                   template.fetch(:name),
-          favorite?:                              template.fetch(:favorite?),
-        }]
-      end
-
-      private
-
-      def template
-        @template ||= config.deep_fetch(:item, :template, :experiences, 0, :spans).first
-      end
-
-      def date_started(date_entry)
-        dates = date_entry.scan(config.deep_fetch(:csv, :regex, :date))
-        raise InvalidDateError, "Conjoined dates" if dates.count > 1
-        raise InvalidDateError, "Missing or incomplete date" if date_entry.present? && dates.empty?
-
-        date_str = dates.first
-        Date.parse(date_str) if date_str
-      rescue Date::Error
-        raise InvalidDateError, "Unparsable date"
-      end
-
-      def date_finished(dates_finished, date_index)
-        return nil if dates_finished.nil?
-
-        date_str = dates_finished[date_index]&.presence
-        Date.parse(date_str) if date_str
-      rescue Date::Error
-        if date_str.match?(config.deep_fetch(:csv, :regex, :date))
-          raise InvalidDateError, "Unparsable date"
-        else
-          raise InvalidDateError, "Missing or incomplete date"
-        end
-      end
-
-      def length
-        sources_str = columns[:sources]&.presence || " "
-        bare_variant = sources_str
-          .split(config.deep_fetch(:csv, :regex, :formats_split))
-          .dig(variant_index)
-          &.split(config.deep_fetch(:csv, :long_separator))
-          &.first
-        length_attr = LengthSubattribute.new(bare_variant:, columns:, config:)
-        length_attr.parse
-      end
-    end
-  end
-end

data/lib/reading/attribute/variants/extra_info_subattribute.rb

@@ -1,44 +0,0 @@
-module Reading
-  class Row
-    class ExtraInfoSubattribute
-      using Util::HashArrayDeepFetch
-
-      private attr_reader :item_head, :variant_with_extras, :config
-
-      # @param item_head [String] see Row#item_heads for a definition.
-      # @param variant_with_extras [String] the full variant string.
-      # @param config [Hash]
-      def initialize(item_head:, variant_with_extras: nil, config:)
-        @item_head = item_head
-        @variant_with_extras = variant_with_extras
-        @config = config
-      end
-
-      def parse
-        (
-          Array(extra_info(item_head)) +
-            Array(extra_info(variant_with_extras))
-        ).presence
-      end
-
-      def parse_head
-        extra_info(item_head)
-      end
-
-      private
-
-      def template
-        config.deep_fetch(:item, :template, :variants, 0, :series).first
-      end
-
-      def extra_info(str)
-        separated = str.split(config.deep_fetch(:csv, :long_separator))
-        separated.delete_at(0) # everything before the extra info
-        separated.reject { |str|
-          str.start_with?("#{config.deep_fetch(:csv, :series_prefix)} ") ||
-            str.match(config.deep_fetch(:csv, :regex, :series_volume))
-        }.presence
-      end
-    end
-  end
-end