csv_plus_plus 0.1.3 → 0.2.0

data/lib/csv_plus_plus/google_options.rb

@@ -1,32 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  # The Google-specific options a user can supply.
-  #
-  # @attr sheet_id [String] The ID of the Google Sheet to write to.
-  class GoogleOptions
-    extend ::T::Sig
-
-    sig { returns(::String) }
-    attr_reader :sheet_id
-
-    sig { params(sheet_id: ::String).void }
-    # @param sheet_id [String] The unique ID Google uses to reference the sheet
-    def initialize(sheet_id)
-      @sheet_id = sheet_id
-    end
-
-    sig { returns(::String) }
-    # Format a string with a verbose description of what we're doing with the options
-    #
-    # @return [String]
-    def verbose_summary
-      <<~SUMMARY
-        ## Google Sheets Options
-
-        > Sheet ID | #{@sheet_id}
-      SUMMARY
-    end
-  end
-end

data/lib/csv_plus_plus/lexer/lexer.rb

@@ -1,89 +0,0 @@
-# typed: false
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  # Common methods to be mixed into the Racc parsers
-  #
-  # @attr_reader tokens [Array]
-  module Lexer
-    attr_reader :tokens
-
-    # Initialize a lexer instance with an empty +@tokens+
-    def initialize(tokens: [])
-      @tokens = tokens
-    end
-
-    # Used by racc to iterate each token
-    #
-    # @return [Array<(String, String)>]
-    def next_token
-      @tokens.shift
-    end
-
-    # Orchestate the tokenizing, parsing and error handling of parsing input.  Each instance will implement their own
-    #   #tokenizer method
-    #
-    # @return [Lexer#return_value] Each instance will define it's own +return_value+ with the result of parsing
-    def parse(input, runtime)
-      return if input.nil?
-
-      return return_value unless anything_to_parse?(input)
-
-      @runtime = runtime
-
-      tokenize(input, runtime)
-      do_parse
-      return_value
-    rescue ::Racc::ParseError => e
-      runtime.raise_formula_syntax_error("Error parsing #{parse_subject}", e.message, wrapped_error: e)
-    rescue ::CSVPlusPlus::Error::ModifierValidationError => e
-      raise(::CSVPlusPlus::Error::ModifierSyntaxError.from_validation_error(runtime, e))
-    end
-
-    TOKEN_LIBRARY = {
-      A1_NOTATION: [::CSVPlusPlus::Entities::CellReference::A1_NOTATION_REGEXP, :A1_NOTATION],
-      FALSE: [/false/i, :FALSE],
-      HEX_COLOR: [::CSVPlusPlus::Color::HEX_STRING_REGEXP, :HEX_COLOR],
-      ID: [/[$!\w:]+/, :ID],
-      INFIX_OP: [%r{\^|\+|-|\*|/|&|<|>|<=|>=|<>}, :INFIX_OP],
-      NUMBER: [/-?[\d.]+/, :NUMBER],
-      STRING: [%r{"(?:[^"\\]|\\(?:["\\/bfnrt]|u[0-9a-fA-F]{4}))*"}, :STRING],
-      TRUE: [/true/i, :TRUE],
-      VAR_REF: [/\$\$/, :VAR_REF]
-    }.freeze
-    public_constant :TOKEN_LIBRARY
-
-    private
-
-    def tokenize(input, runtime)
-      return if input.nil?
-
-      t = tokenizer.scan(input)
-
-      until t.scanner.empty?
-        next if t.matches_ignore?
-
-        return if t.stop?
-
-        t.scan_tokens!
-        consume_token(t, runtime)
-      end
-
-      @tokens << %i[EOL EOL]
-    end
-
-    def consume_token(tokenizer, runtime)
-      if tokenizer.last_token
-        @tokens << [tokenizer.last_token, tokenizer.last_match]
-      elsif tokenizer.scan_catchall
-        @tokens << [tokenizer.last_match, tokenizer.last_match]
-      # TODO: checking the +parse_subject+ like this is a little hacky... but we need to know if we're parsing
-      # modifiers or code_section (or formulas in a cell)
-      elsif parse_subject == 'modifier'
-        runtime.raise_modifier_syntax_error("Unable to parse #{parse_subject} starting at", tokenizer.peek)
-      else
-        runtime.raise_formula_syntax_error("Unable to parse #{parse_subject} starting at", tokenizer.peek)
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/runtime/can_define_references.rb

@@ -1,87 +0,0 @@
-# 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

data/lib/csv_plus_plus/runtime/can_resolve_references.rb

@@ -1,209 +0,0 @@
-# typed: false
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Runtime
-    # Methods for resolving functions and variables.  These should be included onto a class that has +@variables+ and
-    # +@functions+ instance variables.
-    module CanResolveReferences
-      # Resolve all values in the ast of the current cell being processed
-      #
-      # @return [Entity]
-      def resolve_cell_value
-        return unless (ast = @cell&.ast)
-
-        last_round = nil
-        loop do
-          refs = ::CSVPlusPlus::Runtime::References.extract(ast, self)
-          return ast if refs.empty?
-
-          # TODO: throw an error here instead I think - basically we did a round and didn't make progress
-          return ast if last_round == refs
-
-          ast = resolve_functions(resolve_variables(ast, refs.variables), refs.functions)
-        end
-      end
-
-      # Bind +var_id+ to the current cell
-      #
-      # @param var_id [Symbol] The name of the variable to bind the cell reference to
-      #
-      # @return [CellReference]
-      def bind_variable_to_cell(var_id)
-        def_variable(
-          var_id,
-          ::CSVPlusPlus::Entities::CellReference.new(
-            cell_index: @cell_index,
-            row_index: @row_index
-          )
-        )
-      end
-
-      # Bind +var_id+ relative to an ![[expand]] modifier.
-      #
-      # @param var_id [Symbol] The name of the variable to bind the cell reference to
-      # @param expand [Expand] The expand where the variable is accessible (where it will be bound relative to)
-      #
-      # @return [CellReference]
-      def bind_variable_in_expand(var_id, expand)
-        def_variable(
-          var_id,
-          ::CSVPlusPlus::Entities::CellReference.new(
-            scoped_to_expand: expand,
-            cell_index: @cell_index
-          )
-        )
-      end
-
-      # Variables outside of an ![[expand=...] are always in scope.  If it's defined within an expand then things
-      # get trickier because the variable is only in scope while we're processing cells within that expand.
-      #
-      # @param var_id [Symbol] The variable's identifier that we are checking if it's in scope
-      #
-      # @return [boolean]
-      def in_scope?(var_id)
-        value = @variables[var_id]
-
-        raise_modifier_syntax_error('Undefined variable reference', var_id.to_s) if value.nil?
-
-        expand = value.type == ::CSVPlusPlus::Entities::Type::CellReference && value.scoped_to_expand
-        return true unless expand
-
-        unless expand.starts_at
-          raise(::CSVPlusPlus::Error::Error, 'Must call Template.expand_rows! before checking the scope of expands.')
-        end
-
-        @row_index >= expand.starts_at && (expand.ends_at.nil? || row_index <= expand.ends_at)
-      end
-
-      private
-
-      # Resolve all variable references defined statically in the code section
-      #     def resolve_static_variables!
-      #       last_var_dependencies = {}
-      #       loop do
-      #         var_dependencies, resolution_order = variable_resolution_order(only_static_vars(variables))
-      #         return if var_dependencies == last_var_dependencies
-      #
-      #         # TODO: make the contract better here
-      #         @variables = resolve_dependencies(var_dependencies, resolution_order, variables)
-      #         last_var_dependencies = var_dependencies.clone
-      #       end
-      #     end
-      #
-      #     def only_static_vars(var_dependencies)
-      #       var_dependencies.reject { |k| @runtime.builtin_variable?(k) }
-      #     end
-
-      def resolve_functions(ast, refs)
-        refs.reduce(ast.dup) do |acc, elem|
-          function_replace(acc, elem.id, resolve_function(elem.id))
-        end
-      end
-
-      def resolve_variables(ast, refs)
-        refs.reduce(ast.dup) do |acc, elem|
-          variable_replace(acc, elem.id, resolve_variable(elem.id))
-        end
-      end
-
-      # Make a copy of the AST represented by +node+ and replace +fn_id+ with +replacement+ throughout
-      # rubocop:disable Metrics/MethodLength
-      def function_replace(node, fn_id, replacement)
-        if node.type == ::CSVPlusPlus::Entities::Type::FunctionCall && node.id == fn_id
-          call_function_or_builtin(replacement, node)
-        elsif node.type == ::CSVPlusPlus::Entities::Type::FunctionCall
-          # not our function, but continue our depth first search on it
-          ::CSVPlusPlus::Entities::FunctionCall.new(
-            node.id,
-            node.arguments.map { |n| function_replace(n, fn_id, replacement) },
-            infix: node.infix
-          )
-        else
-          node
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def resolve_function(fn_id)
-        id = fn_id.to_sym
-        return @functions[id] if defined_function?(id)
-
-        ::CSVPlusPlus::Entities::Builtins::FUNCTIONS[id]
-      end
-
-      def call_function_or_builtin(function_or_builtin, function_call)
-        if function_or_builtin.type == ::CSVPlusPlus::Entities::Type::Function
-          call_function(function_or_builtin, function_call)
-        else
-          function_or_builtin.resolve_fn.call(self, function_call.arguments)
-        end
-      end
-
-      def call_function(function, function_call)
-        i = 0
-        function.arguments.reduce(function.body.dup) do |ast, argument|
-          variable_replace(ast, argument, function_call.arguments[i]).tap do
-            i += 1
-          end
-        end
-      end
-
-      # Make a copy of the AST represented by +node+ and replace +var_id+ with +replacement+ throughout
-      def variable_replace(node, var_id, replacement)
-        if node.type == ::CSVPlusPlus::Entities::Type::FunctionCall
-          arguments = node.arguments.map { |n| variable_replace(n, var_id, replacement) }
-          # TODO: refactor these places where we copy functions... it's brittle with the kwargs
-          ::CSVPlusPlus::Entities::FunctionCall.new(node.id, arguments, infix: node.infix)
-        elsif node.type == ::CSVPlusPlus::Entities::Type::Variable && node.id == var_id
-          replacement
-        else
-          node
-        end
-      end
-
-      def resolve_variable(var_id)
-        id = var_id.to_sym
-        return @variables[id] if defined_variable?(id)
-
-        raise_formula_syntax_error('Undefined variable', var_id) unless builtin_variable?(var_id)
-
-        ::CSVPlusPlus::Entities::Builtins::VARIABLES[var_id.to_sym].resolve_fn.call(self)
-      end
-
-      #       def check_unbound_vars(dependencies, variables)
-      #         unbound_vars = dependencies.values.flatten - variables.keys
-      #         return if unbound_vars.empty?
-      #
-      #         raise_formula_syntax_error('Undefined variables', unbound_vars.map(&:to_s).join(', '))
-      #       end
-
-      #       def variable_resolution_order(variables)
-      #         # we have a hash of variables => ASTs but they might have references to each other, so
-      #         # we need to interpolate them first (before interpolating the cell values)
-      #         var_dependencies = ::CSVPlusPlus::Graph.dependency_graph(variables, @runtime)
-      #         # are there any references that we don't have variables for? (undefined variable)
-      #         check_unbound_vars(var_dependencies, variables)
-      #
-      #         # a topological sort will give us the order of dependencies
-      #         [var_dependencies, ::CSVPlusPlus::Graph.topological_sort(var_dependencies)]
-      #         # TODO: don't expose this exception directly to the caller
-      #       rescue ::TSort::Cyclic
-      #         @runtime.raise_formula_syntax_error('Cyclic variable dependency detected', var_refs.keys)
-      #       end
-
-      #       def resolve_dependencies(var_dependencies, resolution_order, variables)
-      #         {}.tap do |resolved_vars|
-      #           # for each var and each dependency it has, build up and mutate resolved_vars
-      #           resolution_order.each do |var|
-      #             resolved_vars[var] = variables[var].dup
-      #
-      #             var_dependencies[var].each do |dependency|
-      #               resolved_vars[var] = variable_replace(resolved_vars[var], dependency, variables[dependency])
-      #             end
-      #           end
-      #         end
-      #       end
-    end
-  end
-end

data/lib/csv_plus_plus/writer/base_writer.rb

@@ -1,45 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Writer
-    # Some shared functionality that all Writers should build on
-    #
-    # @attr_reader options [Options] The supplied options - some of which are relevant for our writer instance
-    # @attr_reader runtime [Runtime] The current runtime - needed to resolve variables and display useful error messages
-    class BaseWriter
-      extend ::T::Sig
-      extend ::T::Helpers
-
-      abstract!
-
-      sig { returns(::CSVPlusPlus::Options) }
-      attr_reader :options
-
-      sig { returns(::CSVPlusPlus::Runtime::Runtime) }
-      attr_reader :runtime
-
-      protected
-
-      sig { params(options: ::CSVPlusPlus::Options, runtime: ::CSVPlusPlus::Runtime::Runtime).void }
-      # Open a CSV outputter to the +output_filename+ specified by the +Options+
-      #
-      # @param options [Options] The supplied options.
-      # @param runtime [Runtime] The current runtime.
-      def initialize(options, runtime)
-        @options = options
-        @runtime = runtime
-      end
-
-      sig { abstract.params(template: ::CSVPlusPlus::Template).void }
-      # Write the given +template+.
-      #
-      # @param template [Template]
-      def write(template); end
-
-      sig { abstract.void }
-      # Write a backup of the current spreadsheet.
-      def write_backup; end
-    end
-  end
-end