csv_plus_plus 0.1.1 → 0.1.3

data/lib/csv_plus_plus/writer.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require_relative './writer/base_writer'
@@ -7,18 +8,47 @@ require_relative './writer/google_sheets'
 require_relative './writer/open_document'
 
 module CSVPlusPlus
-  # Various strategies for writing to various formats (excel, google sheets, CSV, OpenDocument)
+  # Various strategies for writing to various formats (excel, google sheets, CSV & OpenDocument (not yet implemented))
   module Writer
-    # Return an instance of a writer depending on the given +options+
-    def self.writer(options)
-      return ::CSVPlusPlus::Writer::GoogleSheets.new(options) if options.google
+    extend ::T::Sig
 
-      case options.output_filename
-      when /\.csv$/ then ::CSVPlusPlus::Writer::CSV.new(options)
-      when /\.ods$/ then ::CSVPlusPlus::Writer::OpenDocument.new(options)
-      when /\.xl(sx|sm|tx|tm)$/ then ::CSVPlusPlus::Writer::Excel.new(options)
-      else raise(::CSVPlusPlus::Error, "Unsupported file extension: #{options.output_filename}")
+    sig do
+      params(
+        options: ::CSVPlusPlus::Options,
+        runtime: ::CSVPlusPlus::Runtime::Runtime
+      ).returns(
+        ::T.any(
+          ::CSVPlusPlus::Writer::CSV,
+          ::CSVPlusPlus::Writer::Excel,
+          ::CSVPlusPlus::Writer::GoogleSheets,
+          ::CSVPlusPlus::Writer::OpenDocument
+        )
+      )
+    end
+    # Return an instance of a writer depending on the given +options+
+    #
+    # @param options [Options] The supplied options.
+    # @param runtime [Runtime] The current runtime.
+    #
+    # @return [Writer::CSV | Writer::Excel | Writer::GoogleSheets | Writer::OpenDocument]
+    # rubocop:disable Metrics/MethodLength
+    def self.writer(options, runtime)
+      output_format = options.output_format
+      case output_format
+      when ::CSVPlusPlus::Options::OutputFormat::CSV then ::CSVPlusPlus::Writer::CSV.new(options, runtime)
+      when ::CSVPlusPlus::Options::OutputFormat::Excel then ::CSVPlusPlus::Writer::Excel.new(options, runtime)
+      when ::CSVPlusPlus::Options::OutputFormat::GoogleSheets then ::CSVPlusPlus::Writer::GoogleSheets.new(
+        options,
+        runtime
+      )
+      when ::CSVPlusPlus::Options::OutputFormat::OpenDocument then ::CSVPlusPlus::Writer::OpenDocument.new(
+        options,
+        runtime
+      )
+      else
+        ::T.absurd(output_format)
       end
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/csv_plus_plus.rb

@@ -1,30 +1,54 @@
+# typed: strict
 # frozen_string_literal: true
 
+require 'sorbet-runtime'
+
+require 'benchmark'
+require 'csv'
+require 'fileutils'
 require 'google/apis/drive_v3'
 require 'google/apis/sheets_v4'
 require 'googleauth'
+require 'optparse'
+require 'pathname'
 require 'rubyXL'
 require 'rubyXL/convenience_methods'
 require 'set'
+require 'tempfile'
+
+require_relative 'csv_plus_plus/source_code'
+
+require_relative 'csv_plus_plus/runtime'
+
+require_relative 'csv_plus_plus/cli_flag'
+require_relative 'csv_plus_plus/entities'
+require_relative 'csv_plus_plus/error'
 
 require_relative 'csv_plus_plus/cell'
 require_relative 'csv_plus_plus/cli'
-require_relative 'csv_plus_plus/code_section'
 require_relative 'csv_plus_plus/color'
-require_relative 'csv_plus_plus/error'
-require_relative 'csv_plus_plus/language/builtins'
-require_relative 'csv_plus_plus/language/compiler'
-require_relative 'csv_plus_plus/language/runtime'
-require_relative 'csv_plus_plus/language/syntax_error'
 require_relative 'csv_plus_plus/modifier'
