reading 0.6.0

data/lib/reading/row/row.rb

@@ -0,0 +1,88 @@
+module Reading
+  # A base class that contains behaviors common to ___Row classes.
+  class Row
+    using Util::StringRemove
+    using Util::HashArrayDeepFetch
+    using Util::HashCompactByTemplate
+
+    private attr_reader :line
+
+    # @param line [Reading::Line] the Line that this Row represents.
+    def initialize(line)
+      @line = line
+
+      after_initialize
+    end
+
+    # Parses a CSV row into an array of hashes of item data. How this is done
+    # depends on how the template methods (further below) are implemented in
+    # subclasses of Row.
+    # @return [Array<Hash>] an array of hashes like the template in config.rb
+    def parse
+      return [] if skip?
+
+      before_parse
+
+      items = item_heads.map { |item_head|
+        item_hash(item_head)
+          .compact_by(template: config.deep_fetch(:item, :template))
+      }.compact
+
+      items
+
+    rescue Reading::Error => e
+      e.handle(line:)
+      []
+    end
+
+    private
+
+    def string
+      @line.string
+    end
+
+    def config
+      @line.csv.config
+    end
+
+    # A "head" is a string in the Head column containing a chunk of item
+    # information, starting with a format emoji. A typical row describes one
+    # item and so contains one head, but a row describing multiple items (with
+    # multiple heads in the Head column) is possible. Also, a row of compact
+    # planned items is essentially a list of heads, though with different
+    # elements than a normal row's head.
+    # @return [Array<String>]
+    def item_heads
+      string_to_be_split_by_format_emojis
+        .split(config.deep_fetch(:csv, :regex, :formats_split))
+        .tap { |item_heads|
+          item_heads.first.remove!(config.deep_fetch(:csv, :regex, :dnf))
+          item_heads.first.remove!(config.deep_fetch(:csv, :regex, :progress))
+        }
+        .map { |item_head| item_head.strip }
+        .partition { |item_head| item_head.match?(/\A#{config.deep_fetch(:csv, :regex, :formats)}/) }
+        .reject(&:empty?)
+        .first
+    end
+
+    # Below: template methods that can (or must) be overridden.
+
+    def after_initialize
+    end
+
+    def before_parse
+    end
+
+    def skip?
+      false
+    end
+
+    def string_to_be_split_by_format_emojis
+      raise NotImplementedError, "#{self.class} should have implemented #{__method__}"
+    end
+
+    def item_hash(item_head)
+      raise NotImplementedError, "#{self.class} should have implemented #{__method__}"
+    end
+  end
+end

data/lib/reading/util/blank.rb

@@ -0,0 +1,146 @@
+# Copied from active_support/core_ext/object/blank
+# https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/object/blank.rb
+# Except detection of ENCODED_BLANKS is omitted here.
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? || BLANK_RE.match?(self)
+  end
+end
+
+class Numeric # :nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time # :nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/reading/util/hash_array_deep_fetch.rb

@@ -0,0 +1,40 @@
+module Reading
+  module Util
+    class FetchDepthExceededError < StandardError
+    end
+
+    # Similar to Array#dig and Hash#dig but raises an error for not found elements.
+    #
+    # More flexible but slightly slower alternative:
+    #   keys.reduce(self) { |a, e| a.fetch(e) }
+    #
+    # See performance comparisons:
+    # https://fpsvogel.com/posts/2022/ruby-hash-dot-syntax-deep-fetch
+    module HashArrayDeepFetch
+      def deep_fetch(*keys)
+        case keys.length
+        when 1
+          fetch(keys[0])
+        when 2
+          fetch(keys[0]).fetch(keys[1])
+        when 3
+          fetch(keys[0]).fetch(keys[1]).fetch(keys[2])
+        when 4
+          fetch(keys[0]).fetch(keys[1]).fetch(keys[2]).fetch(keys[3])
+        when 5
+          fetch(keys[0]).fetch(keys[1]).fetch(keys[2]).fetch(keys[3]).fetch(keys[4])
+        else
+          raise FetchDepthExceededError, "#deep_fetch can't fetch that deep!"
+        end
+      end
+
+      refine Hash do
+        import_methods HashArrayDeepFetch
+      end
+
+      refine Array do
+        import_methods HashArrayDeepFetch
+      end
+    end
+  end
+end

data/lib/reading/util/hash_compact_by_template.rb

@@ -0,0 +1,38 @@
+module Reading
+  module Util
+    # Utility method for a hash containing parsed item data, structured as the
+    # template in config.rb.
+    module HashCompactByTemplate
+      refine Hash do
+        # Removes blank arrays of hashes from the given item hash, e.g. series,
+        # variants, variants[:sources], and experiences in the template in config.rb.
+        # 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.
+        def compact_by(template:)
+          map { |key, val|
+            if is_array_of_hashes?(val)
+              if is_blank_like_template?(val, template.fetch(key))
+                [key, []]
+              else
+                [key, val.map { |el| el.compact_by(template: template.fetch(key).first) }]
+              end
+            else
+              [key, val]
+            end
+          }.to_h
+        end
+
+        private
+
+        def is_array_of_hashes?(val)
+          val.is_a?(Array) && val.first.is_a?(Hash)
+        end
+
+        def is_blank_like_template?(val, template_val)
+          val.length == 1 && val == template_val
+        end
+      end
+    end
+  end
+end

data/lib/reading/util/hash_deep_merge.rb

@@ -0,0 +1,44 @@
+module Reading
+  module Util
+    # Modified from active_support/core_ext/hash/deep_merge
+    # https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+    #
+    # This deep_merge also iterates through arrays of hashes and merges them.
+    module HashDeepMerge
+      refine Hash do
+        def deep_merge(other_hash, &block)
+          dup.deep_merge!(other_hash, &block)
+        end
+
+        def deep_merge!(other_hash, &block)
+          merge!(other_hash) do |key, this_val, other_val|
+            if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+              this_val.deep_merge(other_val, &block)
+            # I added this part for merging values that are arrays of hashes.
+            elsif this_val.is_a?(Array) && other_val.is_a?(Array) &&
+                  this_val.all? { |el| el.is_a?(Hash) } &&
+                  other_val.all? { |el| el.is_a?(Hash) }
+              zip =
+                if other_val.length >= this_val.length
+                  other_val.zip(this_val)
+                else
+                  this_val.zip(other_val).map(&:reverse)
+                end
+              zip.map { |other_el, this_el|
+                if this_el.nil?
+                  other_el
+                else
+                  this_el.deep_merge(other_el || {}, &block)
+                end
+              }
+            elsif block_given?
+              block.call(key, this_val, other_val)
+            else
+              other_val
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reading/util/hash_to_struct.rb

@@ -0,0 +1,29 @@
+module Reading
+  module Util
+    # Converts a Hash to a Struct. Converts inner hashes (and inner arrays of hashes) as well.
+    module HashToStruct
+      refine Hash do
+        def to_struct
+          MEMOIZED_STRUCTS[keys] ||= Struct.new(*keys)
+          struct_class = MEMOIZED_STRUCTS[keys]
+
+          struct_values = transform_values { |v|
+            if v.is_a?(Hash)
+              v.to_struct
+            elsif v.is_a?(Array) && v.all? { |el| el.is_a?(Hash) }
+              v.map(&:to_struct)
+            else
+              v
+            end
+          }.values
+
+          struct_class.new(*struct_values)
+        end
+      end
+
+      private
+
+      MEMOIZED_STRUCTS = {}
+    end
+  end
+end

data/lib/reading/util/string_remove.rb

@@ -0,0 +1,28 @@
+module Reading
+  module Util
+    # Shortcuts for String#sub and String#gsub when replacing with an empty string.
+    module StringRemove
+      refine String do
+        def remove(pattern)
+          sub(pattern, EMPTY_STRING)
+        end
+
+        def remove!(pattern)
+          sub!(pattern, EMPTY_STRING)
+        end
+
+        def remove_all(pattern)
+          gsub(pattern, EMPTY_STRING)
+        end
+
+        def remove_all!(pattern)
+          gsub!(pattern, EMPTY_STRING)
+        end
+      end
+
+      private
+
+      EMPTY_STRING = "".freeze
+    end
+  end
+end

data/lib/reading/util/string_truncate.rb

@@ -0,0 +1,13 @@
+module Reading
+  module Util
+    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
+        end
+      end
+    end
+  end
+end

data/lib/reading/version.rb

@@ -0,0 +1,3 @@
+module Reading
+  VERSION = "0.6.0"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: reading
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Felipe Vogel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pretty-diffs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- fps.vogel@gmail.com
+executables:
+- reading
+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
+- 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/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/string_remove.rb
+- lib/reading/util/string_truncate.rb
+- lib/reading/version.rb
+homepage: https://github.com/fpsvogel/reading
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fpsvogel/reading
+  source_code_uri: https://github.com/fpsvogel/reading
+  changelog_uri: https://github.com/fpsvogel/reading/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: reading parses a CSV reading log.
+test_files: []