csv_plus_plus 0.1.1 → 0.1.3

data/lib/csv_plus_plus/parser/modifier.tab.rb

@@ -0,0 +1,478 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.6.2
+# from Racc grammar file "".
+#
+
+require 'racc/parser.rb'
+
+
+require_relative '../lexer'
+
+module CSVPlusPlus
+  module Parser
+    class Modifier < Racc::Parser
+
+module_eval(<<'...end modifier.y/module_eval...', 'modifier.y', 60)
+  attr_reader :return_value
+
+  include ::CSVPlusPlus::Lexer
+
+  # @param cell_modifier [Modifier]
+  # @param row_modifier [Modifier]
+  def initialize(cell_modifier:, row_modifier:)
+    super()
+
+    @parsing_row = false
+    @cell_modifier = ::CSVPlusPlus::Modifier::ModifierValidator.new(cell_modifier)
+    @row_modifier = ::CSVPlusPlus::Modifier::ModifierValidator.new(row_modifier)
+  end
+
+  protected
+
+  def anything_to_parse?(input)
+    @modifiers_to_parse = input.scan(/!?\[\[/).count
+
+    if @modifiers_to_parse == 0
+      assign_defaults!
+      @return_value = input
+    end
+
+    @modifiers_to_parse > 0
+  end
+
+  def parse_subject
+    'modifier'
+  end
+
+  def tokenizer
+    ::CSVPlusPlus::Lexer::Tokenizer.new(
+      ignore: /\s+/,
+      stop_fn: lambda do |scanner|
+        return false unless scanner.scan(/\]\]/)
+
+        @tokens << [:END_MODIFIERS, scanner.matched]
+        @return_value = scanner.rest
+
+        @modifiers_to_parse -= 1
+        @modifiers_to_parse == 0
+      end,
+      tokens: [
+        [/\bborder\b/, 'border'],
+        [/\bbordercolor\b/, 'bordercolor'],
+        [/\bborderstyle\b/, 'borderstyle'],
+        [/\bcolor\b/, 'color'],
+        [/\bexpand\b/, 'expand'],
+        [/\bfontcolor\b/, 'fontcolor'],
+        [/\bfontfamily\b/, 'fontfamily'],
+        [/\bfontsize\b/, 'fontsize'],
+        [/\bformat\b/, 'format'],
+        [/\bfreeze\b/, 'freeze'],
+        [/\bhalign\b/, 'halign'],
+        [/\bnote\b/, 'note'],
+        [/\bnumberformat\b/, 'numberformat'],
+        [/\bvalidate\b/, 'validate'],
+        [/\bvalign\b/, 'valign'],
+        [/\bvar\b/, 'var'],
+        [/-?[\d.]+/, :NUMBER],
+        TOKEN_LIBRARY[:HEX_COLOR],
+        [
+          /
+            (?:
+              \w+\s*:\s*'([^'\\]|\\.)*')    # allow for a single-quoted string which can accept any input and also allow 
+                                            # for escaping via backslash (i.e., 'ain\\'t won\\'t something' is valid)
+              |                             # - or -
+            (?:'([^'\\]|\\.)*')             # allow for a single-quoted string which can accept any input and also allow 
+              |
+            (?:
+              [\w,_:-]                      # something that accepts most basic input if it doesn't need to be quoted
+              [\w\s,_:-]+                   # same thing but allow spaces in the middle
+              [\w,_:-]                      # no spaces at the end
+            )
+          /x,
+          :RIGHT_SIDE,
+        ],
+        [/\[\[/, :START_CELL_MODIFIERS],
+        [/!\[\[/, :START_ROW_MODIFIERS],
+        [/\//, :MODIFIER_SEPARATOR],
+        [/=/, :EQ],
+      ],
+      alter_matches: {
+        STRING: ->(s) { s.gsub(/^'|'$/, '') }
+      },
+    )
+  end
+
+  private
+
+  def assign_defaults!
+    @cell_modifier.modifier.take_defaults_from!(@row_modifier.modifier)
+  end
+
+  def parsing_row!
+    @parsing_row = true
+  end
+
+  def finished_row!
+    parsing_cell!
+  end
+
+  def parsing_cell!
+    @parsing_row = false
+    assign_defaults!
+  end
+
+  def modifier
+    @parsing_row ? @row_modifier : @cell_modifier
+  end
+...end modifier.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+    13,    14,    15,    16,    17,    18,    19,    20,    21,    22,
+    23,    24,    25,    26,    27,    28,    13,    14,    15,    16,
+    17,    18,    19,    20,    21,    22,    23,    24,    25,    26,
+    27,    28,    13,    14,    15,    16,    17,    18,    19,    20,
+    21,    22,    23,    24,    25,    26,    27,    28,    30,    47,
+     5,     4,     6,    31,    31,     5,    10,    32,    33,    34,
+    35,    36,    37,    38,    39,    40,    41,    42,    43,    44,
+    45,    46,    49,    50,    51,    52,    53,    54,    55,    56,
+    57,    58,    59,    60,    61,    62,    63 ]
+
+racc_action_check = [
+     8,     8,     8,     8,     8,     8,     8,     8,     8,     8,
+     8,     8,     8,     8,     8,     8,     9,     9,     9,     9,
+     9,     9,     9,     9,     9,     9,     9,     9,     9,     9,
+     9,     9,    31,    31,    31,    31,    31,    31,    31,    31,
+    31,    31,    31,    31,    31,    31,    31,    31,    11,    29,
+     0,     0,     1,    11,    29,     2,     6,    13,    14,    15,
+    16,    17,    18,    19,    20,    21,    23,    24,    25,    26,
+    27,    28,    32,    33,    34,    35,    36,    37,    38,    39,
+    40,    41,    42,    43,    44,    45,    46 ]
+
+racc_action_pointer = [
+    36,    52,    41,   nil,   nil,   nil,    56,   nil,   -17,    -1,
+   nil,    41,   nil,    49,    50,    51,    52,    53,    54,    55,
+    56,    57,   nil,    58,    59,    60,    61,    62,    63,    42,
+   nil,    15,    59,    64,    61,    66,    66,    68,    65,    69,
+    67,    68,    69,    70,    71,    72,    73,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil ]
+
+racc_action_default = [
+   -27,   -27,    -2,    -3,    -4,    -6,   -27,    -1,   -27,   -27,
+    64,   -27,    -9,   -27,   -27,   -27,   -27,   -15,   -27,   -27,
+   -27,   -27,   -20,   -27,   -27,   -27,   -27,   -27,   -27,   -27,
+    -5,   -27,   -27,   -27,   -27,   -27,   -27,   -27,   -27,   -27,
+   -27,   -27,   -27,   -27,   -27,   -27,   -27,    -7,    -8,   -10,
+   -11,   -12,   -13,   -14,   -16,   -17,   -18,   -19,   -21,   -22,
+   -23,   -24,   -25,   -26 ]
+
+racc_goto_table = [
+     3,     1,     7,    11,    29,     2,     8,     9,    48 ]
+
+racc_goto_check = [
+     3,     1,     3,     4,     4,     2,     5,     6,     7 ]
+
+racc_goto_pointer = [
+   nil,     1,     5,     0,    -5,     2,     2,   -23 ]
+
+racc_goto_default = [
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,    12 ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  2, 34, :_reduce_none,
+  1, 34, :_reduce_none,
+  1, 34, :_reduce_none,
+  0, 38, :_reduce_4,
+  4, 35, :_reduce_5,
+  0, 39, :_reduce_6,
+  4, 36, :_reduce_none,
+  3, 37, :_reduce_none,
+  1, 37, :_reduce_none,
+  3, 40, :_reduce_10,
+  3, 40, :_reduce_11,
+  3, 40, :_reduce_12,
+  3, 40, :_reduce_13,
+  3, 40, :_reduce_14,
+  1, 40, :_reduce_15,
+  3, 40, :_reduce_16,
+  3, 40, :_reduce_17,
+  3, 40, :_reduce_18,
+  3, 40, :_reduce_19,
+  1, 40, :_reduce_20,
+  3, 40, :_reduce_21,
+  3, 40, :_reduce_22,
+  3, 40, :_reduce_23,
+  3, 40, :_reduce_24,
+  3, 40, :_reduce_25,
+  3, 40, :_reduce_26 ]
+
+racc_reduce_n = 27
+
+racc_shift_n = 64
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  "![[" => 2,
+  "[[" => 3,
+  "]]" => 4,
+  "=" => 5,
+  "/" => 6,
+  :END_MODIFIERS => 7,
+  :EQ => 8,
+  :HEX_COLOR => 9,
+  :NUMBER => 10,
+  :MODIFIER => 11,
+  :MODIFIER_SEPARATOR => 12,
+  :RIGHT_SIDE => 13,
+  :START_CELL_MODIFIERS => 14,
+  :START_ROW_MODIFIERS => 15,
+  :STRING => 16,
+  "border" => 17,
+  "bordercolor" => 18,
+  "borderstyle" => 19,
+  "color" => 20,
+  "expand" => 21,
+  "fontcolor" => 22,
+  "fontfamily" => 23,
+  "fontsize" => 24,
+  "format" => 25,
+  "freeze" => 26,
+  "halign" => 27,
+  "note" => 28,
+  "numberformat" => 29,
+  "validate" => 30,
+  "valign" => 31,
+  "var" => 32 }
+
+racc_nt_base = 33
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "\"![[\"",
+  "\"[[\"",
+  "\"]]\"",
+  "\"=\"",
+  "\"/\"",
+  "END_MODIFIERS",
+  "EQ",
+  "HEX_COLOR",
+  "NUMBER",
+  "MODIFIER",
+  "MODIFIER_SEPARATOR",
+  "RIGHT_SIDE",
+  "START_CELL_MODIFIERS",
+  "START_ROW_MODIFIERS",
+  "STRING",
+  "\"border\"",
+  "\"bordercolor\"",
+  "\"borderstyle\"",
+  "\"color\"",
+  "\"expand\"",
+  "\"fontcolor\"",
+  "\"fontfamily\"",
+  "\"fontsize\"",
+  "\"format\"",
+  "\"freeze\"",
+  "\"halign\"",
+  "\"note\"",
+  "\"numberformat\"",
+  "\"validate\"",
+  "\"valign\"",
+  "\"var\"",
+  "$start",
+  "modifiers_definition",
+  "row_modifiers",
+  "cell_modifiers",
+  "modifiers",
+  "@1",
+  "@2",
+  "modifier" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+# reduce 1 omitted
+
+# reduce 2 omitted
+
+# reduce 3 omitted
+
+module_eval(<<'.,.,', 'modifier.y', 25)
+  def _reduce_4(val, _values, result)
+     parsing_row!
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 27)
+  def _reduce_5(val, _values, result)
+     finished_row!
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 29)
+  def _reduce_6(val, _values, result)
+     parsing_cell!
+    result
+  end
+.,.,
+
+# reduce 7 omitted
+
+# reduce 8 omitted
+
+# reduce 9 omitted
+
+module_eval(<<'.,.,', 'modifier.y', 35)
+  def _reduce_10(val, _values, result)
+     modifier.border = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 36)
+  def _reduce_11(val, _values, result)
+     modifier.bordercolor = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 37)
+  def _reduce_12(val, _values, result)
+     modifier.borderstyle = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 38)
+  def _reduce_13(val, _values, result)
+     modifier.color = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 39)
+  def _reduce_14(val, _values, result)
+     modifier.expand = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 40)
+  def _reduce_15(val, _values, result)
+     modifier.infinite_expand!
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 41)
+  def _reduce_16(val, _values, result)
+     modifier.fontcolor = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 42)
+  def _reduce_17(val, _values, result)
+     modifier.fontfamily = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 43)
+  def _reduce_18(val, _values, result)
+     modifier.fontsize = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 44)
+  def _reduce_19(val, _values, result)
+     modifier.format = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 45)
+  def _reduce_20(val, _values, result)
+     modifier.freeze!
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 46)
+  def _reduce_21(val, _values, result)
+     modifier.halign = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 47)
+  def _reduce_22(val, _values, result)
+     modifier.note = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 48)
+  def _reduce_23(val, _values, result)
+     modifier.numberformat = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 49)
+  def _reduce_24(val, _values, result)
+     modifier.validate = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 50)
+  def _reduce_25(val, _values, result)
+     modifier.valign = val[2]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'modifier.y', 51)
+  def _reduce_26(val, _values, result)
+     modifier.var = val[2]
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class Modifier
+  end   # module Parser
+end   # module CSVPlusPlus

