lucadeal 0.2.9 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4958ee224643a3be3408a9b2c4043ac0ca37a1a4c7f3a537d626756a410e117
-  data.tar.gz: 74d8ead724f3cf89b0d5163565316c9421d1f8a81675e1fa28411b6248674b43
+  metadata.gz: d8159099446dcdae1b4c928d4eac5861cd35fe13f8d37155cdf28dafb30fc21e
+  data.tar.gz: 3c086a2ea6c4c9ec6bc9014fa9500ab9fde0a07c1778a5817fbb64e7409b5670
 SHA512:
-  metadata.gz: 8f91f2b22e69bfa5bbde799ad4664a22b19513e75bcc5bf4a0459e5f0717a945d62abd73850821b320fcd0850c0a77537872f156769e3d3693c8e6c4de24c7c5
-  data.tar.gz: 4f333744805790545bc8ee27eb771b441a6be18dc2b635c15121a385ba7713880c22295c43e5524d1f593a55018ab506c1f56c79775db08583922594dfcab6c7
+  metadata.gz: 0a26cec96f1a0805044470f8710b36b60aacf344bad53527c2a9fd4ff64557a06836e4eefec21f083e0b51bc48a9854dbe2fdd6fed4d4754aba9fe51fa5890ce
+  data.tar.gz: 8a611e016833673fb1e7fcab747a24d4bfdb4152a60086791a1377d8576feb181255c8b2a0dfeca2f6807a4d11d4d2f579be6353ca62a7996a5f960d8b4f1311

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 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,15 +1,15 @@
-# Luca::Deal
+# LucaDeal
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/luca/deal`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/lucadeal.svg)](https://badge.fury.io/rb/lucadeal)
 
-TODO: Delete this and the text above, and describe your gem
+LucaDeal is Sales contract management application.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'luca-deal'
+gem 'lucadeal'
 ```
 
 And then execute:
@@ -18,11 +18,179 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install luca-deal
+    $ gem install lucadeal
 
 ## 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]
+```
+
+Invoice conditions are defined by contracts.
+
+
+## Data Structure
+
+Records are stored in YAML format. On historical records, see [LucaRecord](../lucarecord/README.md#historical-field).
+
+### Customer
+
+Customer consists of label information.
+
+| Top level | Second level |      | historical | Description                    |
+|-----------|--------------|------|------------|--------------------------------|
+| id        |              | auto |            | uuid                           |
+| name      |              | must | x          | customer's name                |
+| address   |              |      | x          |                                |
+| address2  |              |      | x          |                                |
+| contacts  |              |      |            | Array of contact information   |
+|           | mail         |      |            | mail address receiving invoice |
+
+
+### Product
+
+Product is items template referred by Contract.
+
+| Top level | Second level |          | historical | Description                                                                                          |
+|-----------|--------------|----------|------------|------------------------------------------------------------------------------------------------------|
+| id        |              | auto     |            | uuid                                                                                                 |
+| name      |              |          | x          | Product name.                                                                                    |
+| items     |              |          |            | Array of items.                                                                                      |
+|           | name         |          | x          | Item name.                                                                                           |
+|           | price        |          | x          | Item price.                                                                                          |
+|           | qty          | optional | x          | quantity. Default: 1.                                                                                |
+|           | type         | optional |            | If 'initial', this item is treated as initial cost, applied only on the first month of the contract. |
+
+
+### Contract
+
+Contract is core object for calculation. Common fields are as follows:
+
+| Top level   | Second level  |          | historical | Description                                                                                          |
+|-------------|---------------|----------|------------|------------------------------------------------------------------------------------------------------|
+| id          |               | auto     |            | uuid                                                                                                 |
+| customer_id |               | must     | x          | customer's uuid                                                                                      |
+| terms       |               |          |            |                                                                                                      |
+|             | effective     | must     |            | Start date of the contract.                                                                          |
+|             | defunct       |          |            | End date of the contract.                                                                            |
+
+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.                                                  |
+|           | category      | optional |            | Default: 'subscription'                                                                              |
+| products  |               |          |            | Array of products.                                                                                   |
+|           | id            |          |            | reference for Product                                                            |
+| items     |               |          |            | Array of items.                                                                                      |
+|           | name          |          | x          | Item name.                                                                                           |
+|           | price         |          | x          | Item price.                                                                                          |
+|           | qty           | optional | x          | quantity. Default: 1.                                                                                |
+|           | type          | optional |            | If 'initial', this item is treated as initial cost, applied only on the first month of the contract. |
+| sales_fee |               | optional |            |                                                                                                      |
+|           | id            |          |            | contract id of fee with sales partner.                                                               |
+
+
+Fields for sales fee are as bellows:
+
+| Top level | Second level |          | historical | Description                                                                         |
+|-----------|--------------|----------|------------|-------------------------------------------------------------------------------------|
+| terms     |              |          |            |                                                                                     |
+|           | category     |          |            | If 'sales_fee', contract is treated as selling commission. |
+| rate      |              | optional |            |                                                                                     |
+|           | default      |          |            | sales fee rate.                                                                     |
+|           | initial      |          |            | sales fee rate for items of type=initial.                                           |
+
+
+### Invoice
+
+Invoice is basically auto generated from Customer and Contract objects.
+
+| Top level  | Second level | Description                              |
+|------------|--------------|------------------------------------------|
+| id         |              | uuid                                     |
+| issue_date |              |                                          |
+| due_date   |              |                                          |
+| customer   |              |                                          |
+|            | id           | customer's uuid                          |
+|            | name         | customer name                            |
+|            | address      |                                          |
+|            | address2     |                                          |
+|            | to           | Array of mail addresses                  |
+| items      |              | Array of items.                          |
+|            | name         | Item name.                               |
+|            | price        | Item price.                              |
+|            | qty          | quantity. Default: 1.                    |
+|            | type         |                                          |
+|            | product_id   | refrence for Product                     |
+| subtotal   |              | Array of subtotal by tax category.       |
+|            | items        | amount of items                          |
+|            | tax          | amount of tax                            |
+|            | rate         | applied tax category. Default: 'default' |
+| sales_fee  |              |                                          |
+|            | id           | contract id of fee with sales partner.   |
+| status     |              | Array of status with timestamp.          |
+
+
+### Fee
+
+Fee is basically auto generated from Contract and Invoice objects.
+
+| Top level | Second level | Description                                  |
+|-----------|--------------|----------------------------------------------|
+| id        |              | uuid                                         |
+| sales_fee |              |                                              |
+|           | id           | contract id with sales partner.              |
+|           | default.fee  | Amount of fee on dafault rate.               |
+|           | default.tax  | Amount of tax for default.fee.               |
+|           | initial.fee  | Amount of fee on initial cost.               |
+|           | initial.tax  | Amount of tax for initial.fee.               |
+| invoice   |              | Carbon copy of Invoice attributes.           |
+|           | id           |                                              |
+|           | contract_id  |                                              |
+|           | issue_date   |                                              |
+|           | due_date     |                                              |
+| customer  |              | Carbon copy of Invoice customer except 'to'. |
+| items     |              | Carbon copy of Invoice items.                |
+| subtotal  |              | Carbon copy of Invoice subtotal.             |
+| status    |              | Array of status with timestamp.              |
+
 
 ## Development
 
@@ -32,4 +200,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/luca-deal.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chumaltd/luca .

data/exe/luca-deal

@@ -5,57 +5,102 @@ 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.new.generate!(params['name'])
-      puts "Successfully generated Customer  #{id}" if id
-      puts 'Edit customer detail.' if id
-    else
-      puts 'requires customer\'s name. exit'
-      exit 1
+module LucaCmd
+  class Customer
+    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.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Customer.delete(args[0])
+      else
+        puts 'requires customer\'s id. exit'
+        exit 1
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      LucaDeal::Customer.new.list_name
     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
+    def self.create(args = nil, params = {})
+      if args
+        id = LucaDeal::Contract.new.generate!(args[0], 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
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Contract.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      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
+    def self.create(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
+      else
+        puts 'not implemented mode'
+      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
+      LucaDeal::Invoice.new(date).stats(count || 1)
+    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
 end
 
@@ -65,44 +110,75 @@ 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 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers list [options]'
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.list(args, params)
     end
-    args = opt.parse(ARGV)
-    customer(args, params)
-  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 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers create CustomerName'
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.create(args, params)
     end
-    opt.on('--salesfee', 'create contract as sales fee definition') do |_v|
-      params['category'] = 'sales_fee'
+  when 'delete'
+    LucaCmd::Customer.delete(ARGV)
+  else
+    puts 'Usage: luca-deal customers sub-commands'
+  end
+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
-    args = opt.parse(ARGV)
-    contract(args, params)
+  when 'delete'
+    LucaCmd::Contract.delete(ARGV)
+  else
+    puts 'Usage: luca-deal contracts Subcommand'
   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] 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]'
+      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 'Usage: luca-deal invoices SubCommand'
   end
 when 'new'
   params = {}
@@ -112,7 +188,8 @@ when 'new'
   end
 else
   puts 'Usage: luca-deal sub-command [--help|options]'
-  puts '        customer'
-  puts '        contract'
-  puts '        invoice'
+  puts '        customers'
+  puts '        contracts'
+  puts '        invoices'
+  puts '        export'
 end

data/lib/luca_deal.rb

@@ -6,6 +6,8 @@ require 'luca_deal/version'
 module LucaDeal
   autoload :Customer, 'luca_deal/customer'
   autoload :Contract, 'luca_deal/contract'
+  autoload :Fee, 'luca_deal/fee'
   autoload :Invoice, 'luca_deal/invoice'
+  autoload :Product, 'luca_deal/product'
   autoload :Setup, 'luca_deal/setup'
 end

data/lib/luca_deal/contract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'luca_deal/version'
 
 require 'yaml'
@@ -7,41 +9,62 @@ require 'luca_record'
 module LucaDeal
   class Contract < LucaRecord::Base
     @dirname = 'contracts'
+    @required = ['customer_id', 'terms']
 
     def initialize(date = nil)
       @date = date ? Date.parse(date) : Date.today
       @pjdir = Pathname(Dir.pwd)
     end
 
+    # returns active contracts on specified date.
+    #
+    def self.asof(year, month, day)
+      return enum_for(:asof, year, month, day) unless block_given?
+
+      new("#{year}-#{month}-#{day}").active do |contract|
+        yield contract
+      end
+    end
+
     #
     # collect active contracts
     #
     def active
+      return enum_for(:active) unless block_given?
+
       self.class.all do |data|
-        contract = parse_current(data)
-        contract['items'] = contract['items'].map { |item| parse_current(item) }
-        next if !self.class.active_period?(contract)
+        next if !active_period?(data.dig('terms'))
 
-        yield contract
+        contract = parse_current(data)
+        contract['items'] = contract['items']&.map { |item| parse_current(item) }
+        # TODO: handle sales_fee rate change
+        contract['rate'] = contract['rate']
+        yield contract.compact
       end
     end
 
-    def generate!(customer_id, mode = nil)
+    def generate!(customer_id, mode = 'subscription')
       LucaDeal::Customer.find(customer_id) do |customer|
         current_customer = parse_current(customer)
-        obj = { 'customer_id' => current_customer['id'], 'customer_name' => current_customer['name'] }
-        obj['terms'] = { 'effective' => @date }
         if mode == 'sales_fee'
-          obj.merge! salesfee_template
+          obj = salesfee_template
         else
-          obj.merge! monthly_template
+          obj = monthly_template
         end
+        obj.merge!({ 'customer_id' => current_customer['id'], 'customer_name' => current_customer['name'] })
+        obj['terms'] ||= {}
+        obj['terms']['effective'] = @date
         self.class.create(obj)
       end
     end
 
-    def self.active_period?(dat)
-      !dat.dig('terms').nil?
+    def active_period?(dat)
+      unless dat.dig('defunct').nil?
+        defunct = dat.dig('defunct').respond_to?(:year) ? dat.dig('defunct') : Date.parse(dat.dig('defunct'))
+        return false if @date > defunct
+      end
+      effective = dat.dig('effective').respond_to?(:year) ? dat.dig('effective') : Date.parse(dat.dig('effective'))
+      @date >= effective
     end
 
     private

data/lib/luca_deal/customer.rb

@@ -10,6 +10,7 @@ require 'luca_record'
 module LucaDeal
   class Customer < LucaRecord::Base
     @dirname = 'customers'
+    @required = ['name']
 
     def initialize(pjdir = nil)
       @date = Date.today
@@ -21,17 +22,20 @@ module LucaDeal
       YAML.dump(list).tap { |l| puts l }
     end
 
-    def generate!(name)
-      contact = {
+    def self.create(obj)
+      raise ':name is required' if obj[:name].nil?
+
+      contacts = obj[:contact]&.map { |c| { 'mail' => c[:mail] } }&.compact
+      contacts ||= [{
         'mail' => '_MAIL_ADDRESS_FOR_CONTACT_'
+      }]
+      h = {
+        'name' => obj[:name],
+        'address' => obj[:address] || '_CUSTOMER_ADDRESS_FOR_INVOICE_',
+        'address2' => obj[:address2] || '_CUSTOMER_ADDRESS_FOR_INVOICE_',
+        'contacts' => contacts
       }
-      obj = {
-        'name' => name,
-        'address' => '_CUSTOMER_ADDRESS_FOR_INVOICE_',
-        'address2' => '_CUSTOMER_ADDRESS_FOR_INVOICE_',
-        'contacts' => [contact]
-      }
-      self.class.create(obj)
+      super(h)
     end
   end
 end

data/lib/luca_deal/fee.rb

@@ -0,0 +1,118 @@
+require 'luca_deal/version'
+
+require 'mail'
+require 'yaml'
+require 'pathname'
+require 'bigdecimal'
+require 'luca_support/config'
+require 'luca_support/mail'
+require 'luca_deal'
+
+module LucaDeal
+  class Fee < LucaRecord::Base
+    @dirname = 'fees'
+
+    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|
+        next if contract.dig('terms', 'category') != 'sales_fee'
+
+        @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|
+          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
+          end
+          fee['id'] = issue_random_id
+          fee['customer'].delete('to')
+          fee['sales_fee'].merge! subtotal(fee['items'])
+          gen_fee!(fee)
+        end
+      end
+    end
+
+    def get_customer(id)
+      {}.tap do |res|
+        LucaDeal::Customer.find(id) do |dat|
+          customer = parse_current(dat)
+          res['id'] = customer['id']
+          res['name'] = customer.dig('name')
+          res['address'] = customer.dig('address')
+          res['address2'] = customer.dig('address2')
+          res['to'] = customer.dig('contacts').map { |h| take_current(h, 'mail') }.compact
+        end
+      end
+    end
+
+    def gen_fee!(fee)
+      id = fee.dig('invoice', 'contract_id')
+      self.class.create(fee, date: @date, codes: Array(id))
+    end
+
+    private
+
+    def lib_path
+      __dir__
+    end
+
+    # load user company profile from config.
+    #
+    def set_company
+      {}.tap do |h|
+        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|
+        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
+        end
+      end
+    end
+
+    def issue_date(date)
+      base =  date.nil? ? Date.today : Date.parse(date)
+      Date.new(base.year, base.month, -1)
+    end
+
+    # load Tax Rate from config.
+    #
+    def load_tax_rate(name)
+      return 0 if @config.dig('tax_rate', name).nil?
+
+      BigDecimal(take_current(@config['tax_rate'], name).to_s)
+    end
+
+    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
+  end
+end

data/lib/luca_deal/invoice.rb

@@ -1,6 +1,7 @@
 require 'luca_deal/version'
 
 require 'mail'
+require 'json'
 require 'yaml'
 require 'pathname'
 require 'bigdecimal'
@@ -12,6 +13,7 @@ require 'luca_record'
 module LucaDeal
   class Invoice < LucaRecord::Base
     @dirname = 'invoices'
+    @required = ['issue_date', 'customer', 'items', 'subtotal']
 
     def initialize(date = nil)
       @date = issue_date(date)
@@ -58,7 +60,6 @@ module LucaDeal
       mail
     end
 
-    #
     # Output seriarized invoice data to stdout.
     # Returns previous N months on multiple count
     #
@@ -97,7 +98,28 @@ module LucaDeal
             collection << stat
           end
         end
-        puts YAML.dump(collection)
+        puts YAML.dump(LucaSupport::Code.readable(collection))
+      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' => '売掛金', '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']) }
+          end
+          item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
+          item['x-editor'] = 'LucaDeal'
+          res << item
+        end
+        puts JSON.dump(res)
       end
     end
 
@@ -113,12 +135,12 @@ module LucaDeal
         invoice['customer'] = get_customer(contract.dig('customer_id'))
         invoice['due_date'] = due_date(@date)
         invoice['issue_date'] = @date
-        invoice['items'] = contract.dig('items').map do |item|
-          {}.tap do |h|
-            h['name'] = item.dig('name')
-            h['price'] = item.dig('price')
-            h['qty'] = item.dig('qty')
-          end
+        invoice['sales_fee'] = contract['sales_fee'] if contract.dig('sales_fee')
+        invoice['items'] = get_products(contract['products'])
+                             .concat(contract['items']&.map { |i| i['qty'] ||= 1; i } || [])
+                             .compact
+        invoice['items'].reject! do |item|
+          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 } }
@@ -126,7 +148,6 @@ module LucaDeal
       end
     end
 
-    #
     # set variables for ERB template
     #
     def invoice_vars(invoice_dat)
@@ -151,9 +172,23 @@ module LucaDeal
       end
     end
 
+    def get_products(products)
+      return [] if products.nil?
+
+      [].tap do |res|
+        products.each do |product|
+          LucaDeal::Product.find(product['id'])['items'].each do |item|
+            item['product_id'] = product['id']
+            item['qty'] ||= 1
+            res << item
+          end
+        end
+      end
+    end
+
     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)
@@ -172,7 +207,6 @@ module LucaDeal
       __dir__
     end
 
-    #
     # load user company profile from config.
     #
     def set_company
@@ -183,23 +217,22 @@ module LucaDeal
       end
     end
 
-    #
     # calc items & tax amount by tax category
     #
     def subtotal(items)
       {}.tap do |subtotal|
         items.each do |i|
           rate = i.dig('tax') || 'default'
+          qty = i['qty'] || BigDecimal('1')
           subtotal[rate] = { 'items' => 0, 'tax' => 0 } if subtotal.dig(rate).nil?
-          subtotal[rate]['items'] += i['qty'] * i['price']
+          subtotal[rate]['items'] += i['price'] * qty
         end
         subtotal.each do |rate, amount|
-          amount['tax'] = (amount['items'] * load_tax_rate(rate)).to_i
+          amount['tax'] = (amount['items'] * load_tax_rate(rate))
         end
       end
     end
 
-    #
     # load Tax Rate from config.
     #
     def load_tax_rate(name)
@@ -218,5 +251,10 @@ module LucaDeal
       end
       false
     end
+
+    def subsequent_month?(effective_date)
+      effective_date = Date.parse(effective_date) unless effective_date.respond_to? :year
+      effective_date.year != @date.year || effective_date.month != @date.month
+    end
   end
 end

data/lib/luca_deal/product.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'luca_deal/version'
+
+require 'date'
+require 'yaml'
+require 'pathname'
+require 'luca_record'
+
+module LucaDeal
+  class Product < LucaRecord::Base
+    @dirname = 'products'
+    @required = ['items']
+
+    def list_name
+      list = self.class.all.map { |dat| parse_current(dat) }
+      YAML.dump(list).tap { |l| puts l }
+    end
+
+    # Save data with hash in Product format. Simple format is also available as bellows:
+    #   {
+    #      name: 'item_name(required)', price: 'item_price', qty: 'item_qty',
+    #      initial: { name: 'item_name', price: 'item_price', qty: 'item_qty' }
+    #   }
+    def self.create(obj)
+      if obj[:name].nil?
+        h = obj
+      else
+        items = [{
+                   'name' => obj[:name],
+                   'price' => obj[:price] || 0,
+                   'qty' => obj[:qty] || 1
+                 }]
+        if obj[:initial]
+          items << {
+            'name' => obj.dig(:initial, :name),
+            'price' => obj.dig(:initial, :price) || 0,
+            'qty' => obj.dig(:initial, :qty) || 1,
+            'type' => 'initial'
+          }
+        end
+        h = {
+          'name' => obj[:name],
+          'items' => items
+        }
+      end
+      super(h)
+    end
+  end
+end

data/lib/luca_deal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucaDeal
-  VERSION = "0.2.9"
+  VERSION = '0.2.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.18
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -83,7 +83,9 @@ files:
 - lib/luca_deal.rb
 - lib/luca_deal/contract.rb
 - lib/luca_deal/customer.rb
+- lib/luca_deal/fee.rb
 - lib/luca_deal/invoice.rb
+- lib/luca_deal/product.rb
 - lib/luca_deal/setup.rb
 - lib/luca_deal/templates/.keep
 - lib/luca_deal/templates/config.yml