uob-payroll 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ffc20a1da3bc5aebc95f34d5751534f32886c086
-  data.tar.gz: 6ff939c710c741b2700d934f17b45dce2b4cdc19
+SHA256:
+  metadata.gz: 5dffc887932bef572a29ee714a2df50ec348256822bf8d8b00ff87690b9f44db
+  data.tar.gz: 720c558fbdd4414c4bcb341e3bb2b7f813ee80ded4e601e98a41f726e6ba1449
 SHA512:
-  metadata.gz: c5b8e0106265cc6a2b1ef65b52d2e653962808eb93577b0231405383bb719d70f60fffcd24688557b976849042f19857b942a3b729ac8fa5013f77bcabaa2ffe
-  data.tar.gz: 7304289625f6026dbc825163d15f368c3671ad9ac45657ecec7f4f594c03f1a88739bae5cf1aead15dbb231bd4653498d8703e78ddffe028508857b053e80524
+  metadata.gz: '09068c411cb2e052d0ac2c6e92d2c2d20f0b13fa1630d0802618dd9040466f17cacfe13063ce2cfa2409e7ab62d7496f7e6dc0afab78a8a127d78cddaa55d7c9'
+  data.tar.gz: 864c2477f16f0a45c9fa423a2344575cadef9b8a27d6f6061c7fd05bed96b18994264e8945ce8e3f6f4deca8c4739ed7334386a2875dcf43ab15027674907602

data/.github/workflows/build.yml

@@ -0,0 +1,63 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.7
+          - 2.6
+          - 2.5
+          - 2.4
+          - 2.3
+          - 2.2
+        gemfile:
+          - Gemfile-5-0
+          - Gemfile-5-1
+          - Gemfile-5-2
+          - Gemfile-6-0
+          - Gemfile-6-1
+        exclude:
+        - gemfile: Gemfile-6-0
+          ruby: 2.4
+        - gemfile: Gemfile-6-1
+          ruby: 2.4
+        - gemfile: Gemfile-6-0
+          ruby: 2.3
+        - gemfile: Gemfile-6-1
+          ruby: 2.3
+        - gemfile: Gemfile-6-0
+          ruby: 2.2
+        - gemfile: Gemfile-6-1
+          ruby: 2.2
+        - gemfile: Gemfile-5-0
+          ruby: 2.7
+        - gemfile: Gemfile-5-1
+          ruby: 2.7
+        - gemfile: Gemfile-5-0
+          ruby: 3.0
+        - gemfile: Gemfile-5-1
+          ruby: 3.0
+        - gemfile: Gemfile-5-2
+          ruby: 3.0
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec

data/gemfiles/Gemfile-5-0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.0.7'
+gem 'sqlite3', '< 1.4'

data/gemfiles/Gemfile-5-1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.1.4'

data/gemfiles/Gemfile-5-2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.2.6'

data/gemfiles/Gemfile-6-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0.4'

data/gemfiles/Gemfile-6-1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.1.4'

data/lib/txt_data/format_helpers.rb

@@ -0,0 +1,51 @@
+module TxtData
+  # A helpful module for formatting fields for fixed length txt data files.
+  module FormatHelpers
+    # Right justified, "0" padded, 2 decimal places, with no separator.
+    # @param [Fixnum] value
+    # @param [Fixnum] length
+    def money_format(value, length:, just: :right, pad: '0')
+      txt = ("%.2f" % value.round(2)).to_s.sub(".", "").truncate(length, omission: "")
+      justify(txt, length, just, pad)
+    end
+
+    # Right justified, "0" padded, no decimal places, with no separator.
+    # @param [Fixnum] value
+    # @param [Fixnum] length
+    # @param [Symbol] just
+    # @param [String] pad
+    def number_format(value, length:, just: :right, pad: '0')
+      txt = value.to_i.to_s.truncate(length, omission: "")
+      justify(txt, length, just, pad)
+    end
+
+    # Left justified, " " padded, text.
+    # @param [String] value
+    # @param [Fixnum] length
+    # @param [Symbol] just
+    # @param [String] pad
+    def text_format(value, length:, just: :left, sanitize:, pad: ' ')
+      txt = sanitize ? filter_illegal_characters(value.to_s).truncate(length, omission: "") : value
+      justify(txt, length, just, pad)
+    end
+
+    # Filters invalid characters specified in CPF eSubmission spec file.
+    # @param [String] value
+    def filter_illegal_characters(value)
+      value.tr("-_+$<>:;?!=[]`^|\\'\"`~", "")
+    end
+
+    private
+
+    def justify(txt, length, just, pad)
+      case just
+      when :left
+        txt.ljust(length, pad)
+      when :right
+        txt.rjust(length, pad)
+      else
+        raise ArgumentError, "Justification #{just} is not supported."
+      end
+    end
+  end
+end

data/lib/txt_data/txt_data_row_dsl/field.rb

@@ -0,0 +1,43 @@
+require 'txt_data/format_helpers'
+
+module TxtData::TxtDataRowDSL
+  Field = Struct.new(:symbol, :range, :just, :pad, :value, :format, :sanitize) do
+    include TxtData::FormatHelpers
+
+    def to_s(record)
+      data = get_data(record)
+      validate_length!(data)
+      format_data data
+    end
+
+    private
+
+    def format_data(data)
+      case format
+      when :text
+        format_text(data, sanitize: sanitize)
+      when :number
+        number_format(data, length: range.size, just: just, pad: pad)
+      when :money
+        money_format(data, length: range.size, just: just, pad: pad)
+      else
+        raise ArgumentError, "Unsupported format #{format}"
+      end
+    end
+
+    def validate_length!(data)
+      #Do not use .blank?  we need to match ' ' for pad.
+      if (pad.nil? || pad.empty?) && data.length != range.size
+        raise ArgumentError, "Data #{data} is not the correct length for field #{symbol}"
+      end
+    end
+
+    def get_data(record)
+      value || record.public_send(symbol)
+    end
+
+    def format_text(data, sanitize:)
+      text_format(data.to_s, length: range.size, just: just, pad: pad, sanitize: sanitize)
+    end
+  end
+end

data/lib/txt_data/txt_data_row_dsl.rb

@@ -0,0 +1,79 @@
+module TxtData
+  # DSL for defining a class which gives you back a row of a txt data file.
+  # @example
+  # class MyTxtRow
+  #   include TxtData::TxtDataRowDSL
+  #   text :date, 1..6
+  #   spaces 7..51
+  #   number :my_number, 52..55
+  #   text :my_text, 56..58
+  #   text :my_fixed_text, 58..71, value: '1234'
+  #
+  #   def date
+  #     '151201'
+  #   end
+  #
+  #   def my_number
+  #     12
+  #   end
+  #
+  #   def my_text
+  #     "barf"
+  #   end
+  # end
+  # Use #text to define some text, it is by default left padded with spaces
+  # Use #number fo define a number, it is by default left padded with zeroes
+  # Use #spaces to add spaces in that field.
+  module TxtDataRowDSL
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+    autoload :Field
+
+    class_methods do
+      def fields
+        @fields ||= []
+      end
+
+      # Add a text field, right justified with space padding by default.
+      # @param [Symbol] symbol
+      # @param [Range] range
+      # @param [:right|:left] just
+      # @param [String] pad
+      # @param [String] value
+      def text(symbol, range, just: :right, pad: ' ', value: nil, sanitize: true)
+        data(symbol, range, just: just, pad: pad, format: :text, value: value, sanitize: sanitize)
+      end
+
+      def money(symbol, range, just: :right, pad: '0', value: nil)
+        data(symbol, range, just: just, pad: pad, format: :money, value: value)
+      end
+
+      # Add a number field, right justified with zero padding by default.
+      # @param [Symbol] symbol
+      # @param [Range] range
+      # @param [:right|:left] just
+      # @param [String] pad
+      # @param [String] value
+      def number(symbol, range, just: :right, pad: '0', value: nil)
+        data(symbol, range, just: just, pad: pad, format: :number, value: value)
+      end
+
+      # @param [Range] range
+      def spaces(range)
+        data(:spaces, range, just: :left, pad: ' ', format: :text, value: ' ' * range.size)
+      end
+
+      private
+
+      def data(symbol, range, just: :none, pad:, value: nil, format: :text, sanitize: true)
+        fields << Field.new(symbol, range, just, pad, value, format, sanitize)
+      end
+    end
+
+    def to_s
+      self.class.fields.map { |field|
+        field.to_s(self)
+      }.join("")
+    end
+  end
+end

data/lib/uob/payroll/hash_calculator.rb

@@ -28,7 +28,7 @@ module UOB
       def sum_header
         calculate_string(header.originating_bic_code) +
           calculate_padded_string(string: header.originating_account_number, size: 34) +
-          calculate_padded_string(string: header.originating_account_name, size: 140)
+          calculate_padded_string(string: sanitize(header.originating_account_name), size: 140)
       end
 
       def sum_rows
@@ -41,7 +41,7 @@ module UOB
 
           sum += calculate_string(row.receiving_bic_code) +
             hash_code * calculate_padded_string(string: row.receiving_account_number, size: 34) +
-            hash_code * calculate_padded_string(string: row.receiving_account_name, size: 140) +
+            hash_code * calculate_padded_string(string: sanitize(row.receiving_account_name), size: 140) +
             calculate_payment_type(hash_code) +
             calculate_string('SGD') +
             calculate_padded_string(string: row.formatted_amount, size: 18, pad: '0', just: :right) +
@@ -53,6 +53,11 @@ module UOB
 
       private
 
+      # Remove "-" from names.
+      def sanitize(string)
+        string.gsub(/-|'/,'')
+      end
+
       # Payment Type is always 'R', so Payment Code = 22
       def calculate_payment_type(index)
         22 * (index)

data/lib/uob/payroll/txt_file/footer.rb

@@ -1,12 +1,12 @@
 require 'active_model'
-require 'ph_utility'
 require_relative '../hash_calculator'
+require 'txt_data/txt_data_row_dsl'
 
 module UOB
   module Payroll
     class TXTFile::Footer
       include ActiveModel::Model
-      include PhUtility::TxtData::TxtDataRowDSL
+      include TxtData::TxtDataRowDSL
 
       number :record_type, 1..1, value: 9
       text :formatted_total_amount, 2..19, just: :right, pad: '0'

data/lib/uob/payroll/txt_file/header.rb

@@ -1,11 +1,11 @@
 require 'active_model'
-require 'ph_utility'
+require 'txt_data/txt_data_row_dsl'
 
 module UOB
   module Payroll
     class TXTFile::Header
       include ActiveModel::Model
-      include PhUtility::TxtData::TxtDataRowDSL
+      include TxtData::TxtDataRowDSL
 
       number :record_type, 1..1, value: 1
       text :filename, 2..11

data/lib/uob/payroll/txt_file/row.rb

@@ -1,11 +1,11 @@
 require 'active_model'
-require 'ph_utility'
+require 'txt_data/txt_data_row_dsl'
 
 module UOB
   module Payroll
     class TXTFile::Row
       include ActiveModel::Model
-      include PhUtility::TxtData::TxtDataRowDSL
+      include TxtData::TxtDataRowDSL
 
       number :record_type, 1..1, value: 2
       text :receiving_bic_code, 2..12, just: :left
@@ -30,13 +30,13 @@ module UOB
         @bic_code = bic_code
         @account_number = account_number
         @account_name = account_name
-        @amount = amount
+        @amount = amount.is_a?(String) ? BigDecimal(amount) : amount
 
         raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
       end
 
       def formatted_amount
-        (format '%014.2f', amount).gsub('.','')
+        (format '%014.2f', amount.round(2)).gsub('.','')
       end
 
       def receiving_bic_code

data/lib/uob/payroll/txt_file.rb

@@ -20,7 +20,7 @@ module UOB
           value_date: payable_date
         )
         @rows = transactions.map { |transaction| Row.new transaction }
-        @footer = Footer.new total_amount: rows.sum(&:amount), header: header, rows: rows
+        @footer = Footer.new total_amount: total_amount(rows), header: header, rows: rows
       end
 
       def content
@@ -33,6 +33,14 @@ module UOB
 
       private
 
+      # We need to round each amount first before summing them up so that it matches
+      # the amounts in the details
+      def total_amount(rows)
+        rows.each.map { |row|
+          row.amount.round(2)
+        }.reduce(0, :+)
+      end
+
       attr_accessor :header, :rows, :footer
     end
   end

data/lib/uob/payroll/version.rb

@@ -1,5 +1,5 @@
 module Uob
   module Payroll
-    VERSION = "1.0.5"
+    VERSION = "1.1.0"
   end
 end

data/uob-payroll.gemspec

@@ -19,14 +19,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "> 1.16", "< 3"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'github_changelog_generator'
+  if RUBY_VERSION < "2.3"
+    spec.add_development_dependency 'github_changelog_generator', '< 1.15'
+  else
+    spec.add_development_dependency 'github_changelog_generator'
+  end
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'activemodel'
   spec.add_dependency 'ph_model'
-  spec.add_dependency 'ph_utility'
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: uob-payroll
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Vincent Paca
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +128,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ph_utility
-  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'
 description: A UOB Payroll File Generator
 email:
 - vpaca@payrollhero.com
@@ -143,6 +135,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -155,6 +148,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/Gemfile-5-0
+- gemfiles/Gemfile-5-1
+- gemfiles/Gemfile-5-2
+- gemfiles/Gemfile-6-0
+- gemfiles/Gemfile-6-1
+- lib/txt_data/format_helpers.rb
+- lib/txt_data/txt_data_row_dsl.rb
+- lib/txt_data/txt_data_row_dsl/field.rb
 - lib/uob/payroll.rb
 - lib/uob/payroll/errors.rb
 - lib/uob/payroll/hash_calculator.rb
@@ -184,8 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: A UOB Payroll File Generator