ynab_convert 1.0.8 → 2.0.3

data/lib/ynab_convert/transformers/formatters/example_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # Example Formatter
+    class Example < Formatter
+      def initialize
+        super({ date: [0], payee: [2], outflow: [3], inflow: [4] })
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/formatter.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # Formats Statements rows into YNAB4 rows (Date, Payee, Memo, Amount or
+    # Outflow and Inflow.)
+    class Formatter
+      # @param [Hash] headers_indices the indices at which to find each
+      #   header's name
+      # @option  headers_indices [Array<Numeric>] :date transaction date
+      # @option  headers_indices [Array<Numeric>] :payee transaction
+      #   payee/description
+      # @option  headers_indices [Array<Numeric>] :memo transaction memo or
+      #   currency if currency conversion will be performed
+      # @option  headers_indices [Array<Numeric>] :amount transaction amount (if
+      #   Statement is using the :amounts format)
+      # @option  headers_indices [Array<Numeric>] :outflow transaction outflow
+      #   (if using the :flows format)
+      # @option  headers_indices [Array<Numeric>] :inflow transaction inflow (if
+      #   using the :flows format)
+      def initialize(**headers_indices)
+        default_values = {
+          memo: [] # The Memo field tends to be empty for most institutions
+        }
+
+        @format = :flows
+        unless headers_indices[:amount].nil? || headers_indices[:amount].empty?
+          @format = :amounts
+        end
+        @headers_indices = default_values.merge(headers_indices)
+      end
+
+      # Turns CSV rows into YNAB4 rows (Date, Payee, Memo, Amount or Outflow and
+      # Inflow)
+      # @param row [CSV::Row] The CSV row to parse
+      # @return [Array<String>] The YNAB4 formatted row
+      def run(row)
+        ynab_row = [date(row), payee(row), memo(row)]
+
+        if @format == :amounts
+          ynab_row << amount(row)
+        else
+          ynab_row << outflow(row)
+          ynab_row << inflow(row)
+        end
+
+        ynab_row
+      end
+
+      # Processes columns for each row. Based on the method name that is called,
+      # it will extract the corresponding column (field).
+      # @note In more complex cases, some heuristics are required to format some
+      #   of the columns. In that case, any of the aliased #field methods
+      #   (#date, #payee, #memo, #amount, #outflow, #inflow) can be
+      #   overridden in the child.
+      # @param row [CSV::Row] The row to process
+      # @return [String] The corresponding field(s)
+      def field(row)
+        # Figure out the aliased name the method was called with, to derive
+        # which field to return from the row.
+        requested_field = __callee__.to_sym
+        assembled_field = @headers_indices[requested_field].reduce([]) do
+          |fields_data, i|
+          fields_data << row[i]
+        end
+
+        # Avoid turning Dates and Numerics back to strings
+        # If the assembled_field isn't a composite from several Statement
+        # fields, there is no need to join(' ') and turn it into a String
+        formatted_field = assembled_field[0]
+        if assembled_field.length > 1
+          formatted_field = assembled_field.join(' ')
+        end
+
+        # Avoid "nil" values in the output
+        return '' if formatted_field.nil?
+
+        formatted_field
+      end
+
+      # Create alias names for the field method. This allows the function to
+      # figure out which field to extract from its method name.
+      alias date field
+      alias payee field
+      alias memo field
+      alias amount field
+      alias outflow field
+      alias inflow field
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/n26_formatter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ynab_convert/transformers'
+
+module Transformers
+  module Formatters
+    # Formats N26 statement values to YNAB4 value
+    class N26 < Formatter
+      def initialize
+        super({ date: [0], payee: [1], amount: [5] })
+      end
+
+      # All amounts are always in EUR
+      def memo(_row)
+        'EUR'
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/ubs_chequing_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # UBS Switzerland Chequing accounts formatter
+    class UBSChequing < Formatter
+      def initialize
+        super({ date: [9], payee: [12], outflow: [18], inflow: [19] })
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/ubs_credit_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # UBS Switzerland Credit Card accounts formatter
+    class UBSCredit < Formatter
+      def initialize
+        super({ date: [3], payee: [4], outflow: [10], inflow: [11] })
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/wise_formatter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # Wise card accounts formatter
+    class Wise < Formatter
+      def initialize
+        super({ date: [1], payee: [13], amount: [2] })
+      end
+
+      def payee(row)
+        merchant = row[13]
+        description = row[4]
+
+        return description if merchant.nil?
+
+        merchant
+      end
+
+      def memo(row)
+        # Description goes in Memo because we'll need to extract the original
+        # amount from it in the enhancer.
+        description = row[4]
+        amount_currency = row[3]
+        original_amount = description.scan(/\d+\.\d{2}\s\w{3}/).first
+
+        memo = amount_currency
+        # Topups don't have an original amount
+        memo = "#{memo},#{original_amount}" unless original_amount.nil?
+
+        memo
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Regroups all the classes involved in transforming a given Statement into a
+# YNAB4File
+module Transformers
+  transformers = %w[cleaner enhancer formatter]
+
+  # Load all known Transformers
+  transformers.each do |t|
+    # Require the base classes first so that its children can find the parent
+    # class since files are otherwise loaded in alphabetical order
+    require File.join(__dir__, 'transformers', "#{t}s", "#{t}.rb")
+
+    Dir[File.join(__dir__, 'transformers', "#{t}s", '*.rb')].sort.each do |file|
+      require file
+    end
+  end
+end

data/lib/ynab_convert/validators/ynab4_row_validator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Validators
+  # Checks YNAB4 row for validity. A row is valid if it has a Date, Payee, and
+  # one of Amount, Outflow, Inflow.
+  module YNAB4Row
+    # Validates a row
+    # @param row [Array<String, Numeric, Date>] The row to validate
+    # @return [Boolean] Whether the row is valid
+    def self.valid?(row)
+      # we are dealing with a YNAB4 row:
+      # %w[Date Payee Memo Amount|Outflow Inflow]
+      amount_valid?(row) &&
+        transaction_date_valid?(row) &&
+        payee_valid?(row)
+    end
+
+    # Indicates which format the row is in (:flows or :amounts)
+    # @param row [CSV::Row] the row to check
+    # @return [:flows, :amounts] the row's format
+    def self.row_format(row)
+      format = :flows
+      # :flows has 5 columns: Date, Payee, Memo, Outflow, Inflow
+      # :amounts has 4 columns: Date, Payee, Memo, Amount
+      format = :amounts if row.length == 4
+
+      format
+    end
+
+    # Indicates whether the amount on the row is valid
+    # @param row [CSV::Row] the row to check
+    # @return [Boolean] whether the amount is invalid
+    def self.amount_valid?(row)
+      format = row_format(row)
+      indices = [3]
+      indices << 4 if format == :flows
+
+      if format == :amounts
+        return indices.reduce(true) do |valid, i|
+          valid && value_valid?(row[i])
+        end
+      end
+
+      indices.reduce(false) do |valid, i|
+        valid || value_valid?(row[i])
+      end
+    end
+
+    # Indicates whether a value is valid
+    # @note Prefer using the #valid? method
+    # @param value [#zero?, #nil?, #to_s] the value to check
+    # @return [Boolean] whether the value is valid
+    def self.value_valid?(value)
+      if value.respond_to? :zero?
+        !value.zero?
+      else
+        !value.nil? && !value.to_s.empty?
+      end
+    end
+
+    # Validates the Date value
+    # @note Prefer using the #valid? method
+    # @param row [Array<String, Numeric, Date] The row to validate
+    # @return [Boolean] Whether the row's Date is invalid
+    def self.transaction_date_valid?(row)
+      date_index = 0
+      date = row[date_index]
+
+      value_valid?(date)
+    end
+
+    # Validates the Payee value
+    # @note Prefer using the #valid? method
+    # @param row [Array<String, Numeric, Date] The row to validate
+    # @return [Boolean] Whether the row's Payee is valid
+    def self.payee_valid?(row)
+      payee_index = 1
+      payee = row[payee_index]
+
+      value_valid?(payee)
+    end
+  end
+end

data/lib/ynab_convert/validators.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Regroups all the row validators
+module Validators
+  # Load all known Validators
+  Dir[File.join(__dir__, 'validators', '*.rb')].sort.each do |file|
+    require file
+  end
+end

data/lib/ynab_convert/version.rb

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

data/lib/ynab_convert.rb

@@ -3,7 +3,11 @@
 require 'ynab_convert/version'
 require 'slop'
 require 'ynab_convert/logger'
-require 'core_extensions/string.rb'
+require 'core_extensions/string'
+require 'byebug' if ENV['YNAB_CONVERT_DEBUG']
+
+# FIXME: The architecture in here is not the greatest... It should be
+#   redesigned entirely.
 
 # The application
 module YnabConvert
