fat_core 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2a1154179dc04fcdfca93f7e883ead5572b5ea4
-  data.tar.gz: 0b93b77f79888904d940124f51c00afb50beae61
+  metadata.gz: dee8f90ed96b24c51a40eaaf816cda967450ed78
+  data.tar.gz: 83fe257ef4ceba08a7bf11e6ed281a17f452b26f
 SHA512:
-  metadata.gz: caf9a264b140596a98fcbeaaea71f01890c1677b941c1b0e9118c446b9e81190ca83366a0e967df76e5f2d9b3ceb0f024bf36f75370ce8c6770be9c7e569c865
-  data.tar.gz: 1f032a4c6fade3021ae2c9beb6a16ec15b06eaec9d16c75cd070d5526cd1cae71b305562e353d6f3747665d7ffcff641146b81ee1d6232c9c582190bccc60d77
+  metadata.gz: 6f7c36cf04a7b5c0b36c8cdd84014f8b31481834dd674869ff1993af8024e2b42fd8cd5e07685173b236f0c16610972f61eb5c996e71c5fa9360f8f36aa3dee9
+  data.tar.gz: a41b43ff052e3eddf9c46e8047f3ccf424d8070e8afc3bf1b57f5e8fa2fe063057b1800ff8718bff2719429726f9490ce439db07d89b74599e1012b795af520d

data/lib/fat_core/column.rb

@@ -4,12 +4,18 @@ module FatCore
   # nils before proceeding. My original attempt to do this by monkey-patching
   # Array turned out badly.  This works much nicer.
   class Column
-    attr_reader :header, :type, :items
+    attr_reader :header, :raw_header, :type, :items
 
-    TYPES = %w(NilClass Boolean DateTime Numeric String)
+    TYPES = %w(NilClass Boolean DateTime Numeric String).freeze
 
     def initialize(header:, items: [])
-      @header = header.as_sym
+      @raw_header = header
+      @header =
+        if @raw_header.is_a?(Symbol)
+          @raw_header
+        else
+          @raw_header.gsub(/[^A-Za-z0-9 ]/, '').as_sym
+        end
       @type = 'NilClass'
       raise "Unknown column type '#{type}" unless TYPES.include?(@type.to_s)
       @items = []
@@ -44,38 +50,58 @@ module FatCore
     # Aggregates
     ##########################################################################
 
+    VALID_AGGREGATES = %s(first last rng
+                          sum count min max avg var dev
+                          any? all? none? one?)
+
+    # Return the first non-nil item in the column.  Works with any column type.
     def first
       items.compact.first
     end
 
+    # Return the last non-nil item in the column.  Works with any column type.
     def last
       items.compact.last
     end
 
-    # Return a string that of the first and last values.
-    def rng_s
+    # Return a string of the first and last non-nil values.  Works with any
+    # column type.
+    def rng
       "#{first}..#{last}"
     end
 
+    # Return the sum of the non-nil items in the column.  Works with numeric and
+    # string columns. For a string column, it will return the concatenation of
+    # the non-nil items.
     def sum
       only_with('sum', 'Numeric', 'String')
       items.compact.sum
     end
 
+    # Return a count of the non-nil items in the column.  Works with any column
+    # type.
     def count
       items.compact.count
     end
 
+    # Return the smallest non-nil item in the column.  Works with numeric,
+    # string, and datetime columns.
     def min
       only_with('min', 'NilClass', 'Numeric', 'String', 'DateTime')
       items.compact.min
     end
 
+    # Return the largest non-nil item in the column.  Works with numeric,
+    # string, and datetime columns.
     def max
       only_with('max', 'NilClass', 'Numeric', 'String', 'DateTime')
       items.compact.max
     end
 
+    # Return the average value of the non-nil items in the column.  Works with
+    # numeric and datetime columns.  For datetime columns, it converts each date
+    # to its Julian day number, computes the average, and then converts the
+    # average back to a DateTime.
     def avg
       only_with('avg', 'DateTime', 'Numeric')
       if type == 'DateTime'
@@ -86,21 +112,58 @@ module FatCore
       end
     end
 
+    # Return the variance, the average squared deviation from the mean, of the
+    # non-nil items in the column.  Works with numeric and datetime columns.
+    # For datetime columns, it converts each date to its Julian day number and
+    # computes the variance of those numbers.
+    def var
+      only_with('var', 'DateTime', 'Numeric')
+      all_items =
+        if type == 'DateTime'
+          items.compact.map(&:jd)
+        else
+          items.compact
+        end
+      mu = Column.new(header: :mu, items: all_items).avg
+      sq_dev = 0.0
+      all_items.compact.each do |itm|
+        sq_dev += (itm - mu) * (itm - mu)
+      end
+      sq_dev / items.compact.size.to_d
+    end
+
+    # Return the standard deviation, the square root of the variance, of the
+    # non-nil items in the column.  Works with numeric and datetime columns.
+    # For datetime columns, it converts each date to its Julian day number and
+    # computes the standard deviation of those numbers.
+    def dev
+      only_with('dev', 'DateTime', 'Numeric')
+      Math.sqrt(var)
+    end
+
+    # Return true if any of the items in the column are true; otherwise return
+    # false.  Works only with boolean columns.
     def any?
       only_with('any?', 'Boolean')
       items.compact.any?
     end
 
+    # Return true if all of the items in the column are true; otherwise return
+    # false.  Works only with boolean columns.
     def all?
       only_with('all?', 'Boolean')
       items.compact.all?
     end
 
