csv_plus_plus 0.1.2 → 0.2.0

data/lib/csv_plus_plus.rb

@@ -1,66 +1,95 @@
+# 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 'strscan'
 require 'tempfile'
 
+require_relative 'csv_plus_plus/a1_reference'
+require_relative 'csv_plus_plus/google_api_client'
+require_relative 'csv_plus_plus/options'
+require_relative 'csv_plus_plus/runtime/position'
+require_relative 'csv_plus_plus/source_code'
+
+require_relative 'csv_plus_plus/cli_flag'
 require_relative 'csv_plus_plus/entities'
 require_relative 'csv_plus_plus/error'
+require_relative 'csv_plus_plus/error_formatter'
 
-require_relative 'csv_plus_plus/cell'
 require_relative 'csv_plus_plus/cli'
+require_relative 'csv_plus_plus/runtime'
+
+require_relative 'csv_plus_plus/cell'
 require_relative 'csv_plus_plus/color'
+require_relative 'csv_plus_plus/modifier'
+
+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/runtime'
 
 require_relative 'csv_plus_plus/lexer'
-require_relative 'csv_plus_plus/lexer/tokenizer'
-require_relative 'csv_plus_plus/modifier'
-require_relative 'csv_plus_plus/options'
-require_relative 'csv_plus_plus/parser/modifier.tab'
+require_relative 'csv_plus_plus/reader'
 require_relative 'csv_plus_plus/row'
 require_relative 'csv_plus_plus/template'
-require_relative 'csv_plus_plus/validated_modifier'
 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(source_code: ::CSVPlusPlus::SourceCode, options: ::CSVPlusPlus::Options::Options).void }
   # Parse the input into a +Template+ and write it to the desired format
   #
-  # @param input [String] The csvpp input to compile
-  # @param filename [String, nil] The filename the input was read from.  +nil+ if it is read from stdin.
+  # @param source_code [SourceCode] The source code being compiled
   # @param options [Options] The various options to compile with
-  def self.apply_template_to_sheet!(input, filename, options)
-    warn(options.verbose_summary) if options.verbose
+  def self.cli_compile(source_code, options)
+    runtime = ::CSVPlusPlus::Runtime.new(source_code:)
 
-    runtime = ::CSVPlusPlus::Runtime.new(input:, filename:)
+    warn(options.verbose_summary) if options.verbose
 
     ::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
+  rescue ::StandardError => e
+    ::CSVPlusPlus::ErrorFormatter.new(runtime: ::T.must(runtime), options:).handle_error(e)
+    # the caller will exit(1)
+    raise(e)
   end
 
+  sig do
+    params(
+      compiler: ::CSVPlusPlus::Compiler,
+      options: ::CSVPlusPlus::Options::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)
-    compiler.outputting! do
-      output = ::CSVPlusPlus::Writer.writer(options)
+  # @param template [Template] The compiled template
+  def self.write_template(compiler:, options:, template:)
+    compiler.outputting! do |position|
+      output = ::CSVPlusPlus::Writer.writer(options, position)
       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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-drive_v3
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,71 +132,86 @@ 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/a1_reference.rb
 - lib/csv_plus_plus/benchmarked_compiler.rb
-- lib/csv_plus_plus/can_define_references.rb
-- lib/csv_plus_plus/can_resolve_references.rb
 - lib/csv_plus_plus/cell.rb
 - lib/csv_plus_plus/cli.rb
 - lib/csv_plus_plus/cli_flag.rb
 - lib/csv_plus_plus/color.rb
 - lib/csv_plus_plus/compiler.rb
-- lib/csv_plus_plus/data_validation.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/has_identifier.rb
 - lib/csv_plus_plus/entities/number.rb
+- lib/csv_plus_plus/entities/reference.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/error/cli_error.rb
+- lib/csv_plus_plus/error/compiler_error.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/positional_error.rb
 - lib/csv_plus_plus/error/writer_error.rb
-- lib/csv_plus_plus/expand.rb
+- lib/csv_plus_plus/error_formatter.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/lexer.rb
-- lib/csv_plus_plus/lexer/lexer.rb
+- lib/csv_plus_plus/lexer/racc_lexer.rb
 - lib/csv_plus_plus/lexer/tokenizer.rb
 - lib/csv_plus_plus/modifier.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/options/file_options.rb
+- lib/csv_plus_plus/options/google_sheets_options.rb
+- lib/csv_plus_plus/options/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/references.rb
+- lib/csv_plus_plus/reader.rb
+- lib/csv_plus_plus/reader/csv.rb
+- lib/csv_plus_plus/reader/google_sheets.rb
+- lib/csv_plus_plus/reader/reader.rb
+- lib/csv_plus_plus/reader/rubyxl.rb
 - lib/csv_plus_plus/row.rb
 - lib/csv_plus_plus/runtime.rb
