ynab_convert 0.1.0.pre

data/lib/ynab_convert.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'ynab_convert/version'
+require 'slop'
+require 'pry'
+require 'ynab_convert/logger'
+require 'core_extensions/string.rb'
+
+# The application
+module YnabConvert
+  # Metadata about the gem
+  class Metadata
+    def  short_desc
+      puts 'An utility to convert online banking CSV files to a format that ' \
+'can be imported into YNAB 4.'
+    end
+
+    def version
+      puts "YNAB Convert #{YnabConvert::VERSION}"
+    end
+  end
+
+  # Operations on the CSV file to convert
+  class File
+    include YnabLogger
+
+    # @option opts [String] :file The filename or path to the file
+    # @option opts [Processor] :processor The class to use for converting the
+    # CSV file
+    def initialize(opts)
+      logger.debug opts.to_h
+      @file = opts[:file]
+
+      begin
+        @processor = opts[:processor].new(
+          file: @file
+        )
+      rescue Errno::ENOENT
+        handle_file_not_found
+      end
+    end
+
+    # Converts @file to YNAB4 format and writes it to disk
+    # @return [String] The path to the YNAB4 formatted CSV file created
+    def to_ynab!
+      logger.debug "Processing `#{@file}' through `#{@processor.class.name}'"
+      @processor.to_ynab!
+    end
+
+    private
+
+    def file_not_found_message
+      raise Errno::ENOENT, "File `#{@file}' not found or not accessible."
+    end
+  end
+
+  # The command line interface methods
+  class CLI
+    include YnabLogger
+    include CoreExtensions::String::Inflections
+
+    def initialize
+      @metadata = Metadata.new
+      @options = parse_argv
+      return unless no_options_given
+
+      show_usage
+      exit
+    end
+
+    def start
+      @file = File.new opts
+      logger.debug "Using processor `#{@options[:institution]}' => #{processor}"
+      @file.to_ynab!
+    end
+
+    private
+
+    def opts
+      { file: @options[:file], processor: processor }
+    rescue NameError => e
+      raise e unless e.message.match(/#{processor_class_name}/)
+
+      logger.debug "#{@options.to_h}, #{processor_class_name}"
+      show_unknown_institution_message
+      exit false
+    end
+
+    def parse_argv
+      Slop.parse do |o|
+        o.on '-v', '--version', 'print the version' do
+          puts @metadata.version
+          exit
+        end
+        o.string '-i', '--institution', 'name of the financial institution '\
+ 'that generated the file to convert'
+        o.string '-f', '--file', 'path to the csv file to convert'
+      end
+    end
+
+    def processor_class_name
+      "Processor::#{@options[:institution].camel_case}"
+    end
+
+    def processor
+      processor_class_name.split('::').inject(Object) { |o, c| o.const_get c }
+    end
+
+    def no_options_given
+      @options[:institution].nil? || @options[:file].nil?
+    end
+
+    def show_usage
+      puts @metadata.short_desc
+      puts @options
+    end
+
+    def show_unknown_institution_message
+      warn 'Could not find any processor for the institution '\
+        "`#{@options[:institution]}'. If it's not a typo, consider "\
+        'contributing a new processor (see https://github.com/coaxial/'\
+        'ynab_convert#contributing to get started).'
+    end
+  end
+end

data/ynab_convert.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ynab_convert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ynab_convert'
+  spec.version       = YnabConvert::VERSION
+  spec.authors       = ['coaxial']
+  spec.email         = ['hi@64b.it']
+
+  spec.summary       = 'Convert online banking CSV files to YNAB 4 format.'
+  spec.homepage      = 'https://github.com/coaxial/ynab_convert'
+  spec.license       = 'MIT'
+
+  # 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)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/coaxial/ynab_convert'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-core'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'solargraph'
+
+  spec.add_dependency 'i18n'
+  spec.add_dependency 'slop'
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: ynab_convert
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- coaxial
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-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: guard-rubocop
+  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: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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: rubocop
+  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: rubocop-rake
+  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
+    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: solargraph
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  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: 
+email:
+- hi@64b.it
+executables:
+- console
+- setup
+- ynab_convert
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".solargraph.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/ynab_convert
+- lib/core_extensions/string.rb
+- lib/slop/symbol.rb
+- lib/ynab_convert.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/revolut.rb
+- lib/ynab_convert/processor/ubs_chequing.rb
+- lib/ynab_convert/processor/ubs_credit.rb
+- lib/ynab_convert/processors.rb
+- lib/ynab_convert/version.rb
+- ynab_convert.gemspec
+homepage: https://github.com/coaxial/ynab_convert
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/coaxial/ynab_convert
+  source_code_uri: https://github.com/coaxial/ynab_convert
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Convert online banking CSV files to YNAB 4 format.
+test_files: []