lucadeal 0.2.18 → 0.2.24

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/contract.rb

@@ -43,8 +43,18 @@ module LucaDeal
       end
     end
 
+    def describe(id)
+      contract = parse_current(self.class.find(id))
+      if contract['products']
+        contract['products'] = contract['products'].map do |product|
+          Product.find(product['id'])
+        end
+      end
+      readable(contract)
+    end
+
     def generate!(customer_id, mode = 'subscription')
-      LucaDeal::Customer.find(customer_id) do |customer|
+      Customer.find(customer_id) do |customer|
         current_customer = parse_current(customer)
         if mode == 'sales_fee'
           obj = salesfee_template

data/lib/luca_deal/customer.rb

@@ -12,14 +12,27 @@ module LucaDeal
     @dirname = 'customers'
     @required = ['name']
 
-    def initialize(pjdir = nil)
+    def initialize
       @date = Date.today
-      @pjdir = pjdir || Dir.pwd
     end
 
     def list_name
-      list = self.class.all.map { |dat| parse_current(dat) }
-      YAML.dump(list).tap { |l| puts l }
+      self.class.all.map { |dat| parse_current(dat).sort.to_h }
+    end
+
+    def describe(id)
+      customer = parse_current(self.class.find(id))
+      contracts = Contract.all.select { |contract| contract['customer_id'] == customer['id'] }
+      if !contracts.empty?
+        customer['contracts'] = contracts.map do |c|
+          {
+            'id' => c['id'],
+            'effective' => c['terms']['effective'],
+            'defunct' => c['terms']['defunct']
+          }
+        end
+      end
+      readable(customer)
     end
 
     def self.create(obj)

data/lib/luca_deal/fee.rb

@@ -14,40 +14,145 @@ module LucaDeal
 
     def initialize(date = nil)
       @date = issue_date(date)
-      @config = load_config('config.yml')
     end
 
     # calculate fee, based on invoices
     #
     def monthly_fee
-      LucaDeal::Contract.asof(@date.year, @date.month, @date.day) do |contract|
+      Contract.asof(@date.year, @date.month, @date.day) do |contract|
         next if contract.dig('terms', 'category') != 'sales_fee'
+        next if duplicated_contract? contract['id']
 
         @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')
 
-        LucaDeal::Invoice.asof(@date.year, @date.month) do |invoice|
+        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 duplicated_contract? invoice['contract_id']
+          next if exceed_limit?(invoice, limit)
 
-          fee = invoice.dup
-          fee['invoice'] = {}.tap do |f_invoice|
-            %w[id contract_id issue_date due_date].each do |i|
-              f_invoice[i] = invoice[i]
-              fee.delete i
+          invoice['items'].each do |item|
+            rate = item['type'] == 'initial' ? @rate['initial'] : @rate['default']
+            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
+        self.class.create(fee, date: @date, codes: Array(contract['id']))
+      end
+    end
+
+    def deliver_mail(attachment_type = nil, mode: nil)
+      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')
+
+        mail = compose_mail(dat, mode: mode, attachment: attachment_type.to_sym)
+        LucaSupport::Mail.new(mail, PJDIR).deliver
+        self.class.add_status!(path, 'mail_delivered')
+      end
+    end
+
+    def preview_mail(attachment_type = nil)
+      deliver_mail(attachment_type, mode: :preview)
+    end
+
+    # Render HTML to console
+    #
+    def preview_stdout
+      self.class.asof(@date.year, @date.month) do |dat, _|
+        @company = set_company
+        fee_vars(dat)
+        puts render_report
+      end
+    end
+
+    def compose_mail(dat, mode: nil, attachment: :html)
+      @company = set_company
+      fee_vars(dat)
+
+      mail = Mail.new
+      mail.to = dat.dig('customer', 'to') if mode.nil?
+      mail.subject = CONFIG.dig('invoice', 'mail_subject') || 'Your Report is available'
+      if mode == :preview
+        mail.cc = CONFIG.dig('mail', 'preview') || CONFIG.dig('mail', 'from')
+        mail.subject = '[preview] ' + mail.subject
+      end
+      mail.text_part = Mail::Part.new(body: render_erb(search_template('fee-report-mail.txt.erb')), charset: 'UTF-8')
+      mail.attachments[attachment_name(dat, attachment)] = render_report(attachment)
+      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
-          fee['id'] = issue_random_id
-          fee['customer'].delete('to')
-          fee['sales_fee'].merge! subtotal(fee['items'])
-          gen_fee!(fee)
         end
       end
     end
 
