csv_plus_plus 0.1.0 → 0.1.2

data/lib/csv_plus_plus/language/entities/entity.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../entities'
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A basic building block of the abstract syntax tree (AST)
-      #
-      # @attr_reader id [Symbol] The identifier of the entity.  For functions this is the function name,
-      #   for variables it's the variable name
-      # @attr_reader type [Symbol] The type of the entity.  Valid values are defined in +::CSVPlusPlus::Language::Types+
-      class Entity
-        attr_reader :id, :type
-
-        # @param type [::String, Symbol]
-        # @param id [::String, nil]
-        def initialize(type, id: nil)
-          @type = type.to_sym
-          @id = id.downcase.to_sym if id
-        end
-
-        # @return [boolean]
-        def ==(other)
-          self.class == other.class && @type == other.type && @id == other.id
-        end
-
-        # Respond to predicates that correspond to types like #boolean?, #string?, etc
-        #
-        # @param method_name [Symbol] The +method_name+ to respond to
-        def method_missing(method_name, *_arguments)
-          if method_name =~ /^(\w+)\?$/
-            t = ::Regexp.last_match(1)
-            a_type?(t) && @type == t.to_sym
-          else
-            super
-          end
-        end
-
-        # Respond to predicates by type (entity.boolean?, entity.string?, etc)
-        #
-        # @param method_name [Symbol] The +method_name+ to respond to
-        #
-        # @return [boolean]
-        def respond_to_missing?(method_name, *_arguments)
-          (method_name =~ /^(\w+)\?$/ && a_type?(::Regexp.last_match(1))) || super
-        end
-
-        private
-
-        def a_type?(str)
-          ::CSVPlusPlus::Language::TYPES.include?(str.to_sym)
-        end
-      end
-
-      # An entity that can take other entities as arguments.  Current use cases for this
-      # are function calls and function definitions
-      #
-      # @attr_reader arguments [Array<Entity>] The arguments supplied to this entity.
-      class EntityWithArguments < Entity
-        attr_reader :arguments
-
-        # @param type [::String, Symbol]
-        # @param id [::String]
-        # @param arguments [Array<Entity>]
-        def initialize(type, id: nil, arguments: [])
-          super(type, id:)
-          @arguments = arguments
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && @arguments == other.arguments
-        end
-
-        protected
-
-        attr_writer :arguments
-
-        def arguments_to_s
-          @arguments.join(', ')
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/function.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './entity'
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A function definition
-      #
-      # @attr_reader body [Entity] The body of the function.  +body+ can contain variable references
-      # from +@arguments+
-      class Function < EntityWithArguments
-        attr_reader :body
-
-        # @param id [Symbool, String] the name of the function - what it will be callable by
-        # @param arguments [Array<Symbol>]
-        # @param body [Entity]
-        def initialize(id, arguments, body)
-          super(:function, id:, arguments: arguments.map(&:to_sym))
-          @body = body
-        end
-
-        # @return [String]
-        def to_s
-          "def #{@id.to_s.upcase}(#{arguments_to_s}) #{@body}"
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && @body == other.body
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/function_call.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A function call
-      class FunctionCall < EntityWithArguments
-        # @param id [String] The name of the function
-        # @param arguments [Array<Entity>] The arguments to the function
-        def initialize(id, arguments)
-          super(:function_call, id:, arguments:)
-        end
-
-        # @return [String]
-        def to_s
-          "#{@id.to_s.upcase}(#{arguments_to_s})"
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && @id == other.id
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/number.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A number value
-      #
-      # @attr_reader value [Numeric] The parsed number value
-      class Number < Entity
-        attr_reader :value
-
-        # @param value [String, Numeric] Either a +String+ that looks like a number, or an already parsed Numeric
-        def initialize(value)
-          super(:number)
-
-          @value =
-            if value.instance_of?(::String)
-              value.include?('.') ? Float(value) : Integer(value, 10)
-            else
-              value
-            end
-        end
-
-        # @return [String]
-        def to_s
-          @value.to_s
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && value == other.value
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/runtime_value.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A runtime value. These are values which can be materialized at any point via the +resolve_fn+
-      # which takes an ExecutionContext as a param
-      #
-      # @attr_reader resolve_fn [lambda] A lambda that is called when the runtime value is resolved
-      class RuntimeValue < Entity
-        attr_reader :arguments, :resolve_fn
-
-        # @param resolve_fn [lambda] A lambda that is called when the runtime value is resolved
-        def initialize(resolve_fn, arguments: nil)
-          super(:runtime_value)
-
-          @arguments = arguments
-          @resolve_fn = resolve_fn
-        end
-
-        # @return [String]
-        def to_s
-          '(runtime_value)'
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/string.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A string value
-      #
-      # @attr_reader value [String]
-      class String < Entity
-        attr_reader :value
-
-        # @param value [String] The string that has been parsed out of the template
-        def initialize(value)
-          super(:string)
-
-          @value = value.gsub(/^"|"$/, '')
-        end
-
-        # @return [String]
-        def to_s
-          "\"#{@value}\""
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && value == other.value
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities/variable.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A reference to a variable
-      class Variable < Entity
-        # initialize
-        def initialize(id)
-          super(:variable, id:)
-        end
-
-        # to_s
-        def to_s
-          "$$#{@id}"
-        end
-
-        # ==
-        def ==(other)
-          super && id == other.id
-        end
-      end
-    end
-  end
-end

data/lib/csv_plus_plus/language/entities.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'entities/boolean'
-require_relative 'entities/cell_reference'
-require_relative 'entities/entity'
-require_relative 'entities/function'
-require_relative 'entities/function_call'
-require_relative 'entities/number'
-require_relative 'entities/runtime_value'
-require_relative 'entities/string'
-require_relative 'entities/variable'
-
-module CSVPlusPlus
-  module Language
-    TYPES = {
-      boolean: ::CSVPlusPlus::Language::Entities::Boolean,
-      cell_reference: ::CSVPlusPlus::Language::Entities::CellReference,
-      function: ::CSVPlusPlus::Language::Entities::Function,
-      function_call: ::CSVPlusPlus::Language::Entities::FunctionCall,
-      number: ::CSVPlusPlus::Language::Entities::Number,
-      runtime_value: ::CSVPlusPlus::Language::Entities::RuntimeValue,
-      string: ::CSVPlusPlus::Language::Entities::String,
-      variable: ::CSVPlusPlus::Language::Entities::Variable
-    }.freeze
-
-    public_constant :TYPES
-  end
-end

data/lib/csv_plus_plus/language/references.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../graph'
-require_relative './scope'
-
-module CSVPlusPlus
-  module Language
-    # 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 code_section [CodeSection] The +CodeSection+ containing all currently defined functions
-      #
-      # @return [References]
-      def self.extract(ast, code_section)
-        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, code_section)
-            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, code_section)
-        node.function_call? && (code_section.defined_function?(node.id) \
-                                || ::CSVPlusPlus::Language::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
-end

data/lib/csv_plus_plus/language/runtime.rb

@@ -1,205 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'entities'
-require_relative 'syntax_error'
-require 'tempfile'
-
-module CSVPlusPlus
-  module Language
-    # The runtime state of the compiler (the current +line_number+/+row_index+, +cell+ being processed, etc).  We take
-    # multiple runs through the input file for parsing so it's really convenient to have a central place for these
-    # things to be managed.
-    #
-    # @attr_reader filename [String, nil] The filename that the input came from (mostly used for debugging since
-    #   +filename+ can be +nil+ if it's read from stdin.
-    # @attr_reader length_of_code_section [Integer] The length (count of lines) of the code section part of the original
-    #   input.
-    # @attr_reader length_of_csv_section [Integer] The length (count of lines) of the CSV part of the original csvpp
-    #   input.
-    # @attr_reader length_of_original_file [Integer] The length (count of lines) of the original csvpp input.
-    #
-    # @attr cell [Cell] The current cell being processed
-    # @attr cell_index [Integer] The index of the current cell being processed (starts at 0)
-    # @attr row_index [Integer] The index of the current row being processed (starts at 0)
-    # @attr line_number [Integer] The line number of the original csvpp template (starts at 1)
-    class Runtime
-      attr_reader :filename, :length_of_code_section, :length_of_csv_section, :length_of_original_file
-
-      attr_accessor :cell, :cell_index, :row_index, :line_number
-
-      # @param input [String] The input to be parsed
-      # @param filename [String, nil] The filename that the input came from (mostly used for debugging since +filename+
-      #   can be +nil+ if it's read from stdin
-      def initialize(input:, filename:)
-        @filename = filename || 'stdin'
-
-        init_input!(input)
-        start!
-      end
-
-      # Map over an a csvpp file and keep track of line_number and row_index
-      #
-      # @param lines [Array]
-      #
-      # @return [Array]
-      def map_lines(lines, &block)
-        @line_number = 1
-        lines.map do |line|
-          block.call(line).tap { next_line! }
-        end
-      end
-
-      # Map over a single row and keep track of the cell and it's index
-      #
-      # @param row [Array<Cell>] The row to map each cell over
-      #
-      # @return [Array]
-      def map_row(row, &block)
-        @cell_index = 0
-        row.map.with_index do |cell, index|
-          set_cell!(cell, index)
-          block.call(cell, index)
-        end
-      end
-
-      # Map over all rows and keep track of row and line numbers
-      #
-      # @param rows [Array<Row>] The rows to map over (and keep track of indexes)
-      # @param cells_too [boolean] If the cells of each +row+ should be iterated over also.
-      #
-      # @return [Array]
-      def map_rows(rows, cells_too: false, &block)
-        @row_index = 0
-        map_lines(rows) do |row|
-          if cells_too
-            # it's either CSV or a Row object
-            map_row((row.is_a?(::CSVPlusPlus::Row) ? row.cells : row), &block)
-          else
-            block.call(row)
-          end
-        end
-      end
-
-      # Increment state to the next line
-      #
-      # @return [Integer]
-      def next_line!
-        @row_index += 1 unless @row_index.nil?
-        @line_number += 1
-      end
-
-      # Return the current spreadsheet row number.  It parallels +@row_index+ but starts at 1.
-      #
-      # @return [Integer, nil]
-      def rownum
-        return if @row_index.nil?
-
-        @row_index + 1
-      end
-
-      # Set the current cell and index
-      #
-      # @param cell [Cell] The current cell
-      # @param cell_index [Integer] The index of the cell
-      def set_cell!(cell, cell_index)
-        @cell = cell
-        @cell_index = cell_index
-      end
-
-      # Each time we run a parse on the input, reset the runtime state starting at the beginning of the file
-      def start!
-        @row_index = @cell_index = nil
-        @line_number = 1
-      end
-
-      # Reset the runtime state starting at the CSV section
-      def start_at_csv!
-        # TODO: isn't the input re-written anyway without the code section? why do we need this?
-        start!
-        @line_number = @length_of_code_section || 1
-      end
-
-      # @return [String]
-      def to_s
-        "Runtime(cell: #{@cell}, row_index: #{@row_index}, cell_index: #{@cell_index})"
-      end
-
-      # Get the current (entity) value of a runtime value
-      #
-      # @param var_id [String, Symbol] The Variable#id  of the variable being resolved.
-      #
-      # @return [Entity]
-      def runtime_value(var_id)
-        if runtime_variable?(var_id)
-          ::CSVPlusPlus::Language::Builtins::VARIABLES[var_id.to_sym].resolve_fn.call(self)
-        else
-          raise_syntax_error('Undefined variable', var_id)
-        end
-      end
-
-      # Is +var_id+ a runtime variable?  (it's a static variable otherwise)
-      #
-      # @param var_id [String, Symbol] The Variable#id to check if it's a runtime variable
-      #
-      # @return [boolean]
-      def runtime_variable?(var_id)
-        ::CSVPlusPlus::Language::Builtins::VARIABLES.key?(var_id.to_sym)
-      end
-
-      # Called when an error is encoutered during parsing.  It will construct a useful
-      # error with the current +@row/@cell_index+, +@line_number+ and +@filename+
-      #
-      # @param message [String] A message relevant to why this error is being raised.
-      # @param bad_input [String] The offending input that caused this error to be thrown.
-      # @param wrapped_error [StandardError, nil] The underlying error that was raised (if it's not from our own logic)
-      def raise_syntax_error(message, bad_input, wrapped_error: nil)
-        raise(::CSVPlusPlus::Language::SyntaxError.new(message, bad_input, self, wrapped_error:))
-      end
-
-      # The currently available input for parsing.  The tmp state will be re-written
-      # between parsing the code section and the CSV section
-      #
-      # @return [String]
-      def input
-        @tmp
-      end
-
-      # We mutate the input over and over. It's ok because it's just a Tempfile
-      #
-      # @param data [String] The data to rewrite our input file to
-      def rewrite_input!(data)
-        @tmp.truncate(0)
-        @tmp.write(data)
-        @tmp.rewind
-      end
-
-      # Clean up the Tempfile we're using for parsing
-      def cleanup!
-        return unless @tmp
-
-        @tmp.close
-        @tmp.unlink
-        @tmp = nil
-      end
-
-      private
-
-      def count_code_section_lines(lines)
-        eoc = ::CSVPlusPlus::Lexer::END_OF_CODE_SECTION
-        lines.include?(eoc) ? (lines.take_while { |l| l != eoc }).length + 1 : 0
-      end
-
-      def init_input!(input)
-        lines = (input || '').split(/\s*\n\s*/)
-        @length_of_original_file = lines.length
-        @length_of_code_section = count_code_section_lines(lines)
-        @length_of_csv_section = @length_of_original_file - @length_of_code_section
-
-        # we're gonna take our input file, write it to a tmp file then each
-        # step is gonna mutate that tmp file
-        @tmp = ::Tempfile.new
-        rewrite_input!(input)
-      end
-    end
-  end
-end