data/lib/csv_plus_plus/row.rb

@@ -1,26 +1,37 @@
+# typed: strict
 # frozen_string_literal: true
 
-require_relative 'cell'
-require_relative 'modifier.tab'
-
 module CSVPlusPlus
-  # A row of a template
+  # A row of a template.  A row contains an +Array+ of +Cell+s and possibly a row-level +Modifier+.
   #
-  # @attr_reader cells [Array<Cell>]
-  # @attr_reader index [Integer] The index of this row
+  # @attr_reader cells [Array<Cell>] The cells contained by this row.
+  # @attr_reader index [Integer] The index of this row. Starts at 0.
   # @attr_reader modifier [Modifier] The modifier to apply to all cells in this row
   class Row
-    attr_reader :cells, :index, :modifier
+    extend ::T::Sig
 
-    # @param index [Integer] The index of this row (starts at 0)
+    sig { returns(::T::Array[::CSVPlusPlus::Cell]) }
+    attr_reader :cells
+
+    sig { returns(::Integer) }
+    attr_reader :index
+
+    sig { returns(::CSVPlusPlus::Modifier::Modifier) }
+    attr_reader :modifier
+
+    sig do
+      params(cells: ::T::Array[::CSVPlusPlus::Cell], index: ::Integer, modifier: ::CSVPlusPlus::Modifier::Modifier).void
+    end
     # @param cells [Array<Cell>] The cells belonging to this row
