lucasalary 0.1.15 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4928e4415a3764ec3e5a03ce991aedfe31f06e8b8203c000fce9047b60b99d2e
-  data.tar.gz: 3efac02b94c11e641685ba451480eb82691b6d8c5a9dac6b730c17f71543c76a
+  metadata.gz: 7c27c381516005d8ae6962c4d0a44ff0a351f9fd097da547f6dfdcb88d7a6b0d
+  data.tar.gz: 1b116229596958583c4c06b9fef3675cd53a1c7e70e04ef80fdc3733f6417b36
 SHA512:
-  metadata.gz: bf61eab9155888116b78185af91200181a3ff25f083edb6786868cd92f6fce93007c07857f308e7aff725cf20e5e17918661e6c587d87863a346280be048a104
-  data.tar.gz: 5646a55e8bfe9e190fbbf6d87b42d8c3356e662ec5420122d4482d9f3da62e1b4b6ebc76ca0c245c9985181aabe701593079d65359600a948f0d06adb60cc3d5
+  metadata.gz: 970e6cacf4d6b781831b53b714c7c4a7ec01de8c58fcc6ae59f396b52875d1024c36008276ed13caefc9a9809bfa363428e7c4884240e7f3f055434fdf76dfb4
+  data.tar.gz: a1658dfc041cb48eb30f7eca5c762b2f4940f0ffd1dc7d1e03fe16e25075c650d0a0a1f6752ebab387b83f01a047c720aafebf6f6b1b56d1c68b62e35a0feeca

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## LucaSalary 0.1.20
+
+* Implement `year_total`
+* Breaking change: export key 'value' -> 'amount'
+
+## LucaSalary 0.1.19
+
+* Support `payment_term` on config.yml for accounting export.
+
+## 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,27 @@
 # Luca Salary
-Salary calculation framework
+
+[![Gem Version](https://badge.fury.io/rb/lucasalary.svg)](https://badge.fury.io/rb/lucasalary)
+
+LucaSalary is Abstraction framework coworking with each country module. As income tax differs in each county, most of implementation need to be developed separately.  
+At this time, [Japan module](https://github.com/chumaltd/luca-salary-jp) is under development as a practical reference.
+
+## Usage
+
+Create blank profile of employees.
+
+```
+$ luca-salary profiles create EmployeeName
+```
+
+Profile is in YAML format. Need to describe along with each country requirement.  
+Once profiles completed, monthly payment records can be generated as follows:
+
+```
+$ luca-salary payments create yyyy m
+```
+
+Report is available with generated data as follows:
+
+```
+$ luca-salary payments list [--mail] yyyy m
+```

data/exe/luca-salary

@@ -5,61 +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/base.rb

@@ -9,58 +9,18 @@ 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
       @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
-        (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
-          # TODO: to be updated null check
-          if origin == {}
-            month
-          else
-            origin.select { |k, _v| /^[1-4][0-9A-Fa-f]{,3}$/.match(k) }.each do |k, v|
-              payment[k] = payment[k] ? payment[k] + v : v
-            end
-            nil
-          end
-        end
-        self.class.create(past_data.merge!(payment), "payments/#{targetdir}")
-      end
-    end
-
     def select_code(dat, code)
       dat.filter { |k, _v| /^#{code}[0-9A-Fa-f]{,3}$/.match(k.to_s) }
     end
 
-    #
     # Subtotal each items.
     # 1::
     #    Base salary or wages.
@@ -91,19 +51,15 @@ module LucaSalary
 
     private
 
-    def datadir
-      @pjdir / 'data'
-    end
-
     def load_dict
-      LucaRecord::Dict.load_tsv_dict(@pjdir / 'dict' / 'code.tsv')
+      LucaRecord::Dict.load_tsv_dict(Pathname(PJDIR) / 'dict' / 'code.tsv')
     end
 
     def set_driver
-      code = @config['countryCode']
+      code = CONFIG['country']
       if code
         require "luca_salary/#{code.downcase}"
-        Kernel.const_get "LucaSalary::#{code.upcase}"
+        Kernel.const_get "LucaSalary::#{code.capitalise}"
       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)
-      @pjdir = Pathname(LucaSupport::Config::Pjdir)
+      @date = date.nil? ? Date.today : Date.parse(date)
+      @pjdir = Pathname(LucaSupport::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

@@ -13,44 +13,82 @@ module LucaSalary
 
     def initialize(date = nil)
       @date = Date.parse(date)
-      @pjdir = Pathname(LucaSupport::Config::Pjdir)
+      @pjdir = Pathname(LucaSupport::PJDIR)
       @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.create_record!(payment, @date, Array(id))
-    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
     end
 
+    def self.year_total(year)
+      Profile.all do |profile|
+        id = profile.dig('id')
+        payment = { 'profile_id' => id }
+        # payment = {}
+        (1..12).each do |month|
+          search(year, month, nil, id).each do |origin|
+            # TODO: to be updated null check
+            if origin == {}
+              month
+            else
+              origin.select { |k, _v| /^[1-4][0-9A-Fa-f]{,3}$/.match(k) }.each do |k, v|
+                payment[k] = payment[k] ? payment[k] + v : v
+              end
+              nil
+            end
+          end
+        end
+        payment = local_convert(payment)
+        create(payment, date: Date.new(year, 12, 31), codes: [id], basedir: 'payments/total')
+      end
+    end
+
+    def self.local_convert(payment)
+      return payment if CONFIG['country'].nil?
+
+      require "luca_salary/#{CONFIG['country'].downcase}"
+      klass = Kernel.const_get("LucaSalary::#{CONFIG['country'].capitalize}")
+      klass.year_total(payment)
+    rescue
+      return payment
+    end
+
+    # Export json for LucaBook.
+    # Accrual_date can be change with `payment_term` on config.yml. Default value is 0.
+    # `payment_term: 1` means payment on the next month of calculation target.
+    #
     def export_json
-      h = {}
-      h[:debit] = {}
-      h[:credit] = {}
+      accrual_date = if LucaSupport::CONFIG['payment_term']
+                       pt = LucaSupport::CONFIG['payment_term']
+                       Date.new(@date.prev_month(pt).year, @date.prev_month(pt).month, -1)
+                     else
+                       Date.new(@date.year, @date.month, -1)
+                     end
+      h = { debit: {}, credit: {} }
       accumulate.each do |k, v|
         next if @dict.dig(k, :acct_label).nil?
 
@@ -58,11 +96,16 @@ 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|
+        {}.tap do |item|
+          item['date'] = "#{accrual_date.year}-#{accrual_date.month}-#{accrual_date.day}"
+          item['debit'] = h[:debit].map { |k, v| { 'label' => k, 'amount' => v } }
+          item['credit'] = h[:credit].map { |k, v| { 'label' => k, 'amount' => v } }
+          item['x-editor'] = 'LucaSalary'
+          res << item
+        end
+        puts JSON.dump(readable(res))
+      end
     end
 
     private

data/lib/luca_salary/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucasalary
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.20
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -28,44 +28,44 @@ dependencies:
   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
 
 '
@@ -108,7 +108,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: Salary calculation framework