lucasalary 0.1.13 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef7b2ded5f89dc7d34c475b5e57aae90efbac496dc02dba4e5f159636b7d9fa
-  data.tar.gz: 568ffe2f62bf970eb029c4cc890ed459b4bcaa411b92fe29d38229c0df4faa3c
+  metadata.gz: 37e8c1758e8ea780f6f124747241c5c43b4047f96e6a72ebe28d3ae546034843
+  data.tar.gz: b9d761bbedb5f77d222ac7e2d16cd5258ee60d52d7e2cc75ac941f1faae2b5f2
 SHA512:
-  metadata.gz: 168536d2eb3dc3b5b83fd165961b29f36b266e0b314ad3516e213ac7701c849fc8f1357fb13c8cb3ec7aa2f9b16a9999545113aea11db690bc13bf0338ff1231
-  data.tar.gz: 213d83129344747bf8a3857928f4fbba02495c4c14bebfa24263f77723f12b3b395cd92b4d8505889929833202a72ae9b7850aa77a2b03287c94be0a752d0698
+  metadata.gz: de2e967a7585233f87b4f3eeac7729b9d183563fc71610f355ca4329e2ff521d23473514d62e514da8e3735fe7bde4d8bc7f5dd58afd3e3bad2add31bb98630d
+  data.tar.gz: b7fa56bbc2a8e15e20b6db16a7e1e4c4f6f555f0f19da175fe41e67785af84a809e7f3ee16ba1c7d5394e86038e18f0ac756f68ea26140169a1b9bb9bb8eb9dc

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## LucaSalary 0.1.18
+
+* Add summary to payslip. Refactor monthly payment.
+
+## LucaSalary 0.1.17
+
+* Breaking change: restructure CLI in sub-sub command format.
+* Add 'x-editor' on export to LucaBook

data/README.md

@@ -1,2 +1,5 @@
 # Luca Salary
+
+[![Gem Version](https://badge.fury.io/rb/lucasalary.svg)](https://badge.fury.io/rb/lucasalary)
+
 Salary calculation framework

data/exe/luca-salary

@@ -5,60 +5,93 @@ require 'optparse'
 require 'luca_salary'
 require 'luca_salary/monthly'
 
-def export(args = nil, _params = nil)
-  if args
-    args << 28 if args.length == 2 # specify safe last day
-    LucaSalary::Monthly.new(args.join('-')).export_json
-  else
-    LucaSalary::Monthly.new.export_json
+module LucaCmd
+  class Profile
+    def self.create(args = nil, _params = nil)
+      LucaSalary::Profile.gen_profile!(args.first)
+    end
   end
-end
 
-def payment(args = nil, _params = nil)
-  if args
-    args << 28 if args.length == 2 # specify safe last day
-    LucaSalary::Base.new(args.join('-')).calc
-  else
-    LucaSalary::Base.new.calc
-  end
-end
+  class Payment
+    def self.create(args = nil, _params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaSalary::Monthly.new(args.join('-')).calc
+      else
+        LucaSalary::Monthly.new.calc
+      end
+    end
 
-def report(args = nil, params = nil)
-  if args
-    args << 28 if args.length == 2 # specify safe last day
-    LucaSalary::Monthly.new(args.join('-')).report(params.dig('mode'))
-  else
-    LucaSalary::Monthly.new.report(params.dig('mode'))
-  end
-end
+    def self.export(args = nil, _params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaSalary::Payment.new(args.join('-')).export_json
+      else
+        LucaSalary::Payment.new.export_json
+      end
+    end
 
-def add_person(args = nil, _params = nil)
-  LucaSalary::Profile.gen_profile!(args.first)
+    def self.list(args = nil, params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaSalary::Monthly.new(args.join('-')).report(params.dig('mode'))
+      else
+        LucaSalary::Monthly.new.report(params.dig('mode'))
+      end
+    end
+  end
 end
 
+LucaRecord::Base.valid_project?
 cmd = ARGV.shift
+params = {}
 
 case cmd
-when 'add'
-  add_person(ARGV)
-when 'export'
-  export(ARGV)
-when 'report'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-salary report [--mail] year month [date]'
-    opt.on('--mail', 'send to managers') { |_v| params['mode'] = 'mail' }
-    args = opt.parse(ARGV)
-    report(args, params)
+when /profiles?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-salary profiles create Name'
+      args = opt.parse(ARGV)
+      LucaCmd::Profile.create(args)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-salary profile[s] create Name'
+    exit 1
   end
-when 'payment'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-salary payment [--mail] year month [date]'
-    opt.on('--mail', 'send to managers') { |_v| params['mode'] = 'mail' }
-    args = opt.parse(ARGV)
-    payment(args)
+when 'export'
+  LucaCmd::Payment.export(ARGV)
+when /payments?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-salary payments create year month [date]'
+      args = opt.parse(ARGV)
+      LucaCmd::Payment.create(args)
+    end
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-salary payments list [--mail] year month [date]'
+      opt.on('--mail', 'send to managers') { |_v| params['mode'] = 'mail' }
+      args = opt.parse(ARGV)
+      LucaCmd::Payment.list(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-salary payment[s] (create|list) [--help|options]'
+    exit 1
   end
 else
-  puts 'Invalid subcommand'
+  puts 'Proper subcommand needed.'
+  puts
+  puts 'Usage: luca-salary subcommand [options]'
+  puts '        profiles'
+  puts '        payments'
+  puts '        export: puts payment data for LucaBook import'
+  exit 1
 end

data/lib/luca_salary.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'luca_record'
 require 'luca_salary/version'
 
 module LucaSalary

data/lib/luca_salary/base.rb

@@ -9,39 +9,25 @@ require 'luca_record'
 
 module LucaSalary
   class Base < LucaRecord::Base
-    attr_reader :driver, :dict, :config, :pjdir
+    attr_reader :dict, :config, :pjdir
     @dirname = 'payments'
 
     def initialize(date = nil)
       @date = date.nil? ? Date.today : Date.parse(date)
       @pjdir = Pathname(LucaSupport::Config::Pjdir)
-      @config = load_config(@pjdir + 'config.yml')
-      @driver = set_driver
+      @config = load_config(@pjdir / 'config.yml')
       @dict = load_dict
     end
 
-    #
-    # call country specific calculation
-    #
-    def calc
-      self.class.prepare_dir!(datadir / 'payments', @date)
-      country = @driver.new(@pjdir, @config, @date)
-      LucaSalary::Profile.all do |profile|
-        current_profile = parse_current(profile)
-        h = country.calc_payment(current_profile)
-        LucaSalary::Payment.new(@date.to_s).create(current_profile, h)
-      end
-    end
-
     def gen_aggregation!
       LucaSalary::Profile.all do |profile|
         id = profile.dig('id')
         payment = {}
         targetdir = @date.year.to_s + 'Z'
-        past_data = LucaRecord::Base.find(id, "payments/#{targetdir}").first
+        past_data = LucaRecord::Base.find(id, "payments/#{targetdir}")
         (1..12).map do |month|
           origin_dir = @date.year.to_s + [nil, 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L'][month]
-          origin = LucaRecord::Base.find(id, "payments/#{origin_dir}").first
+          origin = LucaRecord::Base.find(id, "payments/#{origin_dir}")
           # TODO: to be updated null check
           if origin == {}
             month
@@ -60,17 +46,31 @@ module LucaSalary
       dat.filter { |k, _v| /^#{code}[0-9A-Fa-f]{,3}$/.match(k.to_s) }
     end
 
+    # Subtotal each items.
+    # 1::
+    #    Base salary or wages.
+    # 2::
+    #    Deduction directly related to work payment, including tax, insurance, pension and so on.
+    # 3::
+    #    Deduction for miscellaneous reasons.
+    # 4::
+    #    Addition for miscellaneous reasons.
+    # 5::
+    #    Net payment amount.
+    #
     def amount_by_code(obj)
       {}.tap do |h|
         (1..4).each do |n|
-          h["#{n}00"] = sum_code(obj, n)
+          code = n.to_s
+          h[code] = sum_code(obj, code)
         end
+        h['5'] = h['1'] - h['2'] - h['3'] + h['4']
       end
     end
 
     def sum_code(obj, code, exclude = nil)
-      target = obj.select { |k, v| /^#{code}[0-9A-Fa-f]{,3}$/.match(k) }
-      target = target.reject { |k, v| exclude.include?(k) } if exclude
+      target = obj.select { |k, _v| /^#{code}[0-9A-Fa-f]{,3}$/.match(k) }
+      target = target.reject { |k, _v| exclude.include?(k) } if exclude
       target.values.inject(:+) || 0
     end
 
@@ -88,7 +88,7 @@ module LucaSalary
       code = @config['countryCode']
       if code
         require "luca_salary/#{code.downcase}"
-        Kernel.const_get "LucaSalary#{code.upcase}"
+        Kernel.const_get "LucaSalary::#{code.upcase}"
       else
         nil
       end

data/lib/luca_salary/monthly.rb

@@ -9,26 +9,46 @@ require 'luca_salary'
 require 'luca_record'
 
 module LucaSalary
-  class Monthly < LucaRecord::Base
+  class Monthly < LucaSalary::Base
+    @dirname = 'payments'
+
     def initialize(date = nil)
-      @date = parse_date(date)
+      @date = date.nil? ? Date.today : Date.parse(date)
       @pjdir = Pathname(LucaSupport::Config::Pjdir)
       @config = load_config(@pjdir + 'config.yml')
+      @driver = set_driver
     end
 
+    # call country specific calculation
     #
+    def calc
+      country = @driver.new(@pjdir, @config, @date)
+      # TODO: handle retirement
+      LucaSalary::Profile.all do |profile|
+        current_profile = parse_current(profile)
+        if self.class.search(@date.year, @date.month, @date.day, current_profile['id']).count > 0
+          puts "payment record already exists: #{current_profile['id']}"
+          return nil
+        end
+        h = country.calc_payment(current_profile)
+        h['profile_id'] = current_profile['id']
+        self.class.create(h, date: @date, codes: Array(current_profile['id']))
+      end
+    end
+
     # output payslips via mail or console
     #
     def report(mode = nil)
+      data = LucaSalary::Payment.new(@date.to_s).payslip
       if mode == 'mail'
         mail = Mail.new do
           subject '[luca salary] Monthly Payment'
         end
         mail.to = @config.dig('mail', 'report_mail')
-        mail.text_part = YAML.dump(LucaSalary::Payment.new(@date.to_s).payslip)
+        mail.text_part = YAML.dump(LucaSupport::Code.readable(data))
         LucaSupport::Mail.new(mail, @pjdir).deliver
       else
-        puts YAML.dump(LucaSalary::Payment.new(@date.to_s).payslip)
+        puts YAML.dump(LucaSupport::Code.readable(data))
       end
     end
 

data/lib/luca_salary/payment.rb

@@ -17,34 +17,28 @@ module LucaSalary
       @dict = LucaRecord::Dict.load_tsv_dict(@pjdir / 'dict' / 'code.tsv')
     end
 
-    #
-    # create record with LucaSalary::Profile instance and apyment data
-    #
-    def create(profile, payment)
-      id = profile.dig('id')
-      if self.class.search(@date.year, @date.month, @date.day, id).first
-        puts "payment record already exists: #{id}"
-        return nil
-      end
-
-      self.class.gen_record_file!('payments', @date, Array(id)) do |f|
-        f.write(YAML.dump(payment.sort.to_h))
-      end
-    end
-
     def payslip
       {}.tap do |report|
         report['asof'] = "#{@date.year}/#{@date.month}"
+        report['payments'] = []
         report['records'] = []
 
         self.class.asof(@date.year, @date.month) do |payment|
+          profile = LucaSalary::Profile.find(payment['profile_id'])
+          summary = {
+            'name' => profile['name'],
+            "#{@dict.dig('5', :label) || '5'}" => payment['5']
+          }
+
           slip = {}.tap do |line|
+            line['name'] = profile['name']
             payment.each do |k, v|
               next if k == 'id'
 
               line["#{@dict.dig(k, :label) || k}"] = v
             end
           end
+          report['payments'] << summary
           report['records'] << slip
         end
       end
@@ -61,11 +55,15 @@ module LucaSalary
         acct_label = @dict[k][:acct_label]
         h[pos][acct_label] = h[pos].key?(acct_label) ? h[pos][acct_label] + v : v
       end
-      res = {}
-      res['date'] = "#{@date.year}-#{@date.month}-#{@date.day}"
-      res['debit'] = h[:debit].map { |k, v| { 'label' => k, 'value' => v } }
-      res['credit'] = h[:credit].map { |k, v| { 'label' => k, 'value' => v } }
-      puts JSON.dump(res)
+      [].tap do |res|
+        item = {}
+        item['date'] = "#{@date.year}-#{@date.month}-#{@date.day}"
+        item['debit'] = h[:debit].map { |k, v| { 'label' => k, 'value' => v } }
+        item['credit'] = h[:credit].map { |k, v| { 'label' => k, 'value' => v } }
+        item['x-editor'] = 'LucaSalary'
+        res << item
+        puts JSON.dump(LucaSupport::Code.readable(res))
+      end
     end
 
     private

data/lib/luca_salary/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucaSalary
-  VERSION = '0.1.13'
+  VERSION = '0.1.18'
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: lucasalary
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.18
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lucarecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 12.3.3
 description: 'Salary calculation framework
 
 '
@@ -73,7 +87,8 @@ files:
 - lib/luca_salary/profile.rb
 - lib/luca_salary/version.rb
 homepage: https://github.com/chumaltd/luca/tree/master/lucasalary
-licenses: []
+licenses:
+- GPL
 metadata:
   homepage_uri: https://github.com/chumaltd/luca/tree/master/lucasalary
   source_code_uri: https://github.com/chumaltd/luca/tree/master/lucasalary
@@ -86,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="