total_recall 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 162939627043b1aea142c3c8a6dedc9c0557801a
-  data.tar.gz: fd307f5b53406336a46225d36b9138d11d228bfd
+  metadata.gz: 4f485de3326ba5aa633added9df0493ab450c74d
+  data.tar.gz: 592cba4e119cf53c307c9734b6d518bb96b90ac5
 SHA512:
-  metadata.gz: a78dcb6fa9e0d5d533dcc8bef4d34769ced4f8809c8f074158c4a3c3de2cd45a53cacd2364d0e0b941330cc7fccf35c8f443106eada6f6dfa7c2b48cc555db3f
-  data.tar.gz: 1ac9db0b80f7c7e08be72ccadb399d1eb209b56bbfa40bafcc0fa3c7037c691e3e329c6a9e4147bcda57b6893058a8b2f8a1b10459ebb31ca7fb428ec701a80f
+  metadata.gz: f4e8ef75a9d06eef5b482edd546535d85472ae299bb004216d44b75a4d072e0eabfc9e430203f273bc86ffefdf5eb2f28cd06433da2ae2f30887d63c9439bd63
+  data.tar.gz: 38ee00655b8c99b10855fb7bfca8d4c8625886e5e0cb218f47241797b9aa19560da19e45b48936ca09ca6aff607a9150e0eda1b3a701fdfd91de8b9735d76f83

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# 0.5.0 / unreleased
+
+* extend the ledger subcommand by passing it a file with customizations
+
+  ```
+  $ cat my_extension.rb
+  module MyExtension
+    def ask_account(*args)
+      # some custom stuff
+      super
+    end
+  end
+  TotalRecall::SessionHelper.include MyExtension
+
+  $ total_recall ledger -c sample.yml -r ./my_extension.rb
+  ```
+
+* add version subcommand
+
+* add default-helper
+
+  Let's you point to the default-value of an attribute:
+
+  ```yaml
+  :context:
+    :transactions:
+      :__defaults__:
+        :a: 1
+      :a: !!proc |
+        ask("What value has a?", default: default)
+  ```
+
+* add transaction-helper
+
+  This allows you to use already set attributes of the transaction:
+
+  ```yaml
+  :context:
+    :transactions:
+      :a: 1
+      :b: !!proc |
+        transaction.a.succ
+  ```
+
+# 0.4.0 / 2014-06-04
+
+* Add yaml-config.
+

data/README.md

@@ -2,13 +2,19 @@
 
 Turn **any** csv-file into a [Ledger](http://ledger-cli.org/) journal.
 
+## Install
+
+```bash
+gem install total_recall
+```
+
 ## Quickstart
 
 ### Generate a sample config
 
 ```bash
 total_recall sample
-# An annotated config 'sample.yml' will be written to CWD.
+# An annotated config 'sample.yml' will be written the current directory.
 ```
 
 ### Generate a ledger
@@ -58,10 +64,11 @@ May I suggest:
 total_recall
 
 # Commands:
-#  total_recall help [COMMAND]              # Describe available commands or one specific command
-#  total_recall init NAME                   # Generate a minimal config NAME.yml
-#  total_recall ledger -c, --config=CONFIG  # Convert the config to a ledger
-#  total_recall sample                      # Generate an annotated config
+#   total_recall help [COMMAND]              # Describe available commands or one specific command
+#   total_recall init NAME                   # Generate a minimal config NAME.yml
+#   total_recall ledger -c, --config=CONFIG  # Convert CONFIG to a ledger
+#   total_recall sample                      # Generate an annotated config
+#   total_recall version                     # Show total_recall version
 
 # typically you would do:
 total_recall init my-bank
@@ -78,6 +85,35 @@ total_recall ledger -c my-bank.yml > my-bank.dat
 ledger -f my-bank.dat bal
 ```
 
+## Extensibility
+
+You can extend the ledger subcommand by passing a file with additions to it:
+
+```
+total_recall ledger -c my-bank.yml -r ./my_extension.rb
+```
+
+This makes it possible to add helpers or redefine existing ones:
+
+```
+cat my_extension.rb
+module MyExtension
+  # adding some options to an existing helper:
+  def ask_account(question, options = {})
+    question.upcase! if options.delete(:scream)
+    super
+  end
+
+  # a new helper:
+  def guess_account(question, options = {})
+    guess = Guesser.new.guess
+    ask_account(question, default: guess)
+  end
+end
+
+TotalRecall::SessionHelper.include MyExtension
+```
+
 ## Develop
     
 ```bash

data/lib/total_recall/templates/sample.yml.tt

@@ -36,12 +36,14 @@
   #
   #:file: sample.csv
   :raw: |-
-    "03.11.2013";"Foo";"04.11.2013";"1.638,00";""
-    "03.11.2013";"Bar";"04.11.2013";"-492,93";""
+    "date";"description";"effective_data";"amount"
+    "03.11.2013";"Foo";"04.11.2013";"1.638,00"
+    "03.11.2013";"Bar";"04.11.2013";"-492,93"
   :options:
     # Any option accepted by CSV#new (http://www.ruby-doc.org/stdlib-2.1.1/libdoc/csv/rdoc/CSV.html#method-c-new).
     :col_sep: ";"
-    :headers: false
+    :headers: true
+    :header_converters: :symbol # row[:date] rather than row[0]
 
 :context:
   # 3). Define the context
@@ -56,15 +58,19 @@
                       default: 'Assets:Checking')
       :currency: $
     # ...and fields that vary per transaction.
-    # Helper method exist such as `row`, `ask_account` (see `TotalRecall::Helper` for more).
-    :date: !!proc |
-      # For weird date formats consider using Date#strptime (http://www.ruby-doc.org/stdlib-2.1.1/libdoc/date/rdoc/Date.html#method-c-strptime)
-      Date.parse(row[0])
-    :description: !!proc row[1]
-    :amount: !!proc row[3]
+    # Helper method exist such as `row`, `ask_account` (see `TotalRecall::SessionHelper` for more).
+    :date: !!proc row[:date]
+    :description: !!proc row[:description]
+    :amount: !!proc row[:amount]
+    :currency: !!proc |
+      case row[:description]
+      when /some regex to detect non-dollar/ then '€'
+      else
+        default
+      end
     :to: !!proc |
       # show the row and let the user decide
-      render_row(columns: [0, 1, 3])
+      render_row(columns: [:date, :description, :amount])
       ask_account("To what account did the money go?")
   :generated_at: !!proc Time.now
 

data/lib/total_recall/version.rb

@@ -1,3 +1,3 @@
 module TotalRecall
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/total_recall.rb

@@ -4,26 +4,24 @@ require "mustache"
 require 'csv'
 
 module TotalRecall
-  class Helper
+  module DefaultHelper
     require 'highline/import'
     require "terminal-table"
 
-    attr_reader :config
-    attr_accessor :row
+    def transaction
+      self
+    end
 
-    def initialize(config = {})
-      @config = config
+    def config
+      @config
     end
 
-    def with_row(row, &block)
-      @row = row
-      instance_eval(&block)
-    ensure
-      @row = nil
+    def row
+      @row
     end
 
-    def highline
-      @highline ||= HighLine.new($stdin, $stderr)
+    def default
+      @default
     end
 
     def ask(question, &block)
@@ -53,16 +51,61 @@ module TotalRecall
 
     def render_row(options = {})
       options = { columns: [] }.merge(options)
-      _row = options[:columns].map{|i| row[i] }
+      _row = options[:columns].map {|i| row[i] }
       $stderr.puts Terminal::Table.new(rows: [ _row ])
     end
+
+    def extract_transaction(row)
+      @row = row
+      transactions_config.each do |k,v|
+        next if k[/^__/]
+        self[k] = value_for(k, v)
+      end
+      self
+    end
+
+    protected
+    def value_for(key, v)
+      if v.respond_to?(:call)
+        @default = self[key.to_sym]
+        instance_eval(&v)
+      else
+        v
+      end
+    ensure
+      @default = nil
+    end
+
+    def transactions_config
+      config[:context][:transactions]
+    end
+
+    def highline
+      @highline ||= HighLine.new($stdin, $stderr)
+    end
+  end
+
+  # Include your module into {SessionHelper} if you want to
+  # add helpers or redefine existing ones.
+  #
+  # @example
+  #   module MyExtension
+  #     def guess_account(question, options = {})
+  #       guess = AccountGuesser.new.guess
+  #       ask_account("What acount provided this?", default: guess)
+  #     end
+  #   end
+  #
+  #   TotalRecall::SessionHelper.include MyExtension
+  module SessionHelper
+    include DefaultHelper
   end
 
   class Config
-    YAML::add_builtin_type('proc') {|_, val| eval("proc{ #{val} }") }
+    YAML::add_builtin_type('proc') {|_, val| eval("proc { #{val} }") }
 
     def initialize(options = {})
-      options = {file: 'total_recall.yml'}.merge(options)
+      options = { file: 'total_recall.yml' }.merge(options)
       @config_file = File.expand_path(options[:file])
     end
 
@@ -93,30 +136,40 @@ module TotalRecall
       end
     end
 
+    def context
+      @context ||= config[:context].merge(transactions: transactions)
+    end
+
     def session
-      @session ||= Helper.new(config)
+      @session ||= session_class.new(transactions_config_defaults, :config => config)
     end
 
-    def context
-      @context ||= config[:context].merge(transactions: transactions)
+    def transaction_attributes
+      @transaction_attributes ||= begin
+        transactions_config.dup.delete_if{|k,_| k[/__/]}.keys |
+          transactions_config_defaults.keys
+      end
     end
 
-    def transactions
-      @transactions ||= begin
-        csv.each_with_object([]) do |row, result|
-          result << transaction_defaults.merge(transactions_config).each_with_object({}) do |(k,v), cfg|
-            next if k[/^__/]
-            cfg[k] = v.respond_to?(:call) ? session.with_row(row, &v) : v
+    def session_class
+      @session_class ||= begin
+        Class.new(Struct.new(*transaction_attributes)) do
+          include SessionHelper
+
+          def initialize(values = {}, options = {})
+            @config = options[:config]
+            values.each do |k,v|
+              self[k] = value_for(k, v)
+            end
           end
         end
       end
     end
 
-    def transaction_defaults
-      @transaction_defaults ||= begin
-        defaults = transactions_config[:__defaults__] || {}
-        defaults.each_with_object({}) do |(k,v), result|
-          result[k] = v.respond_to?(:call) ? session.with_row(nil, &v) : v
+    def transactions
+      @transactions ||= begin
+        csv.each_with_object([]) do |row, transactions|
+          transactions << Hash[session.extract_transaction(row).each_pair.to_a]
         end
       end
     end
@@ -125,6 +178,10 @@ module TotalRecall
       config[:context][:transactions]
     end
 
+    def transactions_config_defaults
+      transactions_config[:__defaults__] || {}
+    end
+
     def ledger
       Mustache.render(template, context)
     end
@@ -136,10 +193,14 @@ module TotalRecall
     include Thor::Actions
     source_root File.expand_path('../total_recall/templates', __FILE__)
 
-    desc "ledger", "Convert the config to a ledger"
+    desc "ledger", "Convert CONFIG to a ledger"
     method_option :config, :aliases => "-c", :desc => "Config file", :required => true
+    method_option :require, :aliases => "-r", :desc => "File to load"
     def ledger
-      puts TotalRecall::Config.new(file: File.expand_path(options[:config])).ledger
+      load(options[:require]) if options[:require]
+
+      config_path = File.expand_path(options[:config])
+      puts TotalRecall::Config.new(file: config_path).ledger
     end
 
     desc "sample", "Generate an annotated config"
@@ -158,5 +219,10 @@ module TotalRecall
       @name = name
       template("simple.yml.tt", destination)
     end
+
+    desc "version", "Show total_recall version"
+    def version
+      puts TotalRecall::VERSION
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,4 @@
-require "rubygems"
-require "bundler"
-Bundler.setup
+require "bundler/setup"
+Bundler.require :default, :test
 
-$:.unshift File.expand_path("../../lib", __FILE__)
-require "total_recall"
 require 'fakefs/spec_helpers'

data/spec/total_recall/total_recall_spec.rb

@@ -173,4 +173,57 @@ describe TotalRecall::Config do
       expect(instance.context).to match(transactions: [{from: 'From'}], a: 1)
     end
   end
+
+  describe 'helper methods' do
+    describe '#transaction' do
+      it 'gives access to the existing attributes' do
+        instance = instance_with_config(<<-CONFIG)
+        :csv:
+          :raw: some csv
+        :context:
+          :transactions:
+            :a: attribute a
+            :b: !!proc |
+              %|not %s| % transaction.a
+        CONFIG
+
+        expect(instance.transactions.first).to match({a: 'attribute a', b: 'not attribute a'})
+      end
+    end
+
+    describe '#config' do
+      it 'gives access to the full config' do
+        instance = instance_with_config(<<-CONFIG)
+        :csv:
+          :raw: some csv
+        :context:
+          :transactions:
+            :a: !!proc |
+              config[:a]
+        :a: 1
+        CONFIG
+
+        expect(instance.transactions.first).to match({a: 1})
+      end
+    end
+
+    describe '#default' do
+      it 'gives access to the default' do
+        instance = instance_with_config(<<-CONFIG)
+        :csv:
+          :raw: some csv
+        :context:
+          :transactions:
+            :__defaults__:
+              :a: !!proc 2
+              :b?: true
+            :a: !!proc |
+              default.succ
+            :b?: true
+        CONFIG
+
+        expect(instance.transactions.first).to match({a: 3, b?: true})
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: total_recall
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -133,6 +133,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile