Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/solidusio-contrib/solidus_print_invoice

Provide your users with printable PDF invoices in Solidus.
https://github.com/solidusio-contrib/solidus_print_invoice

ecommerce extension invoice pdf solidus store

Last synced: 23 days ago
JSON representation

Provide your users with printable PDF invoices in Solidus.

Host: GitHub
URL: https://github.com/solidusio-contrib/solidus_print_invoice
Owner: solidusio-contrib
License: bsd-3-clause
Created: 2016-04-27T18:12:24.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-01-29T03:52:34.000Z (12 months ago)
Last Synced: 2024-12-20T14:33:03.431Z (about 1 month ago)
Topics: ecommerce, extension, invoice, pdf, solidus, store
Language: Ruby
Homepage:
Size: 146 KB
Stars: 18
Watchers: 11
Forks: 30
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

SolidusPrintInvoice
===================

[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_print_invoice.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_print_invoice)

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:

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

Bundle your dependencies and run the installation generator:

```shell
$ bundle install
$ rails g solidus_print_invoice:install
```

[Configuration](http://example.com/)
-------------

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

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

2. 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.

3. 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.

4. 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)

5. Many european countries requires numeric and sequential invoices numbers. To use invoices sequential number fill the specific field in "General Settings" or by set

```ruby
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.

6. Enable packaging slips, by setting

```ruby
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.

7. Set page/document options with

```ruby
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](https://github.com/bbatsov/rubocop) static code analysis.

```shell
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:

```ruby
require 'solidus_print_invoice/factories'
```

Releasing
---------

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

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