csv_plus_plus 0.1.2 → 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,39 +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/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/google_options'
 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/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(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
@@ -42,25 +57,27 @@ module CSVPlusPlus
   def self.apply_template_to_sheet!(input, filename, options)
     warn(options.verbose_summary) if options.verbose
 
-    runtime = ::CSVPlusPlus::Runtime.new(input:, filename:)
+    runtime = ::CSVPlusPlus::Runtime.new(source_code: ::CSVPlusPlus::SourceCode.new(input:, filename:))
 
     ::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)
-    compiler.outputting! do
-      output = ::CSVPlusPlus::Writer.writer(options)
+  # @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.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 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,20 +118,17 @@ 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/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
@@ -139,6 +136,7 @@ files:
 - 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
@@ -152,25 +150,33 @@ files:
 - 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/expand.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/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/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/row.rb
 - lib/csv_plus_plus/runtime.rb
-- lib/csv_plus_plus/scope.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/validated_modifier.rb
 - lib/csv_plus_plus/version.rb
 - lib/csv_plus_plus/writer.rb
 - lib/csv_plus_plus/writer/base_writer.rb
@@ -178,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
@@ -192,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/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/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

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/references.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'graph'
-require_relative 'scope'
-
-module CSVPlusPlus
-  # References in an AST that need to be resolved
-  #
-  # @attr functions [Array<Entities::Function>] Functions references
-  # @attr variables [Array<Entities::Variable>] Variable references
-  class References
-    attr_accessor :functions, :variables
-
-    # Extract references from an AST and return them in a new +References+ object
-    #
-    # @param ast [Entity] An +Entity+ to do a depth first search on for references.  Entities can be
-    #   infinitely deep because they can contain other function calls as params to a function call
-    # @param scope [Scope] The +CodeSection+ containing all currently defined functions & variables
-    #
-    # @return [References]
-    def self.extract(ast, scope)
-      new.tap do |refs|
-        ::CSVPlusPlus::Graph.depth_first_search(ast) do |node|
-          next unless node.function_call? || node.variable?
-
-          refs.functions << node if function_reference?(node, scope)
-          refs.variables << node if node.variable?
-        end
-      end
-    end
-
-    # Is the node a resolvable reference?
-    #
-    # @param node [Entity] The node to check if it's resolvable
-    #
-    # @return [boolean]
-    # TODO: move this into the Entity subclasses
-    def self.function_reference?(node, scope)
-      node.function_call? && (scope.defined_function?(node.id) \
-                              || ::CSVPlusPlus::Entities::Builtins::FUNCTIONS.key?(node.id))
-    end
-
-    private_class_method :function_reference?
-
-    # Create an object with empty references.  The caller will build them up as it depth-first-searches
-    def initialize
-      @functions = []
-      @variables = []
-    end
-
-    # Are there any references to be resolved?
-    #
-    # @return [boolean]
-    def empty?
-      @functions.empty? && @variables.empty?
-    end
-
-    # @return [String]
-    def to_s
-      "References(functions: #{@functions}, variables: #{@variables})"
-    end
-
-    # @return [boolean]
-    def ==(other)
-      @functions == other.functions && @variables == other.variables
-    end
-  end
-end