lucadeal 0.2.24 → 0.2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4fa52c476838906c3ad849ab1bc4a9bf58926a526034553a90d6c6299d7945
-  data.tar.gz: c3e434b8677a0b502cfbef70dc8d936bbc2dd3d7f0be0b6b1e2edea8294baa2c
+  metadata.gz: 68b497e68738101eafbfe6eab73c3e0cf8d297cf4676ccfb8cd05efdadc273a3
+  data.tar.gz: fb8ed0c2d5eb0f7621c4436ddad91ece16aa723f2861ecd661423802ec01d0c4
 SHA512:
-  metadata.gz: ae66f02ef1861eeb9bf217dc5547b05bdd384a9d25bddd8d12dfd62ab2fea63e3f051c699dc267620488949659c98e772799d027dd27101b2d214b8517b55ba2
-  data.tar.gz: 5ec46b9f38cb9bfda178896e2319d728cd41df86d6fb389342a4e9759351e64608abe33980a7cf35e5a8f25459223521c9a69bf356dc61fad55d8cb83588cdda
+  metadata.gz: 5c8941a80f26d67b4855f2757e00f8241dd0b73f37f0fe2ab8799500388118bec4513fcb398116ba8072889bedf97a083fbb2c4ce3fdd4219cb7a15844785b1c
+  data.tar.gz: 91a84225d3d46201f85e9e38bbedbc102b2a3aaf2ccbf0a812db56bc3b502b78b7f89cb4087ec09642db5ff49b4abe58c15f6632bcbee18d471e95f3c1ff2a20

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## LucaDeal 0.2.25
+
+* implement deduction rate for fee calculation.
+* implement `luca-deal fee export`
+* refine export label for luca-book compatibility
+* add `luca-deal invoice create --monthly --with-fee` option.
+* preview_mail can deliver regardless of `mail_delivered` status
+* `luca-deal fee mail` skip no item record by default.
+
 ## LucaDeal 0.2.24
 
 * add `luca-deal invoices create --monthly --mail`, send payment list after monthly invoice creation.

data/README.md

@@ -155,9 +155,11 @@ Fields for sales fee are as bellows:
 | terms     |              |          |            |                                                                                     |
 |           | category     |          |            | If 'sales_fee', contract is treated as selling commission. |
 |           | limit |          |            | If set, fees are calculated as mas as `limit` months. |
+|           | deduction_label |          |            | Label for deduction. Used on export |
 | rate      |              | optional |            |                                                                                     |
 |           | default      |          |            | sales fee rate.                                                                     |
 |           | initial      |          |            | sales fee rate for items of type=initial.                                           |
+|           | deduction |          |            | deduction rate(if any) multiplied by fee    |
 
 
 ### Invoice

data/exe/luca-deal

@@ -124,11 +124,12 @@ class LucaCmd
 
   class Invoice < LucaCmd
     def self.create(args = nil, params = {})
-      case params['mode']
+      case params[:mode]
       when 'monthly'
         date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
         LucaDeal::Invoice.new(date).monthly_invoice
         LucaDeal::NoInvoice.new(date).monthly_invoice
+        LucaDeal::Fee.new(date).monthly_fee if params[:fee]
         if params[:mail]
           LucaDeal::Invoice.new(date).stats_email
         end
@@ -198,7 +199,7 @@ class LucaCmd
 
   class Fee < LucaCmd
     def self.create(args = nil, params = {})
-      case params['mode']
+      case params[:mode]
       when 'monthly'
         date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
         LucaDeal::Fee.new(date).monthly_fee
@@ -217,6 +218,15 @@ class LucaCmd
       end
     end
 
