contract_ltd 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9fcfb371074e8baebc094db4dab997ca657abcc
+  data.tar.gz: 62fec7878ca869515e6191cae4e49b8597ec6479
+SHA512:
+  metadata.gz: 7cda08f35a7cf35e246a7779f6850cc524d0b49050f9edd0ad9610c94e811932cf573189bd24779a13da315d0405a64a725a20ac5b4e5eaf5792d46c5e857ed6
+  data.tar.gz: 1d9e656ebea8cf91a4da22c134c5afbad02d7643ec3649f35f2510248b5440a7c472eb37cc0271c89ef4b2d2cfa8d1ea57c9f28af01990a6781d0b44bd3979f4

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Phil Thompson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+Generate PDF invoice, CSV timesheet and dividend certificates from slim templates and ruby code.
+
+## Install
+
+Install `phantomjs` then:
+
+    gem install contract_ltd
+
+
+## New client
+
+    invoice new
+
+## Usage
+
+    invoice [-f] -months_ago [-i d1,d2,d3,...] [-x d1,d2,d3,...]
+
+    dividend <final|interim> <date paid> <tax year end> <net amount> <company year end>
+
+## Examples
+
+Generate timesheet/invoice for last month, worked every week day:
+
+    invoice -1
+
+Generate timesheet/invoice for current month, worked every day except last week:
+
+    invoice -0 -x 26,27,28,29,30
+
+Regenerate timesheet/invoice for 2 months ago, only worked a couple of days plus 1 half day
+
+    invoice -f -2 -i 3,4,5am
+
+Generate a final dividend for 8th August 2015 for £20,000
+
+    dividend 20150810 2015 20000 2016
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contract_ltd"
+
+# 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/contract_ltd.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+require 'base64'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contract_ltd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contract_ltd"
+  spec.version       = ContractLtd::VERSION
+  spec.authors       = ["Phil Thompson"]
+  spec.email         = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
+
+  spec.summary       = 'Generate invoices for contract work and dividend certificates'
+  spec.homepage      = 'https://github.com/PhilT/contract_ltd'
+
+  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_dependency 'activesupport'
+  spec.add_dependency 'shrimp'
+  spec.add_dependency 'slim'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end
+

data/exe/dividend

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'contract_ltd'
+
+ContractLtd.dividend
+

data/exe/invoice

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'contract_ltd'
+
+ContractLtd.invoice
+

data/lib/contract_ltd/base.rb

@@ -0,0 +1,22 @@
+Shrimp.configure do |config|
+  config.format = 'A4'
+  config.margin = '1cm'
+  config.zoom = 1
+  config.orientation = 'portrait'
+  config.rendering_time = 1000
+  config.rendering_timeout = 20000
+end
+
+I18n.load_path << "#{File.dirname(__FILE__)}/en.yml"
+I18n.t('date.formats').each do |key, value|
+  Date::DATE_FORMATS[key] = value
+end
+
+def write_pdf(template)
+  html = Slim::Template.new(template.name('slim')).render(template)
+  File.write(template.name('html'), html)
+  phantom = Shrimp::Phantom.new("file:///#{Dir.pwd}/#{template.name('html')}")
+  phantom.to_pdf(template.filename)
+  FileUtils.rm_f(template.name('html'))
+end
+

data/lib/contract_ltd/dividend.rb

@@ -0,0 +1,31 @@
+module ContractLtd
+  class Dividend
+    attr_reader :type, :tax_year_end, :shares, :net, :tax_credit, :gross, :amount, :company_year_end
+
+    def initialize args
+      @name = 'dividend'
+      @type = ARGV[0] == 'final' ? 'Final' : 'Interim'
+      @date_paid = Date.parse(ARGV[1])
+      @tax_year_end = Date.parse(ARGV[2], 4, 5).to_s(:long)
+      @shares = 100
+      @net = ARGV[3].to_f
+      @tax_credit = @net * 0.111111
+      @gross = @net + @tax_credit
+      @amount = @net / @shares
+      @company_year_end = Date.parse(ARGV[4], 2, 28).to_s(:long)
+    end
+
+    def date_paid(format = :long)
+      @date_paid.to_s(format)
+    end
+
+    def name(ext)
+      "#{name}.#{ext}"
+    end
+
+    def filename
+      "#{@name}_#{date_paid(:file)}.pdf"
+    end
+  end
+end
+

data/lib/contract_ltd/dividend.slim

