amex_csv_to_ledger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 293cf23b091e043c0dfbb7a2e1ac82fcc5a42030d41a97124f4e3c469f205d38
+  data.tar.gz: 68f8bcbc78d056cb1209065b432b97e9697b60e9f112e463334f944a2f985df2
+SHA512:
+  metadata.gz: f3a3991de3df88999aff7116d0d96a162fbb31bd9662c04abfba393208ed079e90e08f55247dd74dff6404f0bba25d8e3d531eb95b232cf40e34799716df276c
+  data.tar.gz: 5da02d8e0152f2a08fd0fe79b86dc97353ce35a375a789e0b777866ef31d076e9b163a6bb014098c6be949b2a2fa8f990806997bc10211da52a852e389b962bc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'pry-byebug', '~> 3.10'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-minitest', '~> 0.21'
+gem 'rubocop-rake', '~> 0.6'

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    amex_csv_to_ledger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    json (2.6.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.35.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.21.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  amex_csv_to_ledger!
+  minitest (~> 5.0)
+  pry-byebug (~> 3.10)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest (~> 0.21)
+  rubocop-rake (~> 0.6)
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,54 @@
+# AMEX CSV to Ledger
+
+Configurable Ruby gem to convert American Express CSV statements to Ledger 3
+format.
+
+## Dependencies
+
+Requires Ruby 2.6 or above.
+
+## Installation
+
+It's easiest to install it as a Ruby gem:
+
+    $ gem install amex_csv_to_ledger
+
+## Usage
+
+Run the executable that ships with the gem and pass in the path to an AMEX CSV.
+
+    $ amex_csv_to_ledger statement.csv
+
+The output will be the converted statement.
+
+## Configuration
+
+It's possible to configure various things in the output of this script, such as
+the currency, what category names to use, tabs vs. spaces, etc.
+
+There's a template that is populated with the default values in the doc folder.
+Copy it to your home config directory to use it.
+
+    mkdir ~/.config/amex_csv_to_ledger
+    cp doc/config.yml.example ~/.config/amex_csv_to_ledger/config.yml
+
+Then edit it to your liking, it's a normal YAML file.
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run
+`rake test` to run the tests.
+
+Bear in mind when running tests that the tests will pick up the config in your
+home directory. Remove it if you are getting failures.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome. Send via email to the author, the
+address is in git.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/doc/config.yml.example

@@ -0,0 +1,6 @@
+date_format: '%Y-%m-%d'
+use_tabs: false
+indent_size: 4
+currency_prefixed: false
+currency: 'GBP'
+amex_category: 'liabilities:creditcard:amex'

data/lib/amex_csv_to_ledger/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module AmexCsvToLedger
+  # Class to load and parse the config file.
+  class Config
+    DEFAULT_PATH = '~/.config/amex_csv_to_ledger/config.yml'
+
+    def initialize(path = DEFAULT_PATH)
+      @config = YAML.load_file(File.expand_path(path))
+    rescue StandardError
+      @config = {}
+    end
+
+    def date_format
+      @config.fetch('date_format', '%Y-%m-%d')
+    end
+
+    def use_tabs?
+      @config.fetch('use_tabs', false)
+    end
+
+    def indent_size
+      @config.fetch('indent_size', 4)
+    end
+
+    def expense_placeholder
+      @config.fetch('expense_placeholder', 'expenses:placeholder')
+    end
+
+    def currency_prefixed?
+      @config.fetch('currency_prefixed', false)
+    end
+
+    def currency
+      @config.fetch('currency', 'GBP')
+    end
+
+    def amex_category
+      @config.fetch('amex_category', 'liabilities:creditcard:amex')
+    end
+  end
+end

data/lib/amex_csv_to_ledger/ledger_date_line.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module AmexCsvToLedger
+  # Class to format ledger date lines with a description.
+  class LedgerDateLine
+    AMEX_DATE_FORMAT = '%Y/%m/%d'
+
+    attr_reader :description
+
+    def initialize(date:, description:)
+      @date = date
+      @description = description
+    end
+
+    def output
+      "#{date} #{description}"
+    end
+
+    private
+
+    def date
+      parsed_date.strftime(date_format)
+    end
+
+    def parsed_date
+      Date.parse(@date, AMEX_DATE_FORMAT)
+    end
+
+    def date_format
+      AmexCsvToLedger.config.date_format
+    end
+  end
+end

data/lib/amex_csv_to_ledger/ledger_expense_line.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module AmexCsvToLedger
+  # Class to format ledger expense lines with a currency amount.
+  class LedgerExpenseLine
+    DEFAULT_SPACING = 62 # spacing used by LedgerAlignBuffer
+    TAB_LENGTH = 8
+
+    attr_reader :amount
+
+    def initialize(amount:)
+      @amount = amount
+    end
+
+    def output
+      "#{indent}#{placeholder}#{spaces}#{formatted_amount}"
+    end
+
+    private
+
+    def indent
+      if use_tabs?
+        "\t"
+      else
+        ' ' * indent_size
+      end
+    end
+
+    def placeholder
+      AmexCsvToLedger.config.expense_placeholder
+    end
+
+    def spaces
+      ' ' * spacing
+    end
+
+    def spacing
+      len = DEFAULT_SPACING - indent_size - placeholder.length - amount.length
+
+      if currency_prefixed?
+        len - currency.length
+      else
+        len
+      end
+    end
+
+    def currency
+      AmexCsvToLedger.config.currency
+    end
+
+    def use_tabs?
+      AmexCsvToLedger.config.use_tabs?
+    end
+
+    def indent_size
+      if use_tabs?
+        TAB_LENGTH
+      else
+        AmexCsvToLedger.config.indent_size
+      end
+    end
+
+    def currency_prefixed?
+      AmexCsvToLedger.config.currency_prefixed?
+    end
+
+    def formatted_amount
+      if currency_prefixed?
+        "#{currency}#{amount}"
+      else
+        "#{amount} #{currency}"
+      end
+    end
+  end
+end

data/lib/amex_csv_to_ledger/ledger_outgoing_line.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AmexCsvToLedger
+  # Class to format ledger outgoing lines.
+  class LedgerOutgoingLine
+    TAB_LENGTH = 8
+
+    def output
+      "#{indent}#{outgoing_account}"
+    end
+
+    private
+
+    def indent
+      if use_tabs?
+        "\t"
+      else
+        ' ' * indent_size
+      end
+    end
+
+    def outgoing_account
+      AmexCsvToLedger.config.amex_category
+    end
+
+    def use_tabs?
+      AmexCsvToLedger.config.use_tabs?
+    end
+
+    def indent_size
+      AmexCsvToLedger.config.indent_size
+    end
+  end
+end

data/lib/amex_csv_to_ledger/ledger_report.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AmexCsvToLedger
+  # A class to glue together all the ledger lines to create a full report.
+  class LedgerReport
+    attr_reader :statement
+
+    def initialize(statement)
+      @statement = statement
+    end
+
+    def lines
+      statement.lines.map do |line|
+        [
+          date_line(line),
+          expense_line(line),
+          outgoing_line
+        ].join("\n")
+      end
+    end
+
+    private
+
+    def date_line(line)
+      LedgerDateLine.new(
+        date: line.date,
+        description: line.description
+      ).output
+    end
+
+    def expense_line(line)
+      LedgerExpenseLine.new(amount: line.amount).output
+    end
+
+    def outgoing_line
+      LedgerOutgoingLine.new.output
+    end
+  end
+end

data/lib/amex_csv_to_ledger/statement.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module AmexCsvToLedger
+  # Class to hold the data found in an AMEX statement.
+  class Statement
+    attr_reader :csv
+
+    def initialize(csv)
+      @csv = csv
+    end
+
+    def lines
+      @lines ||= CSV.parse(csv, headers: true).map do |row|
+        StatementLine.new(
+          amount: row['Amount'],
+          date: row['Date'],
+          description: row['Description']
+        )
+      end
+    end
+  end
+end

data/lib/amex_csv_to_ledger/statement_line.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AmexCsvToLedger
+  # Class to hold the data found in a line of an AMEX statement.
+  class StatementLine
+    attr_reader :amount, :date, :description
+
+    def initialize(amount:, date:, description:)
+      @amount = amount
+      @date   = date
+      @description = description
+    end
+  end
+end

data/lib/amex_csv_to_ledger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AmexCsvToLedger
+  VERSION = '0.1.0'
+end

data/lib/amex_csv_to_ledger.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'amex_csv_to_ledger/version'
+require_relative 'amex_csv_to_ledger/config'
+require_relative 'amex_csv_to_ledger/ledger_date_line'
+require_relative 'amex_csv_to_ledger/ledger_expense_line'
+require_relative 'amex_csv_to_ledger/ledger_outgoing_line'
+require_relative 'amex_csv_to_ledger/ledger_report'
+require_relative 'amex_csv_to_ledger/statement'
+require_relative 'amex_csv_to_ledger/statement_line'
+
+# Top level class for the converter which glues together all of the code.
+module AmexCsvToLedger
+  def self.convert(csv_path)
+    csv = File.open(csv_path)
+    statement = Statement.new(csv)
+    puts LedgerReport.new(statement).lines.join("\n\n")
+  end
+
+  def self.config
+    Config.new
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: amex_csv_to_ledger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- baak6
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-22 00:00:00.000000000 Z
+dependencies: []
+description: Command line utility to convert AMEX CSV to Ledger.
+email:
+- baak6@baak6.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- doc/config.yml.example
+- lib/amex_csv_to_ledger.rb
+- lib/amex_csv_to_ledger/config.rb
+- lib/amex_csv_to_ledger/ledger_date_line.rb
+- lib/amex_csv_to_ledger/ledger_expense_line.rb
+- lib/amex_csv_to_ledger/ledger_outgoing_line.rb
+- lib/amex_csv_to_ledger/ledger_report.rb
+- lib/amex_csv_to_ledger/statement.rb
+- lib/amex_csv_to_ledger/statement_line.rb
+- lib/amex_csv_to_ledger/version.rb
+- tmp/.gitkeep
+homepage: https://git.baak6.com/amex_csv_to_ledger.git/
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://git.baak6.com/amex_csv_to_ledger.git/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: AMEX CSV to Ledger.
+test_files: []