reading 0.6.1 → 0.8.0

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

@@ -0,0 +1,35 @@
+module Reading
+  module Parsing
+    module Rows
+      module Regular
+        # See https://github.com/fpsvogel/reading/blob/main/doc/csv-format.md#start-dates-and-end-dates-columns
+        class StartDates < Column
+          def self.segment_separator
+            /,\s*/
+          end
+
+          def self.regexes(segment_index)
+            # dnf/progress, date, variant number, group
+            [%r{\A
+              (
+                #{Column::SHARED_REGEXES[:progress]}
+                (\s+|\z)
+              )?
+              (
+                (?<date>\d{4}/\d\d?/\d\d?)
+                (\s+|\z)
+              )?
+              (
+                v(?<variant>\d)
+                (\s+|\z)
+              )?
+              (
+                🤝🏼(?<group>.+)
+              )?
+            \z}x]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reading/parsing/transformer.rb

@@ -0,0 +1,70 @@
+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
+    #
+    # Transforms an intermediate hash (parsed from a CSV row) into item data.
+    # While the intermediate hash mirrors the structure of a row, the output of
+    # Transformer is based around item attributes, which are listed in
+    # Config#default_config[:item][:template] and in the files in parsing/attributes.
+    #
+    class Transformer
+      using Util::HashArrayDeepFetch
+      using Util::HashCompactByTemplate
+
+      attr_reader :config
+      private attr_reader :attributes
+
+      # @param config [Hash] an entire config.
+      def initialize(config)
+        @config = config
+
+        set_attributes
+      end
+
+      # Transforms the intermediate hash of a row into item data.
+      # @param parsed_row [Hash{Symbol => Hash, Array}] output from
+      #   Parsing::Parser#parse_row_to_intermediate_hash.
+      # @return [Array<Hash>] an array of Hashes like the template in
+      #   Config#default_config[:item][:template].
+      def transform_intermediate_hash_to_item_hashes(parsed_row)
+        if parsed_row[:head].blank?
+          raise InvalidHeadError, "Blank or missing Head column"
+        end
+
+        template = config.deep_fetch(:item, :template)
+
+        parsed_row[:head].map.with_index { |_head, head_index|
+          template.map { |attribute_name, default_value|
+            attribute = attributes.fetch(attribute_name)
+            transformed_value = attribute.transform_from_parsed(parsed_row, head_index)
+
+            [attribute_name, transformed_value || default_value]
+          }.to_h
+          .compact_by(template:)
+        }
+      end
+
+      private
+
+      # Sets the attributes classes which do all the transforming work.
+      # See parsing/attributes/*.
+      def set_attributes
+        @attributes ||= config.deep_fetch(:item, :template).map { |attribute_name, _default|
+          attribute_name_camelcase = attribute_name.to_s.split("_").map(&:capitalize).join
+          attribute_class = Attributes.const_get(attribute_name_camelcase)
+
+          [attribute_name, attribute_class.new(config)]
+        }.to_h
+      end
+    end
+  end
+end

data/lib/reading/util/hash_compact_by_template.rb

@@ -9,6 +9,7 @@ module Reading
         # If no parsed data has been added to the template values for these, they
         # are considered blank, and are replaced with an empty array so that their
         # emptiness is more apparent, e.g. item[:experiences].empty? will return true.
+        # @return [Hash]
         def compact_by(template:)
           map { |key, val|
             if is_array_of_hashes?(val)

data/lib/reading/util/hash_deep_merge.rb

@@ -32,7 +32,7 @@ module Reading
                 end
               }
             elsif block_given?
-              block.call(key, this_val, other_val)
+              yield key, this_val, other_val
             else
               other_val
             end

data/lib/reading/util/hash_to_data.rb

@@ -0,0 +1,30 @@
+module Reading
+  module Util
+    # Converts a Hash to a Data. Converts inner hashes (and inner arrays of hashes) as well.
+    module HashToData
+      refine Hash do
+        # @return [Data]
+        def to_data
+          MEMOIZED_DATAS[keys] ||= Data.define(*keys)
+          data_class = MEMOIZED_DATAS[keys]
+
+          data_values = transform_values { |v|
+            if v.is_a?(Hash)
+              v.to_data
+            elsif v.is_a?(Array) && v.all? { |el| el.is_a?(Hash) }
+              v.map(&:to_data)
+            else
+              v
+            end
+          }.values
+
+          data_class.new(*data_values)
+        end
+      end
+
+      private
+
+      MEMOIZED_DATAS = {}
+    end
+  end
+end

data/lib/reading/util/numeric_to_i_if_whole.rb

@@ -0,0 +1,12 @@
+module Reading
+  module Util
+    # Same as #to_i but only applies if the result is equal to the original number.
+    module NumericToIIfWhole
+      refine Numeric do
+        def to_i_if_whole
+          to_i == self ? to_i : self
+        end
+      end
+    end
+  end
+end

data/lib/reading/util/string_truncate.rb

@@ -1,13 +1,22 @@
 module Reading
   module Util
+    # Shortens the String to a given length.
     module StringTruncate
       refine String do
-        def truncate(max, padding: 0, min: 30)
-          end_index = max - padding
-          end_index = min if end_index < min
-          self.length + padding > max ? "#{self[0...end_index]}..." : self
+        # @param length [Integer]
+        # @return [String]
+        def truncate(length)
+          if length < self.length - ELLIPSIS.length
+            "#{self[0...length]}#{ELLIPSIS}"
+          else
+            self
+          end
         end
       end
+
+      private
+
+      ELLIPSIS = "...".freeze
     end
   end
 end

data/lib/reading/version.rb

@@ -1,3 +1,3 @@
 module Reading
-  VERSION = "0.6.1"
+  VERSION = "0.8.0"
 end

data/lib/reading.rb

@@ -0,0 +1,49 @@
+require_relative "reading/parsing/csv"
+require_relative "reading/filter"
+require_relative "reading/config"
+require_relative "reading/item/time_length.rb"
+
+# The gem's public API. See https://github.com/fpsvogel/reading#usage
+#
+# Architectural overview:
+#
+#                 (CSV input)                    (Items)     (filtered Items)
+#                      |                          Λ   |           Λ
+#                      |                          |   ·---.       |
+#                      |                          |       |       |
+#                      V                          |       V       |
+#                   ::parse                       |     ::filter  |
+#                      |                          |          |    |
+#                      |            .----------> Item        Filter
+#  Config,             |           /             / \
+#  errors.rb ----- Parsing::CSV --·    Item::View  Item::TimeLength
+#                     / \
+#      Parsing::Parser  Parsing::Transformer
+#             |                 |
+#      parsing/attributes/*  parsing/rows/*
+#
+module Reading
+  # Parses a CSV file or string. See Parsing::CSV#initialize and #parse for details.
+  def self.parse(...)
+    csv = Parsing::CSV.new(...)
+    csv.parse
+  end
+
+  # Filters an array of Items. See Filter::by for details.
+  def self.filter(...)
+    Filter.by(...)
+  end
+
+  # The default config.
+  # @return [Hash]
+  def self.default_config
+    Config.new.hash
+  end
+
+  # A shortcut for getting a time from a string.
+  # @param string [String] a time duration in "h:mm" format.
+  # @return [Item::TimeLength]
+  def self.time(string)
+    Item::TimeLength.parse(string)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reading
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Felipe Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -28,119 +28,153 @@ 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: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !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/filter.rb
+- lib/reading/item.rb
+- lib/reading/item/time_length.rb
+- lib/reading/item/view.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/hash_to_data.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 +201,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[:notes]
-
-        columns[: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