ynab_convert 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d57290b817fcadeb182c71a128179ca028608242651ea5e4fc6d9ba80ab034a
-  data.tar.gz: 137491a1cb0d063cbd2ee4fc21dde6843121a9ebeaedeb32614300a058d09e1a
+  metadata.gz: 7ad8f2a7b8c6b00d895032525413d35d4879da80be21e0b9fc852e1d413dbaa0
+  data.tar.gz: 99b9168cb23390fe15deec8f0c9c3c27cda183f95867b2849d79fa4e4a704c4d
 SHA512:
-  metadata.gz: 407012e06fcf3f00e5d888181076568530c7d524b7425d8d1068dde4458d9c5dd1c88364e66ca33d6692a4c8ae5351e33ec5b896fdb25c9b894a5bcfd5faab28
-  data.tar.gz: e1b8b00d2ff99dd452ba7d308a800e418aa813f18d5340a0ec787b1f1e9cee35f5dad7858f97405d40fb682cc09052e198c367b023e90ab925a82e9eae6ba0d1
+  metadata.gz: 630775dd15ab4f65a32c6dbe9617bea36c0721ff9d5cca49ee986f4e04831fa9335b41b996b2b3f69bbce630e452ae9045d3d98ec9b3d6862c84f6fb0077a1a6
+  data.tar.gz: 3bdf9b06d5327815fc31b8b3b9a9f6fb52e606ae6dc900501ff8fdf0671c110effe02dd5ca625fed0c3bbeb884b9572ff18ce7b9e46b8c21dd61d0a4b685956c

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/.travis.yml

@@ -3,12 +3,12 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6
+  - 2.7
 before_install: gem install bundler
 
 jobs:
   include:
     - stage: test
-      rvm: 2.6
       script: echo "Running tests for $(ruby -v)..." && bundle exec rake ci
     - stage: gem release
       rvm: 2.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab_convert (1.0.1)
+    ynab_convert (1.0.4)
       i18n
       slop
 
@@ -12,7 +12,7 @@ GEM
     backport (1.1.2)
     byebug (11.0.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     docile (1.3.2)
     ffi (1.11.2)
@@ -35,19 +35,20 @@ GEM
       guard (~> 2.0)
       rubocop (~> 0.20)
     htmlentities (4.3.4)
-    i18n (1.8.9)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.2.0)
+    json (2.5.1)
     listen (3.2.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.0.13)
     method_source (0.9.2)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.8.0)
     nenv (0.3.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -60,6 +61,7 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.1)
     rb-fsevent (0.10.3)
@@ -96,7 +98,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    slop (4.8.2)
+    slop (4.9.1)
     solargraph (0.37.2)
       backport (~> 1.1)
       bundler (>= 1.17.2)
@@ -132,4 +134,4 @@ DEPENDENCIES
   ynab_convert!
 
 BUNDLED WITH
-   2.2.11
+   2.3.8

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/bin/ynab_convert

@@ -9,7 +9,6 @@ require 'ynab_convert/processors'
 require 'ynab_convert/logger'
 require 'ynab_convert/error'
 require 'slop/symbol'
-require 'pry'
 
 # Add mixins and run converter
 class Convert

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

@@ -5,7 +5,8 @@ require 'csv'
 require 'ynab_convert/logger'
 
 module Processor
-  # Base class for a Processor, all processors must inherit from it
+  # Base class for a Processor, all processors must inherit from it.
+
   # rubocop:disable Metrics/ClassLength
   class Base
     include YnabLogger
@@ -13,13 +14,30 @@ module Processor
 
     attr_reader :loader_options
 
-    # @option opts [String] :file Path to the CSV file to process
-    def initialize(opts)
+    # @option options [String] :file Path to the CSV file to process
+    # @option options [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 +56,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,14 +140,15 @@ module Processor
     def convert!
       logger.debug "Will write to `#{temp_filename}'"
 
-      CSV.open(temp_filename, 'wb', output_options) do |converted|
-        CSV.foreach(@file, 'rb', loader_options) do |row|
+      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}'"
           # Some rows don't contain valid or useful data
           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 +196,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,70 @@
+# frozen_string_literal: true
+
+module Processor
+  # Processes CSV files from N26
+  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.1'
+  VERSION = '1.0.4'
 end

data/lib/ynab_convert.rb

@@ -2,7 +2,6 @@
 
 require 'ynab_convert/version'
 require 'slop'
-require 'pry'
 require 'ynab_convert/logger'
 require 'core_extensions/string.rb'
 

data/ynab_convert.gemspec

@@ -14,6 +14,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/coaxial/ynab_convert'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '~> 2.6'
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/coaxial/ynab_convert/issues',
+    'documentation_uri' => 'https://rubydoc.info/github/coaxial/ynab_convert/master',
+    'homepage_uri' => 'https://github.com/coaxial/ynab_convert',
+    'source_code_uri' => 'https://github.com/coaxial/ynab_convert'
+  }
+  spec.post_install_message = 'Happy budgetting!'
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab_convert
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - coaxial
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-23 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
@@ -235,18 +236,20 @@ homepage: https://github.com/coaxial/ynab_convert
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/coaxial/ynab_convert/issues
+  documentation_uri: https://rubydoc.info/github/coaxial/ynab_convert/master
   homepage_uri: https://github.com/coaxial/ynab_convert
   source_code_uri: https://github.com/coaxial/ynab_convert
-post_install_message: 
+  allowed_push_host: https://rubygems.org
+post_install_message: Happy budgetting!
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="