@@ -0,0 +1,144 @@
+doctype html
+html
+  head
+    meta charset="UTF-8"
+    css:
+      body {
+        margin: 20px 55px;
+        font-family: Arial;
+        font-size: 14px;
+        color: #111;
+      }
+
+      h1 {
+        text-align: center;
+        font-size: larger;
+      }
+
+      h2 {
+        font-size: larger;
+      }
+
+      p, div {
+        overflow: auto;
+        clear: both;
+        padding-bottom: 10px;
+      }
+
+      div {
+        margin: 30px 0;
+      }
+
+      div.sig {
+        margin-top: 100px;
+      }
+
+      table {
+        margin: 0 auto;
+        border-collapse: collapse;
+      }
+      table.bordered th, table.bordered td {
+        border: 1px solid black;
+        margin: 0;
+        padding: 5px;
+        text-align: center;
+        max-width: 90px;
+      }
+      td.underline {
+        border-bottom: 1px solid gray;
+        width: 200px;
+        padding-right: 20px;
+      }
+
+      ul {
+        list-style-type: none;
+      }
+
+      ul, li {
+        margin: 0;
+        padding: 0;
+      }
+      li.left {
+        padding-right: 10px;
+        float: left;
+      }
+      li.right {
+        float: right;
+      }
+
+body
+  h1 #{type} Dividend Voucher
+
+  h1 ELECTRIC VISIONS LTD
+
+  div
+    ul
+      li.left
+        strong Date Dividend Paid: #{date_paid}
+      li.right
+        strong Tax Year Ending #{tax_year_end}
+
+  div
+    ul
+      li.left
+        strong Name of Payee:
+      li.left
+        strong Phil Thompson
+
+  div
+    table.bordered
+      thead
+        tr
+          th Date
+          th No. of Shares
+          th Dividend per Share
+          th Gross Dividend
+          th Tax Credit
+          th Net Dividend
+      tbody
+        tr
+          td= date_paid(:short)
+          td= shares
+          td= amount.to_s(:currency)
+          td= gross.to_s(:currency)
+          td= tax_credit.to_s(:currency)
+          td= net.to_s(:currency)
+
+  div
+    small Please keep this dividend voucher in a safe place.
+
+  h2 Minutes of a Board meeting to declare #{article} #{type} Dividend
+
+  ul
+    li Date: #{date_paid}
+    li
+      | Address: 
+      - if @date_paid < Date.new(2012, 3, 19)
+        | Flat 54, 94 Walm Lane, Willesden Green NW2 4QA
+      - elsif @date_paid < Date.new(2012, 10, 17)
+        | 128 Oakdale Road, London E11 4DL
+      - else
+        | 46 Cypress Grove, Ash Vale GU12 5QN
+    end
+
+
+  p Present: Phil Thompson
+
+  p The meeting was confirmed as being properly convened and quorate. The interest of the directors who are also shareholders in the matter to be considered was noted and
+
+  p IT WAS RESOLVED THAT:
+
+  p Having regard to the level of distributable reserves shown by the company's figures on its remittance advices that the following dividend may be fully met out of distributable reserves and that immediately thereafter the company will remain in a solvent position, able to pay its debts as they fall due and the interests of creditors not prejudiced.
+
+  p An #{type} Dividend of #{amount.to_s(:currency)} per ordinary share be voted in request of the company year ending on the #{company_year_end}
+
+
+  div.sig
+    table
+      tr
+        td.underline
+        td Phil Thompson
+      tr
+        td
+        td Chairman
+

data/lib/contract_ltd/en.yml

@@ -0,0 +1,14 @@
+en:
+  date:
+    formats:
+      default: '%d-%m-%Y'
+      short: '%d-%m-%y'
+      long: '%e %B %Y'
+      file_no_day: '%Y_%m'
+      file: '%Y_%m_%d'
+      month_name_year: '%B %Y'
+
+  number:
+    currency:
+      format:
+        unit: £

data/lib/contract_ltd/invoice.rb

