fat_table 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e7e31d83ee64d7aea1c9b19969c80ab8d1d58b7058b0962534a389a222330e
-  data.tar.gz: b0745fd3fa09032d7981cae20520bfa349f546f885b042907fff64401c49f25f
+  metadata.gz: b9661335d0ae8ec4d87b9e16c3055552af05a354c5222b9838d51f8109ddd749
+  data.tar.gz: fe23c745a61b2fff7d3380221ee133b5e38c3bdd9d4ff429bdce2094cbe47755
 SHA512:
-  metadata.gz: 371b2369809d837afc7f40b81092bc03c917276653ae60806a6bc2931d6bfff9a8ab7e866d8141babf5fd77dfb07e7ad8538c74f49391bc4009d888893397005
-  data.tar.gz: e352a6445fce148e2545280d6d44970f55fc74e1e91fb89768a1f65da5d077aeed29c90ace57ea93e4586228251c42d565754fdce28b4637aedca56571f410ab
+  metadata.gz: 201d3df5ba9820b96e22b1a035013c128c2f8cf2efd054cd16b9b6f372c13381334db9cc11b268daa0537d25e2d0475c35cd73f1749d08d8a008a2498010ead1
+  data.tar.gz: e067fc5bedae6541e0ce88e41025fffbff64a16a3545fccd89a6b171f2b6d648fd8e1716227ceafd770db509417361781c3c6d4cc718824ec8b9098a266eafab

data/.solargraph.yml

@@ -0,0 +1,22 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/README.org