+    # Return true if none of the items in the column are true; otherwise return
+    # false.  Works only with boolean columns.
     def none?
       only_with('any?', 'Boolean')
       items.compact.none?
     end
 
+    # Return true if precisely one of the items in the column is true;
+    # otherwise return false.  Works only with boolean columns.
     def one?
       only_with('any?', 'Boolean')
       items.compact.one?
@@ -108,10 +171,9 @@ module FatCore
 
     private
 
-    def only_with(agg, *types)
-      unless types.include?(type)
-        raise "Aggregate '#{agg}' cannot be applied to a #{type} column"
-      end
+    def only_with(agg, *valid_types)
+      return self if valid_types.include?(type)
+      raise "Aggregate '#{agg}' cannot be applied to a #{type} column"
     end
 
     public

data/lib/fat_core/date.rb

@@ -609,7 +609,7 @@ class Date
     month = month.to_i
     raise ArgumentError, 'illegal month number' if month < 1 || month > 12
     n = n.to_i
-    if n > 0
+    if n.positive?
       # Set d to the 1st wday in month
       d = Date.new(year, month, 1)
       d += 1 while d.wday != wday
@@ -620,7 +620,7 @@ class Date
         nd += 1
       end
       d
-    elsif n < 0
+    elsif n.negative?
       n = -n
       # Set d to the last wday in month
       d = Date.new(year, month, 1).end_of_month
@@ -975,9 +975,9 @@ class Date
   def add_fed_business_days(n)
     d = dup
     return d if n.zero?
-    incr = n < 0 ? -1 : 1
+    incr = n.negative? ? -1 : 1
     n = n.abs
-    while n > 0
+    while n.positive?
       d += incr
       n -= 1 if d.fed_workday?
     end
@@ -995,9 +995,9 @@ class Date
   def add_nyse_business_days(n)
     d = dup
     return d if n.zero?
-    incr = n < 0 ? -1 : 1
+    incr = n.negative? ? -1 : 1
     n = n.abs
-    while n > 0
+    while n.positive?
       d += incr
       n -= 1 if d.nyse_workday?
     end

data/lib/fat_core/enumerable.rb

@@ -1,7 +1,18 @@
 module Enumerable
-  # Emit item in groups of n
+  # Yield item in groups of n
   def groups_of(n)
     k = -1
     group_by { k += 1; k.div(n) }
   end
+
+  # Yield each item together with booleans that indicate whether the item is the
+  # first or last in the Enumerable.
+  def each_with_flags
+    last_k = size - 1
+    each_with_index do |v, k|
+      first = (k == 0 ? true : false)
+      last  = (k == last_k ? true : false)
+      yield(v, first, last)
+    end
+  end
 end

data/lib/fat_core/formatters/aoa_formatter.rb

@@ -0,0 +1,84 @@
+module FatCore
+  class AoaFormatter < Formatter
+    def evaluate?
+      true
+    end
+
+    def pre_table
+      '['
+    end
+
+    def post_table
+      ']'
+    end
+
+    def pre_header(_widths)
+      ''
+    end
+
+    def post_header(_widths)
+      ''
+    end
+
+    def pre_row
+      '['
+    end
+
+    def pre_cell(_h)
+      "'"
+    end
+
+    # Because the cell, after conversion to a single-quoted string will be
+    # eval'ed, we need to escape any single-quotes (') that appear in the
+    # string.
+    def quote_cell(v)
+      if v =~ /'/
+        # Use a negative look-behind to only quote single-quotes that are not
+        # already preceded by a backslash
+        v.gsub(/(?<!\\)'/, "'" => "\\'")
+      else
+        v
+      end
+    end
+
+    def post_cell
+      "'"
+    end
+
+    def inter_cell
+      ','
+    end
+
+    def post_row
+      "],\n"
+    end
+
+    def hline(_widths)
+      "nil,\n"
+    end
+
+    def pre_group
+      ''
+    end
+
+    def post_group
+      ''
+    end
+
+    def pre_gfoot
+      ''
+    end
+
+    def post_gfoot
+      ''
+    end
+
+    def pre_foot
+      ''
+    end
+
+    def post_foot
+      ''
+    end
+  end
+end

data/lib/fat_core/formatters/aoh_formatter.rb

@@ -0,0 +1,82 @@
+module FatCore
+  class AohFormatter < Formatter
+    def evaluate?
+      true
+    end
+
+    def pre_table
+      '['
+    end
+
+    def post_table
+      ']'
+    end
+
+    # We include no row for the header because the keys of each hash serve as
+    # the headers.
+    def include_header_row?
+      false
+    end
+
+    def pre_row
+      '{'
+    end
+
+    def pre_cell(h)
+      ":#{h.as_sym} => '"
+    end
+
+    # Because the cell, after conversion to a single-quoted string will be
+    # eval'ed, we need to escape any single-quotes (') that appear in the
+    # string.
+    def quote_cell(v)
+      if v =~ /'/
+        # Use a negative look-behind to only quote single-quotes that are not
+        # already preceded by a backslash
+        v.gsub(/(?<!\\)'/, "'" => "\\'")
+      else
+        v
+      end
+    end
+
+    def post_cell
+      "'"
+    end
+
+    def inter_cell
+      ','
+    end
+
+    def post_row
+      "},\n"
+    end
+
+    def hline(_widths)
+      "nil,\n"
+    end
+
+    def pre_group
+      ''
+    end
+
+    def post_group
+      ''
+    end
+
+    def pre_gfoot
+      ''
+    end
+
+    def post_gfoot
+      ''
+    end
+
+    def pre_foot
+      ''
+    end
+
+    def post_foot
+      ''
+    end
+  end
+end