lucasalary 0.1.18 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37e8c1758e8ea780f6f124747241c5c43b4047f96e6a72ebe28d3ae546034843
-  data.tar.gz: b9d761bbedb5f77d222ac7e2d16cd5258ee60d52d7e2cc75ac941f1faae2b5f2
+  metadata.gz: 49f2002c8bc5ec17d605422ee282c0b7cb6053f88aa2fa3dce308e9dbbbdc5c5
+  data.tar.gz: e993bd468b91510ad9dc68e55b58c54be562b0dcb76f9a757d4f88b6392d860d
 SHA512:
-  metadata.gz: de2e967a7585233f87b4f3eeac7729b9d183563fc71610f355ca4329e2ff521d23473514d62e514da8e3735fe7bde4d8bc7f5dd58afd3e3bad2add31bb98630d
-  data.tar.gz: b7fa56bbc2a8e15e20b6db16a7e1e4c4f6f555f0f19da175fe41e67785af84a809e7f3ee16ba1c7d5394e86038e18f0ac756f68ea26140169a1b9bb9bb8eb9dc
+  metadata.gz: 3847524b19036ca598ae119613fd49a9983ce54cdcd37f233b02fead3c636de0f4dfb2c5f80c459c1bc9d8eda82aa8ac22ddc12326fbbcb3cc13e21f9b159804
+  data.tar.gz: 15758df4fb112cf71614d11315a6477ebc5506a9176c4c29867dfc7776ea549d7a15ffe38ca1b3edab2c7993c09ae3d89ef82ef0fea01fde89538854ae4a984c

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## LucaSalary 0.1.24
+
+* Fix: remove null record from `luca-salary export` JSON
+
+## LucaSalary 0.1.23
+
+* Breaking change: move sum_code() to Class method
+
+## LucaSalary 0.1.22
+
+* Add `luca-salary payments total` command for year total
+* Fix: call localcode with calculation date
+
+## 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.

data/README.md

@@ -1,5 +1,29 @@
 # Luca Salary
 
 [![Gem Version](https://badge.fury.io/rb/lucasalary.svg)](https://badge.fury.io/rb/lucasalary)
+[![doc](https://img.shields.io/badge/doc-rubydoc-green.svg)](https://www.rubydoc.info/gems/lucasalary/index)
+![license](https://img.shields.io/github/license/chumaltd/luca)
 
-Salary calculation framework
+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

@@ -39,6 +39,10 @@ module LucaCmd
         LucaSalary::Monthly.new.report(params.dig('mode'))
       end
     end
+
+    def self.total(args = nil, _params = nil)
+      LucaSalary::Payment.year_total(args.first.to_i)
+    end
   end
 end
 
@@ -80,6 +84,12 @@ when /payments?/
       args = opt.parse(ARGV)
       LucaCmd::Payment.list(args, params)
     end
+  when 'total'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-salary payments total year'
+      args = opt.parse(ARGV)
+      LucaCmd::Payment.total(args)
+    end
   else
     puts 'Proper subcommand needed.'
     puts

data/lib/luca_salary/base.rb

@@ -14,34 +14,9 @@ module LucaSalary
 
     def initialize(date = nil)
       @date = date.nil? ? Date.today : Date.parse(date)
-      @pjdir = Pathname(LucaSupport::Config::Pjdir)
-      @config = load_config(@pjdir / 'config.yml')
       @dict = load_dict
     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}")
-        (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}")
-          # 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
@@ -62,13 +37,13 @@ module LucaSalary
       {}.tap do |h|
         (1..4).each do |n|
           code = n.to_s
-          h[code] = sum_code(obj, code)
+          h[code] = self.class.sum_code(obj, code)
         end
         h['5'] = h['1'] - h['2'] - h['3'] + h['4']
       end
     end
 
-    def sum_code(obj, code, exclude = nil)
+    def self.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.values.inject(:+) || 0
@@ -76,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.capitalize}"
       else
         nil
       end

data/lib/luca_salary/monthly.rb

@@ -14,7 +14,7 @@ module LucaSalary
 
     def initialize(date = nil)
       @date = date.nil? ? Date.today : Date.parse(date)
-      @pjdir = Pathname(LucaSupport::Config::Pjdir)
+      @pjdir = Pathname(LucaSupport::PJDIR)
       @config = load_config(@pjdir + 'config.yml')
       @driver = set_driver
     end

data/lib/luca_salary/payment.rb

@@ -13,7 +13,7 @@ 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
 
@@ -44,10 +44,52 @@ module LucaSalary
       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
+        date = Date.new(year, 12, 31)
+        payment = local_convert(payment, date)
+        create(payment, date: date, codes: [id], basedir: 'payments/total')
+      end
+    end
+
+    def self.local_convert(payment, date)
+      return payment if CONFIG['country'].nil?
+
+      require "luca_salary/#{CONFIG['country'].downcase}"
+      klass = Kernel.const_get("LucaSalary::#{CONFIG['country'].capitalize}")
+      klass.year_total(payment, date)
+    rescue NameError
+      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?
 
@@ -56,13 +98,14 @@ module LucaSalary
         h[pos][acct_label] = h[pos].key?(acct_label) ? h[pos][acct_label] + v : v
       end
       [].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))
+        {}.tap do |item|
+          item['date'] = "#{accrual_date.year}-#{accrual_date.month}-#{accrual_date.day}"
+          item['debit'] = h[:debit].reject { |_k, v| v.nil? }.map { |k, v| { 'label' => k, 'amount' => v } }
+          item['credit'] = h[:credit].reject { |_k, v| v.nil? }.map { |k, v| { 'label' => k, 'amount' => v } }
+          item['x-editor'] = 'LucaSalary'
+          res << item
+        end
+        puts JSON.dump(readable(res))
       end
     end
 

data/lib/luca_salary/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucasalary
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.24
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucarecord
@@ -68,7 +68,7 @@ dependencies:
         version: 12.3.3
 description: 'Salary calculation framework
 
-'
+  '
 email:
 - co.chuma@gmail.com
 executables:
@@ -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.3.5
 signing_key: 
 specification_version: 4
 summary: Salary calculation framework