invoicegenerator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a2ae2f90644130b064a3f74f499282010910997c1b01f91bb54b2262e9f26d0
+  data.tar.gz: 7f182917dad778dce5e3e957d130b6d28d07782bccf37a1d1b511f06909336d9
+SHA512:
+  metadata.gz: 8360844a20cdbcddd216504f8d724f99d5e3cddcbf131542ad7a534aa89ebeb0fc09f2bea23469b146e8fadb5796f3d7f40065ca20123d0ac5b198a121973ea4
+  data.tar.gz: 66c310273372f90b18123e40d530e470dc6dde89473e0bac870873d798d2a008c59acfcd8edaaaf91b2695a6c01aa1823c1339760f7d72324b636ccb4d5b8784

data/.gitignore

@@ -0,0 +1,5 @@
+*.pdf
+Gemfile.lock
+*.yml
+*.rubyproject
+invoicegenerator-*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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,31 @@
+# Stupid invoice generator
+
+Put the data you usualy uses to create your invoices into a YML file, run this
+gem and done, you have a nice pdf invoice
+
+To see an example the fast possible way run:
+
+```
+$ gem install invoicegenerator
+$ invoicegenerator --show-yml-example | invoicegenerator --stdin
+```
+
+To have a starting point to write your YAML describing your invoice, type:
+
+```
+$ invoicegenerator --show-yml-example > invoice.yml
+```
+
+Then change the generated invoice.yml
+
+## How to change the invoice template?
+
+Use the --template command line switch to specify an HTML template, to have a look in a example, type:
+
+```
+$ invoicegenerator --show-template-example
+```
+
+## What to write in the YAML file?
+
+Run `invoicegenerator.rb --show-yml-example` and you will see an example, basically you can use all keys you find as a command line option.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'invoicegenerator'
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/invoicegenerator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'invoicegenerator'
+
+InvoiceGenerator.main

data/invoicegenerator.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoicegenerator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'invoicegenerator'
+  spec.version       = InvoiceGenerator::VERSION
+  spec.authors       = ['Hugo Parente Lima']
+  spec.email         = ['hugo.pl@gmail.com']
+
+  spec.summary       = 'Invoice generator'
+  spec.description   = 'A stupid and simple invoice generator'
+  spec.homepage      = 'https://github.com/hugopl/invoicegenerator'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('money', '~> 6.13')
+  spec.add_dependency('optimist', '~> 3.0')
+  spec.add_dependency('pdfkit', '~> 0.8')
+  spec.add_development_dependency('bundler', '~> 1.17')
+  spec.add_development_dependency('rake', '~> 10.0')
+end

data/lib/invoicegenerator.rb

@@ -0,0 +1 @@
+require 'invoicegenerator/invoicegenerator'

data/lib/invoicegenerator/invoicegenerator.html

@@ -0,0 +1,114 @@
+<html>
+<head>
+<style>
+h1 {
+  text-align: center;
+  background-color: black;
+  color: white;
+  border-radius: 10px;
+}
+
+td {
+  padding: 5px;
+  vertical-align: top;
+  white-space: pre;
+}
+
+table {
+  border-spacing: 0px;
+  border-collapse: separate;
+  margin-bottom: 40px;
+}
+
+table td:first-child {
+  font-weight: bold;
+  white-space: nowrap;
+}
+
+table.items td:first-child {
+  font-weight: normal;
+}
+
+.summary > td {
+  white-space: nowrap;
+}
+
+.client {
+  float: left;
+}
+
+.summary {
+  float: right;
+}
+
+.items {
+  clear: both;
+  width: 100%;
+}
+.items th {
+  padding: 4px;
+  background-color: #e9e9e9;
+  text-align: left;
+}
+.items th:first-child {
+  border-radius: 5px 0px 0px 5px;
+}
+.items th:last-child {
+  border-radius: 0px 5px 5px 0px;
+}
+.notes {
+  white-space: pre;
+}
+</style>
+</head>
+<body>
+<h1>%header%</h1>
+
+<table class="from">
+<tr>
+  <td>From</td>
+  <td>%from%</td>
+</tr>
+</table>
+
+<table class="client">
+<tr>
+  <td>Client</td>
+  <td>%client%</td>
+</tr>
+</table>
+
+
+<table class="summary">
+  <tr>
+    <td>Invoice Number</td>
+    <td>%number%</td>
+  </tr>
+  <tr>
+    <td>Date</td>
+    <td>%date%</td>
+  </tr>
+  <tr>
+    <td>Due date</td>
+    <td>%due-date%</td>
+  </tr>
+  <tr>
+    <td>Balance Due</td>
+    <td>%balance%</td>
+  </tr>
+</table>
+
+<table class="items">
+  <tr>
+    <th>Item</th>
+    <th>Quantity</th>
+    <th>Rate</th>
+    <th>Amount</th>
+  </tr>
+  %items%
+</table>
+
+<h2>Notes</h2>
+<p class="notes">%notes%</p>
+</body>
+</html>

data/lib/invoicegenerator/invoicegenerator.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+
+require 'pdfkit'
+require 'yaml'
+require 'optimist'
+require 'date'
+require 'money'
+
+I18n.enforce_available_locales = false
+Money.locale_backend = :currency
+
+module InvoiceGenerator
+  def show_yml_example_and_exit
+    puts <<eot
+  from: |
+    My multiline name
+    Here's a second line
+  client: |
+    My multiline client
+    Hey ho, second line here
+  number: 2019-123
+  notes: |
+    If all your data are always the same, just the invoice number changes,
+    save the the static data in a yml and pass the invoice number on command line
+    by using (--number).
+
+    Note that the date is always default to today, and the due-date to today + 15
+  items:
+    -
+      - Nice item for %past_month% %year%
+      - 1
+      - 12334
+    -
+      - Other item, for %month%
+      - 0.5
+      - 100000
+  currency: GBP
+eot
+    exit
+  end
+
+  def show_template_example_and_exit
+    puts File.read(template_path)
+    exit
+  end
+
+  def map_date_fields(opts)
+    [:date, 'due-date'].each do |i|
+      opts[i] = yield(opts[i])
+    end
+  end
+
+  def read_params
+    Optimist.options do
+      opt :client,            'Contents of client field.', type: :string
+      opt :currency,          'Currency used.', type: :string, default: 'USD'
+      opt :date,              'Invoice date.', type: :date, default: Date.today
+      opt 'due-date',         'Due date.', type: :date, default: (Date.today + 15)
+      opt :from,              'Contents of from field.', type: :string
+      opt :header,            'Contents of the header.', type: :string, default: 'Invoice'
+      opt :notes,             'Contents of notes field.', type: :string
+      opt :number,            'Invoice number.', type: :string
+      opt 'show-yml-example', 'Show an example of a YML file that can be used by this script.'
+      opt 'show-template-example', 'Show an example of a HTML template.'
+      opt :stdin,             'Read YML file from STDIN.'
+      opt :template,          'HTML template to use', type: :string
+      opt :yml,               'YML file with values for parameters not given into command line.', default: 'invoice.yml'
+    end
+  end
+
+  def read_yml(opts)
+    if opts[:stdin]
+      data = StringIO.new
+      data << STDIN.read until STDIN.eof?
+      yaml = data.string
+    else
+      yaml = File.read(opts[:yml])
+    end
+    YAML.safe_load(yaml).inject(opts) do |memo, item|
+      memo[item[0].to_sym] = item[1]
+      memo
+    end
+    fail('Items not in the right format, something is missing.') unless opts[:items].is_a?(Array)
+
+    opts
+  rescue Errno::ENOENT
+    raise "YML file #{opts[:yml]} not found or can't be read."
+  end
+
+  def fix_date_options(opts)
+    map_date_fields(opts) do |value|
+      value.is_a?(Date) ? value : Date.parse(value)
+    end
+  end
+
+  def add_extra_options(opts)
+    today = Date.today
+    opts[:month] = today.strftime('%B')
+    opts[:past_month] = (today << 1).strftime('%B')
+    opts[:year] = today.strftime('%Y')
+
+    raw_balance = opts[:items].inject(0) do |balance, item|
+      balance + (item[2] * item[1])
+    end
+    opts[:balance] = Money.new(raw_balance, opts[:currency]).format
+  end
+
+  def format_items(opts)
+    opts[:items].map! do |i|
+      fail 'Items must have 3 values' if i.size != 3
+
+      i[3] = Money.new(i[2] * i[1], opts[:currency]).format
+      i[2] = Money.new(i[2], opts[:currency]).format
+      "<tr><td>#{i.join('</td><td>')}</td></tr>"
+    end
+    opts[:items] = opts[:items].join
+  end
+
+  def template_path
+    File.join(File.dirname(__FILE__), 'invoicegenerator.html')
+  end
+
+  def generate_html(opts)
+    map_date_fields(opts) do |value|
+      value.strftime('%B %-d, %Y')
+    end
+
+    html = File.read(opts[:template] || template_path)
+    opts.each do |opt, value|
+      html.gsub!("%#{opt}%", value.to_s)
+    end
+    html
+  end
+
+  def main
+    opts = read_params
+    show_yml_example_and_exit if opts[:'show-yml-example_given']
+    show_template_example_and_exit if opts[:'show-template-example_given']
+
+    read_yml(opts)
+    fix_date_options(opts)
+    add_extra_options(opts)
+    format_items(opts)
+    html = generate_html(opts)
+
+    kit = PDFKit.new(html.encode('iso-8859-1'))
+    name = "invoice-#{opts[:number]}.pdf"
+    puts "Generating #{name}..."
+    kit.to_file(name)
+  rescue Errno::ENOENT => e
+    abort e.message
+  rescue RuntimeError => e
+    abort e.message
+  end
+
+  extend self
+end

data/lib/invoicegenerator/version.rb

@@ -0,0 +1,3 @@
+module InvoiceGenerator
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: invoicegenerator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hugo Parente Lima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.13'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pdfkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: A stupid and simple invoice generator
+email:
+- hugo.pl@gmail.com
+executables:
+- invoicegenerator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/invoicegenerator
+- invoicegenerator.gemspec
+- lib/invoicegenerator.rb
+- lib/invoicegenerator/invoicegenerator.html
+- lib/invoicegenerator/invoicegenerator.rb
+- lib/invoicegenerator/version.rb
+homepage: https://github.com/hugopl/invoicegenerator
+licenses:
+- MIT
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Invoice generator
+test_files: []