@@ -32,7 +36,7 @@ module YnabConvert
 
       begin
         @processor = opts[:processor].new(
-          file: @file
+          filepath: @file
         )
       rescue Errno::ENOENT
         handle_file_not_found
@@ -98,7 +102,22 @@ module YnabConvert
     end
 
     def processor_class_name
-      "Processor::#{@options[:institution].camel_case}"
+      # Processor class names don't always match camelcasing the `-i` argument
+      # from the command line. For those classes that don't, a lookup is
+      # performed to find the proper class name.
+      institution = @options[:institution].to_sym
+      institution_to_classname = {
+        ubs_chequing: 'UBSChequing',
+        ubs_credit: 'UBSCredit'
+      }
+
+      classname = institution_to_classname.fetch(institution) do |el|
+        # If the class name is "regular", it will be found by camelcasing the
+        # name passed as the `-i` argument from the command line.
+        el.to_s.camel_case
+      end
+
+      "Processors::#{classname}"
     end
 
     def processor

data/ynab_convert.gemspec

@@ -59,9 +59,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-core'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'solargraph'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 
   spec.add_dependency 'i18n'
   spec.add_dependency 'slop'
+  spec.add_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab_convert
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.3
 platform: ruby
 authors:
 - coaxial
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Utility to convert CSV statements into the YNAB4 format for easier
   transation import. Supports several banks and can easily be extended to
@@ -205,13 +261,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".solargraph.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -224,15 +281,42 @@ files:
 - lib/core_extensions/string.rb
 - lib/slop/symbol.rb
 - lib/ynab_convert.rb
+- lib/ynab_convert/api_clients/api_client.rb
+- lib/ynab_convert/api_clients/currency_api.rb
+- lib/ynab_convert/documents.rb
+- lib/ynab_convert/documents/statements/example_statement.rb
+- lib/ynab_convert/documents/statements/n26_statement.rb
+- lib/ynab_convert/documents/statements/statement.rb
+- lib/ynab_convert/documents/statements/ubs_chequing_statement.rb
+- lib/ynab_convert/documents/statements/ubs_credit_statement.rb
+- lib/ynab_convert/documents/statements/wise_statement.rb
+- lib/ynab_convert/documents/ynab4_files/ynab4_file.rb
 - lib/ynab_convert/error.rb
 - 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
 - lib/ynab_convert/processors.rb
+- lib/ynab_convert/processors/example_processor.rb
+- lib/ynab_convert/processors/n26_processor.rb
+- lib/ynab_convert/processors/processor.rb
+- lib/ynab_convert/processors/ubs_chequing_processor.rb
+- lib/ynab_convert/processors/ubs_credit_processor.rb
+- lib/ynab_convert/processors/wise_processor.rb
+- lib/ynab_convert/transformers.rb
+- lib/ynab_convert/transformers/cleaners/cleaner.rb
+- lib/ynab_convert/transformers/cleaners/n26_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/ubs_chequing_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/ubs_credit_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/wise_cleaner.rb
+- lib/ynab_convert/transformers/enhancers/enhancer.rb
+- lib/ynab_convert/transformers/enhancers/n26_enhancer.rb
+- lib/ynab_convert/transformers/enhancers/wise_enhancer.rb
+- lib/ynab_convert/transformers/formatters/example_formatter.rb
+- lib/ynab_convert/transformers/formatters/formatter.rb
+- lib/ynab_convert/transformers/formatters/n26_formatter.rb
+- lib/ynab_convert/transformers/formatters/ubs_chequing_formatter.rb
+- lib/ynab_convert/transformers/formatters/ubs_credit_formatter.rb
+- lib/ynab_convert/transformers/formatters/wise_formatter.rb
+- lib/ynab_convert/validators.rb
+- lib/ynab_convert/validators/ynab4_row_validator.rb
 - lib/ynab_convert/version.rb
 - ynab_convert.gemspec
 homepage: https://github.com/coaxial/ynab_convert
@@ -259,7 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Convert online banking CSV files to YNAB 4 format.

data/.travis.yml

@@ -1,20 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-  - 2.7
-before_install: gem install bundler
-
-jobs:
-  include:
-    - stage: test
-      script: echo "Running tests for $(ruby -v)..." && bundle exec rake ci
-    - stage: gem release
-      rvm: 2.6
-      script: echo "Publishing to rubygems.org..."
-      deploy:
-        provider: rubygems
-        gem: ynab_convert
-        api_key: $RUBYGEMS_API_KEY
-        on: master