ynab_convert 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e707b36e18c8b57f7b517bf6f1f29d769e22089316448da062165c35e5fb713
-  data.tar.gz: ee5dbf483c6252085860166c6371fd7d6ba75b91d90dc17a74a9a68ddff80026
+  metadata.gz: 2af241f007b8495197a8971ffbf3b3efe0dda41411c56a3543452dfea50fd03e
+  data.tar.gz: ac7c2614c064e005524c808dd62bddbbaaa8e8395bea6a02b0bf4ef45960133f
 SHA512:
-  metadata.gz: 44f457015648d06a43c98da0622ae12de10eb84025636677b044020d98aa82dca85c2968f9b924541dd8260002a8e727bef22cf60515d6dc17e345d8e06cf0e5
-  data.tar.gz: 0fadae67422faf27caa356890121600879416545043c240ef951a3bc2c9caf9a8af544f25978a50e3e479994eb020e008e99c32a99c76363d239e82d09037fcb
+  metadata.gz: 3f96f0a1839d1bc4111f8f53aeac6f7b503155f65b03e2ccd113e0847baa8637beeef7aeae182538b3f6f4cd5caf5a462b568b0ffae5a42f24062722c4a51cf7
+  data.tar.gz: 4f17efacff3b4b5cb62df38997863bad691b41a4f26d5a27ef3b7bfaa93072f217f4a824f11dd6e462ba422f862991e5ae14990e7f5f8c8879f49a7deba91274

data/.rubocop.yml

@@ -1,6 +1,11 @@
 ---
+# See https://github.com/rubocop/rubocop/blob/master/config/default.yml for all
+# options
 require: rubocop-rake
 
+AllCops:
+  DisplayCopNames: true
+
 Metrics/LineLength:
   Exclude:
     - ynab_convert.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab_convert (1.0.2)
+    ynab_convert (1.0.3)
       i18n
       slop
 
@@ -44,10 +44,10 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.0.13)
     method_source (0.9.2)
-    mini_portile2 (2.6.1)
+    mini_portile2 (2.8.0)
     nenv (0.3.0)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -61,7 +61,7 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    racc (1.5.2)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.1)
     rb-fsevent (0.10.3)

data/Guardfile

@@ -74,7 +74,7 @@ group :red_green_refactor, halt_on_fail: true do
     end
   end
 
-  guard :rubocop, cli: ['--auto-correct'] do
+  guard :rubocop, cli: ['--auto-correct', '--display-cop-names'] do
     watch('Gemfile')
     watch('Rakefile')
     watch('bin/convert')

data/README.md

@@ -27,6 +27,7 @@ latest one on 2019-12-01.
 `-i` argument | Institution's full name | Institution's website | Remarks
 ---|---|---|---
 `example` | Example Bank | N/A | Reference processor implementation, not a real institution