-require_relative 'csv_plus_plus/modifier.tab'
+
+require_relative 'csv_plus_plus/parser/cell_value.tab'
+require_relative 'csv_plus_plus/parser/code_section.tab'
+require_relative 'csv_plus_plus/parser/modifier.tab'
+
+require_relative 'csv_plus_plus/compiler'
+
+require_relative 'csv_plus_plus/google_options'
+require_relative 'csv_plus_plus/lexer'
 require_relative 'csv_plus_plus/options'
 require_relative 'csv_plus_plus/row'
 require_relative 'csv_plus_plus/template'
 require_relative 'csv_plus_plus/writer'
 
+require_relative 'csv_plus_plus/benchmarked_compiler'
+
 # A programming language for writing rich CSV files
 module CSVPlusPlus
+  extend ::T::Sig
+
+  sig { params(input: ::String, filename: ::T.nilable(::String), options: ::CSVPlusPlus::Options).void }
   # Parse the input into a +Template+ and write it to the desired format
   #
   # @param input [String] The csvpp input to compile
@@ -33,25 +57,27 @@ module CSVPlusPlus
   def self.apply_template_to_sheet!(input, filename, options)
     warn(options.verbose_summary) if options.verbose
 
-    runtime = ::CSVPlusPlus::Language::Runtime.new(input:, filename:)
+    runtime = ::CSVPlusPlus::Runtime.new(source_code: ::CSVPlusPlus::SourceCode.new(input:, filename:))
 
-    ::CSVPlusPlus::Language::Compiler.with_compiler(options:, runtime:) do |compiler|
+    ::CSVPlusPlus::Compiler.with_compiler(options:, runtime:) do |compiler|
       template = compiler.compile_template
-
       warn(template.verbose_summary) if options.verbose
 
-      write_template(template, compiler, options)
+      write_template(template:, compiler:, options:)
     end
   end
 
+  sig do
+    params(compiler: ::CSVPlusPlus::Compiler, options: ::CSVPlusPlus::Options, template: ::CSVPlusPlus::Template).void
+  end
   # Write the results (and possibly make a backup) of a compiled +template+
   #
-  # @param template [Template] The compiled template
   # @param compiler [Compiler] The compiler currently in use
   # @param options [Options] The options we're running with
-  def self.write_template(template, compiler, options)
-    output = ::CSVPlusPlus::Writer.writer(options)
-    compiler.outputting! do
+  # @param template [Template] The compiled template
+  def self.write_template(compiler:, options:, template:)
+    compiler.outputting! do |runtime|
+      output = ::CSVPlusPlus::Writer.writer(options, runtime)
       output.write_backup if options.backup
       output.write(template)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_plus_plus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-11 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-drive_v3
@@ -118,48 +118,64 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - README.md
 - bin/csv++
 - bin/csvpp
+- docs/CHANGELOG.md
 - lib/csv_plus_plus.rb
+- lib/csv_plus_plus/benchmarked_compiler.rb
 - lib/csv_plus_plus/cell.rb
 - lib/csv_plus_plus/cli.rb
 - lib/csv_plus_plus/cli_flag.rb
-- lib/csv_plus_plus/code_section.rb
 - lib/csv_plus_plus/color.rb
+- lib/csv_plus_plus/compiler.rb
+- lib/csv_plus_plus/entities.rb
+- lib/csv_plus_plus/entities/ast_builder.rb
+- lib/csv_plus_plus/entities/boolean.rb
+- lib/csv_plus_plus/entities/builtins.rb
+- lib/csv_plus_plus/entities/cell_reference.rb
+- lib/csv_plus_plus/entities/date.rb
+- lib/csv_plus_plus/entities/entity.rb
+- lib/csv_plus_plus/entities/entity_with_arguments.rb
+- lib/csv_plus_plus/entities/function.rb
+- lib/csv_plus_plus/entities/function_call.rb
+- lib/csv_plus_plus/entities/number.rb
+- lib/csv_plus_plus/entities/runtime_value.rb
+- lib/csv_plus_plus/entities/string.rb
+- lib/csv_plus_plus/entities/variable.rb
 - lib/csv_plus_plus/error.rb
-- lib/csv_plus_plus/expand.rb
+- lib/csv_plus_plus/error/error.rb
+- lib/csv_plus_plus/error/formula_syntax_error.rb
+- lib/csv_plus_plus/error/modifier_syntax_error.rb
+- lib/csv_plus_plus/error/modifier_validation_error.rb
+- lib/csv_plus_plus/error/syntax_error.rb
+- lib/csv_plus_plus/error/writer_error.rb
 - lib/csv_plus_plus/google_api_client.rb
 - lib/csv_plus_plus/google_options.rb
-- lib/csv_plus_plus/graph.rb
-- lib/csv_plus_plus/language/ast_builder.rb
-- lib/csv_plus_plus/language/benchmarked_compiler.rb
-- lib/csv_plus_plus/language/builtins.rb
-- lib/csv_plus_plus/language/cell_value.tab.rb
-- lib/csv_plus_plus/language/code_section.tab.rb
-- lib/csv_plus_plus/language/compiler.rb
-- lib/csv_plus_plus/language/entities.rb
-- lib/csv_plus_plus/language/entities/boolean.rb
-- lib/csv_plus_plus/language/entities/cell_reference.rb
-- lib/csv_plus_plus/language/entities/entity.rb
-- lib/csv_plus_plus/language/entities/function.rb
-- lib/csv_plus_plus/language/entities/function_call.rb
-- lib/csv_plus_plus/language/entities/number.rb
-- lib/csv_plus_plus/language/entities/runtime_value.rb
-- lib/csv_plus_plus/language/entities/string.rb
-- lib/csv_plus_plus/language/entities/variable.rb
-- lib/csv_plus_plus/language/references.rb
-- lib/csv_plus_plus/language/runtime.rb
-- lib/csv_plus_plus/language/scope.rb
-- lib/csv_plus_plus/language/syntax_error.rb
 - lib/csv_plus_plus/lexer.rb
 - lib/csv_plus_plus/lexer/lexer.rb
 - lib/csv_plus_plus/lexer/tokenizer.rb
 - lib/csv_plus_plus/modifier.rb
-- lib/csv_plus_plus/modifier.tab.rb
+- lib/csv_plus_plus/modifier/conditional_formatting.rb
+- lib/csv_plus_plus/modifier/data_validation.rb
+- lib/csv_plus_plus/modifier/expand.rb
+- lib/csv_plus_plus/modifier/google_sheet_modifier.rb
+- lib/csv_plus_plus/modifier/modifier.rb
+- lib/csv_plus_plus/modifier/modifier_validator.rb
+- lib/csv_plus_plus/modifier/rubyxl_modifier.rb
 - lib/csv_plus_plus/options.rb
+- lib/csv_plus_plus/parser/cell_value.tab.rb
+- lib/csv_plus_plus/parser/code_section.tab.rb
+- lib/csv_plus_plus/parser/modifier.tab.rb
 - lib/csv_plus_plus/row.rb
+- lib/csv_plus_plus/runtime.rb
+- lib/csv_plus_plus/runtime/can_define_references.rb
+- lib/csv_plus_plus/runtime/can_resolve_references.rb
+- lib/csv_plus_plus/runtime/graph.rb
+- lib/csv_plus_plus/runtime/position_tracker.rb
+- lib/csv_plus_plus/runtime/references.rb
+- lib/csv_plus_plus/runtime/runtime.rb
+- lib/csv_plus_plus/source_code.rb
 - lib/csv_plus_plus/template.rb
 - lib/csv_plus_plus/version.rb
 - lib/csv_plus_plus/writer.rb
@@ -168,11 +184,9 @@ files:
 - lib/csv_plus_plus/writer/excel.rb
 - lib/csv_plus_plus/writer/file_backer_upper.rb
 - lib/csv_plus_plus/writer/google_sheet_builder.rb
-- lib/csv_plus_plus/writer/google_sheet_modifier.rb
 - lib/csv_plus_plus/writer/google_sheets.rb
 - lib/csv_plus_plus/writer/open_document.rb
 - lib/csv_plus_plus/writer/rubyxl_builder.rb
-- lib/csv_plus_plus/writer/rubyxl_modifier.rb
 homepage: https://github.com/patrickomatic/csv-plus-plus
 licenses:
 - MIT
@@ -182,7 +196,7 @@ metadata:
   github_repo: git://github.com/patrickomatic/csv-plus-plus
   homepage_uri: https://github.com/patrickomatic/csv-plus-plus
   source_code_uri: https://github.com/patrickomatic/csv-plus-plus