+    def self.export(args = nil, _params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaDeal::Fee.new(args.join('-')).export_json
+      else
+        LucaDeal::Fee.new.export_json
+      end
+    end
+
     def self.list(args = nil, params = {})
       date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
       if args.empty?
@@ -338,8 +348,9 @@ when /invoices?/, 'i'
   when 'create'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal invoices create [options] --monthly|contract_id year month [date]'
-      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
       opt.on('--mail', 'send payment list by email. Only works with --monthly') { |_v| params[:mail] = true }
+      opt.on('--monthly', 'generate monthly data') { |_v| params[:mode] = 'monthly' }
+      opt.on('--with-fee', 'generate sales fee data after monthly invoice creation') { |_v| params[:fee] = true }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.create(args, params)
     end
@@ -385,12 +396,14 @@ when /fee/
   when 'create'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal fee create [options] year month [date]'
-      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
+      opt.on('--monthly', 'generate monthly data') { |_v| params[:mode] = 'monthly' }
       args = opt.parse(ARGV)
       LucaCmd::Fee.create(args, params)
     end
   when 'delete'
     LucaCmd::Fee.delete(ARGV)
+  when 'export'
+    LucaCmd::Fee.export(ARGV)
   when 'list'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal fee list [options] year month [date]'
@@ -424,6 +437,7 @@ else
   puts '        customers'
   puts '        contracts'
   puts '        invoices'
+  puts '        fee'
   puts '        new: initialize project dir'
   puts '        export: puts invoice data for LucaBook import'
   exit 1

data/lib/luca_deal/contract.rb

@@ -69,11 +69,11 @@ module LucaDeal
     end
 
     def active_period?(dat)
-      unless dat.dig('defunct').nil?
-        defunct = dat.dig('defunct').respond_to?(:year) ? dat.dig('defunct') : Date.parse(dat.dig('defunct'))
+      unless dat['defunct'].nil?
+        defunct = dat['defunct'].respond_to?(:year) ? dat['defunct'] : Date.parse(dat['defunct'])
         return false if @date > defunct
       end
-      effective = dat.dig('effective').respond_to?(:year) ? dat.dig('effective') : Date.parse(dat.dig('effective'))
+      effective = dat['effective'].respond_to?(:year) ? dat['effective'] : Date.parse(dat['effective'])
       @date >= effective
     end
 

data/lib/luca_deal/fee.rb

@@ -1,6 +1,7 @@
 require 'luca_deal/version'
 
 require 'mail'
+require 'json'
 require 'yaml'
 require 'pathname'
 require 'bigdecimal'
@@ -27,7 +28,16 @@ module LucaDeal
         @rate['initial'] = contract.dig('rate', 'initial') ? BigDecimal(contract.dig('rate', 'initial')) : @rate['default']
         limit = contract.dig('terms', 'limit')
 
-        fee = { 'contract_id' => contract['id'], 'items' => [] }
+        fee = {
+          'contract_id' => contract['id'],
+          'items' => [],
+          'sales_fee' => {
+            'fee' => 0,
+            'tax' => 0,
+            'deduction' => 0,
+            'deduction_label' => contract.dig('terms', 'deduction_label')
+          }
+        }
         fee['customer'] = get_customer(contract['customer_id'])
         fee['issue_date'] = @date
         Invoice.asof(@date.year, @date.month) do |invoice|
@@ -38,33 +48,36 @@ module LucaDeal
             rate = item['type'] == 'initial' ? @rate['initial'] : @rate['default']
             fee['items'] << fee_record(invoice, item, rate)
           end
-          fee['sales_fee'] = subtotal(fee['items'])
+          subtotal(fee['items']).each{ |k, v| fee['sales_fee'][k] += v }
         end
         NoInvoice.asof(@date.year, @date.month) do |no_invoice|
           next if no_invoice.dig('sales_fee', 'id') != contract['id']
-          next if exceed_limit?(invoice, limit)
+          next if exceed_limit?(no_invoice, limit)
 
           no_invoice['items'].each do |item|
             rate = item['type'] == 'initial' ? @rate['initial'] : @rate['default']
             fee['items'] << fee_record(no_invoice, item, rate)
           end
-          fee['sales_fee'] = subtotal(fee['items'])
+          subtotal(fee['items']).each{ |k, v| fee['sales_fee'][k] += v }
         end
+        deduction_rate = contract.dig('rate', 'deduction')
+        fee['sales_fee']['deduction'] = -1 * (fee['sales_fee']['fee'] * deduction_rate).floor if deduction_rate
         self.class.create(fee, date: @date, codes: Array(contract['id']))
       end
     end
 
-    def deliver_mail(attachment_type = nil, mode: nil)
+    def deliver_mail(attachment_type = nil, mode: nil, skip_no_item: true)
       attachment_type = CONFIG.dig('fee', 'attachment') || :html
       fees = self.class.asof(@date.year, @date.month)
       raise "No report for #{@date.year}/#{@date.month}" if fees.count.zero?
 
       fees.each do |dat, path|
         next if has_status?(dat, 'mail_delivered')
+        next if skip_no_item && dat['items'].empty?
 
         mail = compose_mail(dat, mode: mode, attachment: attachment_type.to_sym)
         LucaSupport::Mail.new(mail, PJDIR).deliver
-        self.class.add_status!(path, 'mail_delivered')
+        self.class.add_status!(path, 'mail_delivered') if mode.nil?
       end
     end
 
@@ -88,7 +101,7 @@ module LucaDeal
 
       mail = Mail.new
       mail.to = dat.dig('customer', 'to') if mode.nil?
-      mail.subject = CONFIG.dig('invoice', 'mail_subject') || 'Your Report is available'
+      mail.subject = CONFIG.dig('fee', 'mail_subject') || 'Your Report is available'
       if mode == :preview
         mail.cc = CONFIG.dig('mail', 'preview') || CONFIG.dig('mail', 'from')
         mail.subject = '[preview] ' + mail.subject
@@ -139,6 +152,35 @@ module LucaDeal
       end
     end
 
+    def export_json
+      labels = export_labels
+      [].tap do |res|
+        self.class.asof(@date.year, @date.month) do |dat|
+          item = {}
+          item['date'] = dat['issue_date']
+          item['debit'] = []
+          item['credit'] = []
+          sub = dat['sales_fee']
+          if readable(sub['fee']) != 0
+            item['debit'] << { 'label' => labels[:debit][:fee], 'amount' => readable(sub['fee']) }
+            item['credit'] << { 'label' => labels[:credit][:fee], 'amount' => readable(sub['fee']) }
+          end
+          if readable(sub['tax']) != 0
+            item['debit'] << { 'label' => labels[:debit][:tax], 'amount' => readable(sub['tax']) }
+            item['credit'] << { 'label' => labels[:credit][:tax], 'amount' => readable(sub['tax']) }
+          end
+          if readable(sub['deduction']) != 0
+            item['debit'] << { 'label' => labels[:debit][:deduction], 'amount' => readable(sub['deduction'] * -1) }
+            item['credit'] << { 'label' => sub['deduction_label'] || labels[:credit][:deduction], 'amount' => readable(sub['deduction'] * -1) }
+          end
+          item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
+          item['x-editor'] = 'LucaDeal'
+          res << item
+        end
+        puts JSON.dump(res)
+      end
+    end
+
     def render_report(file_type = :html)
       case file_type
       when :html
@@ -173,13 +215,32 @@ module LucaDeal
       @sales_fee = readable(fee_dat['sales_fee'])
       @issue_date = fee_dat['issue_date']
       @due_date = fee_dat['due_date']
-      @amount = readable(fee_dat['sales_fee'].inject(0) { |sum, (_k, v)| sum + v })
+      @amount = readable(fee_dat['sales_fee']
+                           .reject{ |k, _v| k == 'deduction_label' }
+                           .inject(0) { |sum, (_k, v)| sum + v })
     end
 
     def lib_path
       __dir__
     end
 
+    # TODO: load labels from CONFIG before country defaults
+    #
+    def export_labels
+      case CONFIG['country']
+      when 'jp'
+        {
+          debit: { fee: '支払手数料', tax: '支払手数料', deduction: '未払費用' },
+          credit: { fee: '未払費用', tax: '未払費用', deduction: '雑収入' }
+        }
+      else
+        {
+          debit: { fee: 'Fees and commisions', tax: 'Fees and commisions', deduction: 'Accounts payable - other' },
+          credit: { fee: 'Accounts payable - other', tax: 'Accounts payable - other', deduction: 'Miscellaneous income' }
+        }
+      end
+    end
+
     # load user company profile from config.
     #
     def set_company
@@ -201,6 +262,11 @@ module LucaDeal
       end
     end
 
+    def attachment_name(dat, type)
+      id = %r{/}.match(dat['id']) ? dat['id'].gsub('/', '') : dat['id'][0, 7]
+      "feereport-#{id}.#{type}"
+    end
+
     def issue_date(date)
       base =  date.nil? ? Date.today : Date.parse(date)
       Date.new(base.year, base.month, -1)

data/lib/luca_deal/invoice.rb

@@ -20,21 +20,23 @@ module LucaDeal
     end
 
     def deliver_mail(attachment_type = nil, mode: nil)
-      attachment_type = CONFIG.dig('invoice', 'attachment') || :html
       invoices = self.class.asof(@date.year, @date.month)
       raise "No invoice for #{@date.year}/#{@date.month}" if invoices.count.zero?
 
       invoices.each do |dat, path|
         next if has_status?(dat, 'mail_delivered')
 
-        mail = compose_mail(dat, mode: mode, attachment: attachment_type.to_sym)
-        LucaSupport::Mail.new(mail, PJDIR).deliver
-        self.class.add_status!(path, 'mail_delivered')
+        deliver_one(dat, path, mode: mode, attachment_type: attachment_type)
       end
     end
 
     def preview_mail(attachment_type = nil)
-      deliver_mail(attachment_type, mode: :preview)
+      invoices = self.class.asof(@date.year, @date.month)
+      raise "No invoice for #{@date.year}/#{@date.month}" if invoices.count.zero?
+
+      invoices.each do |dat, path|
+        deliver_one(dat, path, mode: :preview, attachment_type: attachment_type)
+      end
     end
 
     # Render HTML to console
@@ -146,6 +148,7 @@ module LucaDeal
     end
 
     def export_json
+      labels = export_labels
       [].tap do |res|
         self.class.asof(@date.year, @date.month) do |dat|
           item = {}
@@ -153,10 +156,14 @@ module LucaDeal
           item['debit'] = []
           item['credit'] = []
           dat['subtotal'].map do |sub|
-            item['debit'] << { 'label' => '売掛金', 'amount' => readable(sub['items']) }
-            item['debit'] << { 'label' => '売掛金', 'amount' => readable(sub['tax']) }
-            item['credit'] << { 'label' => '売上高', 'amount' => readable(sub['items']) }
-            item['credit'] << { 'label' => '売上高', 'amount' => readable(sub['tax']) }
+            if readable(sub['items']) != 0
+              item['debit'] << { 'label' => labels[:debit][:items], 'amount' => readable(sub['items']) }
+              item['credit'] << { 'label' => labels[:credit][:items], 'amount' => readable(sub['items']) }
+            end
+            if readable(sub['tax']) != 0
+              item['debit'] << { 'label' => labels[:debit][:tax], 'amount' => readable(sub['tax']) }
+              item['credit'] << { 'label' => labels[:credit][:tax], 'amount' => readable(sub['tax']) }
+            end
           end
           item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
           item['x-editor'] = 'LucaDeal'
@@ -257,10 +264,34 @@ module LucaDeal
       @amount = readable(invoice_dat['subtotal'].inject(0) { |sum, i| sum + i['items'] + i['tax'] })
     end
 
+    def deliver_one(invoice, path, mode: nil, attachment_type: nil)
+      attachment_type ||= CONFIG.dig('invoice', 'attachment') || :html
+      mail = compose_mail(invoice, mode: mode, attachment: attachment_type.to_sym)
+      LucaSupport::Mail.new(mail, PJDIR).deliver
+      self.class.add_status!(path, 'mail_delivered') if mode.nil?
+    end
+
     def lib_path
       __dir__
     end
 
+    # TODO: load labels from CONFIG before country defaults
+    #
+    def export_labels
+      case CONFIG['country']
+      when 'jp'
+        {
+          debit: { items: '売掛金', tax: '売掛金' },
+          credit: { items: '売上高', tax: '売上高' }
+        }
+      else
+        {
+          debit: { items: 'Accounts receivable - trade', tax: 'Accounts receivable - trade' },
+          credit: { items: 'Amount of Sales', tax: 'Amount of Sales' }
+        }
+      end
+    end
+
     # load user company profile from config.
     #
     def set_company

data/lib/luca_deal/templates/fee-report.html.erb

@@ -39,9 +39,13 @@
                         <td class="price" colspan="3">Tax</td>
                         <td class="price"><%= delimit_num( @sales_fee['tax'] ) %></td>
                     </tr>
+                    <tr>
+                        <td class="price" colspan="3">Deduction</td>
+                        <td class="price"><%= delimit_num( @sales_fee['deduction'] ) %></td>
+                    </tr>
                     <tr>
                         <td class="price" colspan="3">Total</td>
-                        <td class="price"><%= delimit_num( @sales_fee['fee'] + @sales_fee['tax'] ) %></td>
+                        <td class="price"><%= delimit_num(@sales_fee['fee'] + @sales_fee['tax'] + @sales_fee['deduction']) %></td>
                     </tr>
         </table>
 

data/lib/luca_deal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 0.2.25
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord