solidusio-contrib / solidus_print_invoice Goto Github PK

Provide your users with printable PDF invoices in Solidus.

License: BSD 3-Clause "New" or "Revised" License

Ruby 97.41% HTML 1.90% Shell 0.69%

solidus pdf invoice store ecommerce extension

solidus_print_invoice's Introduction

SolidusPrintInvoice

This extension provides a "Print Invoice" button on the Admin Orders view screen which generates a PDF of the order details.

This is meant to provide an example of how this can be done, and is easily extended by overriding the templates however you prefer.

Installation

Add solidus_print_invoice to your Gemfile:

gem 'solidus_print_invoice' , github: 'solidusio-contrib/solidus_print_invoice'

Bundle your dependencies and run the installation generator:

$ bundle install
$ rails g solidus_print_invoice:install

Configuration

Set the logo path preference to include your store / company logo.

Spree::PrintInvoice::Config.set(print_invoice_logo_path: "/path/to/public/images/company-logo.png")

Add your own own footer texts to the locale. The current footer works with :footer_left1 , :footer_left2 and :footer_right1, :footer_right2 where the 1 version is on the left in bold, and the 2 version the "value" on the right.
Override any of the partial templates. They are address, footer, totals, header, bye, and the line_items. In bye the text :thanks is printed. The :extra_note hook has been deprecated as Spree no longer supports hooks.
Set :suppress_anonymous_address option to get blank addresses for anonymous email addresses (as created by my spree_last_address extension for empty/unknown user info)
Many european countries requires numeric and sequential invoices numbers. To use invoices sequential number fill the specific field in "General Settings" or by set

Spree::PrintInvoice::Config.set(print_invoice_next_number: [1|{your current next invoice number}])

The next invoice number will be the one that you specified. You will able to increase it in any moment, for example, to re-sync invoices number if you are making invoices also in other programs for the same business name.

Enable packaging slips, by setting

Spree::PrintInvoice::Config.set(print_buttons: "invoice,packaging_slip")  #comma separated list

Use above feature for your own template if you want. For each button_name, define button_name_print text in your locale.

Set page/document options with

Spree::PrintInvoice::Config.set(prawn_options: { page_layout: :landscape, page_size: "A4", margin: [50, 100, 150, 200] })

Testing

First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs, and Rubocop static code analysis.

bundle
bundle exec rake

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:

require 'solidus_print_invoice/factories'

Releasing

Your new extension version can be released using gem-release like this:

bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release

solidus_print_invoice's People

Contributors

Stargazers

Watchers

solidus_print_invoice's Issues

Dependabot couldn't find a Gemfile-local for this project

Dependabot couldn't find a Gemfile-local for this project.

Dependabot requires a Gemfile-local to evaluate your project's current Ruby dependencies. It had expected to find one at the path: /Gemfile-local.

If this isn't a Ruby project, or if it is a library, you may wish to disable updates for it from within Dependabot.