-  changelog_uri: https://github.com/patrickomatic/csv-plus-plus/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/patrickomatic/csv-plus-plus/blob/main/docs/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/lib/csv_plus_plus/code_section.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './language/code_section.tab'
-require_relative './language/entities'
-
-module CSVPlusPlus
-  # A representation of the code section part of a template (the variable and function definitions)
-  #
-  # @attr variables [Hash<Symbol, Variable>] All defined variables
-  # @attr_reader functions [Hash<Symbol, Function>] All defined functions
-  class CodeSection
-    attr_reader :functions
-    attr_accessor :variables
-
-    # @param variables [Hash<Symbol, Variable>] Initial variables
-    # @param functions [Hash<Symbol, Variable>] Initial functions
-    def initialize(variables: {}, functions: {})
-      @variables = variables
-      @functions = functions
-    end
-
-    # 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
-    def def_variable(id, entity)
-      @variables[id.to_sym] = entity
-    end
-
-    # Define (or re-define existing) variables
-    #
-    # @param variables [Hash<Symbol, Variable>] Variables to define
-    def def_variables(variables)
-      variables.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
-    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
-
-    # @return [String]
-    def to_s
-      "CodeSection(functions: #{@functions}, variables: #{@variables})"
-    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

data/lib/csv_plus_plus/expand.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  Expand =
-    ::Struct.new(:repetitions) do
-      # Does this infinitely expand?
-      def infinite?
-        repetitions.nil?
-      end
-
-      # to_s
-      def to_s
-        "Expand #{repetitions || 'infinity'}"
-      end
-    end
-
-  public_constant :Expand
-end