+    # @param index [Integer] The index of this row (starts at 0)
     # @param modifier [Modifier] The modifier to apply to all cells in this row
-    def initialize(index, cells, modifier)
+    def initialize(cells:, index:, modifier:)
       @cells = cells
       @modifier = modifier
       @index = index
     end
 
+    sig { params(index: ::Integer).void }
     # Set the row's +index+ and update the +row_index+ of all affected cells
     #
     # @param index [Integer] The index of this row (starts at 0)
@@ -29,25 +40,52 @@ module CSVPlusPlus
       @cells.each { |cell| cell.row_index = index }
     end
 
+    sig { returns(::Integer) }
     # How much this row will expand itself, if at all (0)
     #
     # @return [Integer]
     def expand_amount
-      return 0 unless @modifier.expand
+      return 0 if @modifier.expand.nil?
+
+      ::T.must(@modifier.expand).repetitions || (1000 - @index)
+    end
+
+    sig { params(starts_at: ::Integer, into: ::T::Array[::CSVPlusPlus::Row]).returns(::T::Array[::CSVPlusPlus::Row]) }
+    # Starting at +starts_at+, do a deep copy of this row into the +Array+ referenced by +into+.
+    #
+    # @param starts_at [Integer] The +row_index+ where this row was expanded.
+    # @param into [Array<Row>] An array where the expanded rows will be accumulated.
+    #
+    # @return [Array<Row>] The rows expanded
+    def expand_rows(starts_at:, into: [])
+      return into if @modifier.expand.nil?
 
-      @modifier.expand.repetitions || (1000 - @index)
+      ::T.must(@modifier.expand).starts_at = starts_at
+
+      starts_at.upto(expand_amount + starts_at - 1) do |row_index|
+        into << deep_clone.tap { |c| c.index = row_index }
+      end
+      into
     end
 
-    # @return [String]
-    def to_s
-      "Row(index: #{index}, modifier: #{modifier}, cells: #{cells})"
+    sig { returns(::T::Boolean) }
+    # Does the row have an ![[expand]] modifier but is yet to be expanded?
+    #
+    # @return [T::Boolean]
+    def unexpanded?
+      return false if @modifier.expand.nil?
+
+      !::T.must(@modifier.expand).expanded?
     end
 
+    private
+
+    sig { returns(::CSVPlusPlus::Row) }
     # Return a deep copy of this row
     #
     # @return [Row]
     def deep_clone
-      ::Marshal.load(::Marshal.dump(self))
+      ::T.cast(::Marshal.load(::Marshal.dump(self)), ::CSVPlusPlus::Row)
     end
   end
 end

data/lib/csv_plus_plus/runtime/can_define_references.rb

@@ -0,0 +1,87 @@
+# typed: true
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  module Runtime
+    # Methods for classes that need to manage +@variables+ and +@functions+
+    module CanDefineReferences
+      # Define a (or re-define an existing) variable
+      #
+      # @param id [String, Symbol] The identifier for the variable
+      # @param entity [Entity] The value (entity) the variable holds
+      #
+      # @return [Entity] The value of the variable (+entity+)
+      def def_variable(id, entity)
+        @variables[id.to_sym] = entity
+      end
+
+      # Define (or re-define existing) variables
+      #
+      # @param vars [Hash<Symbol, Variable>] Variables to define
+      def def_variables(vars)
+        vars.each { |id, entity| def_variable(id, entity) }
+      end
+
+      # Define a (or re-define an existing) function
+      #
+      # @param id [String, Symbol] The identifier for the function
+      # @param entity [Entities::Function] The defined function
+      #
+      # @return [Entities::Function] The defined function
+      def def_function(id, entity)
+        @functions[id.to_sym] = entity
+      end
+
+      # Is the variable defined?
+      #
+      # @param var_id [Symbol, String] The identifier of the variable
+      #
+      # @return [boolean]
+      def defined_variable?(var_id)
+        @variables.key?(var_id.to_sym)
+      end
+
+      # Is the function defined?
+      #
+      # @param fn_id [Symbol, String] The identifier of the function
+      #
+      # @return [boolean]
+      def defined_function?(fn_id)
+        @functions.key?(fn_id.to_sym)
+      end
+
+      # Provide a summary of the functions and variables compiled (to show in verbose mode)
+      #
+      # @return [String]
+      def verbose_summary
+        <<~SUMMARY
+          # Code Section Summary
+
+          ## Resolved Variables
+
+          #{variable_summary}
+
+          ## Functions
+
+          #{function_summary}
+        SUMMARY
+      end
+
+      private
+
+      def variable_summary
+        return '(no variables defined)' if @variables.empty?
+
+        @variables.map { |k, v| "#{k} := #{v}" }
+                  .join("\n")
+      end
+
+      def function_summary
+        return '(no functions defined)' if @functions.empty?
+
+        @functions.map { |k, f| "#{k}: #{f}" }
+                  .join("\n")
+      end
+    end
+  end
+end