lucadeal 0.2.25 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b497e68738101eafbfe6eab73c3e0cf8d297cf4676ccfb8cd05efdadc273a3
-  data.tar.gz: fb8ed0c2d5eb0f7621c4436ddad91ece16aa723f2861ecd661423802ec01d0c4
+  metadata.gz: 14852f4570ab9b7da28524ffe3c4b9fc2129e96a3f7ade9991cfe2f20c8730e1
+  data.tar.gz: 0a002fdffad8e94900f81ca53d130407c2dee4f03770cc7881d22f7313d20603
 SHA512:
-  metadata.gz: 5c8941a80f26d67b4855f2757e00f8241dd0b73f37f0fe2ab8799500388118bec4513fcb398116ba8072889bedf97a083fbb2c4ce3fdd4219cb7a15844785b1c
-  data.tar.gz: 91a84225d3d46201f85e9e38bbedbc102b2a3aaf2ccbf0a812db56bc3b502b78b7f89cb4087ec09642db5ff49b4abe58c15f6632bcbee18d471e95f3c1ff2a20
+  metadata.gz: 1046732b7d2256f2384186a38cd6d766d8409c7602959d864782f502b0c87729e24b1510c9662a92ea1dae2eb699edfa5e4b9ad36bd4ffd838bb9b42b1ca1ff7
+  data.tar.gz: 4fd222f9031b9032542794d01a81982ca38732ecf38c8dac5ef48a165034dcbcd325646a841595c2b4139d2e30c9471faf5ebeab0b8fab2d140f251e09b5151f

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## LucaDeal 0.4.0
+
+* implement `luca-deal invoices print` for local HTML/PDF rendering.
+* remove `luca-deal invoices list --html` in favor of `print` sub command.
+
+## LucaDeal 0.3.1
+
+* add `luca-deal invoices settle --search-terms` for late payment case.
+
+## LucaDeal 0.3.0
+
+* implement `luca-deal reports balance` for unsettled balance by customer
+* implement `luca-deal invoices settle` for import payment data from LucaBook
+
 ## LucaDeal 0.2.25
 
 * implement deduction rate for fee calculation.

data/README.md

@@ -1,6 +1,8 @@
 # LucaDeal
 
 [![Gem Version](https://badge.fury.io/rb/lucadeal.svg)](https://badge.fury.io/rb/lucadeal)
+[![doc](https://img.shields.io/badge/doc-rubydoc-green.svg)](https://www.rubydoc.info/gems/lucadeal/index)
+![license](https://img.shields.io/github/license/chumaltd/luca)
 
 LucaDeal is Sales contract management application.
 
@@ -10,6 +12,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'lucadeal'
+gem 'mail'       # If you don't use mail functionality, you can remove this line.
 ```
 
 And then execute:
@@ -167,7 +170,7 @@ Fields for sales fee are as bellows:
 Invoice is basically auto generated from Customer and Contract objects.
 
 | Top level  | Second level | Description                              |
-|------------|--------------|------------------------------------------|
+|------------+--------------+------------------------------------------|
 | id         |              | uuid                                     |
 | issue_date |              |                                          |
 | due_date   |              |                                          |
@@ -183,6 +186,10 @@ Invoice is basically auto generated from Customer and Contract objects.
 |            | qty          | quantity. Default: 1.                    |
 |            | type         |                                          |
 |            | product_id   | refrence for Product                     |
+| settled    |              |                                          |
+|            | id           | data source id for duplication check     |
+|            | date         | payment date                             |
+|            | amount       | payment amount                           |
 | subtotal   |              | Array of subtotal by tax category.       |
 |            | items        | amount of items                          |
 |            | tax          | amount of tax                            |

data/exe/luca-deal

@@ -177,15 +177,18 @@ class LucaCmd
         date = "#{Date.today.year}-#{Date.today.month}-1"
         count = 3
       end
-      if params[:html]
-        LucaDeal::Invoice.new(date).preview_stdout
-      elsif params[:mail]
+      if params[:mail]
         LucaDeal::Invoice.new(date).stats_email
       else
         render(LucaDeal::Invoice.new(date).stats(count || 1), params)
       end
     end
 
+    def self.report(args = nil, params = {})
+      date = Date.new(args[0].to_i, args[1].to_i, 1)
+      render(LucaDeal::Invoice.report(date, detail: params[:detail], due: params[:due]), params)
+    end
+
     def self.mail(args = nil, params = {})
       date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
       case params['mode']
@@ -195,6 +198,21 @@ class LucaCmd
         LucaDeal::Invoice.new(date).deliver_mail
       end
     end
+
+    def self.print(args = nil, params = {})
+      if args.length >= 2
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Invoice.new(date).print(nil, params)
+      else
+        date = "#{Date.today.year}-#{Date.today.month}-#{Date.today.day}"
+        LucaDeal::Invoice.new(date).print(args[0], params)
+      end
+    end
+
+    def self.settle(args = nil, params = nil)
+      str = args[0].nil? ? STDIN.read : File.read(args[0])
+      LucaDeal::Invoice.settle(str, params[:term])
+    end
   end
 
   class Fee < LucaCmd
@@ -257,6 +275,12 @@ class LucaCmd
       puts JSON.dump(dat)
     when 'nu'
       LucaSupport::View.nushell(YAML.dump(dat))
+    when 'csv'
+      str = CSV.generate(String.new, col_sep: "\t") do |row|
+        row << dat.first.keys
+        dat.each { |d| row << d.values }
+      end
+      puts str
     else
       puts YAML.dump(dat)
     end
@@ -361,7 +385,6 @@ when /invoices?/, 'i'
       opt.banner = 'Usage: luca-deal invoices list [options] year month [date]'
       opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
       opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
-      opt.on('--html', 'output html invoices') { |_v| params[:html] = 'monthly' }
       opt.on('--mail', 'send payment list by email') { |_v| params[:mail] = true }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.list(args, params)
@@ -373,6 +396,21 @@ when /invoices?/, 'i'
       args = opt.parse(ARGV)
       LucaCmd::Invoice.mail(args, params)
     end
+  when 'print'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices print [options] <invoice_id | year month>'
+      opt.on('--pdf', 'output PDF invoices. wkhtmlpdf is required') { |_v| params[:output] = :pdf }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.print(args, params)
+    end
+  when 'settle'
+    params[:term] = 1
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices settle [filepath]'
+      opt.on('--search-term VAL', 'search invoice N months before payment date. default: 1') { |v| params[:term] = v.to_i }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.settle(args, params)
+    end
   else
     puts 'Proper subcommand needed.'
     puts
@@ -381,6 +419,30 @@ when /invoices?/, 'i'
     puts '  delete'
     puts '  list'
     puts '  mail: send mail with invoice'
+    puts '  print: render invoices into HTML/PDF'
+    puts '  settle'
+    exit 1
+  end
+when /reports?/, 'r'
+  subcmd = ARGV.shift
+  case subcmd
+  when 'balance'
+    params[:detail] = false
+    params[:due] = false
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal r[eports] balance [options] [year month]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      opt.on('--detail', 'show detail info') { |_v| params[:detail] = true }
+      opt.on('--force-due', 'respect due date over actual payment') { |_v| params[:due] = true }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.report(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal r[eports] subcommand [--help|options]'
+    puts '  balance'
     exit 1
   end
 when 'new'
@@ -436,8 +498,9 @@ else
   puts 'Usage: luca-deal subcommand [options]'
   puts '        customers'
   puts '        contracts'
-  puts '        invoices'
+  puts '        i[nvoices]'
   puts '        fee'
+  puts '        r[eports]'
   puts '        new: initialize project dir'
   puts '        export: puts invoice data for LucaBook import'
   exit 1

data/lib/luca_deal/invoice.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'yaml'
 require 'pathname'
 require 'bigdecimal'
+require 'luca_support/code'
 require 'luca_support/config'
 require 'luca_support/mail'
 require 'luca_deal/contract'
@@ -39,13 +40,26 @@ module LucaDeal
       end
     end
 
-    # Render HTML to console
+    # Render HTML/PDF to files
+    # TODO: change output dir
     #
-    def preview_stdout
-      self.class.asof(@date.year, @date.month) do |dat, _|
+    def print(id = nil, params = {})
+      filetype = params[:output] || :html
+      if id
+        dat = self.class.find(id)
         @company = set_company
         invoice_vars(dat)
-        puts render_invoice
+        File.open(attachment_name(dat, filetype), 'w') do |f|
+          f.puts render_invoice(filetype)
+        end
+      else
+        self.class.asof(@date.year, @date.month) do |dat, _|
+          @company = set_company
+          invoice_vars(dat)
+          File.open(attachment_name(dat, filetype), 'w') do |f|
+            f.puts render_invoice(filetype)
+          end
+        end
       end
     end
 
@@ -76,6 +90,113 @@ module LucaDeal
       end
     end
 
+    def self.report(date, scan_years = 10, detail: false, due: false)
+      fy_end = Date.new(date.year, date.month, -1)
+      if detail
+        customers = {}.tap do |h|
+          Customer.all.each { |c| h[c['name']] = c }
+        end
+      end
+      [].tap do |res|
+        items = {}
+        head = date.prev_year(scan_years)
+        e = Enumerator.new do |yielder|
+          while head <= date
+            yielder << head
+            head = head.next_month
+          end
+        end
+        e.each do |d|
+          asof(d.year, d.month).map do |invoice|
+            if invoice['settled']
+              next if !due
+              settle_date = invoice['settled']['date'].class.name == "String" ? Date.parse(invoice['settled']['date']) : invoice['settled']['date']
+              next if (settle_date && settle_date <= fy_end)
+            end
+
+            customer = invoice.dig('customer', 'name')
+            items[customer] ||= { 'unsettled' => BigDecimal('0'), 'invoices' => [] }
+            items[customer]['unsettled'] += (invoice.dig('subtotal', 0, 'items') + invoice.dig('subtotal', 0, 'tax')||0)
+            items[customer]['invoices'] << invoice
+          end
+        end
+        items.each do |k, item|
+          row = {
+            'customer' => k,
+            'unsettled' => LucaSupport::Code.readable(item['unsettled']),
+          }
+          if detail
+            row['address'] = %Q(#{customers.dig(k, 'address')}#{customers.dig(k, 'address2')})
+            row['invoices'] = item['invoices'].map{ |i| { 'id' => i['id'], 'issue' => i['issue_date'].to_s } }
+          end
+          res << row
+        end
+        res.sort! { |a, b| b['unsettled'] <=> a['unsettled'] }
+      end
+    end
+
+    # === JSON Format:
+    #   [
+    #     {
+    #       "journals" : [
+    #         {
+    #           "id": "2021A/U001",
+    #           "header": "customer name",
+    #           "diff": -20000
+    #         }
+    #       ]
+    #     }
+    #   ]
+    #
+    def self.settle(io, payment_terms = 1)
+      customers = {}.tap do |h|
+        Customer.all.each { |c| h[c['name']] = c }
+      end
+      contracts = {}.tap do |h|
+        Contract.all.each { |c| h[c['customer_id']] ||= []; h[c['customer_id']] << c }
+      end
+      JSON.parse(io).each do |d|
+        next if d['journals'].nil?
+
+        d['journals'].each do |j|
+          next if j['diff'] >= 0
+
+          if j['header'] == 'others'
+            STDERR.puts "#{j['id']}: no customer header found. skip"
+            next
+          end
+
+          ord = customers.map do |k, v|
+            [v, LucaSupport::Code.match_score(j['header'], k, 2)]
+          end
+          customer = ord.max { |x, y| x[1] <=> y[1] }.dig(0, 'id')
+
+          if customer
+            contract = contracts[customer].length == 1 ? contracts.dig(customer, 0, 'id') : nil
+            date = Date.parse(j['date'])
+            invoices = term(date.prev_month(payment_terms).year, date.prev_month(payment_terms).month, date.year, date.month, contract)
+            invoices.each do |invoice, _path|
+              next if invoice['customer']['id'] != customer
+              next if invoice['issue_date'] > date
+              if Regexp.new("^LucaBook/#{j['id']}").match invoice.dig('settled', 'id')||''
+                break
+              end
+
+              invoice['settled'] = {
+                'id' => "LucaBook/#{j['id']}",
+                'date' => j['date'],
+                'amount' => j['diff']
+              }
+              save(invoice)
+              break
+            end
+          else
+            STDERR.puts "#{j['id']}: no customer found"
+          end
+        end
+      end
+    end
+
     # Output seriarized invoice data to stdout.
     # Returns previous N months on multiple count
     #

data/lib/luca_deal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.25
+  version: 0.4.0
 platform: ruby
 authors:
 - Chuma Takahiro
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -68,7 +68,7 @@ dependencies:
         version: 12.3.3
 description: 'Deal with contracts
 
-'
+  '
 email:
 - co.chuma@gmail.com
 executables:
@@ -103,7 +103,7 @@ metadata:
   homepage_uri: https://github.com/chumaltd/luca/tree/master/lucadeal
   source_code_uri: https://github.com/chumaltd/luca/tree/master/lucadeal
   changelog_uri: https://github.com/chumaltd/luca/tree/master/lucadeal/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.5
+signing_key:
 specification_version: 4
 summary: Deal with contracts
 test_files: []