reading 0.8.0 → 0.9.1

data/lib/reading/stats/terminal_result_formatters.rb

@@ -0,0 +1,91 @@
+require 'pastel'
+
+module Reading
+  module Stats
+    module ResultFormatters
+      TERMINAL = {
+        average_length: ->(result) { length_to_s(result) },
+        average_amount: ->(result) { length_to_s(result) },
+        :'average_daily-amount' => ->(result) { "#{length_to_s(result)} per day" },
+        total_item: ->(result) {
+          if result.zero?
+            PASTEL.bright_black("none")
+          else
+            color("#{result} #{result == 1 ? "item" : "items"}")
+          end
+        },
+        total_amount: ->(result) { length_to_s(result) },
+        top_length: ->(result) { top_or_bottom_lengths(result) },
+        top_amount: ->(result) { top_or_bottom_lengths(result) },
+        top_speed: ->(result) { top_or_bottom_speeds(result) },
+        bottom_length: ->(result) { top_or_bottom_lengths(result) },
+        botom_amount: ->(result) { top_or_bottom_lengths(result) },
+        bottom_speed: ->(result) { top_or_bottom_speeds(result) },
+      }
+
+      private
+
+      PASTEL = Pastel.new
+
+      # Applies a terminal color.
+      # @param string [String]
+      # @return [String]
+      private_class_method def self.color(string)
+        PASTEL.bright_blue(string)
+      end
+
+      # Converts a length/amount (pages or time) into a string.
+      # @param length [Numeric, Reading::Item::TimeLength]
+      # @param color [Boolean] whether a terminal color should be applied.
+      # @return [String]
+      private_class_method def self.length_to_s(length, color: true)
+        if length.is_a?(Numeric)
+          length_string = "#{length.round} pages"
+        else
+          length_string = length.to_s
+        end
+
+        color ? color(length_string) : length_string
+      end
+
+      # Formats a list of top/bottom length results as a string.
+      # @param result [Array]
+      # @return [String]
+      private_class_method def self.top_or_bottom_lengths(result)
+        offset = result.count.digits.count
+
+        result
+          .map.with_index { |(title, length), index|
+            pad = ' ' * (offset - (index + 1).digits.count)
+
+            title_line = "#{index + 1}. #{pad}#{title}"
+            indent = "    #{' ' * offset}"
+
+            "#{title_line}\n#{indent}#{length_to_s(length)}"
+          }
+          .join("\n")
+      end
+
+      # Formats a list of top/bottom speed results as a string.
+      # @param result [Array]
+      # @return [String]
+      private_class_method def self.top_or_bottom_speeds(result)
+        offset = result.count.digits.count
+
+        result
+          .map.with_index { |(title, hash), index|
+            amount = length_to_s(hash[:amount], color: false)
+            days = "#{hash[:days]} #{hash[:days] == 1 ? "day" : "days"}"
+            pad = ' ' * (offset - (index + 1).digits.count)
+
+            title_line = "#{index + 1}. #{pad}#{title}"
+            indent = "    #{' ' * offset}"
+            colored_speed = color("#{amount} in #{days}")
+
+            "#{title_line}\n#{indent}#{colored_speed}"
+          }
+          .join("\n")
+      end
+    end
+  end
+end

data/lib/reading/util/exclude.rb

@@ -0,0 +1,12 @@
+# Copied from activesupport/lib/active_support/core_ext/enumerable.rb
+module Enumerable
+  def exclude?(object)
+    !include?(object)
+  end
+end
+
+class String
+  def exclude?(object)
+    !include?(object)
+  end
+end

data/lib/reading/util/hash_array_deep_fetch.rb

@@ -1,31 +1,9 @@
 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
+        keys.reduce(self) { |a, e| a.fetch(e) }
       end
 
       refine Hash do

data/lib/reading/util/hash_to_data.rb

@@ -12,9 +12,9 @@ module Reading
             if v.is_a?(Hash)
               v.to_data
             elsif v.is_a?(Array) && v.all? { |el| el.is_a?(Hash) }
-              v.map(&:to_data)
+              v.map(&:to_data).freeze
             else
-              v
+              v.freeze
             end
           }.values
 

data/lib/reading/version.rb

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

data/lib/reading.rb

@@ -1,26 +1,36 @@
-require_relative "reading/parsing/csv"
-require_relative "reading/filter"
-require_relative "reading/config"
-require_relative "reading/item/time_length.rb"
+Dir[File.join(__dir__, 'reading', 'util', '*.rb')].each { |file| require file }
+require_relative 'reading/errors'
+require_relative 'reading/config'
+require_relative 'reading/parsing/csv'
+require_relative 'reading/filter'
+require_relative 'reading/stats/query'
+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/*
+#                                         (filtered    (stats input*
+#        (CSV input)             (Items)   Items)       and Items)    (results)
+#             |                   Λ   |        Λ             |          Λ
+#             V                   |   V        |             V          |
+#          ::parse                |  ::filter  |           ::stats      |
+#             |                   |        |   |             |          |
+#             |                   |        |   |             |          |
+#             |                   |        |   |             |          |
+#        Parsing::CSV ---------> Item      Filter            Stats::Query
+#            /   \               / \                          / | \
+#           /     \    Item::View  Item::TimeLength          /  |  \
+#          /       \                                        /   |   \
+# Parsing::Parser  Parsing::Transformer           Stats::Filter |  Stats::Operation
+#        |                 |                             Stats::Grouping
+#  parsing/rows/*   parsing/attributes/*
+#                                               * Stats input is either from the
+#                                                 command line (via the `reading`
+#                                                 command) or provided via Ruby
+#                                                 code that uses this gem.
+#                                                 Results likewise go either to
+#                                                 stdout or to the gem user.
 #
 module Reading
   # Parses a CSV file or string. See Parsing::CSV#initialize and #parse for details.
@@ -34,10 +44,15 @@ module Reading
     Filter.by(...)
   end
 
-  # The default config.
+  # Returns statistics on Items. See Stats::Query#initialize and #result for details.
+  def self.stats(...)
+    query = Stats::Query.new(...)
+    query.result
+  end
+
   # @return [Hash]
-  def self.default_config
-    Config.new.hash
+  def self.config
+    Config.hash
   end
 
   # A shortcut for getting a time from a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reading
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Felipe Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: amazing_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
@@ -127,12 +127,10 @@ email:
 - fps.vogel@gmail.com
 executables:
 - reading
-- readingfile
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/reading
-- bin/readingfile
 - lib/reading.rb
 - lib/reading/config.rb
 - lib/reading/errors.rb
@@ -154,10 +152,12 @@ files:
 - lib/reading/parsing/attributes/variants.rb
 - lib/reading/parsing/csv.rb
 - lib/reading/parsing/parser.rb
+- lib/reading/parsing/rows/blank.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/custom_config.rb
 - lib/reading/parsing/rows/regular.rb
 - lib/reading/parsing/rows/regular_columns/end_dates.rb
 - lib/reading/parsing/rows/regular_columns/genres.rb
@@ -169,14 +169,18 @@ files:
 - lib/reading/parsing/rows/regular_columns/sources.rb
 - lib/reading/parsing/rows/regular_columns/start_dates.rb
 - lib/reading/parsing/transformer.rb
+- lib/reading/stats/filter.rb
+- lib/reading/stats/grouping.rb
+- lib/reading/stats/operation.rb
+- lib/reading/stats/query.rb
+- lib/reading/stats/terminal_result_formatters.rb
 - lib/reading/util/blank.rb
+- lib/reading/util/exclude.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_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
 homepage: https://github.com/fpsvogel/reading
 licenses:
@@ -185,23 +189,23 @@ 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
+  changelog_uri: https://github.com/fpsvogel/reading/blob/main/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
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.5.15
 signing_key: 
 specification_version: 4
 summary: Parses a CSV reading log.

data/bin/readingfile

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-
-# A script that provides a quick way to see the output of a CSV file.
-#
-# Usage:
-# Run on the command line:
-#   reading "<file path>" "<optional comma-separated names of enabled columns>"
-#
-# Examples:
-#   reading '/home/felipe/reading.csv'
-#   reading '/home/felipe/reading.csv' 'head, sources'
-
-
-require_relative "../lib/reading"
-require "amazing_print"
-require "debug"
-
-path = ARGV[0]
-unless path
-  raise ArgumentError, "CSV path argument required, such as '/home/felipe/reading.csv'"
-end
-
-config = {}
-if ARGV[1]
-  enabled_columns = ARGV[1].split(",").map(&:strip).map(&:to_sym)
-  config = { enabled_columns: }
-end
-
-items = Reading.parse(path, config:, hash_output: true)
-
-ap items

data/lib/reading/util/string_remove.rb

@@ -1,28 +0,0 @@
-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

@@ -1,22 +0,0 @@
-module Reading
-  module Util
-    # Shortens the String to a given length.
-    module StringTruncate
-      refine String do
-        # @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