csv_plus_plus 0.0.3 → 0.0.4

data/lib/csv_plus_plus/options.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative './cli_flag'
 require_relative './google_options'
 
 module CSVPlusPlus

data/lib/csv_plus_plus/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module CSVPlusPlus
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
   public_constant :VERSION
 end

data/lib/csv_plus_plus/writer/excel.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
+require_relative './rubyxl_builder'
+
 module CSVPlusPlus
   module Writer
     # A class that can output a +Template+ to an Excel file
     class Excel < ::CSVPlusPlus::Writer::BaseWriter
-      # write a +template+ to an Excel file
+      # write the +template+ to an Excel file
       def write(template)
-        # TODO
+        ::CSVPlusPlus::Writer::RubyXLBuilder.new(
+          output_filename: @options.output_filename,
+          rows: template.rows,
+          sheet_name: @options.sheet_name
+        ).write
+      end
+
+      protected
+
+      def load_requires
+        require('rubyXL')
+        require('rubyXL/convenience_methods')
       end
     end
   end

data/lib/csv_plus_plus/writer/google_sheet_builder.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require_relative './google_sheet_modifier'
+
 module CSVPlusPlus
   module Writer
-    ##
     # Given +rows+ from a +Template+, build requests compatible with Google Sheets Ruby API
     # rubocop:disable Metrics/ClassLength
     class GoogleSheetBuilder
@@ -26,9 +27,7 @@ module CSVPlusPlus
         ::Google::Apis::SheetsV4
       end
 
-      def sheets_color(color)
-        sheets_ns::Color.new(red: color.red, green: color.green, blue: color.blue)
-      end
+      def sheets_color(color); end
 
       def set_extended_value_type!(extended_value, value)
         v = value || ''
@@ -43,38 +42,20 @@ module CSVPlusPlus
         end
       end
 
-      def build_text_format(mod)
-        sheets_ns::TextFormat.new(
-          bold: mod.formatted?('bold') || nil,
-          italic: mod.formatted?('italic') || nil,
-          strikethrough: mod.formatted?('strikethrough') || nil,
-          underline: mod.formatted?('underline') || nil,
-
-          font_family: mod.fontfamily,
-          font_size: mod.fontsize,
-
-          foreground_color: mod.fontcolor ? sheets_color(mod.fontcolor) : nil
-        )
-      end
-
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
       def build_cell_format(mod)
         sheets_ns::CellFormat.new.tap do |cf|
-          cf.text_format = build_text_format(mod)
+          cf.text_format = mod.text_format
 
-          # TODO: are these not overwriting each other?
-          cf.horizontal_alignment = 'LEFT' if mod.aligned?('left')
-          cf.horizontal_alignment = 'RIGHT' if mod.aligned?('right')
-          cf.horizontal_alignment = 'CENTER' if mod.aligned?('center')
-          cf.vertical_alignment = 'TOP' if mod.aligned?('top')
-          cf.vertical_alignment = 'BOTTOM' if mod.aligned?('bottom')
+          cf.horizontal_alignment = mod.halign if mod.halign
+          cf.vertical_alignment = mod.valign if mod.valign
 
-          cf.background_color = sheets_color(mod.color) if mod.color
+          cf.background_color = mod.color if mod.color
 
-          cf.number_format = sheets_ns::NumberFormat.new(type: mod.numberformat) if mod.numberformat
+          cf.number_format = mod.numberformat if mod.numberformat
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
 
       def grid_range_for_cell(cell)
         sheets_ns::GridRange.new(
@@ -106,10 +87,10 @@ module CSVPlusPlus
       end
 
       def build_cell_data(cell)
-        mod = cell.modifier
+        mod = ::CSVPlusPlus::Writer::GoogleSheetModifier.new(cell.modifier)
 
         sheets_ns::CellData.new.tap do |cd|
-          cd.user_entered_format = build_cell_format(cell.modifier)
+          cd.user_entered_format = build_cell_format(mod)
           cd.note = mod.note if mod.note
 
           # XXX apply data validation

data/lib/csv_plus_plus/writer/google_sheet_modifier.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+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
+      end
+
+      # Format the color for Google Sheets
+      def color
+        google_sheets_color(super) if super
+      end
+
+      # Format the fontcolor for Google Sheets
+      def fontcolor
+        google_sheets_color(super) if super
+      end
+
+      # Format the numberformat for Google Sheets
+      def numberformat
+        ::Google::Apis::SheetsV4::NumberFormat.new(type: super) if super
+      end
+
+      # Builds a SheetsV4::TextFormat with the underlying Modifier
+      def text_format
+        ::Google::Apis::SheetsV4::TextFormat.new(
+          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
+
+      private
+
+      def google_sheets_color(color)
+        ::Google::Apis::SheetsV4::Color.new(
+          red: color.red_percent,
+          green: color.green_percent,
+          blue: color.blue_percent
+        )
+      end
+    end
+  end
+end

data/lib/csv_plus_plus/writer/google_sheets.rb

@@ -26,8 +26,8 @@ module CSVPlusPlus
       def write(template)
         auth!
 
-        save_spreadsheet!
-        save_spreadsheet_values!
+        fetch_spreadsheet!
+        fetch_spreadsheet_values!
 
         create_sheet! if @options.create_if_not_exists
 
@@ -58,7 +58,7 @@ module CSVPlusPlus
         @gs.authorization = ::Google::Auth.get_application_default(::AUTH_SCOPES)
       end
 
-      def save_spreadsheet_values!
+      def fetch_spreadsheet_values!
         formatted_values = get_all_spreadsheet_values('FORMATTED_VALUE')
         formula_values = get_all_spreadsheet_values('FORMULA')
 
@@ -94,7 +94,7 @@ module CSVPlusPlus
         @spreadsheet.sheets.find { |s| s.properties.title.strip == @sheet_name.strip }
       end
 
-      def save_spreadsheet!
+      def fetch_spreadsheet!
         @spreadsheet = @gs.get_spreadsheet(@sheet_id)
 
         return unless @sheet_name.nil?

data/lib/csv_plus_plus/writer/rubyxl_builder.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative './rubyxl_modifier'
+
+module CSVPlusPlus
+  module Writer
+    # Build a RubyXL workbook formatted according to the given +rows+
+    class RubyXLBuilder
+      attr_reader :output_filename, :rows
+
+      # initialize
+      def initialize(output_filename:, rows:, sheet_name:)
+        @rows = rows
+        @output_filename = output_filename
+        @workbook = open_workbook(sheet_name)
+        @worksheet = @workbook[sheet_name]
+      end
+
+      # write the given @rows in +sheet_name+ to +@output_filename+
+      def write
+        build_workbook!
+        @workbook.write(@output_filename)
+      end
+
+      private
+
+      def build_workbook!
+        @rows.each_with_index do |row, x|
+          row.cells.each_with_index do |cell, y|
+            modifier = ::CSVPlusPlus::Writer::RubyXLModifier.new(cell.modifier)
+
+            @worksheet.add_cell(x, y, cell.to_csv)
+            format_cell!(x, y, modifier)
+          end
+        end
+      end
+
+      def do_alignments!(cell, modifier)
+        cell.change_horizontal_alignment(modifier.halign) if modifier.halign
+        cell.change_vertical_alignment(modifier.valign) if modifier.valign
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def do_borders!(cell, modifier)
+        return unless modifier.any_border?
+
+        color = modifier.bordercolor
+        weight = modifier.border_weight
+
+        if modifier.border_all?
+          %i[top bottom left right].each do |direction|
+            # TODO: I can't support a weight and a color?
+            cell.change_border(direction, color || weight)
+          end
+        else
+          modifier.borders.each do |direction|
+            cell.change_border(direction, color || weight)
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def do_fill!(cell, modifier)
+        cell.change_fill(modifier.color.to_hex) if modifier.color
+      end
+
+      def do_formats!(cell, modifier)
+        cell.change_font_bold(true) if modifier.formatted?('bold')
+        cell.change_font_italics(true) if modifier.formatted?('italic')
+        cell.change_font_underline(true) if modifier.formatted?('underline')
+        cell.change_font_strikethrough(true) if modifier.formatted?('strikethrough')
+      end
+
+      def do_fonts!(cell, modifier)
+        cell.change_font_color(modifier.fontcolor.to_hex) if modifier.fontcolor
+        cell.change_font_name(modifier.fontfamily) if modifier.fontfamily
+        cell.change_font_size(modifier.fontsize) if modifier.fontsize
+      end
+
+      def do_number_formats!(cell, modifier)
+        return unless modifier.numberformat
+
+        cell.set_number_format(modifier.number_format_code)
+        # TODO: this is annoying... we have to set the contents with the correct type of object
+        cell.change_contents(cell.value)
+      end
+
+      def format_cell!(row_index, cell_index, modifier)
+        @worksheet.sheet_data[row_index][cell_index].tap do |cell|
+          do_alignments!(cell, modifier)
+          do_borders!(cell, modifier)
+          do_fill!(cell, modifier)
+          do_fonts!(cell, modifier)
+          do_formats!(cell, modifier)
+          do_number_formats!(cell, modifier)
+        end
+      end
+
+      def open_workbook(sheet_name)
+        if ::File.exist?(@output_filename)
+          ::RubyXL::Parser.parse(@output_filename).tap do |workbook|
+            workbook.add_worksheet(sheet_name) unless workbook[sheet_name]
+          end
+        else
+          ::RubyXL::Workbook.new.tap do |workbook|
+            workbook.worksheets[0].sheet_name = sheet_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/csv_plus_plus/writer/rubyxl_modifier.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  # Writer
+  module Writer
+    # Build a RubyXL-decorated Modifier class adds some support for Excel
+    class RubyXLModifier < ::SimpleDelegator
+      # https://www.rubydoc.info/gems/rubyXL/RubyXL/NumberFormats
+      # https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68
+      NUM_FMT_IDS = {
+        currency: 5,
+        date: 14,
+        date_time: 22,
+        number: 1,
+        percent: 9,
+        text: 49,
+        time: 21,
+        scientific: 48
+      }.freeze
+      private_constant :NUM_FMT_IDS
+
+      # https://www.rubydoc.info/gems/rubyXL/2.3.0/RubyXL
+      # ST_BorderStyle = %w{ none thin medium dashed dotted thick double hair mediumDashed dashDot mediumDashDot
+      #                      dashDotDot slantDashDot }
+      BORDER_STYLES = {
+        dashed: 'dashed',
+        dotted: 'dotted',
+        double: 'double',
+        solid: 'thin',
+        solid_medium: 'medium',
+        solid_thick: 'thick'
+      }.freeze
+      private_constant :BORDER_STYLES
+
+      # The excel-specific number format code
+      def number_format_code
+        ::RubyXL::NumberFormats::DEFAULT_NUMBER_FORMATS.find_by_format_id(
+          # rubocop:disable Lint/ConstantResolution
+          NUM_FMT_IDS[numberformat.to_sym]
+          # rubocop:enable Lint/ConstantResolution
+        ).format_code
+      end
+
+      # The excel-specific border weight
+      def border_weight
+        # rubocop:disable Lint/ConstantResolution
+        BORDER_STYLES[borderstyle.to_sym]
+        # rubocop:enable Lint/ConstantResolution
+      end
+    end
+  end
+end

data/lib/csv_plus_plus/writer.rb

@@ -7,7 +7,6 @@ require_relative './writer/google_sheets'
 require_relative './writer/open_document'
 
 module CSVPlusPlus
-  ##
   # Various strategies for writing to various formats (excel, google sheets, CSV, OpenDocument)
   module Writer
     # Return an instance of a writer depending on the given +options+
@@ -17,8 +16,8 @@ module CSVPlusPlus
       case options.output_filename
       when /\.csv$/ then ::CSVPlusPlus::Writer::CSV.new(options)
       when /\.ods$/ then ::CSVPlusPlus::Writer::OpenDocument.new(options)
-      when /\.xls$/ then ::CSVPlusPlus::Writer::Excel.new(options)
-      else raise(::StandardError, "Unsupported extension: #{options.output_filename}")
+      when /\.xl(sx|sm|tx|tm)$/ then ::CSVPlusPlus::Writer::Excel.new(options)
+      else raise(::CSVPlusPlus::Error, "Unsupported file extension: #{options.output_filename}")
       end
     end
   end

data/lib/csv_plus_plus.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'csv_plus_plus/error'
 require_relative 'csv_plus_plus/language/compiler'
 require_relative 'csv_plus_plus/options'
 require_relative 'csv_plus_plus/writer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_plus_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-sheets_v4
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubyXL
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
+        version: '3.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: "A programming language built on top of CSV.  You can define functions
   and variables to use in your spreadsheet, \nthen compile it to Excel, CSV, Google
   Sheets, etc.\n"
@@ -108,8 +108,10 @@ files:
 - bin/csv++
 - lib/csv_plus_plus.rb
 - lib/csv_plus_plus/cell.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/error.rb
 - lib/csv_plus_plus/expand.rb
 - lib/csv_plus_plus/google_options.rb
 - lib/csv_plus_plus/graph.rb
@@ -144,13 +146,22 @@ files:
 - lib/csv_plus_plus/writer/csv.rb
 - lib/csv_plus_plus/writer/excel.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
 metadata:
   rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/patrickomatic/csv-plus-plus/issues
+  documentation_uri: https://www.rubydoc.info/gems/csv_plus_plus/
+  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
 post_install_message:
 rdoc_options: []
 require_paths: