csv_plus_plus 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4462a2a82490271a95479970e10246ed7d8b1e8a62d21928a5f2b710b2bd511
-  data.tar.gz: 31ce301945c5cc4d3154395dfa62271637baba4af78d2efed9b13d779036e015
+  metadata.gz: c29d586e678385367fe7a4a67fa66f4f0d111ceb1ace46125daaecbdd0bf7b03
+  data.tar.gz: aa13e49605c6448aa61cbf6d64ac39f3cfd9d8f84cb20370d8129ab5f1dd6f4b
 SHA512:
-  metadata.gz: a968bc15a47a6ac129b0a4a13df3dfb1997991548f13af9ac28598091b5562be8d7d1943a03f86a1a501533ff2eb974d1e2cc788f43fca27f09be455edcdba9f
-  data.tar.gz: f091403bede1fb2e751fad9b6937a836f0676e5ab284690fa2c8983fa746d90e9780c701d3a7ca1161fa9aca04b84263a1b7e7789dda866d6fe1caf975593287
+  metadata.gz: 6736fa3154f3ad44a4b3737a7d6e3b6571f6ba34226a8be4191a6cce3a53b1bcd09057b25bbc96da0ad01cc8c397e7b78df379b48fd510f881a810e8754aec65
+  data.tar.gz: 8160d63e5bda5417619d6a6e4e2a73b5cee744fc26b356d2c36efe3c56b93e2cfda8ed5cb128758079463542d0306d634c4804e02b7e4c56c14d9b98b0f3c1db

data/README.md

@@ -1,3 +1,7 @@
+# Deprecated!!!
+
+This version of csv++ is deprecated.  For the current version please go to [github.com/patrickomatic/csv-plus-plus](https://github.com/patrickomatic/csv-plus-plus)
+
 ![main](https://github.com/patrickomatic/csv-plus-plus/actions/workflows/rspec.yml/badge.svg)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)
 [![Gem Version](https://badge.fury.io/rb/csv_plus_plus.svg)](https://badge.fury.io/rb/csv_plus_plus)
@@ -59,6 +63,7 @@ Usage: csv++ [options]
     -k, --key-values KEY_VALUES      A comma-separated list of key=values which will be made available to the template
     -n, --sheet-name SHEET_NAME      The name of the sheet to apply the template to
     -o, --output OUTPUT_FILE         The file to write to (must be .csv, .ods, .xls)
+    -s, --safe                       Do not overwrite values in the spreadsheet being written to. The default is to overwrite
     -v, --verbose                    Enable verbose output
     -x, --offset-columns OFFSET      Apply the template offset by OFFSET cells
     -y, --offset-rows OFFSET         Apply the template offset by OFFSET rows

data/docs/CHANGELOG.md

@@ -1,4 +1,6 @@
-## main/upcoming
+## main
+
+- Add a `-s`/`--safe` flag which changes the merge strategy to not overwrite existing values.  If the spreadsheet being written to has values where the csvpp template wants to write, they will be overwritten otherwise.
 
 ## v0.2.0
 

data/lib/csv_plus_plus/cli_flag.rb

@@ -46,6 +46,7 @@ module CSVPlusPlus
       'offset-columns': ->(options, v) { options.offset[0] = v },
       'offset-rows': ->(options, v) { options.offset[1] = v },
       output: ->(options, v) { options.output_filename = ::Pathname.new(v) },
+      safe: ->(options, _v) { options.overwrite_values = false },
       verbose: ->(options, _v) { options.verbose = true }
     },
     ::T::Hash[::Symbol, ::T.proc.params(options: ::CSVPlusPlus::Options::Options, v: ::String).void]
@@ -81,6 +82,11 @@ module CSVPlusPlus
         '--output OUTPUT_FILE',
         'The file to write to (must be .csv, .ods, .xls)'
       ),
+      ::CSVPlusPlus::CLIFlag.new(
+        '-s',
+        '--safe',
+        'Do not overwrite values in the spreadsheet being written to. The default is to overwrite'
+      ),
       ::CSVPlusPlus::CLIFlag.new('-v', '--verbose', 'Enable verbose output'),
       ::CSVPlusPlus::CLIFlag.new('-x OFFSET', '--offset-columns OFFSET', 'Apply the template offset by OFFSET cells'),
       ::CSVPlusPlus::CLIFlag.new('-y OFFSET', '--offset-rows OFFSET', 'Apply the template offset by OFFSET rows')

data/lib/csv_plus_plus/options/options.rb

@@ -9,6 +9,7 @@ module CSVPlusPlus
     # @attr create_if_not_exists [Boolean] Create the spreadsheet if it does not exist?
     # @attr key_values [Hash] Additional variables that can be supplied to the template
     # @attr offset [Array<Integer>] An [x, y] offset (array with two integers)
+    # @attr overwrite_values [Boolean] Whether or not to overwrite existing values in the output spreadsheet.
     # @attr sheet_name [String] The name of the spreadsheet to write to
     # @attr verbose [Boolean] Include extra verbose output?
     class Options
@@ -29,6 +30,9 @@ module CSVPlusPlus
       sig { returns(::T::Array[::Integer]) }
       attr_accessor :offset
 
+      sig { returns(::T::Boolean) }
+      attr_accessor :overwrite_values
+
       sig { returns(::String) }
       attr_accessor :sheet_name
 
@@ -38,12 +42,13 @@ module CSVPlusPlus
       sig { params(sheet_name: ::String).void }
       # Initialize a defaul +Options+ object
       def initialize(sheet_name)
-        @sheet_name = sheet_name
-        @offset = ::T.let([0, 0], ::T::Array[::Integer])
+        @backup = ::T.let(false, ::T::Boolean)
         @create_if_not_exists = ::T.let(false, ::T::Boolean)
         @key_values = ::T.let({}, ::T::Hash[::Symbol, ::CSVPlusPlus::Entities::Entity])
+        @offset = ::T.let([0, 0], ::T::Array[::Integer])
+        @overwrite_values = ::T.let(true, ::T::Boolean)
+        @sheet_name = sheet_name
         @verbose = ::T.let(false, ::T::Boolean)
-        @backup = ::T.let(false, ::T::Boolean)
       end
 
       sig { abstract.returns(::CSVPlusPlus::Options::OutputFormat) }

data/lib/csv_plus_plus/version.rb

@@ -2,6 +2,6 @@
 # frozen_string_literal: true
 
 module CSVPlusPlus
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
   public_constant :VERSION
 end

data/lib/csv_plus_plus/writer/merger.rb

@@ -16,16 +16,41 @@ module CSVPlusPlus
             options: ::CSVPlusPlus::Options::Options
           ).returns(::T.nilable(::T.type_parameter(:V)))
       end
-      # Our strategy for resolving differences between new changes and existing
+      # Consistently enforce our strategy for resolving differences between new changes and existing. By default we
+      # overwrite values that are currently in the spreadsheet but you can override that with the --safe flag
       def merge_cell_value(existing_value:, new_value:, options:)
-        # TODO: make an option that specifies if we override (take new data over old)
-        merged_value = new_value || existing_value
+        merged_value = merge_with_strategy(existing_value:, new_value:, options:)
 
-        return merged_value if !options.verbose || merged_value == existing_value
+        return merged_value unless options.verbose
+
+        if options.overwrite_values && merged_value != existing_value
+          warn("Overwriting existing value: \"#{existing_value}\" with \"#{new_value}\"")
+        # rubocop:disable Style/MissingElse
+        elsif !options.overwrite_values && new_value != merged_value
+          # rubocop:enable Style/MissingElse
+          warn("Keeping old value: \"#{existing_value}\" rather than new value: \"#{new_value}\"")
+        end
 
-        warn("Overwriting existing value: \"#{existing_value}\" with \"#{new_value}\"")
         merged_value
       end
+
+      private
+
+      sig do
+        type_parameters(:V)
+          .params(
+            existing_value: ::T.nilable(::T.all(::T.type_parameter(:V), ::BasicObject)),
+            new_value: ::T.nilable(::T.all(::T.type_parameter(:V), ::BasicObject)),
+            options: ::CSVPlusPlus::Options::Options
+          ).returns(::T.nilable(::T.type_parameter(:V)))
+      end
+      def merge_with_strategy(existing_value:, new_value:, options:)
+        if options.overwrite_values
+          new_value || existing_value
+        else
+          existing_value || new_value
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_plus_plus
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Patrick Carroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-drive_v3
@@ -212,16 +212,16 @@ files:
 - lib/csv_plus_plus/writer/open_document.rb
 - lib/csv_plus_plus/writer/rubyxl_builder.rb
 - lib/csv_plus_plus/writer/writer.rb
-homepage: https://github.com/patrickomatic/csv-plus-plus
+homepage: https://github.com/patrickomatic/csv-plus-plus-ruby
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/patrickomatic/csv-plus-plus/issues
+  bug_tracker_uri: https://github.com/patrickomatic/csv-plus-plus-ruby/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/docs/CHANGELOG.md
+  github_repo: git://github.com/patrickomatic/csv-plus-plus-ruby
+  homepage_uri: https://github.com/patrickomatic/csv-plus-plus-ruby
+  source_code_uri: https://github.com/patrickomatic/csv-plus-plus-ruby
+  changelog_uri: https://github.com/patrickomatic/csv-plus-plus-ruby/blob/main/docs/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []