feature: Add monkey-patch to allow input of serial dates

PR open at:
gimite/google-drive-ruby#379

Also
- Update the spreadsheet mock with a way to input serial dates.
- Remove core_extensions from coverage report.
- Remove CoreExtensions::Worksheet rubocop checking

Author: Drowze

lib/core_extensions.rb

@@ -4,6 +4,7 @@
 
 module AspireBudget
   module CoreExtensions
+    # rubocop:disable all
     module Worksheet
       def rows(skip = 0)
         nc = num_cols
@@ -24,9 +25,98 @@ def rows(skip = 0)
       def rows_with_numerics(skip = 0)
         rows(skip) { |row, col| numeric_value(row, col) || self[row, col] }
       end
+
+      def []=(*args) # rubocop:disable all
+        (row, col) = parse_cell_args(args[0...-1])
+        value = args[-1]
+
+        reload_cells unless @cells
+        @numeric_values[[row, col]] = value.is_a?(Numeric) ? value : nil
+        value = value.to_s
+        validate_cell_value(value)
+
+        @cells[[row, col]] = value
+        @input_values[[row, col]] = value
+        @modified.add([row, col])
+        self.max_rows = row if row > @max_rows
+        self.max_cols = col if col > @max_cols
+        if value.empty?
+          @num_rows = nil
+          @num_cols = nil
+        else
+          @num_rows = row if @num_rows && row > @num_rows
+          @num_cols = col if @num_cols && col > @num_cols
+        end
+      end
+
+      def save # rubocop:disable all
+        sent = false
+
+        if @meta_modified
+          add_request({
+            update_sheet_properties: {
+              properties: {
+                sheet_id: sheet_id,
+                title: title,
+                index: index,
+                grid_properties: {row_count: max_rows, column_count: max_cols},
+              },
+              fields: '*',
+            },
+          })
+        end
+
+        if !@v4_requests.empty?
+          self.spreadsheet.batch_update(@v4_requests)
+          @v4_requests = []
+          sent = true
+        end
+
+        @remote_title = @title
+
+        unless @modified.empty?
+          min_modified_row = 1.0 / 0.0
+          max_modified_row = 0
+          min_modified_col = 1.0 / 0.0
+          max_modified_col = 0
+          @modified.each do |r, c|
+            min_modified_row = r if r < min_modified_row
+            max_modified_row = r if r > max_modified_row
+            min_modified_col = c if c < min_modified_col
+            max_modified_col = c if c > max_modified_col
+          end
+
+          # Uses update_spreadsheet_value instead batch_update_spreadsheet with
+          # update_cells. batch_update_spreadsheet has benefit that the request
+          # can be batched with other requests. But it has drawback that the
+          # type of the value (string_value, number_value, etc.) must be
+          # explicitly specified in user_entered_value. Since I don't know exact
+          # logic to determine the type from text, I chose to use
+          # update_spreadsheet_value here.
+          range = "'%s'!R%dC%d:R%dC%d" %
+              [@title, min_modified_row, min_modified_col, max_modified_row, max_modified_col]
+          values = (min_modified_row..max_modified_row).map do |r|
+            (min_modified_col..max_modified_col).map do |c|
+              next unless @modified.include?([r, c])
+
+              @numeric_values[[r, c]] || @cells[[r, c]] || ''
+            end
+          end
+          value_range = Google::Apis::SheetsV4::ValueRange.new(values: values)
+          @session.sheets_service.update_spreadsheet_value(
+              spreadsheet.id, range, value_range, value_input_option: 'USER_ENTERED')
+
+          @modified.clear
+          sent = true
+        end
+
+        sent
+      end
     end
+    # rubocop:enable all
   end
 end
 
 # https://github.com/gimite/google-drive-ruby/issues/378 (PR #377)
+# https://github.com/gimite/google-drive-ruby/issues/380 (PR #379)
 GoogleDrive::Worksheet.prepend AspireBudget::CoreExtensions::Worksheet

lib/utils.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
 require 'date'
-require 'configuration'
 
 module AspireBudget
   module Utils
     class << self
-      DATE_FORMAT = '%d/%m/%y'
-
       def parse_date(value)
         return parse_serial_date(value) if value.is_a?(Numeric)
         return value.to_date if value.respond_to?(:to_date)

spec/spec_helper.rb

@@ -5,13 +5,14 @@
 if ENV['CI']
   require 'simplecov'
   SimpleCov.start do
+    add_filter 'lib/core_extensions.rb'
     add_filter %r{^/spec/}
   end
 end
 
 require 'pry'
 require 'support/google_drive_mock'
-require 'support/spreadsheet_version_helper'
+require 'support/spreadsheet_mock_helpers'
 require 'aspire_budget'
 
 RSpec.configure do |config|

spec/support/google_drive_mock.rb

