aub-payroll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b61ae020a0974c8833e3b7a7cd4956aeda629da
+  data.tar.gz: d18a160389743a79e08f2fd2b8b6e8ef923486b3
+SHA512:
+  metadata.gz: 3c286327ba7620e0a4b828bbfb1a4a35dd22a97da124f4f274f370bb714c244f29adf1b10531d41493603c597039450b4e3294e0932f3b74a4c73149db366d7d
+  data.tar.gz: 7edb9ccd4d8cdb992c06181394e4f76001af1ce52850f632d8f64729877c75be2e6b4cd573802e1f0453f7a1020964d2348d83dacb2536e60c786fb5fb206a9a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aub-payroll.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, PayrollHero PTE. Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of zoho-subscriptions nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,56 @@
+# AUB::Payroll
+
+[![Gem Version](https://badge.fury.io/rb/aub-payroll.svg)](http://badge.fury.io/rb/aub-payroll)
+[![Code Climate](https://codeclimate.com/github/payrollhero/aub-payroll/badges/gpa.svg)](https://codeclimate.com/github/payrollhero/aub-payroll)
+[![Build Status](https://travis-ci.org/payrollhero/aub-payroll.svg)](https://travis-ci.org/payrollhero/aub-payroll)
+
+An AUB Payroll File Generator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aub-payroll'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aub-payroll
+
+## Usage
+
+```ruby
+  file = AUB::Payroll::File.new company_name: "StyroPrints",
+                                date: Date.new(2000, 6, 2),
+                                transactions: [
+                                  { account_number: "001120001146", amount: 540.00 },
+                                  { account_number: "001120001146", amount: 921.00 },
+                                  { account_number: "001120001146", amount: 816.25 },
+                                  { account_number: "001120001146", amount: 500.00 },
+                                  { account_number: "001120001146", amount: 882.50 },
+                                  { account_number: "001120001146", amount: 857.50 },
+                                  { account_number: "001120001146", amount: 1_044.00 },
+                                  { account_number: "001120001146", amount: 1_612.50 }
+                                ]
+
+  File.write "payroll.epf", file.content
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/payrollhero/aub-payroll/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/aub-payroll.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aub/payroll/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aub-payroll"
+  spec.version       = AUB::Payroll::VERSION
+  spec.authors       = ["Ronald Maravilla"]
+  spec.email         = ["rmaravilla@payrollhero.com"]
+
+  spec.summary       = %q{An AUB Payroll File Generator.}
+  spec.description   = %q{An AUB Payroll File Generator.}
+  spec.homepage      = "https://github.com/payrollhero/aub-payroll"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aub/payroll"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aub/payroll.rb

@@ -0,0 +1,13 @@
+require "aub/payroll/version"
+require "active_support"
+require "active_support/dependencies/autoload"
+require "active_support/core_ext/enumerable"
+
+module AUB
+  module Payroll
+    extend ActiveSupport::Autoload
+
+    autoload :Errors
+    autoload :File
+  end
+end

data/lib/aub/payroll/errors.rb

@@ -0,0 +1,11 @@
+module AUB
+  module Payroll
+    module Errors
+      class Error < StandardError
+      end
+
+      class Invalid < Error
+      end
+    end
+  end
+end

data/lib/aub/payroll/file.rb

@@ -0,0 +1,33 @@
+require "active_model"
+
+module AUB
+  module Payroll
+    class File
+      extend ActiveSupport::Autoload
+
+      autoload :Header
+      autoload :Row
+      autoload :Footer
+
+      include ActiveModel::Model
+
+      def initialize(company_name:, date:, transactions:)
+        @header = Header.new company_name: company_name, date: date
+        @rows = transactions.map { |transaction| Row.new transaction }
+        @footer = Footer.new number_of_records: rows.count, total_amount: rows.sum(&:amount)
+      end
+
+      def content
+        [
+          header,
+          rows,
+          footer,
+        ].join("\r\n")
+      end
+
+      private
+
+      attr_accessor :header, :rows, :footer
+    end
+  end
+end

data/lib/aub/payroll/file/footer.rb

@@ -0,0 +1,41 @@
+require "active_model"
+
+module AUB
+  module Payroll
+    class File::Footer
+      include ActiveModel::Model
+
+      attr_accessor :number_of_records, :total_amount
+
+      validates :number_of_records, numericality: { greater_than: 0, less_than_or_equal_to: 999_999 }
+      validates :total_amount, numericality: { greater_than: 0, less_than_or_equal_to: 999_999_999_999.99 }
+
+      # @param [Integer] number_of_records:
+      # @param [BigDecimal] total_amount:
+      def initialize(*)
+        super
+        raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
+      end
+
+
+      def to_s
+        [
+          "EF", # marks the end of file
+          formatted_number_of_records,
+          formatted_total_amount,
+          "0" * 27,
+        ].join
+      end
+
+      private
+
+      def formatted_number_of_records
+        "%06d" % number_of_records
+      end
+
+      def formatted_total_amount
+        "%015.2f" % total_amount
+      end
+    end
+  end
+end

data/lib/aub/payroll/file/header.rb

@@ -0,0 +1,40 @@
+require "active_model"
+
+module AUB
+  module Payroll
+    class File::Header
+      include ActiveModel::Model
+
+      attr_accessor :company_name, :date
+
+      validates :company_name, presence: true, length: { maximum: 40 }
+      validates :date, presence: true
+
+      # @param [String] company_name:
+      # @param [Date] date:
+      def initialize(*)
+        super
+        raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
+      end
+
+
+      def to_s
+        [
+          "BF", # marks the beginning of file
+          formatted_company_name,
+          formatted_date,
+        ].join
+      end
+
+      private
+
+      def formatted_company_name
+        String(company_name).upcase.ljust 40
+      end
+
+      def formatted_date
+        date.strftime "%Y%m%d"
+      end
+    end
+  end
+end

data/lib/aub/payroll/file/row.rb

@@ -0,0 +1,37 @@
+require "active_model"
+
+module AUB
+  module Payroll
+    class File::Row
+      include ActiveModel::Model
+
+      attr_accessor :account_number, :amount
+
+      validates :account_number, presence: true, length: { is: 12 }
+      validates :amount, numericality: { greater_than: 0, less_than_or_equal_to: 99_999_999_999.99 }
+
+      # @param [String] account_number:
+      # @param [BigDecimal] amount:
+      def initialize(*)
+        super
+        raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
+      end
+
+
+      def to_s
+        [
+          "01",
+          account_number,
+          formatted_amount,
+          "0" * 22
+        ].join
+      end
+
+      private
+
+      def formatted_amount
+        "%014.2f" % amount
+      end
+    end
+  end
+end

data/lib/aub/payroll/version.rb

@@ -0,0 +1,5 @@
+module AUB
+  module Payroll
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: aub-payroll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronald Maravilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: activemodel
+  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: An AUB Payroll File Generator.
+email:
+- rmaravilla@payrollhero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aub-payroll.gemspec
+- bin/console
+- bin/setup
+- lib/aub/payroll.rb
+- lib/aub/payroll/errors.rb
+- lib/aub/payroll/file.rb
+- lib/aub/payroll/file/footer.rb
+- lib/aub/payroll/file/header.rb
+- lib/aub/payroll/file/row.rb
+- lib/aub/payroll/version.rb
+homepage: https://github.com/payrollhero/aub-payroll
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: An AUB Payroll File Generator.
+test_files: []
+has_rdoc: