ynab_convert 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08086730d5b1a483d48378a5f2a10937accd45b695a4b2f07c94dd0c19e27daf'
+  data.tar.gz: 9586296b18ee416fd083b9477d58570da2559d1d3b68b3385ce0bd0bb1f6ded2
+SHA512:
+  metadata.gz: 0c0579fda3f49407a92345875fcbb95bb30cd65d4ffe0e59dd1bddecc6e5ee72aeafe592ef566cd756d4a6307b417e85dd85dd9df68a0375c5b410e08a1ed614
+  data.tar.gz: 5dc8cfa674d17766f7dec08e1b8652f5aa891158355062c5ac75bd33a21bc1ac980401cd5c8eb49fa077081295cc9079de87c8c6cbfbde91a1dc3af66d896bf9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+---
+require: rubocop-rake
+
+Metrics/LineLength:
+  Exclude:
+    - ynab_convert.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - Guardfile
+    - ynab_convert.gemspec
+    - 'spec/**/*_spec.rb'
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+ynab_convert

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 5000

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+before_install: gem install bundler
+script: echo "Running tests for $(ruby -v)..." && bundle exec rake ci
+
+jobs:
+  include:
+    - 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

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ynab_convert.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,135 @@
+PATH
+  remote: .
+  specs:
+    ynab_convert (0.1.0.pre)
+      i18n
+      slop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    backport (1.1.2)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    ffi (1.11.2)
+    formatador (0.2.5)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    htmlentities (4.3.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.2.0)
+    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)
+    nenv (0.3.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    reverse_markdown (1.3.0)
+      nokogiri
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rake (0.5.0)
+      rubocop
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (4.8.2)
+    solargraph (0.37.2)
+      backport (~> 1.1)
+      bundler (>= 1.17.2)
+      htmlentities (~> 4.3, >= 4.3.4)
+      jaro_winkler (~> 1.5)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (~> 1.0, >= 1.0.5)
+      rubocop (~> 0.52)
+      thor (~> 0.19, >= 0.19.4)
+      tilt (~> 2.0)
+      yard (~> 0.9)
+    thor (0.20.3)
+    tilt (2.0.10)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  guard-rspec
+  guard-rubocop
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-core
+  rubocop
+  rubocop-rake
+  simplecov
+  solargraph
+  ynab_convert!
+
+BUNDLED WITH
+   2.2.11

data/Guardfile

@@ -0,0 +1,84 @@
+# vi: set ft=ruby
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+group :red_green_refactor, halt_on_fail: true do
+  # Can't use the rake task here because guard appends rspec options to the
+  # command that aren't compatible with rake
+  guard :rspec, cmd: 'YNAB_CONVERT_ENV=test bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+
+    # Rails files
+    rails = dsl.rails(view_extensions: %w[erb haml slim])
+    dsl.watch_spec_files_for(rails.app_files)
+    dsl.watch_spec_files_for(rails.views)
+
+    watch(rails.controllers) do |m|
+      [
+        rspec.spec.call("routing/#{m[1]}_routing"),
+        rspec.spec.call("controllers/#{m[1]}_controller"),
+        rspec.spec.call("acceptance/#{m[1]}")
+      ]
+    end
+
+    # Rails config changes
+    watch(rails.spec_helper)     { rspec.spec_dir }
+    watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+    watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+    # Capybara features specs
+    watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+    watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+    # Turnip features and steps
+    watch(%r{^spec/acceptance/(.+)\.feature$})
+    watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+    end
+  end
+
+  guard :rubocop, cli: ['--auto-correct'] do
+    watch('Gemfile')
+    watch('Rakefile')
+    watch('bin/convert')
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 coaxial
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# YnabConvert
+
+Convert CSV files from online banking to a [format YNAB 4 can consume](https://docs.youneedabudget.com/article/921-formatting-csv-file).
+
+## Installation
+
+    $ gem install ynab_convert
+
+## Usage
+
+```shell
+$ ynab_convert -f my_transactions.csv -i example
+```
+
+This will process the file `my_transactions.csv` downloaded from Example Bank's
+online banking platform, using the `example` processor (see list of available
+processors below.)
+
+It will then output the converted file as
+`my_transactions_example_bank_20191101-2019-1201_ynab4.csv`. The dates in the
+filename match the interval of the transactions found in the original CSV file.
+In that case, the earliest transaction recorded happened on 2019-11-01 and the
+latest one on 2019-12-01.
+
+## Available processors
+
+`-i` argument | Institution's full name | Institution's website | Remarks
+---|---|---|---
+`example` | Example Bank | N/A | Reference processor implementation, not a real institution
+`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
+
+## Contributing
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Bug reports and pull requests are welcome on GitHub at
+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.
+
+### Adding a new financial institution
+
+If there is no processor for your financial institution, you can contribute one
+to the project.
+
+There is a commented example processor located at
+`lib/ynab_convert/processor/example.rb`. Looking at the other, real-world
+processors in that directory can also help.
+
+Be sure to add tests to your processor as well before you make a PR.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+(c) coaxial 2019

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run all specs'
+task :spec do
+  ENV['YNAB_CONVERT_ENV'] = 'test'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir.glob('spec/**/*_spec.rb')
+    t.rspec_opts = '--format documentation'
+  end
+end
+
+desc 'Run all tests (synonym for spec)'
+task :test do
+  Rake::Task[:spec].invoke
+end
+
+namespace 'spec' do
+  desc 'Enable debug logging'
+  task :debug do
+    ENV['YNAB_CONVERT_DEBUG'] = 'true'
+
+    Rake::Task[:spec].invoke
+  end
+end
+
+desc 'Check code format'
+RuboCop::RakeTask.new
+
+desc 'Run tests and check code format'
+task :ci do
+  Rake::Task[:spec].invoke
+  Rake::Task[:rubocop].invoke
+end
+
+task default: :ci

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ynab_convert'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/ynab_convert

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# vi: ft=ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ynab_convert'
+require 'core_extensions/string'
+require 'ynab_convert/processors'
+require 'ynab_convert/logger'
+require 'ynab_convert/error'
+require 'slop/symbol'
+require 'pry'
+
+# Add mixins and run converter
+class Convert
+  String.include CoreExtensions::String::Inflections
+  YnabConvert.include YnabLogger
+
+  def initialize
+    @yc = YnabConvert::CLI.new
+  end
+
+  def start
+    @yc.start
+  end
+end
+
+yc = Convert.new
+yc.start

data/lib/core_extensions/string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Mimics the module by the same name from Rails, to add convenience methods
+module CoreExtensions
+  module String
+    # Adds convenience methods
+    module Inflections
+      def snake_case
+        downcase.tr(' ', '_').gsub(/[^a-z_]/, '')
+      end
+
+      def camel_case
+        split('_').collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/slop/symbol.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Slop
+  # Add an option to convert a string to a symbol
+  class SymbolOption < Option
+    def call(value)
+      return value.to_sym unless value.empty?
+
+      value
+    end
+  end
+end

data/lib/ynab_convert/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module YnabConvert
+  class Error < StandardError
+  end
+end

data/lib/ynab_convert/logger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Add logging to classes
+module YnabLogger
+  def logger
+    @logger unless @logger.nil?
+    @logger ||= Logger.new(STDERR)
+    @logger.level = Logger::FATAL
+    @logger.level = Logger::DEBUG if ENV['YNAB_CONVERT_DEBUG'] == 'true'
+    @logger
+  end
+end