lucadeal 0.2.9 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4958ee224643a3be3408a9b2c4043ac0ca37a1a4c7f3a537d626756a410e117
-  data.tar.gz: 74d8ead724f3cf89b0d5163565316c9421d1f8a81675e1fa28411b6248674b43
+  metadata.gz: 9a2f79f88f7a7047f07f4c2137888f43e29cec70129e0b8d79544d4c8137e2f4
+  data.tar.gz: 8d3d2dbf4908f7e5851f64003eaf39fd455f34c1e8f51c07dff7685fa913e036
 SHA512:
-  metadata.gz: 8f91f2b22e69bfa5bbde799ad4664a22b19513e75bcc5bf4a0459e5f0717a945d62abd73850821b320fcd0850c0a77537872f156769e3d3693c8e6c4de24c7c5
-  data.tar.gz: 4f333744805790545bc8ee27eb771b441a6be18dc2b635c15121a385ba7713880c22295c43e5524d1f593a55018ab506c1f56c79775db08583922594dfcab6c7
+  metadata.gz: feb4db73cf4f5d59a1caafb5e18c7e00460e9903244ba9a43ac1781b8a2ffd7b6465d95a309211e98e487b5b77daa5e1463c4647313f001b80f779c2e23354ad
+  data.tar.gz: 6204831c6bb54534a3527c7280a5c761bfb422a52831d1dd4d26b484fc221ddc78a979d5b66e42263c1a6d76ebeb140fefcb54c63a203d8b292e6ce40e5e2e05

data/README.md

@@ -1,15 +1,13 @@
-# 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.
-
-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,12 +16,138 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install luca-deal
+    $ gem install lucadeal
 
 ## Usage
 
 TODO: Write usage instructions here
 
+
+## 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'                                                                              |
+| 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         |                                          |
+| 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -32,4 +156,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

@@ -11,7 +11,7 @@ def customer(args = nil, params = {})
     LucaDeal::Customer.new.list_name
   when 'create'
     if params['name']
-      id = LucaDeal::Customer.new.generate!(params['name'])
+      id = LucaDeal::Customer.create(name: params['name'])
       puts "Successfully generated Customer  #{id}" if id
       puts 'Edit customer detail.' if id
     else

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'
@@ -13,35 +15,55 @@ module LucaDeal
       @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

@@ -21,17 +21,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_record!(fee, @date, 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

@@ -58,7 +58,6 @@ module LucaDeal
       mail
     end
 
-    #
     # Output seriarized invoice data to stdout.
     # Returns previous N months on multiple count
     #
@@ -113,20 +112,23 @@ module LucaDeal
         invoice['customer'] = get_customer(contract.dig('customer_id'))
         invoice['due_date'] = due_date(@date)
         invoice['issue_date'] = @date
+        invoice['sales_fee'] = contract.dig('sales_fee')
         invoice['items'] = contract.dig('items').map do |item|
+          next if item.dig('type') == 'initial' && subsequent_month?(contract.dig('terms', 'effective'))
+
           {}.tap do |h|
             h['name'] = item.dig('name')
             h['price'] = item.dig('price')
-            h['qty'] = item.dig('qty')
+            h['qty'] = item.dig('qty') || 1
+            h['type'] = item.dig('type') if item.dig('type')
           end
-        end
+        end.compact
         invoice['subtotal'] = subtotal(invoice['items'])
                               .map { |k, v| v.tap { |dat| dat['rate'] = k } }
         gen_invoice!(invoice)
       end
     end
 
-    #
     # set variables for ERB template
     #
     def invoice_vars(invoice_dat)
@@ -172,7 +174,6 @@ module LucaDeal
       __dir__
     end
 
-    #
     # load user company profile from config.
     #
     def set_company
@@ -183,7 +184,6 @@ module LucaDeal
       end
     end
 
-    #
     # calc items & tax amount by tax category
     #
     def subtotal(items)
@@ -199,7 +199,6 @@ module LucaDeal
       end
     end
 
-    #
     # load Tax Rate from config.
     #
     def load_tax_rate(name)
@@ -218,5 +217,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,42 @@
+# 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'
+
+    def list_name
+      list = self.class.all.map { |dat| parse_current(dat) }
+      YAML.dump(list).tap { |l| puts l }
+    end
+
+    def self.create(obj)
+      raise ':name is required' if obj[:name].nil?
+
+      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
+      }
+      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.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucadeal
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.13
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-11-05 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