+`n26` | N26 | [n26.com](n26.com) | N26 CSV statements
 `revolut` | Revolut Ltd | [revolut.com](https://www.revolut.com/) | The processor isn't aware of currencies. Make sure the statements processed with `revolut` are in the same currency that your YNAB is in
 `ubs_chequing` | UBS Switzerland (private banking) | [ubs.ch](https://ubs.ch) | Private chequing and joint accounts
 `ubs_credit` | UBS Switzerland (credit cards) | [ubs.ch](https://ubs.ch) | Both MasterCard and Visa
@@ -44,7 +45,8 @@ https://github.com/coaxial/ynab_convert.
 
 ### Enable debug output
 
-Run `ynab_convert` with `YNAB_CONVERT_DEBUG=true`, or use the rake task `spec:debug`. Debug logging goes to STDERR.
+Run `ynab_convert` with `YNAB_CONVERT_DEBUG=true`, or use the rake task
+`spec:debug`. Debug logging goes to STDERR.
 
 ### Adding a new financial institution
 

data/lib/core_extensions/string.rb

@@ -6,7 +6,7 @@ module CoreExtensions
     # Adds convenience methods
     module Inflections
       def snake_case
-        downcase.tr(' ', '_').gsub(/[^a-z_]/, '')
+        downcase.tr(' ', '_').gsub(/[^a-z_0-9]/, '')
       end
 
       def camel_case

data/lib/ynab_convert/processor/base.rb

@@ -14,12 +14,29 @@ module Processor
     attr_reader :loader_options
 
     # @option opts [String] :file Path to the CSV file to process
-    def initialize(opts)
+    # @option opts [Symbol] :format YNAB4 format to use, one of :flows or
+    #   :amounts. :flows is useful for CSVs with separate debit and credit
+    #   columns, :amounts is for CSVs with only one amount columns and +/-
+    #   numbers. See
+    #   https://docs.youneedabudget.com/article/921-formatting-csv-file
+    def initialize(options)
+      default_options = { file: '', format: :flows }
+      opts = default_options.merge(options)
+
       logger.debug "Initializing processor with options: `#{opts.to_h}'"
       raise ::Errno::ENOENT unless File.exist? opts[:file]
 
       @file = opts[:file]
-      @headers = { transaction_date: nil, payee: nil, debit: nil, credit: nil }
+      @headers = { transaction_date: nil, payee: nil }
+      @format = opts[:format]
+
+      if @format == :amounts
+        amounts_columns = { amount: nil }
+        @headers.merge!(amounts_columns)
+      else
+        flows_columns = { inflow: nil, outflow: nil }
+        @headers.merge!(flows_columns)
+      end
     end
 
     def to_ynab!
@@ -38,15 +55,41 @@ module Processor
 
     attr_accessor :statement_from, :statement_to, :headers
 
-    def inflow_or_outflow_missing?(row)
+    def amount_invalid?(row)
+      amount_index = 3
+
+      # If there is no amount,
+      # then the row is invalid.
+      row[amount_index].nil? || row[amount_index].empty?
+    end
+
+    def inflow_outflow_invalid?(row)
       inflow_index = 3
       outflow_index = 4
-      # If there is neither inflow and outflow values, or their value is 0,
-      # then the row is not valid to YNAB4
-      (row[inflow_index].nil? || row[inflow_index].empty? ||
-       row[inflow_index] == '0.00') &&
-        (row[outflow_index].nil? || row[outflow_index].empty? ||
-         row[outflow_index] == '0.00')
+
+      # If there is neither inflow and outflow values,
+      # or both the inflow and outflow amounts are 0,
+      # then the row is invalid.
+      (
+        row[inflow_index].nil? ||
+        row[inflow_index].empty? ||
+        row[inflow_index] == '0.00'
+      ) && (
+        row[outflow_index].nil? ||
+        row[outflow_index].empty? ||
+        row[outflow_index] == '0.00'
+      )
+    end
+
+    def amounts_missing?(row)
+      logger.debug "Checking for missing amount in `#{row}`"
+      if @format == :amounts
+        logger.debug 'Using `:amounts`'
+        amount_invalid?(row)
+      else
+        logger.debug 'Using `:flows`'
+        inflow_outflow_invalid?(row)
+      end
     end
 
     def skip_row(row)
@@ -96,6 +139,7 @@ module Processor
     def convert!
       logger.debug "Will write to `#{temp_filename}'"
 
+      logger.debug(loader_options)
       CSV.open(temp_filename, 'wb', output_options) do |converted|
         CSV.foreach(@file, 'rb', loader_options) do |row|
           logger.debug "Parsing row: `#{row.to_h}'"
@@ -103,7 +147,7 @@ module Processor
           catch :skip_row do
             extract_header_names(row)
             ynab_row = transformers(row)
-            if inflow_or_outflow_missing?(ynab_row) ||
+            if amounts_missing?(ynab_row) ||
                transaction_date_missing?(ynab_row)
               logger.debug 'Empty row, skipping it'
               skip_row(row)
@@ -151,7 +195,17 @@ module Processor
     end
 
     def ynab_headers
-      %w[Date Payee Memo Outflow Inflow]
+      common_headers = %w[Date Payee Memo]
+
+      if @format == :amounts
+        amounts_headers = %w[Amount]
+        common_headers.concat(amounts_headers)
+      else
+        flows_headers = %w[Outflow Inflow]
+        common_headers.concat(flows_headers)
+      end
+
+      common_headers
     end
 
     def output_options

data/lib/ynab_convert/processor/example.rb

@@ -14,7 +14,7 @@ module Processor
   # if it's redundant. For instance, this parser is for "Example Bank" but it's
   # named "example.rb", its corresponding spec is
   # "spec/example_processor_spec.rb" and its fixture would be
-  # "spec/fixtures/example.csv"
+  # "spec/fixtures/example/statement.csv"
   class Example < Processor::Base
     # @option options [String] :file Path to the CSV file to process
     def initialize(options)

data/lib/ynab_convert/processor/n26.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Processor
+  # Processes CSV files from N26
+  #
+  # An example of how to implement a custom processor
+  # Processes CSV files with this format:
+  # <<~ROWS
+  # "Date","Payee","Memo","Outflow","Inflow"
+  # "23/12/2019","coaxial","","1000000.00",""
+  # "30/12/2019","Santa","","50000.00",""
+  # "02/02/2020","Someone Else","","45.00",""
+  # ROWS
+  # The file name for the processor should be the institution name in
+  # camel case. It's ok to skip "Bank" or "Credit Union" when naming the file
+  # if it's redundant. For instance, this parser is for "Example Bank" but it's
+  # named "example.rb", its corresponding spec is
+  # "spec/example_processor_spec.rb" and its fixture would be
+  # "spec/fixtures/example.csv"
+  class N26 < Processor::Base
+    # @option options [String] :file Path to the CSV file to process
+    def initialize(options)
+      # Custom converters can be added so that the CSV data is parsed when
+      # loading the original file
+      register_custom_converters
+
+      # These are the options for the CSV module (see
+      # https://ruby-doc.org/stdlib-2.6/libdoc/csv/rdoc/CSV.html#method-c-new)
+      # They should match the format for the CSV file that the financial
+      # institution generates.
+      @loader_options = {
+        col_sep: ',',
+        quote_char: '"',
+        # Use your converters, if any
+        # converters: %i[],
+        headers: true,
+        encoding: 'bom|utf-8'
+      }
+
+      # This is the financial institution's full name as it calls itself. This
+      # usually matches the institution's letterhead and/or commercial name.
+      # It can happen that the same institution needs different parsers because
+      # its credit card CSV files are in one format, and its chequing accounts
+      # in another. In that case, more details can be added in parens.
+      # For instance:
+      # 'Example Bank (credit cards)' and 'Example Bank (chequing)'
+      @institution_name = 'N26 Bank'
+      # N26's CSV only has one columns for all transactions instead of separate
+      # debit and credit columns
+      additional_processor_options = { format: :amounts }
+
+      # This is mandatory.
+      super(options.merge(additional_processor_options))
+    end
+
+    private
+
+    def register_custom_converters; end
+
+    protected
+
+    def transformers(row)
+      transaction_date = row[headers[:transaction_date]]
+      payee = row[headers[:payee]]
+      amount = row[headers[:amount]]
+
+      converted_row = [transaction_date, payee, nil, amount]
+      logger.debug "Converted row: #{converted_row}"
+      converted_row
+    end
+
+    private
+
+    # Institutions love translating the column names, apparently. Rather than
+    # hardcoding the column name as a string, use the headers array at the
+    # right index.
+    # These lookups aren't particularly expensive but they're done on each row
+    # so why not memoize them with ||=
+    def extract_header_names(row)
+      headers[:transaction_date] ||= row.headers[0]
+      headers[:payee] ||= row.headers[1]
+      headers[:amount] ||= row.headers[5]
+    end
+  end
+end

data/lib/ynab_convert/processor/ubs_chequing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Processor
-  # Processes CSV files from UBS Personal Banking Switzerland (French)
+  # Processes CSV files from UBS Personal Banking Switzerland
   class UbsChequing < Processor::Base
     # @option options [String] :file Path to the CSV file to process
     def initialize(options)

data/lib/ynab_convert/processor/ubs_credit.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Processor
-  # Processes CSV files from UBS Credit Cards Switzerland (French)
+  # Processes CSV files from UBS Credit Cards Switzerland
   class UbsCredit < Processor::Base
     # @option options [String] :file Path to the CSV file to process
     def initialize(options)

data/lib/ynab_convert/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YnabConvert
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab_convert
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - coaxial
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -225,6 +225,7 @@ files:
 - lib/ynab_convert/logger.rb
 - lib/ynab_convert/processor/base.rb
 - lib/ynab_convert/processor/example.rb
+- lib/ynab_convert/processor/n26.rb
 - lib/ynab_convert/processor/revolut.rb
 - lib/ynab_convert/processor/ubs_chequing.rb
 - lib/ynab_convert/processor/ubs_credit.rb