lucadeal 0.2.15 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d81788d16b07f572c9d07bf998cdaa5a8e55db76ea5b1b513eebaae3c783c61
-  data.tar.gz: d148d1079305e88354c47c3ce5699e2c656a40099228b9c1653488b451a41afb
+  metadata.gz: 364352a3a1e23daeffffcd2750f711617677866abf7576fe1f821404f35fa439
+  data.tar.gz: f7d5eb22d3df29386be2bac8fd6809af96f78663342e91f16a56bda8d2e64e58
 SHA512:
-  metadata.gz: 1f41b4156fb05131e969b0490937c766076e1795a9a6c725e657e1f533333532436b34bb362f42aa9600dcb67e25f080a7a9f6b3bf8ce4a9c2f276990c69e478
-  data.tar.gz: ae87eae9ca9af5459e3082bf517feb98ec4a98e0af87bb52e625e4067212dd9d6743644a57383c092555d1e90fef4009871a13b6eefc17d1c0f8d5806e76f58d
+  metadata.gz: 2cffac9d4b4092a312311d8096d7e77c1b9b2e945d4f31a6a0d81bf0842d137ddf0e3dd04e261f07a051ca634c89d10f8020211aed9d9dc9339a2926002d7a56
+  data.tar.gz: 1ab6a3eb3cab72dcdc19efed5a417be613d8ca8f2aded7258b6ad806cec9b0096d81b879763d978809099307db10260087c1fc98df1331c6a7d880811bec5122

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+## LucaDeal 0.2.25
+
+* Breaking change: export key 'value' -> 'amount'
+
+## LucaDeal 0.2.21
+
+* Implement `luca-deal fee` subcommands.
+* single invoice creation with contract id fragment.
+
+## LucaDeal 0.2.20
+
+* CLI provides `--nu` option. Add JSON output.
+* `luca-deal invoices list --html`, rendering HTML to stdout.
+
+## LucaDeal 0.2.19
+
+* CLI id completion on Customer delete, Contract create/delete
+* add `describe` to Customer / Contract
+
+## LucaDeal 0.2.18
+
+* Breaking change: restructure CLI in sub-sub command format.
+* Add 'x-customer', 'x-editor' on export to LucaBook
+
+## LucaDeal 0.2.17
+
+* `luca-deal export` export JSON for LucaBook
+
+## LucaDeal 0.2.14
+
+* Introduce Product for selling items template.
+
+## LucaDeal 0.2.12
+
+* Introduce Sales fee calculation.
+
+## LucaDeal 0.2.10
+
+* items can have one time cost at initial month of contract.

data/README.md

@@ -1,5 +1,7 @@
 # LucaDeal
 
+[![Gem Version](https://badge.fury.io/rb/lucadeal.svg)](https://badge.fury.io/rb/lucadeal)
+
 LucaDeal is Sales contract management application.
 
 ## Installation
@@ -20,7 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can create project skelton with `new` sub command.
+
+```
+$ luca-deal new Dir
+```
+
+Example assumes setup with bundler shim. `bundle exec` prefix may be needed in most cases.
+
+
+### Manage Contract
+
+Customer object can be created by `customer create` subcommand with name.
+
+```
+$ luca-deal customer create CustomerName
+Successfully generated Customer  5976652cc2d9c0ebf4a8646f7a28aa8d6bd2d606
+Edit customer detail.
+```
+
+Customer is filed under `data/customers` as YAML. Detail need to be editted.  
+Then, Contract object is created by `contract create` sub command with customer id.
+
+```
+$ luca-deal contract create 5976652cc2d9c0ebf4a8646f7a28aa8d6bd2d606
+uccessfully generated Contract  814c6fc9fffe5566fe8e7ef683b439b355d612dc
+Conditions are tentative. Edit contract detail.
+```
+
+Contract is filed under `data/contracts` as YAML. Detail need to be editted.
+
+
+### Issue invoice
+
+Monthly invoices are generated with `invoice create --monthly` sub command. Target month is optional. Without month, this month including today is the target.
+
+```
+$ luca-deal invoice create --monthly [yyyy m]
+```
+
+Or, any invoice can be created with contract ID. Contract ID is just unique fragment of uuid, listed with `luca-deal invoice create` with no args.
+
+```
+$ luca-deal invoice create 1d3 yyyy m
+```
+
+Invoice conditions are defined by contracts.
+
+
+### Send Invoice
+
+Invoice is implemented with HTML & ERB. Copy [default template](lib/luca_deal/templates/invoice.html.erb) to `templates/` in the data directory, and customize.  
+If you want to send invoices in PDF, you need to install `wkhtmltopdf command separately. Send mail command is as bellows:`
+
+```
+$ luca-deal invoice mail yyyy m
+```
+
+
+### Sales Fee
+
+You can also manage revenue share program with Fee object. Setup proper contract structure.
 
 
 ## Data Structure

data/exe/luca-deal

@@ -5,57 +5,245 @@ require 'date'
 require 'optparse'
 require 'luca_deal'
 
-def customer(args = nil, params = {})
-  case params['mode']
-  when 'list'
-    LucaDeal::Customer.new.list_name
-  when 'create'
-    if params['name']
-      id = LucaDeal::Customer.create(name: params['name'])
-      puts "Successfully generated Customer  #{id}" if id
-      puts 'Edit customer detail.' if id
-    else
-      puts 'requires customer\'s name. exit'
-      exit 1
+class LucaCmd
+  class Customer < LucaCmd
+    def self.create(args = nil, params = {})
+      if args
+        id = LucaDeal::Customer.create(name: args[0])
+        puts "Successfully generated Customer  #{id}" if id
+        puts 'Edit customer detail.' if id
+      else
+        puts 'requires customer\'s name. exit'
+        exit 1
+      end
+    end
+
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Customer.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Customer.delete(list.first)
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      render(LucaDeal::Customer.new.list_name, params)
     end
-  else
-    puts 'invalid option. --help for usage'
-    exit 1
   end
-end
 
-def contract(args = nil, params = {})
-  case params['mode']
-  when 'create'
-    if params['customer_id']
-      id = LucaDeal::Contract.new.generate!(params['customer_id'], params['category'])
-      puts "Successfully generated Contract  #{id}" if id
-      puts 'Conditions are tentative. Edit contract detail.' if id
-    else
-      puts 'requires customer\'s id. exit'
-      exit 1
+  class Contract < LucaCmd
+    def self.create(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.new.generate!(list.first, params['category'])
+          puts "Successfully generated Contract  #{id}" if id
+          puts 'Conditions are tentative. Edit contract detail.' if id
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
+        puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Contract.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
+        puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.delete(list.first)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
     end
-  else
   end
-end
 
-def invoice(args = nil, params = {})
-  date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
-  case params['mode']
-  when 'monthly'
-    LucaDeal::Invoice.new(date).monthly_invoice
-  when 'mail'
-    LucaDeal::Invoice.new(date).deliver_mail
-  when 'preview'
-    LucaDeal::Invoice.new(date).preview_mail
-  when 'stats'
-    if args.empty?
-      date = "#{Date.today.year}-#{Date.today.month}-1"
-      count = 3
-    end
-    LucaDeal::Invoice.new(date).stats(count || 1)
-  else
-    puts 'not implemented mode'
+  class Invoice < LucaCmd
+    def self.create(args = nil, params = {})
+      case params['mode']
+      when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Invoice.new(date).monthly_invoice
+      else
+        date = "#{args[1]}-#{args[2]}-#{args[3] || '1'}" if !args.empty?
+        list = LucaDeal::Contract.id_completion(args[0] || '', label: 'customer_name')
+        if args.length != 3
+          puts 'requires contract id & year month. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        else
+          case list.length
+          when 1
+            id = LucaDeal::Invoice.new(date).single_invoice(list.first)
+          else
+            puts 'found multiple contract id. exit'
+            list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+            exit 1
+          end
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Invoice.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      end
+    end
+
+    def self.export(args = nil, _params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaDeal::Invoice.new(args.join('-')).export_json
+      else
+        LucaDeal::Invoice.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?
+        date = "#{Date.today.year}-#{Date.today.month}-1"
+        count = 3
+      end
+      if params[:html]
+        LucaDeal::Invoice.new(date).preview_stdout
+      else
+        render(LucaDeal::Invoice.new(date).stats(count || 1), params)
+      end
+    end
+
+    def self.mail(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      case params['mode']
+      when 'preview'
+        LucaDeal::Invoice.new(date).preview_mail
+      else
+        LucaDeal::Invoice.new(date).deliver_mail
+      end
+    end
+  end
+
+  class Fee < LucaCmd
+    def self.create(args = nil, params = {})
+      case params['mode']
+      when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Fee.new(date).monthly_fee
+      else
+        puts "not implemented yet"
+        exit 1
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Fee.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      if args.empty?
+        date = "#{Date.today.year}-#{Date.today.month}-1"
+        count = 3
+      end
+      if params[:html]
+        LucaDeal::Fee.new(date).preview_stdout
+      else
+        render(LucaDeal::Fee.new(date).stats(count || 1), params)
+      end
+    end
+
+    def self.mail(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      case params['mode']
+      when 'preview'
+        LucaDeal::Fee.new(date).preview_mail
+      else
+        LucaDeal::Fee.new(date).deliver_mail
+      end
+    end
+  end
+
+  def self.render(dat, params)
+    case params[:output]
+    when 'json'
+      puts JSON.dump(dat)
+    when 'nu'
+      LucaSupport::View.nushell(YAML.dump(dat))
+    else
+      puts YAML.dump(dat)
+    end
   end
 end
 
@@ -65,54 +253,170 @@ end
 
 LucaRecord::Base.valid_project?
 cmd = ARGV.shift
+params = {}
 
 case cmd
-when 'customer'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal customer [options]'
-    opt.on('--list', 'list all customers') { |v| params['mode'] = 'list' }
-    opt.on('--create CustomerName', 'register new customer') do |v|
-      params['mode'] = 'create'
-      params['name'] = v
+when /customers?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers create CustomerName'
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.create(args, params)
     end
-    args = opt.parse(ARGV)
-    customer(args, params)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers list [options]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.list(args, params)
+    end
+  when 'describe'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.describe(args, params)
+    end
+  when 'delete'
+    LucaCmd::Customer.delete(ARGV)
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal customer[s] subcommands [--help|options]'
+    puts '  create'
+    puts '  list'
+    puts '  describe: show customer with contracts info'
+    puts '  delete'
+    exit 1
   end
-when 'contract'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal contract [options]'
-    opt.on('--create CustomerId', 'register new contract') do |v|
-      params['mode'] = 'create'
-      params['customer_id'] = v
+when /contracts?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal contracts create [options] CustomerId'
+      opt.on('--salesfee', 'create contract as sales fee definition') do |_v|
+        params['category'] = 'sales_fee'
+      end
+      args = opt.parse(ARGV)
+      LucaCmd::Contract.create(args, params)
     end
-    opt.on('--salesfee', 'create contract as sales fee definition') do |_v|
-      params['category'] = 'sales_fee'
+  when 'describe'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal contracts describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Contract.describe(args, params)
     end
-    args = opt.parse(ARGV)
-    contract(args, params)
+  when 'delete'
+    LucaCmd::Contract.delete(ARGV)
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal contract[s] subcommand [--help|options]'
+    puts '  create'
+    puts '  describe: show contract with puroducts or items info'
+    puts '  delete'
+    exit 1
   end
-when 'invoice'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal invoice [options] year month [date]'
-    opt.on('--monthly', 'generate monthly data') { |v| params['mode'] = 'monthly' }
-    opt.on('--mail', 'send to customers') { |v| params['mode'] = 'mail' }
-    opt.on('--preview', 'send to preview user') { |v| params['mode'] = 'preview' }
-    opt.on('--stats', 'list invoices') { |v| params['mode'] = 'stats' }
-    args = opt.parse(ARGV)
-    invoice(args, params)
+when 'export'
+  LucaCmd::Invoice.export(ARGV)
+when /invoices?/, 'i'
+  subcmd = ARGV.shift
+  case subcmd
+  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' }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.create(args, params)
+    end
+  when 'delete'
+    LucaCmd::Invoice.delete(ARGV)
+  when 'list'
+    OptionParser.new do |opt|
+      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' }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.list(args, params)
+    end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices mail [options] year month [date]'
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.mail(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal invoices subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with invoice'
+    exit 1
   end
 when 'new'
   params = {}
   OptionParser.new do |opt|
+    opt.banner = 'Usage: luca-deal new DIR'
     args = opt.parse(ARGV)
     new_pj(args, params)
   end
+when /fee/
+  subcmd = ARGV.shift
+  case subcmd
+  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' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.create(args, params)
+    end
+  when 'delete'
+    LucaCmd::Fee.delete(ARGV)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee 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' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.list(args, params)
+    end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee mail [options] year month [date]'
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.mail(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal fee subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with report'
+    exit 1
+  end
 else
-  puts 'Usage: luca-deal sub-command [--help|options]'
-  puts '        customer'
-  puts '        contract'
-  puts '        invoice'
+  puts 'Proper subcommand needed.'
+  puts
+  puts 'Usage: luca-deal subcommand [options]'
+  puts '        customers'
+  puts '        contracts'
+  puts '        invoices'
+  puts '        new: initialize project dir'
+  puts '        export: puts invoice data for LucaBook import'
+  exit 1
 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,99 @@ 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']
 
-        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']
-
-          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
-            end
+
+          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
+            }
           end
-          fee['id'] = issue_random_id
-          fee['customer'].delete('to')
-          fee['sales_fee'].merge! subtotal(fee['items'])
-          gen_fee!(fee)
+          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
+
+    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 +117,19 @@ module LucaDeal
       end
     end
 
-    def gen_fee!(fee)
-      id = fee.dig('invoice', 'contract_id')
-      self.class.create_record!(fee, @date, 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 +138,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,12 +160,18 @@ 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
 
     def duplicated_contract?(id)

data/lib/luca_deal/invoice.rb

@@ -1,6 +1,7 @@
 require 'luca_deal/version'
 
 require 'mail'
+require 'json'
 require 'yaml'
 require 'pathname'
 require 'bigdecimal'
@@ -16,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
 
@@ -45,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
     #
@@ -87,28 +102,60 @@ 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
+
+    def export_json
+      [].tap do |res|
+        self.class.asof(@date.year, @date.month) do |dat|
+          item = {}
+          item['date'] = dat['issue_date']
+          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']) }
           end
+          item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
+          item['x-editor'] = 'LucaDeal'
+          res << item
         end
-        puts YAML.dump(LucaSupport::Code.readable(collection))
+        puts JSON.dump(res)
       end
     end
 
+    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
-      LucaDeal::Contract.new(@date.to_s).active do |contract|
+      Contract.new(@date.to_s).active do |contract|
         next if contract.dig('terms', 'billing_cycle') != 'monthly'
         # 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)
@@ -121,25 +168,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')
@@ -155,7 +190,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
@@ -166,7 +201,7 @@ module LucaDeal
 
     def gen_invoice!(invoice)
       id = invoice.dig('contract_id')
-      self.class.create_record!(invoice, @date, Array(id))
+      self.class.create(invoice, date: @date, codes: Array(id))
     end
 
     def issue_date(date)
@@ -176,11 +211,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
@@ -189,9 +236,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
 
@@ -214,13 +261,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)

data/lib/luca_deal/templates/fee-report-mail.txt.erb

@@ -0,0 +1,6 @@
+Your monthly fee report is available.
+Please find the document attaced at the bottom of this email.
+-- 
+<%= @company['name'] %>
+<%= @company['address'] %>
+<%= @company['address2'] %>

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

@@ -0,0 +1,54 @@
+<html>
+    <head>
+        <meta charset="utf-8">
+        <style>
+            body { size: A4 }
+        </style>
+    </head>
+    <body>
+        <div style="text-align: right">Issue date: <%= @issue_date %></div>
+        <h1 style="display: block; margin: auto; text-align: center">Fee Report</h1>
+        <section><%= @customer["name"] %></section>
+        <section>Total amount: <%= delimit_num(@amount) %></section>
+
+        <table style="width: 100%">
+            <thead>
+                <th>#</th>
+                <th>Customer Name</th>
+                <th>Item Name</th>
+                <th>qty</th>
+                <th>Sales</th>
+                <th>Fee</th>
+            </thead>
+            <tbody>
+                <% @items.each.with_index(1) do |item, i| %>
+                    <tr class="item">
+                        <td class="unit"><%= i %></td>
+                        <td><%= item["customer_name"] %></td>
+                        <td><%= item["name"] %></td>
+                        <td class="unit"><%= item["qty"] %></td>
+                        <td class="price"><%= delimit_num( item["price"] * item["qty"] ) %></td>
+                        <td class="price"><%= delimit_num( item["fee"] ) %></td>
+                    </tr>
+                <% end %>
+                    <tr>
+                        <td class="price" colspan="3">Subtotal</td>
+                        <td class="price"><%= delimit_num( @sales_fee['fee'] ) %></td>
+                    </tr>
+                    <tr>
+                        <td class="price" colspan="3">Tax</td>
+                        <td class="price"><%= delimit_num( @sales_fee['tax'] ) %></td>
+                    </tr>
+                    <tr>
+                        <td class="price" colspan="3">Total</td>
+                        <td class="price"><%= delimit_num( @sales_fee['fee'] + @sales_fee['tax'] ) %></td>
+                    </tr>
+        </table>
+
+        <section>
+        <div><%= @company["name"] %></div>
+        <div><%= @company["address"] %></div>
+        <div><%= @company["address2"] %></div>
+        </section>
+    </body>
+</html>

data/lib/luca_deal/templates/invoice-mail.txt.erb

@@ -0,0 +1,6 @@
+Your monthly invoice is available.
+Please find the document attaced at the bottom of this email.
+-- 
+<%= @company['name'] %>
+<%= @company['address'] %>
+<%= @company['address2'] %>

data/lib/luca_deal/templates/invoice.html.erb

@@ -0,0 +1,52 @@
+<html>
+    <head>
+        <meta charset="utf-8">
+        <style>
+            body { size: A4 }
+        </style>
+    </head>
+    <body>
+        <div style="text-align: right">Issue date: <%= @issue_date %></div>
+        <h1 style="display: block; margin: auto; text-align: center">Invoice</h1>
+        <section><%= @customer["name"] %></section>
+        <section>Total amount: <%= delimit_num(@amount) %></section>
+
+        <table style="width: 100%">
+            <thead>
+                <th>#</th>
+                <th>Item</th>
+                <th>qty</th>
+                <th>Amount</th>
+            </thead>
+            <tbody>
+                <% @items.each.with_index(1) do |item, i| %>
+                    <tr class="item">
+                        <td class="unit"><%= i %></td>
+                        <td><%= item["name"] %></td>
+                        <td class="unit"><%= item["qty"] %></td>
+                        <td class="price"><%= delimit_num( item["price"] * item["qty"] ) %></td>
+                    </tr>
+                <% end %>
+                <% @subtotal.each.with_index(1) do |sub, i| %>
+                    <tr>
+                        <td class="price" colspan="3">Subtotal</td>
+                        <td class="price"><%= delimit_num( sub['items'] ) %></td>
+                    </tr>
+                    <tr>
+                        <td class="price" colspan="3">Tax</td>
+                        <td class="price"><%= delimit_num( sub['tax'] ) %></td>
+                    </tr>
+                    <tr>
+                        <td class="price" colspan="3">Total</td>
+                        <td class="price"><%= delimit_num( sub['items'] + sub['tax'] ) %></td>
+                    </tr>
+                <% end %>
+        </table>
+
+        <section>
+        <div><%= @company["name"] %></div>
+        <div><%= @company["address"] %></div>
+        <div><%= @company["address2"] %></div>
+        </section>
+    </body>
+</html>

data/lib/luca_deal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.22
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -89,6 +89,10 @@ files:
 - lib/luca_deal/setup.rb
 - lib/luca_deal/templates/.keep
 - lib/luca_deal/templates/config.yml
+- lib/luca_deal/templates/fee-report-mail.txt.erb
+- lib/luca_deal/templates/fee-report.html.erb
+- lib/luca_deal/templates/invoice-mail.txt.erb
+- lib/luca_deal/templates/invoice.html.erb
 - lib/luca_deal/version.rb
 homepage: https://github.com/chumaltd/luca/tree/master/lucadeal
 licenses:
@@ -112,7 +116,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: Deal with contracts