-- lib/csv_plus_plus/scope.rb
+- lib/csv_plus_plus/runtime/graph.rb
+- lib/csv_plus_plus/runtime/position.rb
+- lib/csv_plus_plus/runtime/references.rb
+- lib/csv_plus_plus/runtime/runtime.rb
+- lib/csv_plus_plus/runtime/scope.rb
+- lib/csv_plus_plus/source_code.rb
 - lib/csv_plus_plus/template.rb
-- lib/csv_plus_plus/validated_modifier.rb
 - lib/csv_plus_plus/version.rb
 - lib/csv_plus_plus/writer.rb
-- lib/csv_plus_plus/writer/base_writer.rb
 - lib/csv_plus_plus/writer/csv.rb
 - 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/google_sheets_builder.rb
+- lib/csv_plus_plus/writer/merger.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
+- lib/csv_plus_plus/writer/writer.rb
 homepage: https://github.com/patrickomatic/csv-plus-plus
 licenses:
 - MIT
@@ -192,7 +221,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/can_define_references.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  # 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
-    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(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
-    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 variables
-      @variables ||= {}
-    end
-
-    def functions
-      @functions ||= {}
-    end
-
-    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/can_resolve_references.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  # Methods for classes that need to resolve references
-  module CanResolveReferences
-    # TODO
-  end
-end

data/lib/csv_plus_plus/data_validation.rb

@@ -1,138 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  # A validation on a cell value.  Used to support the `validate=` modifier directive.  This is mostly based on the
-  # Google Sheets API spec which can be seen here:
-  #
-  # {https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ConditionType}
-  #
-  # @attr_reader arguments [Array<::String>] The parsed arguments as required by the condition.
-  # @attr_reader condition [Symbol] The condition (:blank, :text_eq, :date_before, etc.)
-  # @attr_reader invalid_reason [::String, nil] If set, the reason why this modifier is not valid.
-  class DataValidation
-    attr_reader :arguments, :condition, :invalid_reason
-
-    # @param value [::String] The value to parse as a data validation
-    def initialize(value)
-      condition, args = unquote(value).split(/\s*:\s*/)
-      @arguments = unquote(args || '').split(/\s+/)
-      @condition = condition.to_sym
-
-      validate!
-    end
-
-    # Each data validation represented by (+condition+) has their own require
-    # @return [boolean]
-    def valid?
-      @invalid_reason.nil?
-    end
-
-    protected
-
-    def unquote(str)
-      # TODO: I'm pretty sure this isn't sufficient and we need to deal with the backslashes
-      str.gsub(/^['\s]*|['\s]*$/, '')
-    end
-
-    def invalid!(reason)
-      @invalid_reason = reason
-    end
-
-    def a_number(arg)
-      Float(arg)
-    rescue ::ArgumentError
-      invalid!("Requires a number but given: #{arg}")
-    end
-
-    def a1_notation(arg)
-      return arg if ::CSVPlusPlus::Entities::CellReference.valid_cell_reference?(arg)
-    end
-
-    def a_date(arg, allow_relative_date: false)
-      return arg if ::CSVPlusPlus::Entities::Date.valid_date?(arg)
-
-      if allow_relative_date
-        a_relative_date(arg)
-      else
-        invalid!("Requires a date but given: #{arg}")
-      end
-    end
-
-    def a_relative_date(arg)
-      return arg if %w[past_month past_week past_year yesterday today tomorrow].include?(arg.downcase)
-
-      invalid!('Requires a relative date: past_month, past_week, past_year, yesterday, today or tomorrow')
-    end
-
-    def no_args
-      return if @arguments.empty?
-
-      invalid!("Requires no arguments but #{@arguments.length} given: #{@arguments}")
-    end
-
-    def one_arg
-      return @arguments[0] if @arguments.length == 1
-
-      invalid!("Requires only one argument but #{@arguments.length} given: #{@arguments}")
-    end
-
-    def one_arg_or_more
-      return @arguments if @arguments.length.positive?
-
-      invalid!("Requires at least one argument but #{@arguments.length} given: #{@arguments}")
-    end
-
-    def two_dates
-      return @arguments if @arguments.length == 2 && a_date(@arguments[0]) && a_date(@arguments[1])
-
-      invalid!("Requires exactly two dates but given: #{@arguments}")
-    end
-
-    def two_numbers
-      return @arguments if @arguments.length == 2 && a_number(@arguments[0]) && a_number(@arguments[1])
-
-      invalid!("Requires exactly two numbers but given: #{@arguments}")
-    end
-
-    # validate_boolean is a weird one because it can have 0, 1 or 2 @arguments - all of them must be (true | false)
-    def validate_boolean
-      return @arguments if @arguments.empty?
-
-      converted_args = @arguments.map(&:strip).map(&:downcase)
-      return @arguments if [1, 2].include?(@arguments.length) && converted_args.all? do |arg|
-                             %w[true false].include?(arg)
-                           end
-
-      invalid!("Requires 0, 1 or 2 arguments and they all must be either 'true' or 'false'. Received: #{arguments}")
-    end
-
-    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
-    def validate!
-      case condition.to_sym
-      when :blank, :date_is_valid, :not_blank, :text_is_email, :text_is_url
-        no_args
-      when :text_contains, :text_ends_with, :text_eq, :text_not_contains, :text_starts_with
-        one_arg
-      when :date_after, :date_before, :date_on_or_after, :date_on_or_before
-        a_date(one_arg, allow_relative_date: true)
-      when :date_eq, :date_not_eq
-        a_date(one_arg)
-      when :date_between, :date_not_between
-        two_dates
-      when :one_of_range
-        a1_notation(one_arg)
-      when :custom_formula, :one_of_list, :text_not_eq
-        one_arg_or_more
-      when :number_eq, :number_greater, :number_greater_than_eq, :number_less, :number_less_than_eq, :number_not_eq
-        a_number(one_arg)
-      when :number_between, :number_not_between
-        two_numbers
-      when :boolean
-        validate_boolean
-      else
-        invalid!('Not a recognized data validation directive')
-      end
-    end
-    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
-  end
-end

data/lib/csv_plus_plus/entities/cell_reference.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './ast_builder'
-require_relative './entity'
-
-module CSVPlusPlus
-  module Entities
-    # A reference to a cell
-    #
-    # @attr_reader cell_reference [String] The cell reference in A1 format
-    class CellReference < Entity
-      attr_reader :cell_reference
-
-      A1_NOTATION_REGEXP = /(['\w]+!)?\w+:\w+/
-      public_constant :A1_NOTATION_REGEXP
-
-      # Create a +CellReference+ to the given indexes
-      #
-      # @param cell_index [Integer] The current cell index
-      # @param row_index [Integer] The current row index
-      #
-      # @return [CellReference]
-      def self.from_index(cell_index:, row_index:)
-        return unless row_index || cell_index
-
-        # I can't just extend this class due to circular references :(
-        ::Class.new.extend(::CSVPlusPlus::Entities::ASTBuilder).ref(cell_index:, row_index:)
-      end
-
-      # Does the given +cell_reference_string+ conform to a valid cell reference?
-      #
-      # {https://developers.google.com/sheets/api/guides/concepts}
-      #
-      # @param cell_reference_string [::String] The string to check if it is a valid cell reference (we assume it's in
-      #   A1 notation but maybe can support R1C1)
-      #
-      # @return [boolean]
-      def self.valid_cell_reference?(cell_reference_string)
-        !(cell_reference_string =~ ::CSVPlusPlus::Entities::CellReference::A1_NOTATION_REGEXP).nil?
-      end
-
-      # @param cell_reference [String] The cell reference in A1 format
-      def initialize(cell_reference)
-        super(:cell_reference)
-
-        @cell_reference = cell_reference
-      end
-
-      # @return [::String]
-      def to_s
-        @cell_reference
-      end
-
-      # @return [Boolean]
-      def ==(other)
-        super && @cell_reference == other.cell_reference
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/entities/variable.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Entities
-    # TODO: get rid of this I think - everything will just be References
-    #
-    # A reference to a variable
-    class Variable < Entity
-      # @param id [Symbol] The identifier of the variable
-      def initialize(id)
-        super(:variable, id:)
-      end
-
-      # @return [String]
-      def to_s
-        "$$#{@id}"
-      end
-
-      # @return [boolean]
-      def ==(other)
-        super && id == other.id
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/error/syntax_error.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Error
-    # An error that can be thrown for various syntax errors
-    class SyntaxError < ::CSVPlusPlus::Error::Error
-      # @param runtime [Runtime] The current runtime
-      # @param wrapped_error [StandardError] The underlying error that caused the syntax error.  For example a
-      #   Racc::ParseError that was thrown
-      def initialize(runtime, wrapped_error: nil)
-        @runtime = runtime
-        @wrapped_error = wrapped_error
-
-        super()
-      end
-
-      # @return [String]
-      def to_s
-        to_trace
-      end
-
-      # Output a verbose user-helpful string that references the current runtime
-      def to_verbose_trace
-        warn(@wrapped_error.full_message) if @wrapped_error
-        warn(@wrapped_error.backtrace) if @wrapped_error
-        to_trace
-      end
-
-      # Output a user-helpful string that references the runtime state
-      #
-      # @return [String]
-      def to_trace
-        "#{message_prefix}#{cell_index} #{error_message}"
-      end
-
-      private
-
-      def cell_index
-        row_index = @runtime.row_index
-        if @runtime.cell_index
-          "[#{row_index},#{@runtime.cell_index}]"
-        elsif row_index
-          "[#{row_index}]"
-        else
-          ''
-        end
-      end
-
-      def message_prefix
-        line_number = @runtime.line_number
-        filename = @runtime.filename
-
-        line_str = line_number ? ":#{line_number}" : ''
-        "#{filename}#{line_str}"
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/expand.rb

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