lucadeal 0.2.23 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f3d23a1f082ee44833db42f3cf4dbdecc0d078ea3ca6499d5cf77e6d235580a
-  data.tar.gz: c2ea468ea064bb865d0b481d9717a03f11afe212f0bfd3b58ac43722116a95e7
+  metadata.gz: 0e4fa52c476838906c3ad849ab1bc4a9bf58926a526034553a90d6c6299d7945
+  data.tar.gz: c3e434b8677a0b502cfbef70dc8d936bbc2dd3d7f0be0b6b1e2edea8294baa2c
 SHA512:
-  metadata.gz: 545d6acb5b7837497c30d17a42c6a32611186f2e12f9821d116c9aa3ed9735dc1c8bc2c072d1439c9e21e1fd38d7398de770ffd9fd835352f4565f96a18a19ca
-  data.tar.gz: c8cf01067781332a241138ab9b253d282902a3838a19d2f9623d9eb29c6c4a3432e7d0e6818bc67a3e3b3e682e5ba3c4c5c128a90f93b3f91dcadca0285ea2f4
+  metadata.gz: ae66f02ef1861eeb9bf217dc5547b05bdd384a9d25bddd8d12dfd62ab2fea63e3f051c699dc267620488949659c98e772799d027dd27101b2d214b8517b55ba2
+  data.tar.gz: 5ec46b9f38cb9bfda178896e2319d728cd41df86d6fb389342a4e9759351e64608abe33980a7cf35e5a8f25459223521c9a69bf356dc61fad55d8cb83588cdda

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## LucaDeal 0.2.24
+
+* add `luca-deal invoices create --monthly --mail`, send payment list after monthly invoice creation.
+* add 'other_payments' tracking with no invoices.
+* can have limit on fee calculation.
+* initial implment of `luca-deal fee list`
+
 ## LucaDeal 0.2.23
 
 * implement `luca-deal invoices list --mail`: payment list via HTML mail

data/README.md

@@ -135,7 +135,7 @@ Fields for subscription customers are as bellows:
 | Top level | Second level  |          | historical | Description                                                                                          |
 |-----------|---------------|----------|------------|------------------------------------------------------------------------------------------------------|
 | terms     |               |          |            |                                                                                                      |
-|           | billing_cycle | optional |            | If 'monthly', invoices are generated on each month.                                                  |
+|           | billing_cycle | optional |            | If 'monthly', invoices are generated on each month. If 'other_payments', no_invoices are generated on each month. `no_invoices` are mostly same as invoices, but not sending email. |
 |           | category      | optional |            | Default: 'subscription'                                                                              |
 | products  |               |          |            | Array of products.                                                                                   |
 |           | id            |          |            | reference for Product                                                            |
@@ -154,6 +154,7 @@ 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. |
 | rate      |              | optional |            |                                                                                     |
 |           | default      |          |            | sales fee rate.                                                                     |
 |           | initial      |          |            | sales fee rate for items of type=initial.                                           |

data/exe/luca-deal

@@ -128,6 +128,10 @@ class LucaCmd
       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
+        if params[:mail]
+          LucaDeal::Invoice.new(date).stats_email
+        end
       else
         date = "#{args[1]}-#{args[2]}-#{args[3] || '1'}" if !args.empty?
         list = LucaDeal::Contract.id_completion(args[0] || '', label: 'customer_name')
@@ -335,6 +339,7 @@ when /invoices?/, 'i'
     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 }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.create(args, params)
     end

data/lib/luca_deal.rb

@@ -8,6 +8,7 @@ module LucaDeal
   autoload :Contract, 'luca_deal/contract'
   autoload :Fee, 'luca_deal/fee'
   autoload :Invoice, 'luca_deal/invoice'
+  autoload :NoInvoice, 'luca_deal/no_invoice'
   autoload :Product, 'luca_deal/product'
   autoload :Setup, 'luca_deal/setup'
 end

data/lib/luca_deal/fee.rb

@@ -25,23 +25,28 @@ module LucaDeal
 
         @rate = { 'default' => BigDecimal(contract.dig('rate', 'default')) }
         @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['customer'] = get_customer(contract['customer_id'])
         fee['issue_date'] = @date
         Invoice.asof(@date.year, @date.month) do |invoice|
           next if invoice.dig('sales_fee', 'id') != contract['id']
