webtranslateit-payday 1.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3aeab98b068c4f44f598410d9f9dfabab144bc3ea55d8126876b2c89cf5968f0
+  data.tar.gz: c988edd5e6b6d2d9c07ec4f0c2caf9e7182d36ce0b30696c32288be7ae465f3f
+SHA512:
+  metadata.gz: dcca015e4fa6f6bebcf95a2bb24b3ed6c28bf06dc062509d358da45fde40d512ef8c29532ac2d83c54441283706b8d164b5330bf02ad22635a8ac1ab874213af
+  data.tar.gz: bb6e23f0ae4aea9c277812598b005a7ba04148af6444b4a9e9833fdbf7d2e8e57b954dec63281ae1f9991c395ba21a81cb69a6f03b5763b309ceb969e8395529

data/.gitattributes

@@ -0,0 +1 @@
+*.pdf binary

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec
+
+  linters:
+    name: Linters
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2.3.5
+
+      - name: Install ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6.9 # Use .ruby-version file instead of duplicating here and in Gemfile?
+          bundler-cache: true
+
+      - name: Run ruby linter
+        run: bundle exec rubocop --format github

data/.gitignore

@@ -0,0 +1,8 @@
+tmp/
+doc/
+.yardoc/
+*.gem
+Gemfile.lock
+.bundle
+pkg/*
+bin/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - lib/generators/**/*
+
+inherit_mode:
+  merge:
+    - Exclude
+
+require: rubocop-rspec

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-02-02 14:41:30 UTC using RuboCop version 1.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/generators/payday/setup/setup_generator.rb'
+
+# Offense count: 19
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# CHANGELOG
+
+## 1.2.7 (2022-02-04)
+
+* Allow styling line item descriptions and notes.
+
+## 1.2.6 (2022-02-03)
+
+* Add new fonts and increase font size.
+
+## 1.2.5 (2022-02-02)
+
+* New: Ability to add LineItems with “pre-defined” amounts.
+  `LineItem.new(description: 'Flat fee', predefined_amount: 244)`.
+  This allows to create lines without quantities and unit prices, which is useful to add flat fees.
+
+## 1.2.4 (2022-02-02)
+
+* Lint code with Rubocop.
+
+## 1.2.3 (2022-02-02)
+
+* Fix deprecation warning.
+
+## 1.2.2 (2022-02-02)
+
+* Dependency updates (prawn, prawn-svg, add prawn-table). This update might break tests as PDF are rendered slightly differently.
+* Fix deprecation warning.
+
+## 1.2.1 (2022-02-01)
+
+* Add convenience method to add line_items to invoices (`Invoice#add_line_item(options)`). Takes the same options as `LineItem.new(options)`.
+
+## 1.2.0 (2021-12-22)
+
+This brings changes made for WebTranslateIt.com’s billing system:
+
+* Tax rate is a full percent number (for instance `21.0` for a 21% tax rate, `10.0` for a 10% tax rate). This is a breaking change compared to the previous `0.21` for 21% tax rate and `0.1` for 10% tax rate, but it is more convenient to use.
+* Invoices were updated to call the document `Invoice` if the document was not paid or `Receipt` if the document was paid.
+
+## 1.1.7 (2021-12-22)
+
+* Remove `.ruby-version` file locking ruby at 2.1.5.
+* Add CI.
+* Ruby 2.6, 2.7 and 3.0 compatibility.
+* Specify dependencies to `activesupport` and `rexml` in gemspec.
+* Fix deprecation warnings with newer versions of the Money gem.
+
+## 1.1.6 (2021-11-29)
+
+* Ruby 2.6 Compatibility.
+
+## 1.1.4 (2015-05-29)
+
+* Bumped money gem to 6.5 (was 6.1.1)
+* Bumped i18n gem to 0.7 (was 0.6.11)
+* Added German translation for invoice date.
+
+## 1.1.3 (2015-01-02)
+
+* Loosened requirements on Money gem.
+* Bumped rspec to latest and cleared up a deprecation warning.
+* Added support for `invoice_date` field (thanks [danielma](https://github.com/danielma)!)
+* Bugfix: Resolved issue where money values were being shown at 1/100th of the intended amount (thanks [watsonbox](https://github.com/watsonbox)!)
+
+## 1.1.2 (2014-05-03)
+
+* Added NL locale (thanks [jedi4ever](https://github.com/jedi4ever)!).
+* Updated Prawn to 1.0.
+* Updated Prawn SVG to 0.15.0.0.
+* Updated Money to 6.1.1.
+* Updated i18n to 0.6.9.
+
+## 1.1.1 (2013-07-20)
+
+* Added support for zh-CN locale (thanks [Martin91](https://github.com/Martin91)!).

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec, cmd: 'bundle exec rspec --color --format progress' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')                        { 'spec' }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -0,0 +1,175 @@
+Payday!
+===
+Payday is a library for rendering invoices to pdfs.
+
+We use payday intensively at [WebTranslateIt.com](https://webtranslateit.com) to generate customer’s invoices and receipts. When we upgraded our app to ruby 2.7 this gem failed in many ways and the original source code by Alan Johnson was nowhere to be found on GitHub. So we took the source code out of [rubygems.org](https://rubygems.org) and created this repo. We’ve since added a few new features and fixes, which can be seen [in the changelog](https://github.com/webtranslateit/payday/blob/main/CHANGELOG.md).
+
+Here’s an [example PDF Invoice](https://github.com/webtranslateit/payday/raw/main/spec/assets/testing_predefined_amount.pdf) generated with our fork of payday.
+
+Installing
+===
+Payday is available as a Rubygem, so installing it is as easy as running:
+
+```
+gem install webtranslateit-payday
+```
+
+Or, using bundler:
+
+```
+gem 'webtranslateit-payday', require: 'payday'
+```
+
+Using Payday
+===
+It's pretty easy to use Payday with the built in objects. We include the Invoice and LineItem classes, and with them you can get started pretty quickly.
+
+Example:
+
+``` ruby
+invoice = Payday::Invoice.new(invoice_number: 12)
+# 2 lines with a price and a quantity. Amount will be calculated by price * quantity
+invoice.add_line_item(price: 20, quantity: 5, description: 'Pants')
+invoice.add_line_item(price: 10, quantity: 3, description: 'Shirts')
+# a line with no price or quantity but with a predefined price (or flat fee)
+invoice.add_line_item(predefined_amount: 10, description: 'Shipping')
+invoice.render_pdf_to_file('/path/to_file.pdf')
+```
+
+Documentation
+===
+Documentation for the latest version of Payday is available at [rubydoc.info](http://www.rubydoc.info/gems/payday).
+
+Customizing Your Invoice
+===
+`Payday::Config` includes quite a few options for customizing your invoices, such as options for customizing the logo and
+company details on the invoice.
+
+Example:
+
+``` ruby
+Payday::Config.default.invoice_logo = "/path/to/company/logo.png"
+Payday::Config.default.company_name = "Awesome Corp"
+Payday::Config.default.company_details = "10 This Way\nManhattan, NY 10001\n800-111-2222\nawesome@awesomecorp.com"
+```
+
+Using Payday with ActiveRecord Objects (or any other objects, for that matter)
+===
+
+Payday focuses on two main objects, an invoice and a line item, so to use Payday with ActiveRecord you'll want to create your own classes for those objects. We include the Payday::Invoiceable and Payday::LineItemable modules to help out with that.
+
+Thanks to the work of Andrew Nordman, Payday includes a Rails generator that makes it super simple to generate the necessary models and migration for wiring Payday up to your app. Run `rails generate payday:setup --help` for more information about using the generator.
+
+For a bit more fleshed out example, be sure to check out [http://github.com/commondream/payday-example](http://github.com/commondream/payday-example).
+
+Rendering Payday PDFs To The Web
+===
+Payday's Invoiceable module includes methods for rendering pdfs to disk and for rendering them to a string. In a Rails controller, you can use the
+render to string method to render a pdf directly to the browser like this:
+
+In `config/initializers/mime_types.rb`:
+
+``` ruby
+Mime::Type.register 'application/pdf', :pdf
+```
+
+In your controller:
+
+``` ruby
+respond_to do |format|
+  format.html
+  format.pdf do
+    send_data invoice.render_pdf, filename: 'Invoice #12.pdf', type: 'application/pdf', disposition: 'inline'
+  end
+end
+```
+
+Be sure to restart your server after you edit the mime_types initializer. The updated setting won't take effect until you do.
+
+I18n
+===
+Payday uses the i18n gem to provide support for custom labels and internationalized applications. You can change the default labels by adding a YAML file in the `config/locales` directory of your Rails app. Here are the default labels you can customize:
+
+``` yaml
+en:
+  payday:
+    status:
+      paid: PAID
+      overdue: OVERDUE
+      refunded: REFUNDED
+    invoice:
+      bill_to: Bill To
+      ship_to: Ship To
+      invoice_no: "Invoice #:"
+      due_date: "Due Date:"
+      paid_date: "Paid Date:"
+      subtotal: "Subtotal:"
+      tax: "Tax:"
+      total: "Total:"
+    line_item:
+      description: Description
+      unit_price: Unit Price
+      quantity: Quantity
+      amount: Amount
+```
+
+If you translate the invoice to your own language, please send me a copy of your locale.yml file so that we can include it with
+the main Payday distribution and other Payday users can enjoy the fruits of your labor.
+
+Examples
+===
+Here's an [example PDF Invoice](https://github.com/webtranslateit/payday/raw/main/spec/assets/testing_predefined_amount.pdf)
+
+Contributing
+===
+Payday is pretty young, so there's still a good bit of work to be done. I highly recommend sending me a message on GitHub before making too many changes, just to make sure that two folks aren't doing the same work, but beyond that feel free to fork the project, make some changes, and send a pull request. If you're unsure about what to work on but would like to help, send me a message on GitHub. I'd love the help!
+
+We've had some awesome contributers:
+
+* Sam Pizzey ([pizzeys](http://github.com/pizzeys))
+* Andrew Nordman ([cadwallion](http://github.com/cadwallion))
+* Pierre Olivier Martel ([pomartel](http://github.com/pomartel))
+* Matt Hoofman ([mhoofman](https://github.com/mhoofman))
+* Édouard Brière ([edouard](https://github.com/edouard))
+* Jim Jones ([aantix](https://github.com/aantix))
+* Hussein Morsy ([husseinmorsy](https://github.com/husseinmorsy))
+
+To Do
+===
+Here's what we're planning on working on with Payday in the near future:
+
+* Actually get a designer to style the invoices.
+* Add support for Money values
+* Add support for blank line items
+* Add support for indented line items
+* Apply different tax rates to different line items
+* Add support for shipping either pre or post tax
+* Add ability to show skus or product ids on each line item
+* Add ability to add fine print to invoices.
+* Ability to render invoice to html for web viewing
+
+Acknowledgements
+===
+This wouldn't be possible without the amazing [Prawn](http://prawn.majesticseacreature.com) gem and the team behind it.
+
+License
+===
+Copyright (C) 2011 by Alan Johnson
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+
+require 'rake'
+require 'rake/testtask'
+
+task default: :test
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/generators/payday/setup/USAGE

@@ -0,0 +1,30 @@
+Description:
+	Creates the Invoice and LineItem models for Payday to use to 
+	render invoicing, and optionally a migration.
+		
+Usage:
+	Pass the name of the Invoice and LineItems to the generator to
+	establish the models and database migrations for you.  These 
+	parameters can be in camel-case or in under_scored format.
+	
+	If no invoice_name or line_item_name is passed, it will default
+	to Invoice and LineItem.
+	
+	If you wish to not create the migration and only have the
+	models generated for you, pass the --skip-migration flag to
+	the generator.
+	
+Examples:
+	`rails generate payday:setup`
+	
+	Will create Invoice and LineItem models with Payday
+	configured, and a database migration file to create
+	the tables and the minimum Payday needs to operate.
+		
+	`rails generate payday:setup --invoice-name=Bill --line_item-name=Actions`
+	
+	Will create Bill and Actions models with Payday's 
+	associations and configurations established, as well
+	as a database migration for the bills and actions
+	tables.
+

data/lib/generators/payday/setup/setup_generator.rb

@@ -0,0 +1,44 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+# rails g payday:setup <invoice_name> <line_item_name>
+# Generates models for invoicing with Payday includes prepped
+# Params:
+
+# OPTIONS:
+# --skip-migration - Does not create the migration file for invoicing
+module Payday
+  class SetupGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    class_option :invoice_name, type: :string, default: "Invoice"
+    class_option :line_item_name, type: :string, default: "LineItem"
+    class_option :skip_migration, desc: "Does not create the migration file for tables", type: :boolean
+
+    def generate_invoice_model
+      template "invoice.rb", "app/models/#{options.invoice_name.underscore}.rb"
+    end
+
+    def generate_line_item_model
+      template "line_item.rb", "app/models/#{options.line_item_name.underscore}.rb"
+    end
+
+    def generate_migration
+      unless options.skip_migration?
+        migration_template "migration.rb", "db/migrate/create_payday_tables.rb"
+      end
+    end
+
+    private
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  end
+end

data/lib/generators/payday/setup/templates/invoice.rb

@@ -0,0 +1,5 @@
+class <%= options.invoice_name.singularize %> < ActiveRecord::Base
+  include Payday::Invoiceable
+  
+  has_many :<%= options.line_item_name.pluralize.underscore %>
+end

data/lib/generators/payday/setup/templates/line_item.rb

@@ -0,0 +1,5 @@
+class <%= options.line_item_name.singularize %> < ActiveRecord::Base
+  include Payday::LineItemable
+  
+  belongs_to :<%= options.invoice_name.underscore %>
+end

data/lib/generators/payday/setup/templates/migration.rb

@@ -0,0 +1,26 @@
+class CreatePaydayTables < ActiveRecord::Migration
+  def self.up
+    create_table :<%= options.invoice_name.pluralize.underscore.split("/").last %> do |t|
+      # invoices will work without anything but bill_to, but there are quite a few options for the fields you can save, like ship_to
+      # due_at, refunded_at, and paid_at
+      t.string :bill_to
+
+      t.timestamps
+    end
+
+    create_table :<%= options.line_item_name.pluralize.underscore.split("/").last %> do |t|
+      t.decimal :price
+      t.string :description
+      t.integer :quantity     # can also be :decimal or :float - just needs to be numeric
+
+      t.references :<%= options.invoice_name.underscore %>
+
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :<%= options.invoice_name.pluralize.underscore.split("/").last %>
+    drop_table :<%= options.line_item_name.pluralize.underscore.split("/").last %>
+  end
+end

data/lib/payday/config.rb

@@ -0,0 +1,35 @@
+module Payday
+  # Configuration for Payday. This is a singleton, so to set the company_name you would call
+  # Payday::Config.default.company_name = "Awesome Corp".
+  class Config
+    attr_accessor :invoice_logo, :company_name, :company_details, :date_format, :currency
+
+    # Sets the page size to use. See the
+    # {http://prawn.majesticseacreature.com/docs/0.10.2/Prawn/Document/PageGeometry.html Prawn documentation} for valid
+    # page_size values.
+    attr_accessor :page_size
+
+    # Returns the default configuration instance
+    def self.default
+      @default ||= new
+    end
+
+    # Internal: Resets a config object back to its default settings.
+    #
+    # Primarily intended for use in our tests.
+    def reset
+      # TODO: Move into specs and make minimal configuration required (company name / details)
+      self.invoice_logo = File.join(File.dirname(__FILE__), '..', '..', 'spec', 'assets', 'default_logo.png')
+      self.company_name = 'Awesome Corp'
+      self.company_details = 'awesomecorp@commondream.net'
+      self.date_format = '%B %e, %Y'
+      self.currency = 'USD'
+      self.page_size = 'LETTER'
+    end
+
+    # Internal: Contruct a new config object.
+    def initialize
+      reset
+    end
+  end
+end

data/lib/payday/i18n.rb

@@ -0,0 +1,3 @@
+# Load everything in the local folder
+I18n.enforce_available_locales = false
+I18n.load_path.concat(Dir[File.join(File.dirname(__FILE__), 'locale', '*.yml')])

data/lib/payday/invoice.rb

@@ -0,0 +1,52 @@
+module Payday
+  # Basically just an invoice. Stick a ton of line items in it, add some details, and then render it out!
+  class Invoice
+    include Payday::Invoiceable
+
+    attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :shipping_description,
+                  :tax_description, :due_at, :paid_at, :refunded_at, :currency, :invoice_details, :invoice_date
+
+    attr_reader :tax_rate, :shipping_rate
+
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/MethodLength
+    # rubocop:todo Metrics/AbcSize
+    def initialize(options = {}) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+      self.invoice_number = options[:invoice_number] || nil
+      self.bill_to = options[:bill_to] || nil
+      self.ship_to = options[:ship_to] || nil
+      self.notes = options[:notes] || nil
+      self.line_items = options[:line_items] || []
+      self.shipping_rate = options[:shipping_rate] || nil
+      self.shipping_description = options[:shipping_description] || nil
+      self.tax_rate = options[:tax_rate] || nil
+      self.tax_description = options[:tax_description] || nil
+      self.due_at = options[:due_at] || nil
+      self.paid_at = options[:paid_at] || nil
+      self.refunded_at = options[:refunded_at] || nil
+      self.currency = options[:currency] || nil
+      self.invoice_details = options[:invoice_details] || []
+      self.invoice_date = options[:invoice_date] || nil
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    # The tax rate that we're applying, as a BigDecimal
+    def tax_rate=(value)
+      value = 0 if value.to_s.blank?
+      @tax_rate = BigDecimal(value.to_s)
+    end
+
+    # Shipping rate
+    def shipping_rate=(value)
+      value = 0 if value.to_s.blank?
+      @shipping_rate = BigDecimal(value.to_s)
+    end
+
+    # Adds a line item
+    def add_line_item(options = {})
+      line_items << Payday::LineItem.new(options)
+    end
+  end
+end