aub-payroll 0.1.0 → 1.0.0

data/.scss-lint.yml

@@ -0,0 +1,25 @@
+exclude:
+ - '*.min.css'
+ - 'vendor/assets/**/*'
+ - 'node_modules/**/*'
+ - 'coverage/**/*'
+
+linters:
+  ColorKeyword:
+    enabled: false
+  Indentation:
+    width: 2
+    character: "space"
+  LeadingZero:
+    style: "include_zero"
+  ColorVariable:
+    enabled: false
+  Comment:
+    enabled: false
+  SelectorDepth:
+    max_depth: 5
+  NestingDepth:
+    max_depth: 5
+  QualifyingElement:
+    allow_element_with_attribute: true
+    allow_element_with_class: true

data/.travis.yml

@@ -1,3 +1,18 @@
 language: ruby
 rvm:
   - 2.1.6
+
+env:
+  - CI=true
+
+before_install:
+  - PWD=`pwd`
+  - "echo '## Installing dependencies'"
+  - "sudo apt-get update"
+  - "sudo apt-get install -y openssl build-essential xorg libssl-dev xfonts-75dpi"
+  - "echo '## Downloading wkhtmltopdf'"
+  - "wget http://download.gna.org/wkhtmltopdf/0.12/0.12.2.1/wkhtmltox-0.12.2.1_linux-wheezy-amd64.deb"
+  - "echo '## Installing wkhtmltox'"
+  - "sudo dpkg -i wkhtmltox-0.12.2.1_linux-wheezy-amd64.deb"
+  - WHICH_WK=`which wkhtmltopdf`
+  - "export WKHTMLTOPDF_CMD=$WHICH_WK"

data/DEPLOYING.md

@@ -0,0 +1,25 @@
+## Setup
+
+In order to deploy a new version of the gem into the wild ...
+
+You will need to configure your github api token for the changelog.
+
+Generate a new token for changelogs [here](https://github.com/settings/tokens/new).
+
+add:
+
+```bash
+export CHANGELOG_GITHUB_TOKEN=YOUR_CHANGELOG_API_TOKEN
+```
+
+somewhere in your shell init. (ie .zshrc or simillar)
+
+## Deploying
+
+1. Update `lib/aub-payroll/version.rb`
+2. Commit the changed files with the version number eg: `1.8.0`
+3. Push this to git
+4. Run `rake release`
+5. Run `rake changelog` (has to be ran after release since its based on github tagging)
+6. Commit the changed changelog named something like `changelog for 1.8.0`
+7. Push this to git

data/README.md

@@ -24,23 +24,72 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+
+This gem uses wkhtmltopdf, it has been tested against version 0.12.3
+
+If you'r wkhtmltopdf binary is different from the default, you can set it in the gem confuguration as follows:
+
 ```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 }
-                                ]
+AUB::Payroll.configure do |c|
+  c.wkhtmltopdf_bin = 'wkhtmltopdf-0.12.3'
+end
+```
+
+### EPF Bank File
 
+```ruby
+  file = AUB::Payroll::EPFFile.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
 ```
 
+### Summary PDF File
+
+```ruby
+  company_info = {
+    name: 'SomeCorp',
+    account_number: '12345678',
+    bank_branch: 'SomeBranch',
+    address1: '123 some address',
+    address2: '543 some more addresss',
+    prepared_by_name_1: 'William Samson',
+    prepared_by_name_2: 'Junior P. Santos',
+    checked_by_name_1: 'Winnie Po',
+    checked_by_name_2: 'Paul Sen',
+  }
+
+  transactions = [
+    {
+      employee_name: 'John Doe',
+      account_number: '12345678',
+      amount: 1235.45,
+    }
+  ] * 47 # ok fine, this is a repeating example, but you'd have real data here :)
+
+  payroll_info = {
+    period_start: Date.new(2010, 1, 1),
+    period_end: Date.new(2010, 1, 31),
+    pay_date: Date.new(2010, 2, 5),
+    total: transactions.sum { |t| t[:amount] },
+  }
+
+  pdf = AUB::Payroll::SummaryFile.generate(company_info: company_info, payroll_info: payroll_info, transactions: transactions)
+   
+  File.write "summary.pdf", pdf
+```
+
 ## 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.

data/aub-payroll.gemspec

@@ -4,25 +4,35 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aub/payroll/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aub-payroll"
+  spec.name          = 'aub-payroll'
   spec.version       = AUB::Payroll::VERSION
-  spec.authors       = ["Ronald Maravilla"]
-  spec.email         = ["rmaravilla@payrollhero.com"]
+  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.summary       = 'An AUB Payroll File Generator.'
+  spec.description   = '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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'shotgun'
+  spec.add_development_dependency 'pdf_spec'
+  spec.add_development_dependency 'github_changelog_generator'
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "activemodel"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'pdfkit'
+  spec.add_dependency 'ph_model'
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'slim'
+  spec.add_dependency 'sass'
+  spec.add_dependency 'configurations', '~> 2.2.0'
 end

data/lib/aub/payroll.rb

@@ -3,11 +3,26 @@ require "active_support"
 require "active_support/dependencies/autoload"
 require "active_support/core_ext/enumerable"
 
+require 'pdfkit'
+require 'ph_model'
+require 'tilt'
+require 'configurations'
+
 module AUB
   module Payroll
     extend ActiveSupport::Autoload
+    include Configurations
+
+    configurable :wkhtmltopdf_bin
+
+    configuration_defaults do |c|
+      c.wkhtmltopdf_bin = 'wkhtmltopdf'
+    end
 
     autoload :Errors
-    autoload :File
+    autoload :EPFFile
+    autoload :SummaryFile
+
+    GEM_ROOT = File.expand_path(File.dirname(__FILE__) + '/../..')
   end
 end

data/lib/aub/payroll/{file.rb → epf_file.rb}

@@ -2,7 +2,7 @@ require "active_model"
 
 module AUB
   module Payroll
-    class File
+    class EPFFile
       extend ActiveSupport::Autoload
 
       autoload :Header

data/lib/aub/payroll/{file → epf_file}/footer.rb

@@ -1,8 +1,8 @@
-require "active_model"
+require 'active_model'
 
 module AUB
   module Payroll
-    class File::Footer
+    class EPFFile::Footer
       include ActiveModel::Model
 
       attr_accessor :number_of_records, :total_amount
@@ -17,24 +17,23 @@ module AUB
         raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
       end
 
-
       def to_s
         [
-          "EF", # marks the end of file
+          'EF', # marks the end of file
           formatted_number_of_records,
           formatted_total_amount,
-          "0" * 27,
+          '0' * 27,
         ].join
       end
 
       private
 
       def formatted_number_of_records
-        "%06d" % number_of_records
+        format '%06d', number_of_records
       end
 
       def formatted_total_amount
-        "%015.2f" % total_amount
+        format '%015.2f', total_amount
       end
     end
   end

data/lib/aub/payroll/{file → epf_file}/header.rb

@@ -1,8 +1,8 @@
-require "active_model"
+require 'active_model'
 
 module AUB
   module Payroll
-    class File::Header
+    class EPFFile::Header
       include ActiveModel::Model
 
       attr_accessor :company_name, :date
@@ -17,10 +17,9 @@ module AUB
         raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
       end
 
-
       def to_s
         [
-          "BF", # marks the beginning of file
+          'BF', # marks the beginning of file
           formatted_company_name,
           formatted_date,
         ].join
@@ -33,7 +32,7 @@ module AUB
       end
 
       def formatted_date
-        date.strftime "%Y%m%d"
+        date.strftime '%Y%m%d'
       end
     end
   end

data/lib/aub/payroll/{file → epf_file}/row.rb

@@ -1,8 +1,8 @@
-require "active_model"
+require 'active_model'
 
 module AUB
   module Payroll
-    class File::Row
+    class EPFFile::Row
       include ActiveModel::Model
 
       attr_accessor :account_number, :amount
@@ -17,20 +17,19 @@ module AUB
         raise Errors::Invalid, errors.full_messages.to_sentence unless valid?
       end
 
-
       def to_s
         [
-          "01",
+          '01',
           account_number,
           formatted_amount,
-          "0" * 22
+          '0' * 22
         ].join
       end
 
       private
 
       def formatted_amount
-        "%014.2f" % amount
+        format '%014.2f', amount
       end
     end
   end

data/lib/aub/payroll/summary_file.rb

@@ -0,0 +1,19 @@
+module AUB
+  module Payroll
+    module SummaryFile
+      extend ActiveSupport::Autoload
+
+      autoload :Generator
+      autoload :HTMLGenerator
+      autoload :CompanyInfo
+      autoload :PayrollInfo
+      autoload :Transaction
+      autoload :CustomPDFKit
+
+      def self.generate(*args)
+        Generator.new(*args).generate
+      end
+
+    end
+  end
+end

data/lib/aub/payroll/summary_file/company_info.rb

@@ -0,0 +1,23 @@
+module AUB
+  module Payroll
+    module SummaryFile
+      class CompanyInfo
+        include PhModel
+
+        attribute :name
+        attribute :account_number
+        attribute :address1
+        attribute :address2
+        attribute :bank_branch
+
+        attribute :prepared_by_name_1
+        attribute :prepared_by_name_2
+        attribute :checked_by_name_1
+        attribute :checked_by_name_2
+
+        validates :name, :account_number, :bank_branch, presence: true
+
+      end
+    end
+  end
+end

data/lib/aub/payroll/summary_file/custom_pdf_kit.rb

@@ -0,0 +1,14 @@
+module AUB
+  module Payroll
+    module SummaryFile
+
+      # just overriding executable so its easy to configure this for the gem directly
+      class CustomPDFKit < PDFKit
+        def executable
+          AUB::Payroll.configuration.wkhtmltopdf_bin
+        end
+      end
+
+    end
+  end
+end

data/lib/aub/payroll/summary_file/generator.rb

@@ -0,0 +1,36 @@
+module AUB
+  module Payroll
+    module SummaryFile
+      class Generator
+
+        def initialize(company_info:, payroll_info:, transactions:)
+          @company_info = CompanyInfo.build(company_info)
+          @payroll_info = PayrollInfo.build(payroll_info)
+          @transactions = transactions.map { |transaction| Transaction.build(transaction) }
+        end
+
+        def generate
+          html_generator.generate do
+            kit = File.open('body.html', 'r') do |body_file|
+              options = {
+                page_size: 'Letter',
+                header_html: 'header.html',
+                footer_html: 'footer.html',
+                margin_top: 38,
+                margin_bottom: 5,
+                margin_left: 0,
+                margin_right: 0,
+              }
+              CustomPDFKit.new(body_file, options)
+            end
+            kit.to_pdf
+          end
+        end
+
+        def html_generator
+          HTMLGenerator.new(company_info: @company_info, payroll_info: @payroll_info, transactions: @transactions)
+        end
+      end
+    end
+  end
+end