@@ -86,10 +86,11 @@ def [](*args)
         else
           args
         end
-      rows[row - 1][col - 1].to_s
+
+      rows[row - 1][col - 1]
     end
 
-    def []=(row, col, value) # rubocop:disable Metrics/MethodLength
+    def []=(row, col, value) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       @dirty = true
 
       if row > num_rows
@@ -104,15 +105,21 @@ def []=(row, col, value) # rubocop:disable Metrics/MethodLength
         end
       end
 
-      @rows[row - 1][col - 1] = value
+      value = treat_value(row, col, value) || value
+
+      @rows[row - 1][col - 1] = value.to_s
     end
 
+    # treat the values (e.g. convert to date or currency)
+    # used by #treat_cells_as test helper
+    def treat_value(row, col, value); end
+
     # assumes that "," is not a decimal separator
     # assumes date format as defined above
     def numeric_value(*args)
-      value = self[*args]
+      value = self[*args].to_s
       if value.match?(CURRENCY_REGEX)
-        value.gsub(/[€$,]/, '').to_f
+        Float(value.gsub(/[€$,]/, ''))
       elsif value.match?(%r{\d+/\d+/\d+})
         Float(Date.strptime(value, DATE_FORMAT) - LOTUS_DAY_ONE)
       end

spec/support/spreadsheet_mock_helpers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'utils'
+
+module SpreadsheetMockHelpers
+  def use_spreadsheet_version(version)
+    AspireBudget.configure do |config|
+      config.session = GoogleDrive.from_config('foo')
+      config.spreadsheet_key = version
+    end
+  end
+
+  # When inputing into a numeric cell, mock it first so we'll try to coerce its
+  # contents.
+  #
+  # @param currency [Array] currency cells ([row, col] format)
+  # @param date [Array] date cels ([row, col] format)
+  def treat_cells_as(currency: [], date: [])
+    allow_any_instance_of(GoogleDriveMock::Worksheet)
+      .to receive(:treat_value) do |_obj, row, col, value|
+        if date.include?([row, col])
+          AspireBudget::Utils.parse_date(Float(value)).strftime('%-d/%-m/%y')
+        elsif currency.include?([row, col])
+          value = format('%<value>.2f', value: value)
+          "$#{format('%<value>.2f', value: value)}"
+        end
+      end
+  end
+end
+
+RSpec.configure do |config|
+  config.include SpreadsheetMockHelpers
+end

spec/support/spreadsheet_version_helper.rb

@@ -32,8 +32,12 @@
       end
 
       describe '#insert' do
+        before do
+          treat_cells_as(date: [[11, 2]], currency: [[11, 3]])
+        end
+
         let(:params) do
-          { date: '03/06/2020', amount: 120.43, from: 'Available to budget', to: 'Groceries', memo: 'ruby' }
+          { date: Date.parse('2020-06-03'), amount: 120.43, from: 'Available to budget', to: 'Groceries', memo: 'ruby' }
         end
         let(:new_record_attributes) do
           {
@@ -52,7 +56,7 @@
               .to change { subject.all.size }
               .by(1)
 
-            expect(new_record).to have_attributes(new_record_attributes)
+            expect(subject.all.last).to have_attributes(new_record_attributes)
 
             expect(subject).not_to be_dirty
           end
@@ -67,7 +71,7 @@
             allow(category_transfer)
               .to receive(:to_row)
               .with(%i[date amount from to memo])
-              .and_return(['03/06/20', '120.43', 'Available to budget', 'Groceries', 'ruby'])
+              .and_return([43_985.0, 120.43, 'Available to budget', 'Groceries', 'ruby'])
           end
 
           it 'inserts new data' do
@@ -76,7 +80,7 @@
               .to change { subject.all.size }
               .by(1)
 
-            expect(new_record).to have_attributes(new_record_attributes)
+            expect(subject.all.last).to have_attributes(new_record_attributes)
 
             expect(subject).not_to be_dirty
           end

spec/worksheets/category_transfers_spec.rb

@@ -56,9 +56,16 @@
       end
 
       describe '#insert' do
+        before do
+          treat_cells_as(
+            date: [[13, 2]],
+            currency: [[13, 3], [13, 4]]
+          )
+        end
+
         let(:params) do
           {
-            date: '03/06/2020',
+            date: Date.parse('2020-06-03'),
             outflow: 900,
             inflow: 800,
             category: 'Test',
@@ -101,7 +108,7 @@
             allow(transaction)
               .to receive(:to_row)
               .with(%i[date outflow inflow category account memo status])
-              .and_return(['03/06/20', '900.00', '800.00', 'Test', '💰 Checking', 'ruby', '✅'])
+              .and_return([43_985.0, 900.00, 800.00, 'Test', '💰 Checking', 'ruby', '✅'])
           end
 
           it 'inserts new data' do