@@ -0,0 +1,102 @@
+def file_date(prefix, date, suffix)
+  "#{prefix}_#{date.to_s(:file_no_day)}.#{suffix}"
+end
+
+def timesheet_filename(date)
+  file_date("timesheet", date, "csv")
+end
+
+def invoice_filename(date)
+  file_date("invoice", date, "pdf")
+end
+
+def write_timesheet(date)
+  csv = "Timesheet for Ruby Web Development Services\n"
+  csv += "by Phil Thompson (Electric Visions Ltd)\n"
+  csv += "for #{date.to_s(:month_name_year)}\n\n"
+  csv += "Day,Hours\n"
+  total = 0
+  (date..date.end_of_month.to_date).each do |d|
+    day = working_days(d)
+    total += day if day.is_a?(Float)
+    csv += "#{d.day},#{day * 7.5}\n"
+  end
+  csv += "\n"
+  csv += "Total (hours),#{total * 7.5}\n"
+  csv += "Total (days),#{total}\n"
+  File.open(timesheet_filename(date), 'w') {|f| f.write csv }
+  total
+end
+
+class Invoice
+  def initialize(date, total_days)
+    @name = 'invoice'
+    @date = date
+    @total_days = total_days
+  end
+
+  def invoice_num
+    previous_invoice_count = Dir['invoice_*'].size
+    if previous_invoice_count == 0
+      puts "WARNING: NO PREVIOUS INVOICES DETECTED"
+      puts "If this is the first invoice you can ignore this warning"
+      puts "Otherwise make sure previous invoices are in the correct format:"
+      puts "    #{timesheet_filename(@date)}"
+      puts "    #{invoice_filename(@date)}"
+    end
+    '%03d' % (previous_invoice_count + 1)
+  end
+
+  def month_year
+    @date.to_s(:month_name_year)
+  end
+
+  def todays_date
+    Date.today.to_s(:long)
+  end
+
+  def total_hours
+    @total_days * 7.5
+  end
+
+  def rate(rate = nil)
+    @rate ||= rate
+  end
+
+  def days
+    @total_days
+  end
+
+  def subtotal
+    rate * days
+  end
+
+  def vat
+    subtotal * 0.2
+  end
+
+  def total
+    subtotal + vat
+  end
+
+  def name(ext)
+    "#{@name}.#{ext}"
+  end
+
+  def filename
+    invoice_filename(@date)
+  end
+end
+
+def working_days(date)
+  if @days_are_included
+    @days[date.day] || ''
+  else
+    if date.saturday? || date.sunday?
+    ''
+    else
+      1.0 - @days[date.day].to_f
+    end
+  end
+end
+

data/lib/contract_ltd/invoice.slim

@@ -0,0 +1,136 @@
+- company = 'Electric Visions Ltd'
+- email = 'info@electricvisions.com'
+- address1 = '46 Cypress Grove'
+- address2 = 'Ash Vale'
+- address3 = 'GU12 5QN'
+- company_no = '7369361'
+- vat_no = '141 5526 34'
+- client = 'Havas EHS Ltd'
+- client_address1 = '6 Briset Street'
+- client_address2 = 'London'
+- client_address3 = 'EC1M 5NR'
+- invoice_prefix = 'HAV'
+- rate(480)
+- payment_terms = '14'
+- account_name = 'Phil Thompson'
+- account_sortcode = '40-04-26'
+- account_number = '21523996'
+
+doctype html
+html
+  head
+    meta charset="utf-8"
+    css:
+      body {
+        margin: 20px 55px;
+        font: normal 12px sans-serif;
+        color: #222;
+      }
+
+      h1 {
+        text-align: center;
+      }
+
+      h2 {
+        font-size: larger;
+      }
+
+      .address {
+        text-align: right;
+        width: 100%;
+      }
+
+      table {
+        width: 100%;
+      }
+
+      thead td {
+        padding-bottom: 10px;
+      }
+
+      td.first {
+        width: 60%;
+        padding-right: 20px;
+        text-align: right;
+      }
+
+      tfoot td {
+        font-weight: bold;
+      }
+
+      ul {
+        list-style-type: none;
+      }
+      ul, li {
+        margin: 0;
+        padding: 0;
+      }
+      ul.account {
+        padding-left: 50px;
+      }
+
+body
+  h1= "#{company} - Invoice"
+
+  aside.address
+    ul
+      li= address1
+      li= address2
+      li= address3
+      li
+      li= email
+      li Company No. #{company_no}
+      li VAT Registration No. #{vat_no}
+
+  p
+    ul
+      li= client
+      li= client_address1
+      li= client_address2
+      li= client_address3
+
+  ul
+    li
+      | Invoice No:
+      strong  #{invoice_prefix}#{invoice_num}
+    li
+      | Date:
+      strong  #{todays_date}
+
+  p
+    | To:
+    strong  #{client}
+
+  h2 Fees:
+
+  table
+    thead
+      tr
+        td.first Ruby Web Development Services provided to #{client} for #{month_year}
+        td #{rate.to_s(:currency, precision: 0)} * #{"%g days" % days}
+    tbody
+      tr
+        td.first Subtotal
+        td= subtotal.to_s(:currency)
+      tr
+        td.first VAT (20%)
+        td= vat.to_s(:currency)
+    tfoot
+      tr
+        td.first Total
+        td= total.to_s(:currency)
+
+  h2 Payment terms
+
+  p Payment within #{payment_terms} days via money transfer only to the following account:
+  ul.account
+    li
+      | Name:
+      strong  #{account_name}
+    li
+      | Sort Code:
+      strong  #{account_sortcode}
+    li
+      | Account No:
+      strong  #{account_number}
+

data/lib/contract_ltd/new.rb

@@ -0,0 +1,2 @@
+require 'readline'
+

data/lib/contract_ltd/version.rb

@@ -0,0 +1,4 @@
+module ContractLtd
+  VERSION = "0.2.0"
+end
+

data/lib/contract_ltd.rb

@@ -0,0 +1,80 @@
+require 'bundler/setup'
+require 'active_support'
+require 'active_support/time'
+require 'active_support/core_ext/numeric/conversions'
+require 'shrimp'
+require 'slim'
+require 'contract_ltd/base'
+require 'contract_ltd/dividend'
+require 'contract_ltd/invoice'
+require 'contract_ltd/new'
+require "contract_ltd/version"
+
+module ContractLtd
+  def self.invoice
+    if ARGV.empty?
+      puts <<-EOB
+        Create a new invoice.slim template:
+
+        invoice new
+
+
+        Generate a timesheet (CSV) and invoice (PDF) from existing invoice.slim template.
+
+        invoice [-f] [-p] -n [-x|-i [day[am|pm]],[...]]
+          -f    - overwrite existing timesheet/invoice
+          -n    - generate timesheet/invoice for n months ago (-0 to -12)
+          -x    - specify days to exclude (sat/sun excluded anyway)
+          -i    - specify days to include
+          am|pm - just the morning or afternoon was taken off (half a day)
+
+      EOB
+      exit
+    end
+
+    # Arguments (other args must be removed before days)
+    @days_are_included = ARGV.delete('-i')
+    @days_are_excluded = ARGV.delete('-x')
+    if @days_are_included && @days_are_excluded
+      puts "Days can only be included or excluded. Not both. Specify -i or -x."
+      exit 1
+    end
+
+    @overwrite = ARGV.delete('-f')
+    month = (0..12).detect {|n| ARGV.delete("-#{n}") }
+    if ARGV.size > 0
+      @days = Hash[*(ARGV.first.split(',').map do |day|
+        [day.to_i, day =~ /am|pm/ ? 0.5 : 1.0]
+      end.flatten)]
+    else
+      @days = []
+    end
+
+    date = month.month.ago.beginning_of_month.to_date
+    if File.exist?(timesheet_filename(date)) || File.exist?(invoice_filename(date))
+      if @overwrite
+        FileUtils.rm_f(timesheet_filename(date))
+        FileUtils.rm_f(invoice_filename(date))
+      else
+        puts "Existing timesheet and/or invoice detected for #{date}"
+        puts "Use -f to overwrite"
+        exit 1
+      end
+    end
+    total_days = write_timesheet(date)
+    write_pdf(Invoice.new(date, total_days))
+  end
+
+  def self.dividend
+    if ARGV.size != 5
+      puts 'dividend <final|interim> <date_paid> <tax_year_end> <net> <year_end>'
+      puts '  date_paid     (yyyymmdd)'
+      puts '  tax_year_end  (yyyy)'
+      puts '  net           amount dividend actually paid out'
+      puts '  year_end      company accounts year end (yyyy)'
+    else
+      write_pdf(Dividend.new(ARGV))
+    end
+  end
+end
+

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: contract_ltd
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Phil Thompson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !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: shrimp
+  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: slim
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email: phil@electricvisions.com
+executables:
+- dividend
+- invoice
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contract_ltd.gemspec
+- exe/dividend
+- exe/invoice
+- lib/contract_ltd.rb
+- lib/contract_ltd/base.rb
+- lib/contract_ltd/dividend.rb
+- lib/contract_ltd/dividend.slim
+- lib/contract_ltd/en.yml
+- lib/contract_ltd/invoice.rb
+- lib/contract_ltd/invoice.slim
+- lib/contract_ltd/new.rb
+- lib/contract_ltd/version.rb
+homepage: https://github.com/PhilT/contract_ltd
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Generate invoices for contract work and dividend certificates
+test_files: []