csv_plus_plus 0.1.0 → 0.1.2

data/lib/csv_plus_plus/writer/google_sheet_builder.rb

@@ -25,12 +25,6 @@ module CSVPlusPlus
 
       private
 
-      def sheets_ns
-        ::Google::Apis::SheetsV4
-      end
-
-      def sheets_color(color); end
-
       def set_extended_value_type!(extended_value, value)
         v = value || ''
         if v.start_with?('=')
@@ -45,7 +39,7 @@ module CSVPlusPlus
       end
 
       def build_cell_format(mod)
-        sheets_ns::CellFormat.new.tap do |cf|
+        ::Google::Apis::SheetsV4::CellFormat.new.tap do |cf|
           cf.text_format = mod.text_format
 
           cf.horizontal_alignment = mod.halign
@@ -56,7 +50,7 @@ module CSVPlusPlus
       end
 
       def grid_range_for_cell(cell)
-        sheets_ns::GridRange.new(
+        ::Google::Apis::SheetsV4::GridRange.new(
           sheet_id: @sheet_id,
           start_column_index: cell.index,
           end_column_index: cell.index + 1,
@@ -72,7 +66,7 @@ module CSVPlusPlus
       end
 
       def build_cell_value(cell)
-        sheets_ns::ExtendedValue.new.tap do |xv|
+        ::Google::Apis::SheetsV4::ExtendedValue.new.tap do |xv|
           value =
             if cell.value.nil?
               current_value(cell.row_index, cell.index)
@@ -87,7 +81,7 @@ module CSVPlusPlus
       def build_cell_data(cell)
         mod = ::CSVPlusPlus::Writer::GoogleSheetModifier.new(cell.modifier)
 
-        sheets_ns::CellData.new.tap do |cd|
+        ::Google::Apis::SheetsV4::CellData.new.tap do |cd|
           cd.user_entered_format = build_cell_format(mod)
           cd.note = mod.note if mod.note
 
@@ -97,13 +91,13 @@ module CSVPlusPlus
       end
 
       def build_row_data(row)
-        sheets_ns::RowData.new(values: row.cells.map { |cell| build_cell_data(cell) })
+        ::Google::Apis::SheetsV4::RowData.new(values: row.cells.map { |cell| build_cell_data(cell) })
       end
 
       def build_update_cells_request(rows)
-        sheets_ns::UpdateCellsRequest.new(
+        ::Google::Apis::SheetsV4::UpdateCellsRequest.new(
           fields: '*',
-          start: sheets_ns::GridCoordinate.new(
+          start: ::Google::Apis::SheetsV4::GridCoordinate.new(
             sheet_id: @sheet_id,
             column_index: @column_index,
             row_index: @row_index
@@ -113,29 +107,31 @@ module CSVPlusPlus
       end
 
       def build_border(cell)
-        mod = cell.modifier
-        # TODO: allow different border styles per side
-        border = sheets_ns::Border.new(color: mod.bordercolor || '#000000', style: mod.borderstyle || 'solid')
-        sheets_ns::UpdateBordersRequest.new(
-          top: mod.border_along?('top') ? border : nil,
-          right: mod.border_along?('right') ? border : nil,
-          left: mod.border_along?('left') ? border : nil,
-          bottom: mod.border_along?('bottom') ? border : nil,
+        mod = ::CSVPlusPlus::Writer::GoogleSheetModifier.new(cell.modifier)
+        border = mod.border
+
+        ::Google::Apis::SheetsV4::UpdateBordersRequest.new(
+          top: mod.border_along?(:top) ? border : nil,
+          right: mod.border_along?(:right) ? border : nil,
+          left: mod.border_along?(:left) ? border : nil,
+          bottom: mod.border_along?(:bottom) ? border : nil,
           range: grid_range_for_cell(cell)
         )
       end
 
       def build_update_borders_request(cell)
-        sheets_ns::Request.new(update_borders: build_border(cell))
+        ::Google::Apis::SheetsV4::Request.new(update_borders: build_border(cell))
+      end
+
+      def chunked_requests(rows)
+        rows.each_slice(1000).to_a.map do |chunked_rows|
+          ::Google::Apis::SheetsV4::Request.new(update_cells: build_update_cells_request(chunked_rows))
+        end
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def build_batch_request(rows)
-        sheets_ns::BatchUpdateSpreadsheetRequest.new.tap do |bu|
-          bu.requests =
-            rows.each_slice(1000).to_a.map do |chunked_rows|
-              sheets_ns::Request.new(update_cells: build_update_cells_request(chunked_rows))
-            end
+        ::Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest.new.tap do |bu|
+          bu.requests = chunked_requests(rows)
 
           rows.each do |row|
             row.cells.filter { |c| c.modifier.any_border? }
@@ -145,7 +141,6 @@ module CSVPlusPlus
           end
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end
     # rubocop:enable Metrics/ClassLength
   end

data/lib/csv_plus_plus/writer/google_sheet_modifier.rb

@@ -4,44 +4,65 @@ module CSVPlusPlus
   module Writer
     # Decorate a Modifier so it can be written to the Google Sheets API
     class GoogleSheetModifier < ::SimpleDelegator
-      # Format the halign for Google Sheets
-      def halign
-        super&.upcase
-      end
-
-      # Format the valign for Google Sheets
-      def valign
-        super&.upcase
+      # Format the border for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Border]
+      def border
+        # TODO: allow different border styles per side
+        ::Google::Apis::SheetsV4::Border.new(
+          color: bordercolor&.to_s || '#000000',
+          style: borderstyle&.to_s || 'solid'
+        )
       end
 
       # Format the color for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Color]
       def color
         google_sheets_color(super) if super
       end
 
       # Format the fontcolor for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Color]
       def fontcolor
         google_sheets_color(super) if super
       end
 
+      # Format the halign for Google Sheets
+      #
+      # @return [String]
+      def halign
+        super&.to_s&.upcase
+      end
+
       # Format the numberformat for Google Sheets
+      #
+      # @return [::Google::Apis::SheetsV4::NumberFormat]
       def numberformat
         ::Google::Apis::SheetsV4::NumberFormat.new(type: super) if super
       end
 
       # Builds a SheetsV4::TextFormat with the underlying Modifier
+      #
+      # @return [::Google::Apis::SheetsV4::TextFormat]
       def text_format
         ::Google::Apis::SheetsV4::TextFormat.new(
-          bold: formatted?('bold') || nil,
-          italic: formatted?('italic') || nil,
-          strikethrough: formatted?('strikethrough') || nil,
-          underline: formatted?('underline') || nil,
+          bold: formatted?(:bold) || nil,
+          italic: formatted?(:italic) || nil,
+          strikethrough: formatted?(:strikethrough) || nil,
+          underline: formatted?(:underline) || nil,
           font_family: fontfamily,
           font_size: fontsize,
           foreground_color: fontcolor
         )
       end
 
+      # Format the valign for Google Sheets
+      def valign
+        super&.to_s&.upcase
+      end
+
       private
 
       def google_sheets_color(color)

data/lib/csv_plus_plus/writer/rubyxl_builder.rb

@@ -24,10 +24,7 @@ module CSVPlusPlus
       #
       # @return [RubyXL::Workbook]
       def build_workbook
-        open_workbook.tap do |workbook|
-          @worksheet = workbook[@sheet_name]
-          build_workbook!
-        end
+        open_workbook.tap { build_workbook! }
       end
 
       private
@@ -107,11 +104,11 @@ module CSVPlusPlus
       def open_workbook
         if ::File.exist?(@input_filename)
           ::RubyXL::Parser.parse(@input_filename).tap do |workbook|
-            workbook.add_worksheet(@sheet_name) unless workbook[@sheet_name]
+            @worksheet = workbook[@sheet_name] || workbook.add_worksheet(@sheet_name)
           end
         else
           ::RubyXL::Workbook.new.tap do |workbook|
-            workbook.worksheets[0].sheet_name = @sheet_name
+            @worksheet = workbook.worksheets[0].tap { |w| w.sheet_name = @sheet_name }
           end
         end
       end

data/lib/csv_plus_plus.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
+require 'benchmark'
+require 'csv'
+require 'fileutils'
 require 'google/apis/drive_v3'
 require 'google/apis/sheets_v4'
 require 'googleauth'
+require 'pathname'
 require 'rubyXL'
 require 'rubyXL/convenience_methods'
+require 'set'
+require 'tempfile'
 
-require_relative 'csv_plus_plus/cli'
+require_relative 'csv_plus_plus/entities'
 require_relative 'csv_plus_plus/error'
-require_relative 'csv_plus_plus/language/builtins'
-require_relative 'csv_plus_plus/language/compiler'
-require_relative 'csv_plus_plus/language/runtime'
+
+require_relative 'csv_plus_plus/cell'
+require_relative 'csv_plus_plus/cli'
+require_relative 'csv_plus_plus/color'
+
+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/row'
+require_relative 'csv_plus_plus/template'
+require_relative 'csv_plus_plus/validated_modifier'
 require_relative 'csv_plus_plus/writer'
 
 # A programming language for writing rich CSV files
@@ -21,23 +39,30 @@ module CSVPlusPlus
   # @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 options [Options] The various options to compile with
-  #
-  # rubocop:disable Metrics/MethodLength
   def self.apply_template_to_sheet!(input, filename, options)
     warn(options.verbose_summary) if options.verbose
 
-    ::CSVPlusPlus::Language::Compiler.with_compiler(
-      options:,
-      runtime: ::CSVPlusPlus::Language::Runtime.new(input:, filename:)
-    ) do |c|
-      template = c.compile_template
+    runtime = ::CSVPlusPlus::Runtime.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)
+    end
+  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)
-      c.outputting! do
-        output.write_backup if options.backup
-        output.write(template)
-      end
+      output.write_backup if options.backup
+      output.write(template)
     end
   end
-  # rubocop:enable Metrics/MethodLength
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_plus_plus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-drive_v3
@@ -123,44 +123,54 @@ files:
 - bin/csv++
 - bin/csvpp
 - 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/code_section.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/function.rb
+- lib/csv_plus_plus/entities/function_call.rb
+- lib/csv_plus_plus/entities/number.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/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/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/language/ast_builder.rb
-- lib/csv_plus_plus/language/benchmarked_compiler.rb
-- lib/csv_plus_plus/language/builtins.rb
-- lib/csv_plus_plus/language/cell_value.tab.rb
-- lib/csv_plus_plus/language/code_section.tab.rb
-- lib/csv_plus_plus/language/compiler.rb
-- lib/csv_plus_plus/language/entities.rb
-- lib/csv_plus_plus/language/entities/boolean.rb
-- lib/csv_plus_plus/language/entities/cell_reference.rb
-- lib/csv_plus_plus/language/entities/entity.rb
-- lib/csv_plus_plus/language/entities/function.rb
-- lib/csv_plus_plus/language/entities/function_call.rb
-- lib/csv_plus_plus/language/entities/number.rb
-- lib/csv_plus_plus/language/entities/runtime_value.rb
-- lib/csv_plus_plus/language/entities/string.rb
-- lib/csv_plus_plus/language/entities/variable.rb
-- lib/csv_plus_plus/language/references.rb
-- lib/csv_plus_plus/language/runtime.rb
-- lib/csv_plus_plus/language/scope.rb
-- lib/csv_plus_plus/language/syntax_error.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.tab.rb
+- lib/csv_plus_plus/modifier/conditional_formatting.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/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

data/lib/csv_plus_plus/code_section.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './language/code_section.tab'
-require_relative './language/entities'
-
-module CSVPlusPlus
-  # A representation of the code section part of a template (the variable and function definitions)
-  #
-  # @attr variables [Hash<Symbol, Variable>] All defined variables
-  # @attr_reader functions [Hash<Symbol, Function>] All defined functions
-  class CodeSection
-    attr_reader :functions
-    attr_accessor :variables
-
-    # @param variables [Hash<Symbol, Variable>] Initial variables
-    # @param functions [Hash<Symbol, Variable>] Initial functions
-    def initialize(variables: {}, functions: {})
-      @variables = variables
-      @functions = functions
-    end
-
-    # 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(variables)
-      variables.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
-
-    # @return [String]
-    def to_s
-      "CodeSection(functions: #{@functions}, variables: #{@variables})"
-    end
-  end
-end

data/lib/csv_plus_plus/language/benchmarked_compiler.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark'
-
-module CSVPlusPlus
-  module Language
-    # Extend a +Compiler+ class and add benchmark timings
-    # @attr_reader timings [Array<Benchmark::Tms>] +Benchmark+ timings that have been accumulated by each step of
-    #   compilation
-    # @attr_reader benchmark [Benchmark] A +Benchmark+ instance
-    module BenchmarkedCompiler
-      attr_reader :benchmark, :timings
-
-      # Wrap a +Compiler+ with our instance methods that add benchmarks
-      def self.with_benchmarks(compiler, &block)
-        ::Benchmark.benchmark(::Benchmark::CAPTION, 25, ::Benchmark::FORMAT, '> Total') do |x|
-          # compiler = new(options:, runtime:, benchmark: x)
-          compiler.extend(self)
-          compiler.benchmark = x
-
-          block.call(compiler)
-
-          [compiler.timings.reduce(:+)]
-        end
-      end
-
-      # @param benchmark [Benchmark] A +Benchmark+ instance
-      def benchmark=(benchmark)
-        @benchmark = benchmark
-        @timings = []
-      end
-
-      # Time the Compiler#outputting! stage
-      def outputting!
-        time_stage('Writing the spreadsheet') { super }
-      end
-
-      protected
-
-      def parse_code_section!
-        time_stage('Parsing code section') { super }
-      end
-
-      def parse_csv_section!
-        time_stage('Parsing CSV section') { super }
-      end
-
-      def expanding
-        time_stage('Expanding rows') { super }
-      end
-
-      def resolve_all_cells!(template)
-        time_stage('Resolving each cell') { super(template) }
-      end
-
-      private
-
-      def time_stage(stage, &block)
-        ret = nil
-        @timings << @benchmark.report(stage) { ret = block.call }
-        ret
-      end
-    end
-  end
-end