+    def render_report(file_type = :html)
+      case file_type
+      when :html
+        render_erb(search_template('fee-report.html.erb'))
+      when :pdf
+        erb2pdf(search_template('fee-report.html.erb'))
+      else
+        raise 'This filetype is not supported.'
+      end
+    end
+
     def get_customer(id)
       {}.tap do |res|
-        LucaDeal::Customer.find(id) do |dat|
+        Customer.find(id) do |dat|
           customer = parse_current(dat)
           res['id'] = customer['id']
           res['name'] = customer.dig('name')
@@ -58,13 +163,19 @@ module LucaDeal
       end
     end
 
-    def gen_fee!(fee)
-      id = fee.dig('invoice', 'contract_id')
-      self.class.create(fee, date: @date, codes: Array(id))
-    end
-
     private
 
+    # set variables for ERB template
+    #
+    def fee_vars(fee_dat)
+      @customer = fee_dat['customer']
+      @items = readable(fee_dat['items'])
+      @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 })
+    end
+
     def lib_path
       __dir__
     end
@@ -73,25 +184,20 @@ module LucaDeal
     #
     def set_company
       {}.tap do |h|
-        h['name'] = @config.dig('company', 'name')
-        h['address'] = @config.dig('company', 'address')
-        h['address2'] = @config.dig('company', 'address2')
+        h['name'] = CONFIG.dig('company', 'name')
+        h['address'] = CONFIG.dig('company', 'address')
+        h['address2'] = CONFIG.dig('company', 'address2')
       end
     end
 
     # calc fee & tax amount by tax category
     #
     def subtotal(items)
-      {}.tap do |subtotal|
+      { 'fee' => 0, 'tax' => 0 }.tap do |subtotal|
         items.each do |i|
-          rate = i.dig('type') || 'default'
-          subtotal[rate] = { 'fee' => 0, 'tax' => 0 } if subtotal.dig(rate).nil?
-          subtotal[rate]['fee'] += i['qty'] * i['price'] * @rate[rate]
-        end
-        subtotal.each do |rate, amount|
-          amount['tax'] = (amount['fee'] * load_tax_rate(rate)).to_i
-          amount['fee'] = amount['fee'].to_i
+          subtotal['fee'] += i['fee']
         end
+        subtotal['tax'] = (subtotal['fee'] * load_tax_rate('default')).to_i
       end
     end
 
@@ -100,19 +206,46 @@ module LucaDeal
       Date.new(base.year, base.month, -1)
     end
 
+    # TODO: support due_date variation
+    def due_date(date)
+      next_month = date.next_month
+      Date.new(next_month.year, next_month.month, -1)
+    end
+
     # load Tax Rate from config.
     #
     def load_tax_rate(name)
-      return 0 if @config.dig('tax_rate', name).nil?
+      return 0 if CONFIG.dig('tax_rate', name).nil?
 
-      BigDecimal(take_current(@config['tax_rate'], name).to_s)
+      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

@@ -17,26 +17,33 @@ module LucaDeal
 
     def initialize(date = nil)
       @date = issue_date(date)
-      @pjdir = Pathname(LucaSupport::Config::Pjdir)
-      @config = load_config(@pjdir / 'config.yml')
     end
 
-    def deliver_mail
-      attachment_type = @config.dig('invoice', 'attachment') || :html
-      self.class.asof(@date.year, @date.month) do |dat, path|
+    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, attachment: attachment_type.to_sym)
-        LucaSupport::Mail.new(mail, @pjdir).deliver
+        mail = compose_mail(dat, mode: mode, attachment: attachment_type.to_sym)
+        LucaSupport::Mail.new(mail, PJDIR).deliver
         self.class.add_status!(path, 'mail_delivered')
       end
     end
 
     def preview_mail(attachment_type = nil)
-      attachment_type ||= @config.dig('invoice', 'attachment') || :html
-      self.class.asof(@date.year, @date.month) do |dat, _path|
-        mail = compose_mail(dat, mode: :preview, attachment: attachment_type.to_sym)
-        LucaSupport::Mail.new(mail, @pjdir).deliver
+      deliver_mail(attachment_type, mode: :preview)
+    end
+
+    # Render HTML to console
+    #
+    def preview_stdout
+      self.class.asof(@date.year, @date.month) do |dat, _|
+        @company = set_company
+        invoice_vars(dat)
+        puts render_invoice
       end
     end
 
@@ -46,20 +53,27 @@ module LucaDeal
 
       mail = Mail.new
       mail.to = dat.dig('customer', 'to') if mode.nil?
-      mail.subject = @config.dig('invoice', 'mail_subject') || 'Your Invoice is available'
+      mail.subject = CONFIG.dig('invoice', 'mail_subject') || 'Your Invoice is available'
       if mode == :preview
-        mail.cc = @config.dig('mail', 'preview') || @config.dig('mail', 'from')
+        mail.cc = CONFIG.dig('mail', 'preview') || CONFIG.dig('mail', 'from')
         mail.subject = '[preview] ' + mail.subject
       end
       mail.text_part = Mail::Part.new(body: render_erb(search_template('invoice-mail.txt.erb')), charset: 'UTF-8')
-      if attachment == :html
-        mail.attachments[attachment_name(dat, attachment)] = render_erb(search_template('invoice.html.erb'))
-      elsif attachment == :pdf
-        mail.attachments[attachment_name(dat, attachment)] = erb2pdf(search_template('invoice.html.erb'))
-      end
+      mail.attachments[attachment_name(dat, attachment)] = render_invoice(attachment)
       mail
     end
 
+    def render_invoice(file_type = :html)
+      case file_type
+      when :html
+        render_erb(search_template('invoice.html.erb'))
+      when :pdf
+        erb2pdf(search_template('invoice.html.erb'))
+      else
+        raise 'This filetype is not supported.'
+      end
+    end
+
     # Output seriarized invoice data to stdout.
     # Returns previous N months on multiple count
     #
@@ -88,18 +102,47 @@ module LucaDeal
                 'customer' => invoice.dig('customer', 'name'),
                 'subtotal' => amount,
                 'tax' => tax,
-                'due' => invoice.dig('due_date')
+                'due' => invoice.dig('due_date'),
+                'mail' => invoice.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 << stat
+            collection << readable(stat)
+          end
+        end
+      end
+    end
+
+    # send payment list to preview address or from address.
+    #
+    def stats_email
+      {}.tap do |res|
+        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
-        puts YAML.dump(LucaSupport::Code.readable(collection))
+        @invoices = res.values
       end
+      @company = CONFIG.dig('company', 'name')
+
+      mail = Mail.new
+      mail.to = CONFIG.dig('mail', 'preview') || CONFIG.dig('mail', 'from')
+      mail.subject = 'Check monthly payment list'
+      mail.html_part = Mail::Part.new(body: render_erb(search_template('monthly-payment-list.html.erb')), content_type: 'text/html; charset=UTF-8')
+      LucaSupport::Mail.new(mail, PJDIR).deliver
     end
 
     def export_json
@@ -110,10 +153,10 @@ module LucaDeal
           item['debit'] = []
           item['credit'] = []
           dat['subtotal'].map do |sub|
-            item['debit'] << { 'label' => '売掛金', 'value' => LucaSupport::Code.readable(sub['items']) }
-            item['debit'] << { 'label' => '売掛金', 'value' => LucaSupport::Code.readable(sub['tax']) }
-            item['credit'] << { 'label' => '売上高', 'value' => LucaSupport::Code.readable(sub['items']) }
-            item['credit'] << { 'label' => '売上高', 'value' => LucaSupport::Code.readable(sub['tax']) }
+            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']) }
           end
           item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
           item['x-editor'] = 'LucaDeal'
@@ -123,14 +166,25 @@ module LucaDeal
       end
     end
 
-    def monthly_invoice
-      LucaDeal::Contract.new(@date.to_s).active do |contract|
-        next if contract.dig('terms', 'billing_cycle') != 'monthly'
+    def single_invoice(contract_id)
+      contract = Contract.find(contract_id)
+      raise "Invoice already exists for #{contract_id}. exit" if duplicated_contract? contract['id']
+
+      gen_invoice!(invoice_object(contract))
+    end
+
+    def monthly_invoice(target = 'monthly')
+      Contract.new(@date.to_s).active do |contract|
+        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']
 
-        invoice = {}
-        invoice['id'] = issue_random_id
+        gen_invoice!(invoice_object(contract))
+      end
+    end
+
+    def invoice_object(contract)
+      {}.tap do |invoice|
         invoice['contract_id'] = contract['id']
         invoice['customer'] = get_customer(contract.dig('customer_id'))
         invoice['due_date'] = due_date(@date)
@@ -143,25 +197,13 @@ module LucaDeal
           item.dig('type') == 'initial' && subsequent_month?(contract.dig('terms', 'effective'))
         end
         invoice['subtotal'] = subtotal(invoice['items'])
-                              .map { |k, v| v.tap { |dat| dat['rate'] = k } }
-        gen_invoice!(invoice)
+                                .map { |k, v| v.tap { |dat| dat['rate'] = k } }
       end
     end
 
-    # set variables for ERB template
-    #
-    def invoice_vars(invoice_dat)
-      @customer = invoice_dat['customer']
-      @items = invoice_dat['items']
-      @subtotal = invoice_dat['subtotal']
-      @issue_date = invoice_dat['issue_date']
-      @due_date = invoice_dat['due_date']
-      @amount = @subtotal.inject(0) { |sum, i| sum + i['items'] + i['tax'] }
-    end
-
     def get_customer(id)
       {}.tap do |res|
-        LucaDeal::Customer.find(id) do |dat|
+        Customer.find(id) do |dat|
           customer = parse_current(dat)
           res['id'] = customer['id']
           res['name'] = customer.dig('name')
@@ -177,7 +219,7 @@ module LucaDeal
 
       [].tap do |res|
         products.each do |product|
-          LucaDeal::Product.find(product['id'])['items'].each do |item|
+          Product.find(product['id'])['items'].each do |item|
             item['product_id'] = product['id']
             item['qty'] ||= 1
             res << item
@@ -198,11 +240,23 @@ module LucaDeal
 
     # TODO: support due_date variation
     def due_date(date)
-      Date.new(date.year, date.month + 1, -1)
+      next_month = date.next_month
+      Date.new(next_month.year, next_month.month, -1)
     end
 
     private
 
+    # set variables for ERB template
+    #
+    def invoice_vars(invoice_dat)
+      @customer = invoice_dat['customer']
+      @items = readable(invoice_dat['items'])
+      @subtotal = readable(invoice_dat['subtotal'])
+      @issue_date = invoice_dat['issue_date']
+      @due_date = invoice_dat['due_date']
+      @amount = readable(invoice_dat['subtotal'].inject(0) { |sum, i| sum + i['items'] + i['tax'] })
+    end
+
     def lib_path
       __dir__
     end
@@ -211,9 +265,9 @@ module LucaDeal
     #
     def set_company
       {}.tap do |h|
-        h['name'] = @config.dig('company', 'name')
-        h['address'] = @config.dig('company', 'address')
-        h['address2'] = @config.dig('company', 'address2')
+        h['name'] = CONFIG.dig('company', 'name')
+        h['address'] = CONFIG.dig('company', 'address')
+        h['address2'] = CONFIG.dig('company', 'address2')
       end
     end
 
@@ -236,13 +290,14 @@ module LucaDeal
     # load Tax Rate from config.
     #
     def load_tax_rate(name)
-      return 0 if @config.dig('tax_rate', name).nil?
+      return 0 if CONFIG.dig('tax_rate', name).nil?
 
-      BigDecimal(take_current(@config['tax_rate'], name).to_s)
+      BigDecimal(take_current(CONFIG['tax_rate'], name).to_s)
     end
 
     def attachment_name(dat, type)
-      "invoice-#{dat.dig('id')[0, 7]}.#{type}"
+      id = %r{/}.match(dat['id']) ? dat['id'].gsub('/', '') : dat['id'][0, 7]
+      "invoice-#{id}.#{type}"
     end
 
     def duplicated_contract?(id)