csv_plus_plus 0.0.3 → 0.0.5

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
@@ -14,7 +15,6 @@ module CSVPlusPlus
       @create_if_not_exists = false
       @key_values = {}
       @verbose = false
-      # TODO: switch to true? probably a safer choice
       @backup = false
     end
 

data/lib/csv_plus_plus/version.rb

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

data/lib/csv_plus_plus/writer/base_writer.rb

@@ -2,7 +2,6 @@
 
 module CSVPlusPlus
   module Writer
-    ##
     # Some shared functionality that all Writers should build on
     class BaseWriter
       attr_accessor :options

data/lib/csv_plus_plus/writer/csv.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require_relative './file_backer_upper'
+
 module CSVPlusPlus
   module Writer
-    ##
     # A class that can output a +Template+ to CSV
     class CSV < ::CSVPlusPlus::Writer::BaseWriter
+      include ::CSVPlusPlus::Writer::FileBackerUpper
+
       # write a +template+ to CSV
       def write(template)
         # TODO: also read it and merge the results

data/lib/csv_plus_plus/writer/excel.rb

@@ -1,12 +1,28 @@
 # frozen_string_literal: true
 
+require_relative './file_backer_upper'
+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
+      include ::CSVPlusPlus::Writer::FileBackerUpper
+
+      # 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/file_backer_upper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+module CSVPlusPlus
+  module Writer
+    # A mixin that can
+    module FileBackerUpper
+      # we don't want to include a bunch of second/millisecond stuff in the filename  unless we
+      # really need to. so try a less specifically formatted filename then get more specific
+      DESIRED_BACKUP_FORMATS = [%(%Y_%m_%d-%I_%M%p), %(%Y_%m_%d-%I_%M_%S%p), %(%Y_%m_%d-%I_%M_%S_%L%p)].freeze
+      private_constant :DESIRED_BACKUP_FORMATS
+
+      # Assuming the underlying spreadsheet is file-based, create a backup of it
+      # rubocop:disable Metrics/MethodLength
+      def write_backup
+        return unless ::File.exist?(@options.output_filename)
+
+        attempted = []
+        backed_up_to = nil
+
+        # rubocop:disable Lint/ConstantResolution
+        DESIRED_BACKUP_FORMATS.find do |file_format|
+          # rubocop:enable Lint/ConstantResolution
+          filename = format_backup_filename(file_format)
+          attempted << filename
+          backed_up_to = backup(filename)
+
+          break if backed_up_to
+        end
+
+        unless backed_up_to
+          raise(::CSVPlusPlus::Error, "Unable to write backup file despite trying these: #{attempted.join(', ')}")
+        end
+
+        warn("Backed up #{@options.output_filename} to #{backed_up_to}") if @options.verbose
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      def backup(filename)
+        return if ::File.exist?(filename)
+
+        ::FileUtils.cp(@options.output_filename, filename)
+        filename
+      end
+
+      def format_backup_filename(file_format)
+        pn = ::Pathname.new(@options.output_filename)
+        pn.sub_ext("-#{::Time.now.strftime(file_format)}" + pn.extname)
+      end
+    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

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
+require_relative '../google_api_client'
 require_relative 'base_writer'
 require_relative 'google_sheet_builder'
 
-AUTH_SCOPES = ['https://www.googleapis.com/auth/spreadsheets'].freeze
-FULL_RANGE = 'A1:Z1000'
-
 module CSVPlusPlus
   module Writer
-    # A class that can output a +Template+ to Google Sheets (via their API)
+    # A class that can write a +Template+ to Google Sheets (via their API)
     class GoogleSheets < ::CSVPlusPlus::Writer::BaseWriter
-      # XXX it would be nice to raise this but we shouldn't expand out more than necessary for our data
+      # TODO: it would be nice to raise this but we shouldn't expand out more than necessary for our data
       SPREADSHEET_INFINITY = 1000
       public_constant :SPREADSHEET_INFINITY
 
