lucabook 0.2.22 → 0.2.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4755b2574729e35ae914dd92338ed007df2e1158d49c613613cac3b42423c6ee
-  data.tar.gz: a559a270322897b10b6dae569102f028004221431300debe19f3d0e5ae6432fe
+  metadata.gz: ad4b1eba3419508d64bfeade5f776ed2ca0f32313deab25660864aff47767787
+  data.tar.gz: 57aef956cbc763dbf4d089d5745c9cc4d6a6ed44dd3ff726b9c80fbc6b29629d
 SHA512:
-  metadata.gz: 34b28c364e41ddecf9296ef39130897f03228e0bb0184241e0a7fce4349d41b14ff0ea72318154eb0bfa5e8fdac401783851c61e34e3419620eac6ab12cf6b05
-  data.tar.gz: 1bbd862143cc37ba7c459a6d3fae832bbdad744b1db6afc3956175fa97660a1decf8a778c6c40c3e276dd35272ed363f5d9e575ce555b73a368cf2ef8173fcbf
+  metadata.gz: 317b373f1a31c85c107dfa294ec6df0dcc89f13b8ab10277bb004b3bdceaaf0ec58cfa5c2220a088932965b5b156fd71fef1ce67be67c330857bbcea127de365
+  data.tar.gz: e7456d393a4309bafb9a3622c28da10067e1483c80b0bbbd73a05508bb3d9a6742051e2d190870a1f6e39df5ec10b5dd7d1de698faef969a3bc54efa7b46b153

data/exe/luca-book

@@ -10,7 +10,8 @@ class LucaCmd
       if params['config']
         LucaBook::Import.new(args[0], params['config']).import_csv
       elsif params['json']
-        LucaBook::Import.import_json(STDIN.read)
+        str = args[0].nil? ? STDIN.read : File.read(args[0])
+        LucaBook::Import.import_json(str)
       else
         puts 'Usage: luca-book import -c import_config'
         exit 1
@@ -20,7 +21,11 @@ class LucaCmd
     def self.list(args, params)
       args = gen_range(params[:n] || 1) if args.empty?
       if params['code']
-        render(LucaBook::List.term(*args, code: params['code']).list_on_code, params)
+        if params['headers']
+          render(LucaBook::ListByHeader.term(*args, code: params['code'], header: params['headers']).list_by_code, params)
+        else
+          render(LucaBook::List.term(*args, code: params['code'], recursive: params[:recursive]).list_by_code(params[:recursive]), params)
+        end
       else
         render(LucaBook::List.term(*args).list_journals, params)
       end
@@ -29,14 +34,30 @@ class LucaCmd
     def self.stats(args, params)
       args = gen_range(params[:n]) if args.empty?
       if params['code']
-        render(LucaBook::State.by_code(params['code'], *args), params)
+        render(LucaBook::State.by_code(params['code'], *args, recursive: params[:recursive]), params)
       else
         render(LucaBook::State.range(*args).stats(params[:level]), params)
       end
     end
+
+    def self.add_header(args, params)
+      args = gen_range(params[:n] || 1) if args.empty?
+      if params['code']
+        LucaBook::List.add_header(*args, code: params['code'], header_key: params[:key], header_val: params[:value])
+      else
+        puts 'no code specified.'
+      end
+    end
   end
 
   class Report < LucaCmd
+    def self.xbrl(args, params)
+      level = params[:level] || 3
+      legal = params[:legal] || false
+      args = gen_range(params[:n] || 1) if args.empty?
+      LucaBook::State.range(*args).render_xbrl(params[:output])
+    end
+
     def self.balancesheet(args, params)
       level = params[:level] || 3
       legal = params[:legal] || false
@@ -49,6 +70,12 @@ class LucaCmd
       args = gen_range(params[:n]) if args.empty?
       render(LucaBook::State.range(*args).pl(level), params)
     end
+
+    def self.report_mail(args, params)
+      level = params[:level] || 3
+      args = gen_range(params[:n] || 12) if args.empty?
+      render(LucaBook::State.range(*args).report_mail(level), params)
+    end
   end
 
   def self.gen_range(count)
@@ -68,6 +95,12 @@ class LucaCmd
       puts YAML.dump(dat)
     end
   end
+
+  class Dict < LucaCmd
+    def self.update_balance(args, params)
+      LucaBook::Dict.generate_balance(*args)
+    end
+  end
 end
 
 def new_pj(args = nil, params = {})
@@ -91,9 +124,12 @@ when /journals?/, 'j'
       LucaCmd::Journal.import(args, params)
     end
   when 'list'
+    params[:recursive] = false
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-book journals list [options] [YYYY M]'
-      opt.on('-c', '--code VAL', 'search with code') { |v| params['code'] = v }
+      opt.on('-c', '--code VAL', 'filter with code or label') { |v| params['code'] = v }
+      opt.on('-r', '--recursive', 'include subaccounts') { |_v| params[:recursive] = true }
+      opt.on('--customer', 'categorize by x-customer header') { |_v| params['headers'] = 'x-customer' }
       opt.on('-n VAL', 'report count') { |v| params[:n] = v.to_i }
       opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
       opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
@@ -101,10 +137,22 @@ when /journals?/, 'j'
       args = opt.parse!(ARGV)
       LucaCmd::Journal.list(args, params)
     end
+  when 'set'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-book journals set [options] [YYYY M]'
+      opt.on('-c', '--code VAL', 'search with code') { |v| params['code'] = v }
+      opt.on('--header VAL', 'header key') { |v| params[:key] = v }
+      opt.on('--val VAL', 'header value') { |v| params[:value] = v }
+      opt.on_tail('set header to journals on specified code.')
+      args = opt.parse!(ARGV)
+      LucaCmd::Journal.add_header(args, params)
+    end
   when 'stats'
+    params[:recursive] = false
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-book journals stats [options] [YYYY M]'
-      opt.on('-c', '--code VAL', 'search with code') { |v| params['code'] = v }
+      opt.on('-c', '--code VAL', 'filter with code or label') { |v| params['code'] = v }
+      opt.on('-r', '--recursive', 'include subaccounts') { |_v| params[:recursive] = true }
       opt.on('-n VAL', 'report count') { |v| params[:n] = v.to_i }
       opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
       opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
@@ -130,6 +178,13 @@ when 'new'
 when /reports?/, 'r'
   subcmd = ARGV.shift
   case subcmd
+  when 'xbrl'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-book reports bs [options] [YYYY M]'
+      opt.on('-o', '--output VAL', 'output filename') { |v| params[:output] = v }
+      args = opt.parse!(ARGV)
+      LucaCmd::Report.xbrl(args, params)
+    end
   when 'bs'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-book reports bs [options] [YYYY M]'
@@ -150,6 +205,14 @@ when /reports?/, 'r'
       args = opt.parse!(ARGV)
       LucaCmd::Report.profitloss(args, params)
     end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-book reports mail [options] [YYYY M YYYY M]'
+      opt.on('-l', '--level VAL', 'account level') { |v| params[:level] = v.to_i }
+      opt.on('-n VAL', 'report count') { |v| params[:n] = v.to_i }
+      args = opt.parse!(ARGV)
+      LucaCmd::Report.report_mail(args, params)
+    end
   else
     puts 'Proper subcommand needed.'
     puts
@@ -158,6 +221,16 @@ when /reports?/, 'r'
     puts '  pl: show statement of income'
     exit 1
   end
+when /balance/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'update'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-book balance update YYYY [M]'
+      args = opt.parse!(ARGV)
+      LucaCmd::Dict.update_balance(args, params)
+    end
+  end
 else
   puts 'Proper subcommand needed.'
   puts

data/lib/luca_book.rb

@@ -5,10 +5,12 @@ require 'luca_record'
 require 'luca_book/version'
 
 module LucaBook
+  autoload :Accumulator, 'luca_book/accumulator'
   autoload :Dict, 'luca_book/dict'
   autoload :Import, 'luca_book/import'
   autoload :Journal, 'luca_book/journal'
   autoload :List, 'luca_book/list'
+  autoload :ListByHeader, 'luca_book/list_by_header'
   autoload :Setup, 'luca_book/setup'
   autoload :State, 'luca_book/state'
   autoload :Util, 'luca_book/util'

data/lib/luca_book/accumulator.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'luca_book/util'
+require 'luca_support/config'
+
+module LucaBook
+  module Accumulator
+    def self.included(klass) # :nodoc:
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def accumulate_month(year, month)
+        monthly_record, count = net(year, month)
+        [total_subaccount(monthly_record), count]
+      end
+
+      # Accumulate Level 2, 3 account.
+      #
+      def total_subaccount(report)
+        {}.tap do |res|
+          res['A0'] = sum_matched(report, /^[A][0-9A-Z]{2,}/)
+          res['B0'] = sum_matched(report, /^[B][0-9A-Z]{2,}/)
+          res['BA'] = res['A0'] - res['B0']
+          res['C0'] = sum_matched(report, /^[C][0-9A-Z]{2,}/)
+          res['CA'] = res['BA'] - res['C0']
+          res['D0'] = sum_matched(report, /^[D][0-9A-Z]{2,}/)
+          res['E0'] = sum_matched(report, /^[E][0-9A-Z]{2,}/)
+          res['EA'] = res['CA'] + res['D0'] - res['E0']
+          res['F0'] = sum_matched(report, /^[F][0-9A-Z]{2,}/)
+          res['G0'] = sum_matched(report, /^[G][0-9][0-9A-Z]{1,}/)
+          res['GA'] = res['EA'] + res['F0'] - res['G0']
+          res['H0'] = sum_matched(report, /^[H][0-9][0-9A-Z]{1,}/)
+          res['HA'] = res['GA'] - res['H0']
+
+          report['9142'] = (report['9142'] || BigDecimal('0')) + res['HA']
+          res['9142'] = report['9142']
+          res['10'] = sum_matched(report, /^[12][0-9A-Z]{2,}/)
+          jp_4v = sum_matched(report, /^[4][V]{2,}/) # deferred assets for JP GAAP
+          res['30'] = sum_matched(report, /^[34][0-9A-Z]{2,}/) - jp_4v
+          res['4V'] = jp_4v if LucaSupport::CONFIG['country'] == 'jp'
+          res['50'] = sum_matched(report, /^[56][0-9A-Z]{2,}/)
+          res['70'] = sum_matched(report, /^[78][0-9A-Z]{2,}/)
+          res['91'] = sum_matched(report, /^91[0-9A-Z]{1,}/)
+          res['8ZZ'] = res['50'] + res['70']
+          res['9ZZ'] = sum_matched(report, /^[9][0-9A-Z]{2,}/)
+
+          res['1'] = res['10'] + res['30']
+          res['5'] = res['8ZZ'] + res['9ZZ']
+          res['_d'] = report['_d']
+
+          report.each do |k, v|
+            res[k] ||= sum_matched(report, /^#{k}[0-9A-Z]{1,}/) if k.length == 2
+            res[k] = v if k.length == 3
+          end
+
+          report.each do |k, v|
+            if k.length >= 4
+              if res[k[0, 3]]
+                res[k[0, 3]] += v
+              else
+                res[k[0, 3]] = v
+              end
+              res[k] = v
+            end
+          end
+          res.sort.to_h
+        end
+      end
+
+      def sum_matched(report, reg)
+        report.select { |k, v| reg.match(k)}.values.sum
+      end
+
+      # for assert purpose
+      #
+      def gross(start_year, start_month, end_year = nil, end_month = nil,  code:  nil, date_range: nil, rows: 4, recursive: false)
+        if ! date_range.nil?
+          raise if date_range.class != Range
+          # TODO: date based range search
+        end
+
+        end_year ||= start_year
+        end_month ||= start_month
+        sum = { debit: {}, credit: {}, debit_count: {}, credit_count: {} }
+        idx_memo = []
+        term(start_year, start_month, end_year, end_month, code) do |f, _path|
+          CSV.new(f, headers: false, col_sep: "\t", encoding: 'UTF-8')
+            .each_with_index do |row, i|
+            break if i >= rows
+
+            case i
+            when 0
+              idx_memo = row.map(&:to_s)
+              next if code && idx_memo.select { |idx| /^#{code}/.match(idx) }.empty?
+
+              idx_memo.each do |r|
+                sum[:debit][r] ||= BigDecimal('0')
+                sum[:debit_count][r] ||= 0
+              end
+            when 1
+              next if code && idx_memo.select { |idx| /^#{code}/.match(idx) }.empty?
+
+              row.each_with_index do |r, j|
+                sum[:debit][idx_memo[j]] += BigDecimal(r.to_s)
+                sum[:debit_count][idx_memo[j]] += 1
+              end
+            when 2
+              idx_memo = row.map(&:to_s)
+              break if code && idx_memo.select { |idx| /^#{code}/.match(idx) }.empty?
+
+              idx_memo.each do |r|
+                sum[:credit][r] ||= BigDecimal('0')
+                sum[:credit_count][r] ||= 0
+              end
+            when 3
+              row.each_with_index do |r, j|
+                sum[:credit][idx_memo[j]] += BigDecimal(r.to_s)
+                sum[:credit_count][idx_memo[j]] += 1
+              end
+            else
+              puts row # for debug
+            end
+          end
+        end
+        return sum if code.nil?
+
+        codes = if recursive
+                  sum[:debit].keys.concat(sum[:credit].keys).uniq.select { |k| /^#{code}/.match(k) }
+                else
+                  Array(code)
+                end
+        res = { debit: 0, credit: 0, debit_count: 0, credit_count: 0 }
+        codes.each do |code|
+          res[:debit] += sum[:debit][code] || BigDecimal('0')
+          res[:credit] += sum[:credit][code] || BigDecimal('0')
+          res[:debit_count] += sum[:debit_count][code] || 0
+          res[:credit_count] += sum[:credit_count][code] || 0
+        end
+        res
+      end
+
+      # netting vouchers in specified term
+      #
+      def net(start_year, start_month, end_year = nil, end_month = nil, code: nil, date_range: nil)
+        g = gross(start_year, start_month, end_year, end_month, code: code, date_range: date_range)
+        idx = (g[:debit].keys + g[:credit].keys).uniq.sort
+        count = {}
+        diff = {}.tap do |sum|
+          idx.each do |code|
+            sum[code] = g.dig(:debit, code).nil? ? BigDecimal('0') : LucaBook::Util.calc_diff(g[:debit][code], code)
+            sum[code] -= g.dig(:credit, code).nil? ? BigDecimal('0') : LucaBook::Util.calc_diff(g[:credit][code], code)
+            count[code] = (g.dig(:debit_count, code) || 0) + (g.dig(:credit_count, code) || 0)
+          end
+        end
+        [diff, count]
+      end
+    end
+  end
+end

data/lib/luca_book/console.rb

@@ -49,7 +49,7 @@ class LucaBookConsole
           print "  " if h[:code].length > 3
         end
         puts cnsl_label(h[:label], h[:code])
-        h[:value].each_slice(6) do |v|
+        h[:amount].each_slice(6) do |v|
           puts "#{cnsl_fmt("", 14)} #{v.map{|v| cnsl_fmt(v, 14)}.join}"
         end
       end
@@ -72,13 +72,13 @@ class LucaBookConsole
     end
     convert_collection(report).each do |h|
       if /^[A-Z]/.match(h[:code])
-        total = [h[:value].inject(:+)] + Array.new(h[:value].length)
+        total = [h[:amount].inject(:+)] + Array.new(h[:amount].length)
         if /[^0]$/.match(h[:code])
           print "  "
           print "  " if h[:code].length > 3
         end
         puts cnsl_label(h[:label], h[:code])
-        h[:value].each_slice(6).with_index(0) do |v, i|
+        h[:amount].each_slice(6).with_index(0) do |v, i|
           puts "#{cnsl_fmt(total[i], 14)} #{v.map{|v| cnsl_fmt(v, 14)}.join}"
         end
       end
@@ -98,7 +98,7 @@ class LucaBookConsole
         end
       end
     }.sort.map do |k,v|
-      {code: k, label: @report.dict.dig(k, :label), value: v}
+      {code: k, label: @report.dict.dig(k, :label), amount: v}
     end
   end
 

data/lib/luca_book/dict.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
+require 'luca_support/code'
 require 'luca_support/config'
 require 'luca_record/dict'
+require 'luca_record/io'
+require 'luca_book'
 require 'date'
 require 'pathname'
 
 module LucaBook
   class Dict < LucaRecord::Dict
+    include Accumulator
+    include LucaRecord::IO
+
+    @dirname = 'journals'
+    @record_type = 'raw'
     # Column number settings for CSV/TSV convert
     #
     # :label
@@ -15,10 +23,10 @@ module LucaBook
     #   must be specified with label
     # :debit_label
     #   for double entry data
-    # * debit_value
+    # * debit_amount
     # :credit_label
     #   for double entry data
-    # * credit_value
+    # * credit_amount
     # :note
     #   can be the same column as another label
     #
@@ -41,8 +49,8 @@ module LucaBook
           end
         end
         config[:type] ||= 'invalid'
-        config[:debit_value] = @config['debit_value'].to_i if @config.dig('debit_value')
-        config[:credit_value] = @config['credit_value'].to_i if @config.dig('credit_value')
+        config[:debit_amount] = @config['debit_amount'].to_i if @config.dig('debit_amount')
+        config[:credit_amount] = @config['credit_amount'].to_i if @config.dig('credit_amount')
         config[:note] = @config['note'] if @config.dig('note')
         config[:encoding] = @config['encoding'] if @config.dig('encoding')
 
@@ -84,14 +92,93 @@ module LucaBook
       nil
     end
 
-    def self.latest_balance
-      dict_dir = Pathname(LucaSupport::Config::Pjdir) / 'data' / 'balance'
-      # TODO: search latest balance dictionary
-      load_tsv_dict(dict_dir / 'start.tsv')
+    # Find balance at financial year start by given date.
+    # If not found 'start-yyyy-mm-*.tsv', use 'start.tsv' as default.
+    #
+    def self.latest_balance(date)
+      load_tsv_dict(latest_balance_path(date))
+    end
+
+    def self.latest_balance_path(date)
+      start_year = date.month >= LucaSupport::CONFIG['fy_start'] ? date.year : date.year - 1
+      latest = Date.new(start_year, LucaSupport::CONFIG['fy_start'], 1).prev_month
+      dict_dir = Pathname(LucaSupport::PJDIR) / 'data' / 'balance'
+      fileglob = %Q(start-#{latest.year}-#{format("%02d", latest.month)}-*)
+      path = Dir.glob(fileglob, base: dict_dir)[0] || 'start.tsv'
+      dict_dir / path
     end
 
     def self.issue_date(obj)
       Date.parse(obj.dig('_date', :label))
     end
+
+    def self.generate_balance(year, month = nil)
+      start_date = Date.new((year.to_i - 1), LucaSupport::CONFIG['fy_start'], 1)
+      month ||= LucaSupport::CONFIG['fy_start'] - 1
+      end_date = Date.new(year.to_i, month, -1)
+      labels = load('base.tsv')
+      bs = load_balance(start_date, end_date)
+      fy_digest = checksum(start_date, end_date)
+      current_ref = gitref
+      csv = CSV.generate(String.new, col_sep: "\t", headers: false) do |f|
+        f << ['code', 'label', 'balance']
+        f << ['_date', end_date]
+        f << ['_digest', fy_digest]
+        f << ['_gitref', current_ref] if current_ref
+        bs.each do |code, balance|
+          next if LucaSupport::Code.readable(balance) == 0
+
+          f << [code, labels.dig(code, :label), LucaSupport::Code.readable(balance)]
+        end
+      end
+      dict_dir = Pathname(LucaSupport::PJDIR) / 'data' / 'balance'
+      filepath = dict_dir / "start-#{end_date.to_s}.tsv"
+
+      File.open(filepath, 'w') { |f| f.write csv }
+    end
+
+    def self.load_balance(start_date, end_date)
+      base = latest_balance(start_date).each_with_object({}) do |(k, v), h|
+        h[k] = BigDecimal(v[:balance].to_s) if v[:balance]
+      end
+
+      search_range = term_by_month(start_date, end_date)
+      bs = search_range.each_with_object(base) do |date, h|
+        net(date.year, date.month)[0].each do |code, amount|
+          next if /^[^1-9]/.match(code)
+
+          h[code] ||= BigDecimal('0')
+          h[code] += amount
+        end
+      end
+      bs['9142'] ||= BigDecimal('0')
+      bs['9142'] += LucaBook::State
+                     .range(start_date.year, start_date.month, end_date.year, end_date.month)
+                     .net_income
+      bs.sort
+    end
+
+    def self.checksum(start_date, end_date)
+      digest = update_digest(String.new, File.read(latest_balance_path(start_date)))
+      term_by_month(start_date, end_date)
+        .map { |date| dir_digest(date.year, date.month) }
+        .each { |month_digest| digest = update_digest(digest, month_digest) }
+      digest
+    end
+
+    def self.gitref
+      digest = `git rev-parse HEAD`
+      $?.exitstatus == 0 ? digest.strip : nil
+    end
+
+    def self.term_by_month(start_date, end_date)
+      Enumerator.new do |yielder|
+        each_month = start_date
+        while each_month <= end_date
+          yielder << each_month
+          each_month = each_month.next_month
+        end
+      end
+    end
   end
 end