lucabook 0.2.23 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866a73f9e372f2ac755ed301c9e9b88bebb556b53a5ffd604391c45eda927653
-  data.tar.gz: 41b02c0e5c567dbfedf37fe4148d11270a0f8776c6fcc78f630354e281aad5d3
+  metadata.gz: 55e730a696b4537183e9a298cff7d715c2a93dfa22fabc10cc889fd18c72b1a1
+  data.tar.gz: f5e579c528ad978533f7df60eed6b4a494dd723a4fdef15180622737fd9be32a
 SHA512:
-  metadata.gz: 1f295b8ab521f4b95c81ec57c57579ebf87ae01c3f1acf2fbc564bf076731d1b1d089e0959660752529e190eecfa3e107ee184b6f91484f9bdc61977eda80886
-  data.tar.gz: '0820bc3b42bfd48b0cf8f2924774acc8887c6fda373ec71fcebab5152b46e292096b68f174ac643613fda4ef72dc62a79300b4fa82e306d144f2fe404a770213'
+  metadata.gz: 607110ed2c686b35c1be749b16bd6f4c0827450e55277d44c62ddb5acfb06fbb67d601c9fe475c453f5999afa23a1bf83923d7251ba72a7a24267e0cfc8b4057
+  data.tar.gz: d8fe5540370bc81494847b5f9d975667d19bda4e7979fc852556e81b2adbd644b87ca11bdf7601334454cfe545070698e0e20570895fd2e0eb4bb790eea19711

data/exe/luca-book

@@ -39,6 +39,15 @@ class LucaCmd
         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
@@ -107,6 +116,16 @@ 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'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-book journals stats [options] [YYYY M]'

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

@@ -15,10 +15,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 +41,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')
 

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,13 +1,21 @@
-#
-# 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
@@ -41,20 +49,22 @@ module LucaBook
       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'], 'value'))
-      credit_amount = LucaSupport::Code.decimalize(serialize_on_key(d['credit'], 'value'))
+      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')
 
-      csv = CSV.generate('', col_sep: "\t", headers: false) 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|
+        ACCEPTED_HEADERS.each do |x_header|
           f << [x_header, d['headers'][x_header]] if d.dig('headers', x_header)
         end
         f << []
@@ -62,6 +72,19 @@ module LucaBook
       end
     end
 
+    # Set accepted header with key/value
+    #
+    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
+      end
+    end
+
     def self.update_codes(obj)
       debit_code = serialize_on_key(obj[:debit], :code)
       credit_code = serialize_on_key(obj[:credit], :code)
@@ -73,15 +96,15 @@ module LucaBook
       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
@@ -90,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|

data/lib/luca_book/list.rb

@@ -7,11 +7,12 @@ 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'
+    attr_reader :data
 
     def initialize(data, start_date, code = nil)
       @data = data
@@ -31,6 +32,16 @@ module LucaBook
       new data, Date.new(from_year.to_i, from_month.to_i, 1), code
     end
 
+    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
       calc_code
       convert_label

data/lib/luca_book/list_by_header.rb

@@ -7,9 +7,9 @@ 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 ListByHeader < LucaBook::Journal
     @dirname = 'journals'
 

data/lib/luca_book/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucaBook
-  VERSION = '0.2.23'
+  VERSION = '0.2.24'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucabook
 version: !ruby/object:Gem::Version
-  version: 0.2.23
+  version: 0.2.24
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Book keep