@@ -140,7 +140,7 @@ org-mode buffer as an org-table, ready for processing by other code blocks.
         - [[#to-aoa-array-of-arrays][To AoA (Array of Arrays)]]
         - [[#to-aoh-array-of-hashes][To AoH (Array of Hashes)]]
     - [[#formatting-directives][Formatting Directives]]
-      - [[#string][String]]
+      - [[#all-types-as-strings][All Types as Strings]]
       - [[#numeric][Numeric]]
       - [[#datetime][DateTime]]
       - [[#boolean][Boolean]]
@@ -2389,7 +2389,7 @@ formats can be defined by adding additional classes.
 **** Examples
 ***** To Text
 
-This formatter uses nothing by ASCII characters to draw the table.  Notice
+This formatter uses nothing but ASCII characters to draw the table.  Notice
 that, unlike to ~to_org~ formatter shown below, the intersections of lines are
 represented by a ~+~ character.  Embelishments such as color, bold, and so
 forth are ignored.
@@ -2421,7 +2421,7 @@ characters to draw the table, but, the intersections of lines are represented
 by a ~|~ character.  Embelishments such as color, bold, and so forth are
 ignored.  When working in Org Mode, note that Emacs will convert an Array of
 Arrays into an Org Mode table, so when constructing tables programmatically,
-it may be better to use that formatter as shown below.
+it may be better to use the =to_aoa= formatter shown below.
 
 #+begin_SRC ruby :wrap EXAMPLE
   tab_a.to_org
@@ -2528,28 +2528,28 @@ order, so '$R,' and ',$R' are equivalent.
 
 Here is a list of all the formatting directives that apply to each cell type:
 
-**** String
+**** All Types as Strings
 
-For a string element, the following instructions are valid. Note that these can
-also be applied to all the other cell types as well since they are all converted
-to a string in forming the output.
+For a string element, or any an element of any type (since these are applied
+after the element has been converted to a String), the following instructions
+are valid.
 
-- u :: convert the element to all lowercase,
-- U :: convert the element to all uppercase,
+- u :: convert the element to all lowercase [default false],
+- U :: convert the element to all uppercase [default false],
 - t :: title case the element, that is, upcase the initial letter in
-    each word and lower case the other letters
-- B ~B :: make the element bold, or turn off bold
-- I ~I :: make the element italic, or turn off italic
-- R :: align the element on the right of the column
-- L :: align the element on the left of the column
-- C :: align the element in the center of the column
+    each word and lower case the other letters [default false],
+- B ~B :: make the element bold, or turn off bold [default ~B]
+- I ~I :: make the element italic, or turn off italic [default ~I]
+- R :: align the element on the right of the column [default off]
+- L :: align the element on the left of the column [default on]
+- C :: align the element in the center of the column [default off]
 - c[<color_spec>] :: render the element in the given color; the <color_spec>
   can have the form fgcolor, fgcolor.bgcolor, or .bgcolor, to set the
   foreground or background colors respectively, and each of those can be an
   ANSI or X11 color name in addition to the special color, 'none', which keeps
-  the output's default color.
-- _ ~_ :: underline the element, or turn off underline
-- * ~* :: cause the element to blink, or turn off blink
+  the output's default color [default none].
+- _ ~_ :: underline the element, or turn off underline [default off]
+- * ~* :: cause the element to blink, or turn off blink [default off]
 
 For example, the directive 'tCc[red.yellow]' would title-case the element,
 center it, and color it red on a yellow background. The directives that are
@@ -2562,16 +2562,21 @@ particular columns.
 For a numeric element, all the instructions valid for string are available, in
 addition to the following:
 
-- , ~, :: insert grouping commas, or do not insert grouping commas,
-- $ ~$ :: format the number as currency according to the locale, or not,
-- m.n :: include at least m digits before the decimal point, padding on
-    the left with zeroes as needed, and round the number to the n
-    decimal places and include n digits after the decimal point,
-    padding on the right with zeroes as needed,
+- , ~, :: insert grouping commas, or do not insert grouping commas [default
+  ~,],
+- $ ~$ :: format the number as currency according to the locale, or not
+  [default ~$],
+- m.n :: include at least m digits before the decimal point, padding on the
+  left with zeroes as needed, and round the number to the n decimal places and
+  include n digits after the decimal point, padding on the right with zeroes
+  as needed.  If n is negative, the value will be rounded to the left of the
+  decimal point: e.g., if n is -2, the number will be rounded to the nearest
+  hundred, if -3, to the nearest thousand, etc. [default 0.0]
 - H :: convert the number (assumed to be in units of seconds) to ~HH:MM:SS.ss~
-     form. So a column that is the result of subtracting two :datetime forms
-     will result in a :numeric expressed as seconds and can be displayed in
-     hours, minutes, and seconds with this formatting instruction.
+  form. So a column that is the result of subtracting two :datetime forms will
+  result in a :numeric expressed as seconds and can be displayed in hours,
+  minutes, and seconds with this formatting instruction.  If this directive is
+  included, all other numeric directives will be ignored. [default off]
 
 For example, the directive 'R5.0c[blue]' would right-align the numeric
 element, pad it on the left with zeros, and color it blue.
@@ -2598,7 +2603,7 @@ For a boolean cell, all the instructions valid for string are available, in
 addition to the following:
 
 - Y :: print true as ~Y~ and false as ~N~,
-- T :: print true as ~T~ and false as ~F~,
+- T :: print true as ~T~ and false as ~F~ [this is the default],
 - X :: print true as ~X~ and false as an empty string '',
 - b[xxx,yyy] :: print true as the string given as ~xxx~ and false as the string
      given as ~yyy~,
@@ -2616,7 +2621,7 @@ By default, ~nil~ elements are rendered as blank cells, but you can make them
 visible with the following, and in that case, all the formatting instructions
 valid for strings are also available:
 
-- n[niltext] :: render a ~nil~ item with the given niltext.
+- n[niltext] :: render a ~nil~ item with the given niltext [default ''].
 
 For example, you might want to use 'n[-]Cc[purple]' to make nils visible as a
 centered purple hyphen.

data/TODO.org

@@ -1,4 +1,21 @@
 
+* TODO Explicitly typed columns
+Having FatTable infer column types from the content of a table is nice, but as
+I learned from the need to have force_string!, sometimes we want to restrict
+the type of the column and throw an error if the content does not conform.
+So, perhaps when the table columns are specified, we can allow them to be
+terminated with a "sigil" that restricts its type:
+
+- @ :: at Date or DateTime column,
+- # :: a Numeric column
+- ? :: a Boolean column
+- ~ :: a String Column,
+- * :: a tolerant Column, i.e., it infers the type from the content, but
+  allows strings to be added as items in an otherwise typed column but treat
+  them a nil for calculation purposes.
+- @*, #*, ?* :: a Date, Numeric, or Boolean column that is also tolerant.
+  `~*` could be treated the same as `~`.
+
 * TODO Specify Column Widths
 Allow a formatter to specify column widths.  This could be a number of
 characters, which would be interpreted as a number of "ems" for LaTeX.
@@ -23,6 +40,13 @@ Possible enhancements:
 This is a [[https://github.com/westonganger/spreadsheet_architect][gem]] that I can include into the Table model to convert a table into
 a spread-sheet, or even a sheet in a multi-sheet spreadsheet file.
 
+* TODO Conversion to HTML
+Perhaps an obvious formatter would be HTML tables, but CSS controls the
+styling, so have to think on that one.
+
+* TODO Conversion to JSON, YAML
+These would need no color formatting and might prove useful.
+
 * TODO Add Quandl or EODDATA Queries
 Possible replacements for YQL.
 

data/fat_table.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'fat_table'
   spec.version       = FatTable::VERSION
   spec.authors       = ['Daniel E. Doherty']
-  spec.email         = ['ded-law@ddoherty.net']
+  spec.email         = ['ded@ddoherty.net']
 
   spec.summary       = 'Provides tools for working with tables as a data type.'
   spec.description   = <<-DESC

data/lib/fat_table/column.rb

@@ -70,7 +70,7 @@ module FatTable
     #      except in the case of String columns, which retain them a blank
     #      strings.
     #
-    # Examples:
+    # @example
     #
     #   require 'fat_table'
     #   col = FatTable::Column.new(header: 'date')
@@ -83,6 +83,8 @@ module FatTable
     #   col.type #=> 'Numeric'
     #   col.header #=> :prices
     #   col.sum #=> 18376.75
+    #
+    # @param
     def initialize(header:, items: [], type: 'NilClass', tolerant: false)
       @raw_header = header
       @header =
@@ -153,8 +155,6 @@ module FatTable
     # Force the column to have String type and then convert all items to
     # strings.
     def force_string!
-      # msg = "Can only force an empty column to String type"
-      # raise UserError, msg unless empty?
       @type = 'String'
       unless empty?
         @items = items.map(&:to_s)

data/lib/fat_table/convert.rb

@@ -102,23 +102,25 @@ module FatTable
       end
     end
 
-    ISO_DATE_RE = %r{(?<yr>\d\d\d\d)[-\/]
+    ISO_DATE_RE = %r{\A(?<yr>\d\d\d\d)[-\/]
                 (?<mo>\d\d?)[-\/]
                 (?<dy>\d\d?)\s*
-                (T?\s*\d\d:\d\d(:\d\d)?
-                ([-+](\d\d?)(:\d\d?))?)?}x
+                (T?\s*\d\d:\d\d(:\d\d)?\s*
+                ([-+](\d\d?)(:\d\d?))?)?\s*
+                ((mon|tue|wed|thu|fri|sat|sun)[a-zA-z]*)?\s*
+                \z}xi
 
-    AMR_DATE_RE = %r{(?<dy>\d\d?)[-/](?<mo>\d\d?)[-/](?<yr>\d\d\d\d)\s*
-                     (?<tm>T\d\d:\d\d:\d\d(\+\d\d:\d\d)?)?}x
+    AMR_DATE_RE = %r{\A(?<dy>\d\d?)[-/](?<mo>\d\d?)[-/](?<yr>\d\d\d\d)\s*
+                     (?<tm>T\d\d:\d\d:\d\d(\+\d\d:\d\d)?)?\z}xi
 
     # A Date like 'Tue, 01 Nov 2016' or 'Tue 01 Nov 2016' or '01 Nov 2016'.
     # These are emitted by Postgresql, so it makes from_sql constructor
     # possible without special formatting of the dates.
-    INV_DATE_RE = %r{((mon|tue|wed|thu|fri|sat|sun)[a-zA-z]*,?)?\s+  # looks like dow
+    INV_DATE_RE = %r{\A((mon|tue|wed|thu|fri|sat|sun)[a-zA-z]*,?)?\s+  # looks like dow
     (?<dy>\d\d?)\s+  # one or two-digit day
     (?<mo_name>[jfmasondJFMASOND][A-Za-z]{2,})\s+  # looks like a month name
     (?<yr>\d\d\d\d) # and a 4-digit year
-    }xi
+    \z}xi
 
     # Convert the val to a DateTime if it is either a DateTime, a Date, a Time, or a
     # String that can be parsed as a DateTime, otherwise return nil. It only
@@ -132,7 +134,7 @@ module FatTable
       return val.to_datetime if val.is_a?(Time)
 
       begin
-        str = val.to_s.clean
+        str = val.to_s.clean.sub(/\A[\[\(\{\<]\s*/, '').sub(/[\]\)\}\>]\s*\z/, '')
         return nil if str.blank?
 
         if str.match(ISO_DATE_RE)

data/lib/fat_table/formatters/formatter.rb

@@ -64,7 +64,7 @@ module FatTable
       bgcolor: 'none',
       hms: false,
       pre_digits: 0,
-      post_digits: -1,
+      post_digits: 0,
       commas: false,
       currency: false,
       datetime_fmt: '%F %H:%M:%S',
@@ -1026,46 +1026,59 @@ module FatTable
     # specializing this method.
     def format_numeric(val, istruct)
       return istruct.nil_text if val.nil?
+      return val.secs_to_hms if istruct.hms
 
-      val = val.round(istruct.post_digits) if istruct.post_digits >= 0
-      if istruct.hms
-        result = val.secs_to_hms
-        istruct.commas = false
-      elsif istruct.currency
-        delim = istruct.commas ? ',' : ''
-        result =
-        if istruct.post_digits < 0
-          val.to_s(:currency, delimiter: delim,
-                          unit: FatTable.currency_symbol)
-        else
-          val.to_s(:currency, precision: istruct.post_digits, delimiter: delim,
-                          unit: FatTable.currency_symbol)
-        end
-        # istruct.commas = false
-      elsif istruct.pre_digits.positive?
-        if val.whole?
-          # No fractional part, ignore post_digits
-          result = sprintf("%0#{istruct.pre_digits}d", val)
-        elsif istruct.post_digits >= 0
-          # There's a fractional part and pre_digits.  sprintf width includes
-          # space for fractional part and decimal point, so add pre, post, and 1
-          # to get the proper sprintf width.
-          wid = istruct.pre_digits + 1 + istruct.post_digits
-          result = sprintf("%0#{wid}.#{istruct.post_digits}f", val)
-        else
-          val = val.round(0)
-          result = sprintf("%0#{istruct.pre_digits}d", val)
+      if istruct.commas
+        # Commify the whole number part if not done already.
+        result = val.commas(istruct.post_digits)
+      else
+        result = val.round(istruct.post_digits).to_s
+        match = result.match(/\.(\d+)\z/)
+        if match && match[1]&.size < istruct.post_digits
+          # Add trailing zeros to pad out post_digits
+          n_zeros = [istruct.post_digits - match[1].size, 0].max
+          zeros = '0' * n_zeros
+          result = result + zeros
         end
-      elsif istruct.post_digits >= 0
-        # Round to post_digits but no padding of whole number, pad fraction with
-        # trailing zeroes.
-        result = sprintf("%.#{istruct.post_digits}f", val)
+        result
+      end
+
+      if istruct.pre_digits.positive?
+        match = result.match(/\A([\d,]+)(\.\d+)?\z/)
+        whole_part = match[1]
+        frac_part = match[2]
+        n_zeros = [istruct.pre_digits - whole_part.gsub(',', '').size, 0].max
+        result =
+          if n_zeros.positive?
+            if istruct.commas
+              # Insert leading zeros with commas
+              pre_comma_match = whole_part.match(/\A(\d+),/)
+              if pre_comma_match
+                n_partial_zeros = 3 - pre_comma_match[1].size
+                whole_part = "0" * n_partial_zeros + whole_part
+                n_zeros -= n_partial_zeros
+              end
+              zeros = ''
+              if n_zeros.positive?
+                zeros = "0" * n_zeros
+                if n_zeros > 3 && istruct.commas
+                  zeros = zeros.reverse.gsub!(/([0-9]{3})/, "\\1,").reverse
+                end
+              end
+              "#{zeros},#{whole_part}#{frac_part}"
+            else
+              # Insert leading zeros without commas
+              zeros = "0" * n_zeros
+              "#{zeros}#{whole_part}#{frac_part}"
+            end
+          else
+            "#{whole_part}#{frac_part}"
+          end
       else
-        result = val.to_s
+        result
       end
-      if istruct.commas
-        # Commify the whole number part if not done already.
-        result = result.commas
+      if istruct.currency
+        result = "#{FatTable.currency_symbol}#{result}"
       end
       result
     end
@@ -1199,8 +1212,10 @@ module FatTable
         result += post_header(widths)
       end
       new_rows.each do |loc_row|
-        result += hline(widths) if loc_row.nil?
-        next if loc_row.nil?
+        if loc_row.nil?
+          result += hline(widths)
+          next
+        end
 
         _loc, row = *loc_row
         result += pre_row

data/lib/fat_table/table.rb

@@ -379,11 +379,10 @@ module FatTable
 
     # :category: Attributes
 
-    # Set the column type for Column with the given +key+ as a String type,
-    # but only if empty.  Otherwise, we would have to worry about converting
-    # existing items in the column to String.  Perhaps that's a TODO.
+    # Set the column type for Column with the given +key+ as a String type.
     def force_string!(*keys)
       keys.each do |h|
+        raise UserError, "force_string!: #{h} not a column in table" unless column(h)
         column(h).force_string!
       end
       self

data/lib/fat_table/version.rb

@@ -2,5 +2,5 @@
 
 module FatTable
   # The current version of FatTable
-  VERSION = '0.6.4'
+  VERSION = '0.6.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_table
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - Daniel E. Doherty
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -264,7 +264,7 @@ description: |2
       array of arrays with its .to_aoa output function and will be rendered in an
       org-mode buffer as an org-table, ready for processing by other code blocks.
 email:
-- ded-law@ddoherty.net
+- ded@ddoherty.net
 executables:
 - ft_console
 extensions: []
@@ -274,6 +274,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
+- ".solargraph.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -319,7 +320,7 @@ licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
   yard.run: yri
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -334,8 +335,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.4.1
+signing_key: 
 specification_version: 4
 summary: Provides tools for working with tables as a data type.
 test_files: []