lucabook 0.2.22 → 0.2.27

data/lib/luca_book/import.rb

@@ -35,13 +35,13 @@ module LucaBook
     #       "debit" : [
     #         {
     #           "label": "savings accounts",
-    #           "value": 20000
+    #           "amount": 20000
     #         }
     #       ],
     #       "credit" : [
     #         {
     #           "label": "trade notes receivable",
-    #           "value": 20000
+    #           "amount": 20000
     #         }
     #       ],
     #       "note": "settlement for the last month trade"
@@ -75,20 +75,21 @@ module LucaBook
     # convert single entry data
     #
     def parse_single(row)
-      if (row.dig(@config[:credit_value]) || []).empty?
-        value = BigDecimal(row[@config[:debit_value]])
+      if (row.dig(@config[:credit_amount]) || []).empty?
+        amount = BigDecimal(row[@config[:debit_amount]])
         debit = true
       else
-        value = BigDecimal(row[@config[:credit_value]])
+        amount = BigDecimal(row[@config[:credit_amount]])
       end
       default_label = debit ? @config.dig(:default_debit) : @config.dig(:default_credit)
-      code, options = search_code(row[@config[:label]], default_label, value)
+      code, options = search_code(row[@config[:label]], default_label, amount)
       counter_code = @code_map.dig(@config[:counter_label])
-      if respond_to? :tax_extension
-        data, data_c = tax_extension(code, counter_code, value, options) if options
+      if options
+        x_customer = options[:'x-customer'] if options[:'x-customer']
+        data, data_c = tax_extension(code, counter_code, amount, options) if respond_to? :tax_extension
       end
-      data ||= [{ 'code' => code, 'value' => value }]
-      data_c ||= [{ 'code' => counter_code, 'value' => value }]
+      data ||= [{ 'code' => code, 'amount' => amount }]
+      data_c ||= [{ 'code' => counter_code, 'amount' => amount }]
       {}.tap do |d|
         d['date'] = parse_date(row)
         if debit
@@ -99,7 +100,8 @@ module LucaBook
           d['credit'] = data
         end
         d['note'] = Array(@config[:note]).map{ |col| row[col] }.join(' ')
-        d['x-editor'] = "LucaBook::Import/#{@dict_name}"
+        d['headers'] = { 'x-editor' => "LucaBook::Import/#{@dict_name}" }
+        d['headers']['x-customer'] = x_customer if x_customer
       end
     end
 
@@ -110,11 +112,11 @@ module LucaBook
         d['date'] = parse_date(row)
         d['debit'] = {
           'code' => search_code(row[@config[:label]], @config.dig(:default_debit)) || DEBIT_DEFAULT,
-          'value' => row.dig(@config[:debit_value])
+          'amount' => row.dig(@config[:debit_amount])
         }
         d['credit'] = {
           'code' => search_code(row[@config[:label]], @config.dig(:default_credit)) || CREDIT_DEFAULT,
-          'value' => row.dig(@config[:credit_value])
+          'amount' => row.dig(@config[:credit_amount])
         }
         d['note'] = Array(@config[:note]).map{ |col| row[col] }.join(' ')
         d['x-editor'] = "LucaBook::Import/#{@dict_name}"

data/lib/luca_book/import_jp.rb

@@ -31,17 +31,17 @@ module LucaBook
             amount1 = amount
             amount1 -= consumption_amount if consumption_idx == 0
             amount1 += gensen_amount if gensen_idx == 1
-            res1 << { 'code' => code1, 'value' => amount1 }
-            res1 << { 'code' => consumption_code, 'value' => consumption_amount } if consumption_idx == 0
-            res1 << { 'code' => gensen_code, 'value' => gensen_amount } if gensen_idx == 0
+            res1 << { 'code' => code1, 'amount' => amount1 }
+            res1 << { 'code' => consumption_code, 'amount' => consumption_amount } if consumption_idx == 0
+            res1 << { 'code' => gensen_code, 'amount' => gensen_amount } if gensen_idx == 0
           end
           res << [].tap do |res2|
             amount2 = amount
             amount2 -= consumption_amount if consumption_idx == 1
             amount2 += gensen_amount if gensen_idx == 0
-            res2 << { 'code' => code2, 'value' => amount2 }
-            res2 << { 'code' => consumption_code, 'value' => consumption_amount } if consumption_idx == 1
-            res2 << { 'code' => gensen_code, 'value' => gensen_amount } if gensen_idx == 1
+            res2 << { 'code' => code2, 'amount' => amount2 }
+            res2 << { 'code' => consumption_code, 'amount' => consumption_amount } if consumption_idx == 1
+            res2 << { 'code' => gensen_code, 'amount' => gensen_amount } if gensen_idx == 1
           end
         end
       elsif options[:tax_options].include?('jp-gensen')
@@ -51,15 +51,15 @@ module LucaBook
           res << [].tap do |res1|
             amount1 = amount
             amount1 += gensen_amount if gensen_idx == 1
-            res1 << { 'code' => code, 'value' => amount1 }
-            res1 << { 'code' => gensen_code, 'value' => gensen_amount } if gensen_idx == 0
+            res1 << { 'code' => code, 'amount' => amount1 }
+            res1 << { 'code' => gensen_code, 'amount' => gensen_amount } if gensen_idx == 0
           end
           res << [].tap do |res2|
             amount2 = amount
             amount2 += gensen_amount if gensen_idx == 0
             mount2 ||= amount
-            res2 << { 'code' => code2, 'value' => amount2 }
-            res2 << { 'code' => gensen_code, 'value' => gensen_amount } if gensen_idx == 1
+            res2 << { 'code' => code2, 'amount' => amount2 }
+            res2 << { 'code' => gensen_code, 'amount' => gensen_amount } if gensen_idx == 1
           end
         end
       elsif options[:tax_options].include?('jp-consumption')
@@ -68,14 +68,14 @@ module LucaBook
         res << [].tap do |res1|
           amount1 = amount
           amount1 -= consumption_amount if consumption_idx == 0
-          res1 << { 'code' => code1, 'value' => amount1 }
-          res1 << { 'code' => consumption_code, 'value' => consumption_amount } if consumption_idx == 0
+          res1 << { 'code' => code1, 'amount' => amount1 }
+          res1 << { 'code' => consumption_code, 'amount' => consumption_amount } if consumption_idx == 0
         end
         res << [].tap do |res2|
           amount2 = amount
           amount2 -= consumption_amount if consumption_idx == 1
-          res2 << { 'code' => code2, 'value' => amount2 }
-          res2 << { 'code' => consumption_code, 'value' => consumption_amount } if consumption_idx == 1
+          res2 << { 'code' => code2, 'amount' => amount2 }
+          res2 << { 'code' => consumption_code, 'amount' => consumption_amount } if consumption_idx == 1
         end
       end
     end

data/lib/luca_book/journal.rb

@@ -1,44 +1,90 @@
-#
-# manipulate files based on transaction date
-#
+# frozen_string_literal: true
 
 require 'csv'
 require 'date'
 require 'luca_record'
 
-module LucaBook
+module LucaBook #:nodoc:
+  # Journal has several annotations on headers:
+  #
+  # x-customer::
+  #     Identifying customer.
+  # x-editor::
+  #     Application name editing the journal.
+  # x-tax::
+  #     For tracking tax related transaction.
+  #
   class Journal < LucaRecord::Base
+    ACCEPTED_HEADERS = ['x-customer', 'x-editor', 'x-tax']
     @dirname = 'journals'
 
     # create journal from hash
     #
-    def self.create(d)
+    def self.create(dat)
+      d = LucaSupport::Code.keys_stringify(dat)
       validate(d)
+      raise 'NoDateKey' unless d.key?('date')
+
       date = Date.parse(d['date'])
 