@@ -24,21 +22,26 @@ module CSVPlusPlus
 
       # write a +template+ to Google Sheets
       def write(template)
-        auth!
+        @sheets_client = ::CSVPlusPlus::GoogleApiClient.sheets_client
 
-        save_spreadsheet!
-        save_spreadsheet_values!
+        fetch_spreadsheet!
+        fetch_spreadsheet_values!
 
         create_sheet! if @options.create_if_not_exists
 
         update_cells!(template)
-      rescue ::Google::Apis::ClientError => e
-        handle_google_error(e)
+      end
+
+      # write a backup of the google sheet
+      def write_backup
+        drive_client = ::CSVPlusPlus::GoogleApiClient.drive_client
+        drive_client.copy_file(@sheet_id)
       end
 
       protected
 
       def load_requires
+        require('google/apis/drive_v3')
         require('google/apis/sheets_v4')
         require('googleauth')
       end
@@ -50,15 +53,10 @@ module CSVPlusPlus
       end
 
       def full_range
-        format_range(::FULL_RANGE)
+        format_range('A1:Z1000')
       end
 
-      def auth!
-        @gs ||= sheets_ns::SheetsService.new
-        @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')
 
@@ -85,7 +83,7 @@ module CSVPlusPlus
       end
 
       def get_all_spreadsheet_values(render_option)
-        @gs.get_spreadsheet_values(@sheet_id, full_range, value_render_option: render_option)
+        @sheets_client.get_spreadsheet_values(@sheet_id, full_range, value_render_option: render_option)
       end
 
       def sheet
@@ -94,8 +92,8 @@ module CSVPlusPlus
         @spreadsheet.sheets.find { |s| s.properties.title.strip == @sheet_name.strip }
       end
 
-      def save_spreadsheet!
-        @spreadsheet = @gs.get_spreadsheet(@sheet_id)
+      def fetch_spreadsheet!
+        @spreadsheet = @sheets_client.get_spreadsheet(@sheet_id)
 
         return unless @sheet_name.nil?
 
@@ -105,34 +103,23 @@ module CSVPlusPlus
       def create_sheet!
         return if sheet
 
-        @gs.create_spreadsheet(@sheet_name)
-        get_spreadsheet!
+        @sheets_client.create_spreadsheet(@sheet_name)
+        fetch_spreadsheet!
         @sheet_name = @spreadsheet.sheets.last.properties.title
       end
 
       def update_cells!(template)
-        builder = ::CSVPlusPlus::Writer::GoogleSheetBuilder.new(
+        @sheets_client.batch_update_spreadsheet(@sheet_id, builder(template).batch_update_spreadsheet_request)
+      end
+
+      def builder(template)
+        ::CSVPlusPlus::Writer::GoogleSheetBuilder.new(
           rows: template.rows,
           sheet_id: sheet&.properties&.sheet_id,
           column_index: @options.offset[1],
           row_index: @options.offset[0],
           current_sheet_values: @current_sheet_values
         )
-        @gs.batch_update_spreadsheet(@sheet_id, builder.batch_update_spreadsheet_request)
-      rescue ::Google::Apis::ClientError => e
-        handle_google_error(e)
-      end
-
-      def sheets_ns
-        ::Google::Apis::SheetsV4
-      end
-
-      def handle_google_error(error)
-        if @options.verbose
-          warn("#{error.status_code} Error making Google Sheets API request [#{error.message}]: #{error.body}")
-        else
-          warn("Error making Google Sheets API request: #{error.message}")
-        end
       end
     end
   end

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,7 @@
 # frozen_string_literal: true
 
+require_relative 'csv_plus_plus/cli'
+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'
@@ -14,7 +16,10 @@ module CSVPlusPlus
       template = c.parse_template
 
       output = ::CSVPlusPlus::Writer.writer(options)
-      c.outputting! { output.write(template) }
+      c.outputting! do
+        output.write_backup if options.backup
+        output.write(template)
+      end
     end
   end
 end