reading 0.7.0 → 0.9.0

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).freeze
+            else
+              v.freeze
+            end
+          }.values
+
+          data_class.new(*data_values)
+        end
+      end
+
+      private
+
+      MEMOIZED_DATAS = {}
+    end
+  end
+end

data/lib/reading/version.rb

@@ -1,3 +1,3 @@
 module Reading
-  VERSION = "0.7.0"
+  VERSION = '0.9.0'
 end

data/lib/reading.rb

@@ -1,8 +1,37 @@
-require_relative "reading/parsing/csv"
-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:
+#
+#                                         (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.
   def self.parse(...)
@@ -10,9 +39,26 @@ module Reading
     csv.parse
   end
 
+  # Filters an array of Items. See Filter::by for details.
+  def self.filter(...)
+    Filter.by(...)
+  end
+
+  # 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.config
+    Config.hash
+  end
+
+  # A shortcut for getting a time from a string.
   # @param string [String] a time duration in "h:mm" format.
-  # @return [Reading::Item::TimeLength]
+  # @return [Item::TimeLength]
   def self.time(string)
-    Reading::Item::TimeLength.parse(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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Felipe Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -113,16 +127,17 @@ 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
+- 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
@@ -137,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
@@ -152,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_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
 homepage: https://github.com/fpsvogel/reading
 licenses:

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/alex/reading.csv'
-#   reading '/home/alex/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/alex/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:)
-
-ap items

data/lib/reading/util/hash_to_struct.rb

@@ -1,30 +0,0 @@
-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
-        # @return [Struct]
-        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

@@ -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