data/lib/csv_plus_plus/graph.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'tsort'
-
-module CSVPlusPlus
-  # Graph ordering and searching functions
-  module Graph
-    # Get a list of all variables references in a given +ast+
-    # TODO: this is only used in one place - refactor it
-    def self.variable_references(ast, runtime, include_runtime_variables: false)
-      depth_first_search(ast) do |node|
-        next unless node.variable?
-
-        node.id if !runtime.runtime_variable?(node.id) || include_runtime_variables
-      end
-    end
-
-    # Create a dependency graph of +variables+
-    def self.dependency_graph(variables, runtime)
-      ::CSVPlusPlus::Graph::DependencyGraph[
-        variables.map { |var_id, ast| [var_id, variable_references(ast, runtime)] }
-      ]
-    end
-
-    # Perform a topological sort on a +DependencyGraph+.  A toplogical sort is noteworthy
-    # because it will give us the order in which we need to resolve our variable dependencies.
-    #
-    # Given this dependency graph:
-    #
-    #  { a: [b c], b: [c], c: [d], d: [] }
-    #
-    # it will return:
-    #
-    #  [d, c, b, a]
-    #
-    def self.topological_sort(dependencies)
-      dependencies.tsort
-    end
-
-    # Do a DFS on an AST starting at +node+
-    def self.depth_first_search(node, accum = [], &)
-      ret = yield(node)
-      accum << ret unless ret.nil?
-
-      return accum unless node.function_call?
-
-      node.arguments.each { |n| depth_first_search(n, accum, &) }
-      accum
-    end
-
-    # A dependency graph represented as a +Hash+ which will be used by our +topological_sort+ function
-    class DependencyGraph < Hash
-      include ::TSort
-      alias tsort_each_node each_key
-
-      # sort each child
-      def tsort_each_child(node, &)
-        fetch(node).each(&)
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/ast_builder.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './entities'
-
-module CSVPlusPlus
-  module Language
-    # Some helpful functions that can be mixed into a class to help building ASTs
-    module ASTBuilder
-      # Let the current class have functions which can build a given entity by calling it's type.  For example
-      # +number(1)+, +variable(:foo)+
-      #
-      # @param method_name [Symbol] The +method_name+ to respond to
-      # @param arguments [] The arguments to create the entity with
-      #
-      # @return [Entity, #super]
-      def method_missing(method_name, *args, **kwargs, &)
-        entity_class = ::CSVPlusPlus::Language::TYPES[method_name.to_sym]
-        return super unless entity_class
-
-        entity_class.new(*args, **kwargs, &)
-      end
-
-      # Let the current class have functions which can build a given entity by calling it's type.  For example
-      # +number(1)+, +variable(:foo)+
-      #
-      # @param method_name [Symbol] The +method_name+ to respond to
-      # @param arguments [] The arguments to create the entity with
-      #
-      # @return [Boolean, #super]
-      def respond_to_missing?(method_name, *_arguments)
-        ::CSVPlusPlus::Language::TYPES.include?(method_name.to_sym) || super
-      end
-
-      # Turns index-based/X,Y coordinates into a A1 format
-      #
-      # @param row_index [Integer]
-      # @param cell_index [Integer]
-      #
-      # @return [String]
-      def ref(row_index: nil, cell_index: nil)
-        return unless row_index || cell_index
-
-        rowref = row_index ? (row_index + 1).to_s : ''
-        cellref = cell_index ? cell_ref(cell_index) : ''
-        cell_reference([cellref, rowref].join)
-      end
-
-      private
-
-      ALPHA = ('A'..'Z').to_a.freeze
-      private_constant :ALPHA
-
-      def cell_ref(cell_index)
-        c = cell_index.dup
-        ref = ''
-
-        while c >= 0
-          # rubocop:disable Lint/ConstantResolution
-          ref += ALPHA[c % 26]
-          # rubocop:enable Lint/ConstantResolution
-          c = (c / 26).floor - 1
-        end
-
-        ref.reverse
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/benchmarked_compiler.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark'
-
-module CSVPlusPlus
-  module Language
-    # Extend a +Compiler+ class and add benchmark timings
-    # @attr_reader timings [Array<Benchmark::Tms>] +Benchmark+ timings that have been accumulated by each step of
-    #   compilation
-    # @attr_reader benchmark [Benchmark] A +Benchmark+ instance
-    module BenchmarkedCompiler
-      attr_reader :benchmark, :timings
-
-      # Wrap a +Compiler+ with our instance methods that add benchmarks
-      def self.with_benchmarks(compiler, &block)
-        ::Benchmark.benchmark(::Benchmark::CAPTION, 25, ::Benchmark::FORMAT, '> Total') do |x|
-          # compiler = new(options:, runtime:, benchmark: x)
-          compiler.extend(self)
-          compiler.benchmark = x
-
-          block.call(compiler)
-
-          [compiler.timings.reduce(:+)]
-        end
-      end
-
-      # @param benchmark [Benchmark] A +Benchmark+ instance
-      def benchmark=(benchmark)
-        @benchmark = benchmark
-        @timings = []
-      end
-
-      # Time the Compiler#outputting! stage
-      def outputting!
-        time_stage('Writing the spreadsheet') { super }
-      end
-
-      protected
-
-      def parse_code_section!
-        time_stage('Parsing code section') { super }
-      end
-
-      def parse_csv_section!
-        time_stage('Parsing CSV section') { super }
-      end
-
-      def expanding
-        time_stage('Expanding rows') { super }
-      end
-
-      def resolve_all_cells!(template)
-        time_stage('Resolving each cell') { super(template) }
-      end
-
-      private
-
-      def time_stage(stage, &block)
-        ret = nil
-        @timings << @benchmark.report(stage) { ret = block.call }
-        ret
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/builtins.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './ast_builder'
-
-module CSVPlusPlus
-  module Language
-    # Provides ASTs for builtin functions and variables
-    module Builtins
-      extend ::CSVPlusPlus::Language::ASTBuilder
-
-      VARIABLES = {
-        # The number (integer) of the current cell. Starts at 1
-        cellnum: runtime_value(->(runtime) { number(runtime.cell_index + 1) }),
-
-        # A reference to the current cell
-        cellref: runtime_value(->(runtime) { ref(row_index: runtime.row_index, cell_index: runtime.cell_index) }),
-
-        # A reference to the row above
-        rowabove: runtime_value(->(runtime) { ref(row_index: [0, (runtime.row_index - 1)].max) }),
-
-        # A reference to the row below
-        rowbelow: runtime_value(->(runtime) { ref(row_index: runtime.row_index + 1) }),
-
-        # The number (integer) of the current row.  Starts at 1
-        rownum: runtime_value(->(runtime) { number(runtime.rownum) }),
-
-        # A reference to the current row
-        rowref: runtime_value(->(runtime) { ref(row_index: runtime.row_index) })
-      }.freeze
-      public_constant :VARIABLES
-
-      FUNCTIONS = {
-        # TODO: A reference to a cell in a given row?
-        # A reference to a cell above the current row
-        cellabove: runtime_value(->(runtime, args) { cell_reference([args[0], [1, (runtime.rownum - 1)].max].join) }),
-
-        # A reference to a cell in the current row
-        celladjacent: runtime_value(->(runtime, args) { cell_reference([args[0], runtime.rownum].join) }),
-
-        # A reference to a cell below the current row
-        cellbelow: runtime_value(->(runtime, args) { cell_reference([args[0], runtime.rownum + 1].join) })
-      }.freeze
-      public_constant :FUNCTIONS
-    end
-  end
-end