csv_plus_plus 0.1.1 → 0.1.3

data/lib/csv_plus_plus/language/compiler.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-require 'csv'
-
-require_relative 'benchmarked_compiler'
-require_relative 'code_section.tab'
-require_relative 'entities'
-require_relative 'runtime'
-require_relative 'scope'
-
-module CSVPlusPlus
-  module Language
-    # Encapsulates the parsing and building of objects (+Template+ -> +Row+ -> +Cell+). Variable resolution is delegated
-    # to the +Scope+
-    #
-    # @attr_reader options [Options] The +Options+ to compile with
-    # @attr_reader runtime [Runtime] The runtime execution
-    # @attr_reader scope [Scope] +Scope+ for variable resolution
-    class Compiler
-      attr_reader :timings, :benchmark, :options, :runtime, :scope
-
-      # Create a compiler and make sure it gets cleaned up
-      #
-      # @param runtime [Runtime] The initial +Runtime+ for the compiler
-      # @param options [Options]
-      def self.with_compiler(runtime:, options:, &block)
-        compiler = new(options:, runtime:)
-        if options.verbose
-          ::CSVPlusPlus::Language::BenchmarkedCompiler.with_benchmarks(compiler) do |c|
-            block.call(c)
-          end
-        else
-          yield(compiler)
-        end
-      ensure
-        runtime.cleanup!
-      end
-
-      # @param runtime [Runtime]
-      # @param options [Options]
-      # @param scope [Scope, nil]
-      def initialize(runtime:, options:, scope: nil)
-        @options = options
-        @runtime = runtime
-        @scope = scope || ::CSVPlusPlus::Language::Scope.new(runtime:)
-      end
-
-      # Write the compiled results
-      def outputting!
-        @runtime.start_at_csv!
-        yield
-      end
-
-      # Compile a template and return a +::CSVPlusPlus::Template+ instance ready to be written with a +Writer+
-      #
-      # @return [Template]
-      def compile_template
-        parse_code_section!
-        rows = parse_csv_section!
-
-        ::CSVPlusPlus::Template.new(rows:, code_section: scope.code_section).tap do |t|
-          t.validate_infinite_expands(@runtime)
-          expanding { t.expand_rows! }
-          resolve_all_cells!(t)
-        end
-      end
-
-      # @return [String]
-      def to_s
-        "Compiler(options: #{@options}, runtime: #{@runtime}, scope: #{@scope})"
-      end
-
-      protected
-
-      # Parses the input file and returns a +CodeSection+
-      #
-      # @return [CodeSection]
-      def parse_code_section!
-        @runtime.start!
-        parsing_code_section do |input|
-          code_section, csv_section = ::CSVPlusPlus::Language::CodeSectionParser.new.parse(input, @runtime)
-          # TODO: infer a type
-          # allow user-supplied key/values to override anything global or from the code section
-          code_section.def_variables(
-            options.key_values.transform_values { |v| ::CSVPlusPlus::Language::Entities::String.new(v.to_s) }
-          )
-          @scope.code_section = code_section
-
-          # return the csv_section to the caller because they're gonna re-write input with it
-          next csv_section
-        end
-        @scope.code_section
-      end
-
-      # Parse the CSV section and return an array of +Row+s
-      #
-      # @return [Array<Row>]
-      def parse_csv_section!
-        @runtime.start_at_csv!
-        @runtime.map_rows(::CSV.new(runtime.input)) do |csv_row|
-          parse_row(csv_row)
-        end
-      ensure
-        # we're done with the file and everything is in memory
-        @runtime.cleanup!
-      end
-
-      # Iterates through each cell of each row and resolves it's variable and function references.
-      #
-      # @param template [Template]
-      # @return [Array<Entity>]
-      def resolve_all_cells!(template)
-        @runtime.start_at_csv!
-        @runtime.map_rows(template.rows, cells_too: true) do |cell|
-          cell.ast = @scope.resolve_cell_value if cell.ast
-        end
-      end
-
-      # Expanding rows
-      def expanding
-        @runtime.start_at_csv!
-        yield
-      end
-
-      private
-
-      def parsing_code_section
-        csv_section = yield(@runtime.input.read)
-        @runtime.rewrite_input!(csv_section)
-      end
-
-      # Using the current +@runtime+ and the given +csv_row+ parse it into a +Row+ of +Cell+s
-      # +csv_row+ should have already been run through a CSV parser and is an array of strings
-      #
-      # @param csv_row [Array<Array<String>>]
-      # @return [Row]
-      def parse_row(csv_row)
-        row_modifier = ::CSVPlusPlus::Modifier.new(row_level: true)
-
-        cells =
-          @runtime.map_row(csv_row) do |value, _cell_index|
-            cell_modifier = ::CSVPlusPlus::Modifier.new
-            parsed_value = ::CSVPlusPlus::ModifierParser.new(row_modifier:, cell_modifier:).parse(value, @runtime)
-
-            ::CSVPlusPlus::Cell.parse(parsed_value, runtime:, modifier: cell_modifier)
-          end
-
-        ::CSVPlusPlus::Row.new(@runtime.row_index, cells, row_modifier)
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './entity'
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A boolean value
-      #
-      # @attr_reader value [true, false]
-      class Boolean < Entity
-        attr_reader :value
-
-        # @param value [String, Boolean]
-        def initialize(value)
-          super(:boolean)
-          # TODO: probably can do a lot better in general on type validation
-          @value = value.is_a?(::String) ? (value.downcase == 'true') : value
-        end
-
-        # @return [String]
-        def to_s
-          @value.to_s.upcase
-        end
-
-        # @return [boolean]
-        def ==(other)
-          super && value == other.value
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './entity'
-
-module CSVPlusPlus
-  module Language
-    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
-
-        # @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
-end

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,37 +0,0 @@
-# frozen_string_literal: true
-
-module CSVPlusPlus
-  module Language
-    module Entities
-      # A function call
-      #
-      # @attr_reader infix [boolean] Whether or not this function call is infix (X * Y, A + B, etc)
-      class FunctionCall < EntityWithArguments
-        attr_reader :infix
-
-        # @param id [String] The name of the function
-        # @param arguments [Array<Entity>] The arguments to the function
-        # @param infix [boolean] Whether the function is infix
-        def initialize(id, arguments, infix: false)
-          super(:function_call, id:, arguments:)
-
-          @infix = infix
-        end
-
-        # @return [String]
-        def to_s
-          if @infix
-            "(#{arguments.join(" #{@id} ")})"
-          else
-            "#{@id.to_s.upcase}(#{arguments_to_s})"
-          end
-        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