-      debit_amount = LucaSupport::Code.decimalize(serialize_on_key(d['debit'], 'value'))
-      credit_amount = LucaSupport::Code.decimalize(serialize_on_key(d['credit'], 'value'))
+      # TODO: need to sync filename & content. Limit code length for filename
+      # codes = (debit_code + credit_code).uniq
+      codes = nil
+
+      create_record(nil, date, codes) { |f| f.write journal2csv(d) }
+    end
+
+    # update journal with hash.
+    # If record not found with id, no record will be created.
+    #
+    def self.save(dat)
+      d = LucaSupport::Code.keys_stringify(dat)
+      raise 'record has no id.' if d['id'].nil?
+
+      validate(d)
+      parts = d['id'].split('/')
+      raise 'invalid ID' if parts.length != 2
+
+      codes = nil
+      open_records(@dirname, parts[0], parts[1], codes, 'w') { |f, _path| f.write journal2csv(d) }
+    end
+
+    # Convert journal object to TSV format.
+    #
+    def self.journal2csv(d)
+      debit_amount = LucaSupport::Code.decimalize(serialize_on_key(d['debit'], 'amount'))
+      credit_amount = LucaSupport::Code.decimalize(serialize_on_key(d['credit'], 'amount'))
       raise 'BalanceUnmatch' if debit_amount.inject(:+) != credit_amount.inject(:+)
 
       debit_code = serialize_on_key(d['debit'], 'code')
       credit_code = serialize_on_key(d['credit'], 'code')
 
-      # TODO: need to sync filename & content. Limit code length for filename
-      # codes = (debit_code + credit_code).uniq
-      codes = nil
-      create_record!(date, codes) do |f|
+      csv = CSV.generate(String.new, col_sep: "\t", headers: false) do |f|
         f << debit_code
         f << LucaSupport::Code.readable(debit_amount)
         f << credit_code
         f << LucaSupport::Code.readable(credit_amount)
-        ['x-customer', 'x-editor'].each do |x_header|
-          f << [x_header, d[x_header]] if d.dig(x_header)
+        ACCEPTED_HEADERS.each do |x_header|
+          f << [x_header, d['headers'][x_header]] if d.dig('headers', x_header)
         end
         f << []
         f << [d.dig('note')]
       end
     end
 
+    # Set accepted header with key/value, update record if exists.
+    #
+    def self.add_header(journal_hash, key, val)
+      return journal_hash if val.nil?
+      return journal_hash unless ACCEPTED_HEADERS.include?(key)
+
+      journal_hash.tap do |o|
+        o[:headers] = {} unless o.dig(:headers)
+        o[:headers][key] = val
+        save o if o[:id]
+      end
+    end
+
     def self.update_codes(obj)
       debit_code = serialize_on_key(obj[:debit], :code)
       credit_code = serialize_on_key(obj[:credit], :code)
@@ -46,27 +92,19 @@ module LucaBook
       change_codes(obj[:id], codes)
     end
 
-    # define new transaction ID & write data at once
-    def self.create_record!(date_obj, codes = nil)
-      create_record(nil, date_obj, codes) do |f|
-        f.write CSV.generate('', col_sep: "\t", headers: false) { |c| yield(c) }
-      end
-    end
-
     def self.validate(obj)
-      raise 'NoDateKey' unless obj.key?('date')
       raise 'NoDebitKey' unless obj.key?('debit')
       raise 'NoCreditKey' unless obj.key?('credit')
       debit_codes = serialize_on_key(obj['debit'], 'code').compact
-      debit_values = serialize_on_key(obj['debit'], 'value').compact
+      debit_amount = serialize_on_key(obj['debit'], 'amount').compact
       raise 'NoDebitCode' if debit_codes.empty?
-      raise 'NoDebitValue' if debit_values.empty?
-      raise 'UnmatchDebit' if debit_codes.length != debit_values.length
+      raise 'NoDebitAmount' if debit_amount.empty?
+      raise 'UnmatchDebit' if debit_codes.length != debit_amount.length
       credit_codes = serialize_on_key(obj['credit'], 'code').compact
-      credit_values = serialize_on_key(obj['credit'], 'value').compact
+      credit_amount = serialize_on_key(obj['credit'], 'amount').compact
       raise 'NoCreditCode' if credit_codes.empty?
-      raise 'NoCreditValue' if credit_values.empty?
-      raise 'UnmatchCredit' if credit_codes.length != credit_values.length
+      raise 'NoCreditAmount' if credit_amount.empty?
+      raise 'UnmatchCredit' if credit_codes.length != credit_amount.length
     end
 
     # collect values on specified key
@@ -75,7 +113,21 @@ module LucaBook
       array_of_hash.map { |h| h[key] }
     end
 
-    # override de-serializing journal format
+    # override de-serializing journal format. Sample format is:
+    #
+    #   {
+    #     id: '2021A/V001',
+    #     headers: {
+    #       'x-customer' => 'Some Customer Co.'
+    #     },
+    #     debit: [
+    #       { code: 'A12', amount: 1000 }
+    #     ],
+    #     credit: [
+    #       { code: '311', amount: 1000 }
+    #     ],
+    #     note: 'note for each journal'
+    #   }
     #
     def self.load_data(io, path)
       {}.tap do |record|
@@ -93,10 +145,16 @@ module LucaBook
           when 3
             line.each_with_index { |amount, j| record[:credit][j][:amount] = BigDecimal(amount.to_s) }
           else
-            if body == false && line.empty?
-              record[:note] ||= []
-              body = true
-            else
+            case body
+            when false
+              if line.empty?
+                record[:note] ||= []
+                body = true
+              else
+                record[:headers] ||= {}
+                record[:headers][line[0]] = line[1]
+              end
+            when true
               record[:note] << line.join(' ') if body
             end
           end

data/lib/luca_book/list.rb

@@ -7,37 +7,53 @@ require 'luca_record'
 require 'luca_record/dict'
 require 'luca_book'
 
-# Journal List on specified term
-#
-module LucaBook
+module LucaBook #:nodoc:
+  # Journal List on specified term
+  #
   class List < LucaBook::Journal
     @dirname = 'journals'
+    @@dict = LucaRecord::Dict.new('base.tsv')
+    attr_reader :data
 
     def initialize(data, start_date, code = nil)
       @data = data
       @code = code
       @start = start_date
-      @dict = LucaRecord::Dict.load('base.tsv')
     end
 
-    def self.term(from_year, from_month, to_year = from_year, to_month = from_month, code: nil, basedir: @dirname)
+    def self.term(from_year, from_month, to_year = from_year, to_month = from_month, code: nil, basedir: @dirname, recursive: false)
+      code = search_code(code) if code
       data = LucaBook::Journal.term(from_year, from_month, to_year, to_month, code).select do |dat|
         if code.nil?
           true
         else
-          [:debit, :credit].map { |key| serialize_on_key(dat[key], :code) }.flatten.include?(code)
+          if recursive
+            ! [:debit, :credit].map { |key| serialize_on_key(dat[key], :code) }.flatten.select { |idx|  /^#{code}/.match(idx) }.empty?
+          else
+            [:debit, :credit].map { |key| serialize_on_key(dat[key], :code) }.flatten.include?(code)
+          end
         end
       end
       new data, Date.new(from_year.to_i, from_month.to_i, 1), code
     end
 
-    def list_on_code
-      calc_code
+    def self.add_header(from_year, from_month, to_year = from_year, to_month = from_month, code: nil, header_key: nil, header_val: nil)
+      return nil if code.nil?
+      return nil unless Journal::ACCEPTED_HEADERS.include?(header_key)
+
+      term(from_year, from_month, to_year, to_month, code: code)
+        .data.each do |journal|
+        Journal.add_header(journal, header_key, header_val)
+      end
+    end
+
+    def list_by_code(recursive = false)
+      calc_code(recursive: recursive)
       convert_label
       @data = [code_header] + @data.map do |dat|
         date, txid = LucaSupport::Code.decode_id(dat[:id])
         {}.tap do |res|
-          res['code'] = dat[:code]
+          res['code'] = dat[:code].length == 1 ? dat[:code].first : dat[:code]
           res['date'] = date
           res['no'] = txid
           res['id'] = dat[:id]
@@ -59,7 +75,7 @@ module LucaBook
           res['no'] = txid
           res['id'] = dat[:id]
           res['debit_code'] = dat[:debit].length == 1 ? dat[:debit][0][:code] : dat[:debit].map { |d| d[:code] }
-          res['debit_amount'] =  dat[:debit].inject(0) { |sum, d| sum + d[:amount] }
+          res['debit_amount'] = dat[:debit].inject(0) { |sum, d| sum + d[:amount] }
           res['credit_code'] = dat[:credit].length == 1 ? dat[:credit][0][:code] : dat[:credit].map { |d| d[:code] }
           res['credit_amount'] = dat[:credit].inject(0) { |sum, d| sum + d[:amount] }
           res['note'] = dat[:note]
@@ -74,32 +90,35 @@ module LucaBook
       end
     end
 
+    def self.search_code(code)
+      return code if @@dict.dig(code)
+
+      @@dict.search(code).tap do |new_code|
+        if new_code.nil?
+          puts "Search word is not matched with labels"
+          exit 1
+        end
+      end
+    end
+
     private
 
-    def set_balance
+    def set_balance(recursive = false)
       return BigDecimal('0') if @code.nil? || /^[A-H]/.match(@code)
 
-      balance_dict = Dict.latest_balance
-      start_balance = BigDecimal(balance_dict.dig(@code.to_s, :balance) || '0')
-      start = Dict.issue_date(balance_dict)&.next_month
-      last = @start.prev_month
-      if last.year >= start.year && last.month >= start.month
-        start_balance + self.class.term(start.year, start.month, last.year, last.month, code: @code).accumulate_code
-      else
-        start_balance
-      end
+      LucaBook::State.start_balance(@start.year, @start.month, recursive: recursive)
     end
 
-    def calc_code
-      @balance = set_balance
+    def calc_code(recursive: false)
+      @balance = set_balance(recursive)[@code] || BigDecimal('0')
       if @code
         balance = @balance
         @data.each do |dat|
           dat[:diff] = Util.diff_by_code(dat[:debit], @code) - Util.diff_by_code(dat[:credit], @code)
           balance += dat[:diff]
           dat[:balance] = balance
-          dat[:code] = @code
-          counter = dat[:diff] * Util.pn_debit(@code) > 0 ? :credit : :debit
+          target, counter = dat[:diff] * Util.pn_debit(@code) > 0 ? [:debit, :credit] : [:credit, :debit]
+          dat[:code] = dat[target].map { |d| d[:code] }
           dat[:counter_code] = dat[counter].map { |d| d[:code] }
         end
       end
@@ -109,20 +128,16 @@ module LucaBook
     def convert_label
       @data.each do |dat|
         if @code
-          dat[:code] = "#{dat[:code]} #{@dict.dig(dat[:code], :label)}"
-          dat[:counter_code] = dat[:counter_code].map { |counter| "#{counter} #{@dict.dig(counter, :label)}" }
+          dat[:code] = dat[:code].map { |target| "#{target} #{@@dict.dig(target, :label)}" }
+          dat[:counter_code] = dat[:counter_code].map { |counter| "#{counter} #{@@dict.dig(counter, :label)}" }
         else
-          dat[:debit].each { |debit| debit[:code] = "#{debit[:code]} #{@dict.dig(debit[:code], :label)}" }
-          dat[:credit].each { |credit| credit[:code] = "#{credit[:code]} #{@dict.dig(credit[:code], :label)}" }
+          dat[:debit].each { |debit| debit[:code] = "#{debit[:code]} #{@@dict.dig(debit[:code], :label)}" }
+          dat[:credit].each { |credit| credit[:code] = "#{credit[:code]} #{@@dict.dig(credit[:code], :label)}" }
         end
       end
       self
     end
 
-    def dict
-      LucaBook::Dict::Data
-    end
-
     def code_header
       {}.tap do |h|
         %w[code date no id diff balance counter_code note].each do |k|