+          next if exceed_limit?(invoice, limit)
 
           invoice['items'].each do |item|
             rate = item['type'] == 'initial' ? @rate['initial'] : @rate['default']
-            fee['items'] << {
-              'invoice_id' => invoice['id'],
-              'customer_name' => invoice.dig('customer', 'name'),
-              'name' => item['name'],
-              'price' => item['price'],
-              'qty' => item['qty'],
-              'fee' => item['price'] * item['qty'] * rate
-            }
+            fee['items'] << fee_record(invoice, item, rate)
+          end
+          fee['sales_fee'] = subtotal(fee['items'])
+        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)
+
+          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'])
         end
@@ -93,6 +98,47 @@ module LucaDeal
       mail
     end
 
+    # Output seriarized fee data to stdout.
+    # Returns previous N months on multiple count
+    #
+    # === Example YAML output
+    #   ---
+    #   - records:
+    #     - customer: Example Co.
+    #       subtotal: 100000
+    #       tax: 10000
+    #       due: 2020-10-31
+    #       issue_date: '2020-09-30'
+    #     count: 1
+    #     total: 100000
+    #     tax: 10000
+    #
+    def stats(count = 1)
+      [].tap do |collection|
+        scan_date = @date.next_month
+        count.times do
+          scan_date = scan_date.prev_month
+          {}.tap do |stat|
+            stat['records'] = self.class.asof(scan_date.year, scan_date.month).map do |fee|
+              {
+                'customer' => fee.dig('customer', 'name'),
+                'client' => fee['items'].map{ |item| item.dig('customer_name') }.join(' / '),
+                'subtotal' => fee.dig('sales_fee', 'fee'),
+                'tax' => fee.dig('sales_fee', 'tax'),
+                'due' => fee.dig('due_date'),
+                'mail' => fee.dig('status')&.select { |a| a.keys.include?('mail_delivered') }&.first
+              }
+            end
+            stat['issue_date'] = scan_date.to_s
+            stat['count'] = stat['records'].count
+            stat['total'] = stat['records'].inject(0) { |sum, rec| sum + rec.dig('subtotal') }
+            stat['tax'] = stat['records'].inject(0) { |sum, rec| sum + rec.dig('tax') }
+            collection << readable(stat)
+          end
+        end
+      end
+    end
+
     def render_report(file_type = :html)
       case file_type
       when :html
@@ -174,11 +220,32 @@ module LucaDeal
       BigDecimal(take_current(CONFIG['tax_rate'], name).to_s)
     end
 
+    # Fees are unique contract_id in each month
+    # If update needed, remove the target fee file.
+    #
     def duplicated_contract?(id)
       self.class.asof(@date.year, @date.month, @date.day) do |_f, path|
         return true if path.include?(id)
       end
       false
     end
+
+    def fee_record(invoice, item, rate)
+      {
+        'invoice_id' => invoice['id'],
+        'customer_name' => invoice.dig('customer', 'name'),
+        'name' => item['name'],
+        'price' => item['price'],
+        'qty' => item['qty'],
+        'fee' => item['price'] * item['qty'] * rate
+      }
+    end
+
+    def exceed_limit?(invoice, limit)
+      return false if limit.nil?
+
+      contract_start = Contract.find(invoice['contract_id']).dig('terms', 'effective')
+      contract_start.next_month(limit).prev_day < @date
+    end
   end
 end

data/lib/luca_deal/invoice.rb

@@ -120,17 +120,23 @@ module LucaDeal
     #
     def stats_email
       {}.tap do |res|
-        stats(2).each.with_index(1) do |stat, i|
-          @issue_date = stat['issue_date'] if i == 1
+        stats(3).each.with_index(1) do |stat, i|
           stat['records'].each do |record|
             res[record['customer']] ||= {}
             res[record['customer']]['customer_name'] ||= record['customer']
             res[record['customer']]["amount#{i}"] ||= record['subtotal']
             res[record['customer']]["tax#{i}"] ||= record['tax']
           end
+          if i == 1
+            @issue_date = stat['issue_date']
+            @total_amount = stat['total']
+            @total_tax = stat['tax']
+            @total_count = stat['count']
+          end
         end
         @invoices = res.values
       end
+      @company = CONFIG.dig('company', 'name')
 
       mail = Mail.new
       mail.to = CONFIG.dig('mail', 'preview') || CONFIG.dig('mail', 'from')
@@ -167,9 +173,9 @@ module LucaDeal
       gen_invoice!(invoice_object(contract))
     end
 
-    def monthly_invoice
+    def monthly_invoice(target = 'monthly')
       Contract.new(@date.to_s).active do |contract|
-        next if contract.dig('terms', 'billing_cycle') != 'monthly'
+        next if contract.dig('terms', 'billing_cycle') != target
         # TODO: provide another I/F for force re-issue if needed
         next if duplicated_contract? contract['id']
 

data/lib/luca_deal/no_invoice.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'luca_deal/invoice'
+
+module LucaDeal #:nodoc:
+  # Invoice compatible transactions for other payment methods.
+  #
+  class NoInvoice < Invoice
+    @dirname = 'no_invoices'
+
+    def monthly_invoice
+      super('other_payments')
+    end
+
+    # Override not to send mail to customer.
+    #
+    def deliver_mail(attachment_type = nil, mode: nil)
+    end
+  end
+end

data/lib/luca_deal/setup.rb

@@ -12,7 +12,7 @@ module LucaDeal
         FileUtils.cp("#{__dir__}/templates/config.yml", 'config.yml') unless File.exist?('config.yml')
         Dir.mkdir('data') unless Dir.exist?('data')
         Dir.chdir('data') do
-          %w[contracts customers invoices].each do |subdir|
+          %w[contracts customers invoices no_invoices].each do |subdir|
             Dir.mkdir(subdir) unless Dir.exist?(subdir)
           end
         end

data/lib/luca_deal/templates/monthly-payment-list.html.erb

@@ -3,37 +3,51 @@
         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
         <style>
-         td { text-align: right; line-height: 2em; min-width: 7em }
+         td { text-align: right; line-height: 2em; min-width: 6em }
          thead th, thead td { text-align: center }
+         thead { border-bottom: solid 1px #aaa }
+         tr#total { border-top: solid 1px #aaa }
          tr.sub { font-size: .8em; color: #aaa }
+         .past { color: #777 }
         </style>
     </head>
     <body>
+        <div style="margin: 1em 0"><%= @company %></div>
         <div style="margin: 1em 0">Issue date: <%= @issue_date %></div>
         <table>
             <thead>
                 <tr>
                     <th>#</th>
                     <th>Customer</th>
-                    <th>Amount</th><th>Tax</th>
-                    <th>Amount</th><th>Tax</th>
+                    <th>This month</th>
+                    <th>Last Month</th>
+                    <th>2 Month ago</th>
                 </tr>
                 <tr class="sub">
                     <th></th>
                     <th></th>
-                    <th>This month</th><th>This month</th>
-                    <th>Last Month</th><th>Last Month</th>
+                    <th>Amount / Tax</th>
+                    <th class="past">Amount / Tax</th>
+                    <th class="past">Amount / Tax</th>
                 </tr>
             </thead>
             <tbody>
                 <% @invoices.each.with_index(1) do |invoice, i| %>
                     <tr>
-                        <td><%= i %></td>
+                        <th><%= i %></th>
                         <td><%= invoice["customer_name"] %></td>
-                        <td><%= invoice["amount1"] %></td><td><%= invoice["tax1"] %></td>
-                        <td><%= invoice["amount2"] %></td><td><%= invoice["tax2"] %></td>
+                        <td><%= delimit_num(invoice["amount1"]) %><br /><%= delimit_num(invoice["tax1"]) %></td>
+                        <td class="past"><%= delimit_num(invoice["amount2"]) %><br /><%= delimit_num(invoice["tax2"]) %></td>
+                        <td class="past"><%= delimit_num(invoice["amount3"]) %><br /><%= delimit_num(invoice["tax3"]) %></td>
                     </tr>
                 <% end %>
+                <tr id="total">
+                    <td></td>
+                    <td>Total (<%= @total_count %> records)</td>
+                    <td><%= delimit_num(@total_amount) %><br /><%= delimit_num(@total_tax) %></td>
+                    <td></td>
+                    <td></td>
+                </tr>
             </tbody>
         </table>
     </body>

data/lib/luca_deal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.23
+  version: 0.2.24
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-31 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -85,6 +85,7 @@ files:
 - lib/luca_deal/customer.rb
 - lib/luca_deal/fee.rb
 - lib/luca_deal/invoice.rb
+- lib/luca_deal/no_invoice.rb
 - lib/luca_deal/product.rb
 - lib/luca_deal/setup.rb
 - lib/luca_deal/templates/.keep