receipt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4c0420932892a7173d88048aed6a0cdddbbfae5
+  data.tar.gz: 869caaabf30b5028a12fbf083ae3041877a8a2e6
+SHA512:
+  metadata.gz: 9952a5ca12bca8480590aa40315c447c974a994f72362cb60f2bc9e2458b93cafc62cb50e0d08ad502278b49c7a79796090a6f5418fd9fee1a75e6e730665e3b
+  data.tar.gz: 025365f9c35c03830c3df0bab0eb87783f22f36accae81d122d08f25ee4fa103dda795c50f6ef3bc68ab76a1c1d4b961b800cc730e024c70e8ee918c8cf87c7a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-gemset
+/.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fernando Almeida
+
+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,64 @@
+# Receipt
+
+PDF Receipts generator for any ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'receipt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install receipt
+
+## Usage
+
+```ruby
+receipt = Receipt::Pdf.new(
+  id: 1,
+  date: Time.now.strftime('%d/%m/%Y'),
+  amount: 100.0,
+  currency: '$',
+  payer: 'Chucky Norris',
+  receiver: 'Fernando Almeida',
+  description: 'Transaction #123',
+  logo: 'logo.png'
+).generate
+
+# send to email
+receipt.send_to('payer@email.com')
+
+# send to download
+send_data(receipt.data, filename: receipt.filename, type: receipt.type)
+```
+
+## 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 use it. 
+
+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).
+
+## Maintainer
+
+[Fernando Almeida](http://fernandoalmeida.net)
+
+## Contributing
+
+1. Fork it ( https://github.com/fernandoalmeida/receipt/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 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'receipt'
+
+require 'pry'
+Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

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

data/config/locale/en.yml

@@ -0,0 +1,61 @@
+---
+en:
+  receipt: Receipt
+  number: Number
+  amount: Amount
+  received_from: Received from
+  the_amount_of: the amount of
+  relating_to: relating to
+  date:
+    abbr_day_names:
+    - Sun
+    - Mon
+    - Tue
+    - Wed
+    - Thu
+    - Fri
+    - Sat
+    abbr_month_names:
+    - 
+    - Jan
+    - Feb
+    - Mar
+    - Apr
+    - May
+    - Jun
+    - Jul
+    - Aug
+    - Sep
+    - Oct
+    - Nov
+    - Dec
+    day_names:
+    - Sunday
+    - Monday
+    - Tuesday
+    - Wednesday
+    - Thursday
+    - Friday
+    - Saturday
+    formats:
+      default: "%m/%d/%Y"
+      long: "%B %d, %Y"
+      short: "%b %d"
+    month_names:
+    - 
+    - January
+    - February
+    - March
+    - April
+    - May
+    - June
+    - July
+    - August
+    - September
+    - October
+    - November
+    - December
+    order:
+    - :year
+    - :month
+    - :day

data/config/locale/pt.yml

@@ -0,0 +1,61 @@
+---
+pt:
+  receipt: Recibo
+  number: Numero
+  amount: Valor
+  received_from: Recebi de
+  the_amount_of: a quantia de
+  relating_to: referente a
+  date:
+    abbr_day_names:
+    - Dom
+    - Seg
+    - Ter
+    - Qua
+    - Qui
+    - Sex
+    - Sáb
+    abbr_month_names:
+    - 
+    - Jan
+    - Fev
+    - Mar
+    - Abr
+    - Mai
+    - Jun
+    - Jul
+    - Ago
+    - Set
+    - Out
+    - Nov
+    - Dez
+    day_names:
+    - Domingo
+    - Segunda
+    - Terça
+    - Quarta
+    - Quinta
+    - Sexta
+    - Sábado
+    formats:
+      default: "%d/%m/%Y"
+      long: "%d de %B de %Y"
+      short: "%d de %B"
+    month_names:
+    - 
+    - Janeiro
+    - Fevereiro
+    - Março
+    - Abril
+    - Maio
+    - Junho
+    - Julho
+    - Agosto
+    - Setembro
+    - Outubro
+    - Novembro
+    - Dezembro
+    order:
+    - :day
+    - :month
+    - :year

data/lib/receipt/pdf.rb

@@ -0,0 +1,205 @@
+# -*- coding: utf-8 -*-
+require 'ostruct'
+require 'i18n'
+
+module Receipt
+  class MissingRequiredParamError < StandardError; end
+  class Pdf
+    extend Forwardable
+
+    include Prawn::View
+
+    attr_reader :params, :errors
+
+    def_delegators :I18n, :t, :l
+
+    def_delegators :params, *[
+      :id,
+      :payer,
+      :receiver,
+      :amount,
+      :date,
+      :currency,
+      :description,
+      :logo,
+      :location,
+      :locale,
+      :filepath
+    ]
+
+    def initialize(params)
+      @params = OpenStruct.new(params)
+      setup_i18n
+
+      @errors = {}
+    end
+
+    def data
+      return unless valid?
+
+      generate
+      render
+    end
+
+    def file
+      return unless valid?
+
+      @file ||= lambda do
+        generate
+        save_as(path)
+        path
+      end.call
+    end
+
+    def before_receipt_box(&block)
+      @before ||= block
+    end
+
+    def after_receipt_box(&block)
+      @after ||= block
+    end
+
+    def valid?
+      [
+        :id,
+        :amount,
+        :payer,
+        :receiver,
+        :description
+      ].each do |p|
+        @errors[p] = 'required param not found' if params.send(p).to_s.empty?
+      end
+
+      @errors.size == 0
+    end
+
+    private
+
+    def generate
+      valid?
+
+      before_receipt_box.call if before_receipt_box
+
+      move_down 20
+      receipt_box
+
+      move_down 20
+      after_receipt_box.call if after_receipt_box
+    end
+
+    def header
+      pad(10) do
+        text(t(:receipt).upcase, align: :center, style: :bold, size: 20)
+
+        move_up 20
+        text("#{t(:number)}: <b>#{id}</b>", inline_format: true)
+
+        move_up 15
+        text("#{t(:amount)}: <b>#{formated_amount}</b>",
+             inline_format: true, align: :right)
+        pad(10) { stroke_horizontal_rule }
+      end
+    end
+
+    def body
+      text(
+        [
+          "#{t(:received_from)} <b>#{payer}</b>",
+          "#{t(:the_amount_of)} <b>#{formated_amount}</b>",
+          "#{t(:relating_to)} <b>#{description}</b>."
+        ].join(' '),
+        inline_format: true
+      )
+    end
+
+    def footer
+      move_cursor_to 70
+      stroke_horizontal_rule
+
+      pad(35) do
+        position = cursor
+        width = bounds.width / 2
+
+        date_box(0, position, width)
+        signature_box(width, position, width)
+      end
+    end
+
+    def formated_amount
+      [
+        currency,
+        amount
+      ].join(' ')
+    end
+
+    def date_box(x, y, width)
+      bounding_box [x, y], width: width do
+        text(
+          [
+            location,
+            l(date, format: :long)
+          ].join(', ')
+        )
+      end
+    end
+
+    def receipt_box
+      padded_bounding_box(10, [30, cursor], width: 500, height: 250) do
+        header
+        body
+        footer
+      end
+    end
+
+    def signature_box(x, y, width)
+      bounding_box [x, y], width: width do
+        stroke_horizontal_rule
+        move_down 10
+        centered_text(receiver)
+      end
+    end
+
+    def centered_text(s)
+      text(s, align: :center)
+    end
+
+    def padded_bounding_box(padding, *args)
+      bounding_box(*args) do
+        stroke_bounds
+
+        bounding_box(
+          [padding, bounds.height - padding],
+          width: bounds.width - (2 * padding),
+          height: bounds.height - (2 * padding)
+        ) do
+          yield
+        end
+      end
+    end
+
+    def setup_i18n
+      load_translations
+      set_locale
+    end
+
+    def load_translations
+      I18n.load_path += Dir[File.expand_path('config/locale/*.yml')]
+      I18n.backend.load_translations
+    end
+
+    def set_locale
+      I18n.locale = (locale || I18n.default_locale)
+    end
+
+    def path
+      @path ||= (params.filepath || tempfilepath)
+    end
+
+    def tempfilepath
+      @tempfilepath ||= File.join(
+        Dir.tmpdir,
+        Dir::Tmpname.make_tmpname("#{t(:receipt)}", "#{id}.pdf")
+      )
+    end
+  end
+end

data/lib/receipt/version.rb

@@ -0,0 +1,3 @@
+module Receipt
+  VERSION = '0.1.0'
+end

data/lib/receipt.rb

@@ -0,0 +1,6 @@
+require 'prawn'
+require 'receipt/version'
+require 'receipt/pdf'
+
+module Receipt
+end

data/receipt.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'receipt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'receipt'
+  spec.version       = Receipt::VERSION
+  spec.authors       = ['Fernando Almeida']
+  spec.email         = ['fernando@fernandoalmeida.net']
+  spec.summary       = 'Receipt generator for ruby application.'
+  spec.description   = 'Generates receipts on PDF format.'
+  spec.homepage      = 'http://github.com/fernandoalmeida/receipt'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'prawn', '~> 2.0'
+  spec.add_dependency 'i18n', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'pdf-inspector', '~> 1.2'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: receipt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Almeida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Generates receipts on PDF format.
+email:
+- fernando@fernandoalmeida.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locale/en.yml
+- config/locale/pt.yml
+- lib/receipt.rb
+- lib/receipt/pdf.rb
+- lib/receipt/version.rb
+- receipt.gemspec
+homepage: http://github.com/fernandoalmeida/receipt
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Receipt generator for ruby application.
+test_files: []