spree-print-invoice 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d33f08c18b4f9e205319dc38437c7a39e35a94c
+  data.tar.gz: 24a5d139084b510b6fe1e826800b43dc87d10c8b
+SHA512:
+  metadata.gz: 19878476a8d422f7cfd025024fd77655d29886e216459188035638be2e4a8cb7b1573e2cef284d30b6a50c552d4223f349994d02f47b542faaa334ef5f4aea67
+  data.tar.gz: 7c5d6dd88bf9901d2154393ee01e6531d325b01829811f08629f264da72aeabbba0deb00d3559a97f0d6c450b4702f9f0791a80779170abb14ad2ab93959551b

data/.gitignore

@@ -0,0 +1,12 @@
+\#*
+*~
+.#*
+.DS_Store
+.bundle
+coverage
+Gemfile.lock
+tmp
+pkg
+spec/dummy
+.rvmrc
+.localeapp

data/.hound.yml

@@ -0,0 +1,3 @@
+---
+LineLength:
+  Enabled: false

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+script:
+  - bundle exec rspec spec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing [translations][3]
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree/spree_print_invoice/issues
+[3]: http://www.localeapp.com/projects/6630

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-1-stable'
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', cmd: 'bundle exec rspec', all_on_start: false, all_after_pass: false do
+  watch('spec/spec_helper.rb')                       { 'spec' }
+  watch('config/routes.rb')                          { 'spec/controllers' }
+  watch(%r{^spec/(.+)_spec\.rb$})                    { |m| "spec/#{m[1]}_spec.rb"}
+  watch(%r{^app/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$})                       { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$}) { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2011-2014 Christopher Angileri, Tobias Bohwalli, and other contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,48 @@
+# Spree Print Invoice
+
+[![Build Status](https://api.travis-ci.org/futhr/spree-print-invoice.png?branch=2-1-stable)](https://travis-ci.org/futhr/spree-print-invoice)
+[![Coverage Status](https://coveralls.io/repos/futhr/spree-print-invoice/badge.png?branch=2-1-stable)](https://coveralls.io/r/futhr/spree-print-invoice)
+[![Code Climate](https://codeclimate.com/github/futhr/spree-print-invoice.png)](https://codeclimate.com/github/futhr/spree-print-invoice)
+[![Gem Version](https://badge.fury.io/rb/spree-print-invoice.png)](http://badge.fury.io/rb/spree-print-invoice)
+
+This extension provides a "Print Invoice" button (per default) on the Admin Orders view screen which generates a PDF of the order details. It's fully extendable so you can add own _print slips_ from your own Rails app. It also comes with a packaging slip.
+
+## Installation
+
+Add to your `Gemfile`
+```ruby
+gem 'spree-print-invoice', '~> 2.1.0'
+```
+
+Run
+```
+bundle install
+rails g spree_print_invoice:install
+```
+
+Enjoy! Now allow to generate invoices with sequential numbers.
+
+---
+
+## Configuration and extending slips
+
+See corresponding [wiki pages][1]
+
+---
+
+## Contributing
+
+See corresponding [guidelines][2]
+
+---
+
+## License
+
+Copyright (c) 2011-2014 [Christopher Angileri][3], [Tobias Bohwalli][4], and other [contributors][5], released under the [New BSD License][6]
+
+[1]: https://github.com/futhr/spree-print-invoice/wiki
+[2]: https://github.com/futhr/spree-print-invoice/blob/master/CONTRIBUTING.md
+[3]: https://github.com/angileri
+[4]: https://github.com/futhr
+[5]: https://github.com/futhr/spree-print-invoice/contributors
+[6]: https://github.com/futhr/spree-print-invoice/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_print_invoice'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/javascripts/admin/spree_print_invoice.js

@@ -0,0 +1 @@
+//= require admin/spree_backend

data/app/assets/stylesheets/admin/spree_print_invoice.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_backend
+*/

data/app/controllers/spree/admin/orders_controller_decorator.rb

@@ -0,0 +1,18 @@
+Spree::Admin::OrdersController.class_eval do
+  respond_to :pdf
+
+  def show
+    load_order
+    respond_with(@order) do |format|
+      format.pdf do
+        template = params[:template] || 'invoice'
+        if (template == 'invoice') && Spree::PrintInvoice::Config.use_sequential_number? && !@order.invoice_number.present?
+          @order.invoice_number = Spree::PrintInvoice::Config.increase_invoice_number
+          @order.invoice_date = Date.today
+          @order.save!
+        end
+        render layout: false, template: "spree/admin/orders/#{template}.pdf.prawn"
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/print_invoice_settings_controller.rb

@@ -0,0 +1,16 @@
+module Spree
+  module Admin
+    class PrintInvoiceSettingsController < ResourceController
+
+      def update
+        settings = Spree::PrintInvoiceSetting.new
+        params[:preferences].each do |name, value|
+          next unless settings.has_preference? name
+          settings[name] = value
+        end
+        flash[:success] = Spree.t(:successfully_updated, resource: Spree.t(:settings, scope: :print_invoice))
+        redirect_to edit_admin_print_invoice_settings_path
+      end
+    end
+  end
+end

data/app/overrides/add_print_invoice_to_admin_configuration_sidebar.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(virtual_path:  "spree/admin/shared/_configuration_menu",
+                     name:          "print_invoice_admin_configurations_menu",
+                     insert_bottom: "[data-hook='admin_configurations_sidebar_menu'], #admin_configurations_sidebar_menu[data-hook]",
+                     text:          "<%= configurations_sidebar_menu_item Spree.t(:settings, scope: :print_invoice), edit_admin_print_invoice_settings_path %>",
+                     original:      "737741636d3b0e7dcffd17c5b463c2983647e168 ",
+                     disabled:      false)

data/app/overrides/layouts_admin_print_buttons_decorator.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_content_header",
+                     :name => "print_buttons",
+                     :insert_top => "[data-hook='toolbar']>ul",
+                     :partial => "spree/admin/orders/print_buttons",
+                     :original => 'a3a6281b8d3543510afa905d0a1602f03f14d7b9',
+                     :disabled => false)

data/app/views/spree/admin/orders/_print_buttons.html.erb

@@ -0,0 +1,12 @@
+<% if @order && @order.completed_at? %>
+  <div style="margin-bottom:4px" data-hook="admin_order_print_buttons">
+    <% buttons = Spree::PrintInvoice::Config[:print_buttons].split(',').compact.collect{|b| b.strip } %>
+    <% buttons.each do |button| %>
+      <li>
+        <%= link_to(Spree.t(:"#{button}", scope: [:print_invoice, :buttons], default: 'PDF Slip'),
+          spree.admin_order_path(@order, :pdf , template: button),
+          class: 'button icon-print', target: :blank) %>
+      </li>
+    <% end %>
+  </div>
+<% end %>

data/app/views/spree/admin/orders/invoice.pdf.prawn

@@ -0,0 +1,155 @@
+define_grid(columns: 5, rows: 8, gutter: 10)
+
+# HEADER
+repeat(:all) do
+  im = Rails.application.assets.find_asset(Spree::PrintInvoice::Config[:print_invoice_logo_path])
+  if File.exists? im
+    image im, vposition: :top, height: 40
+  end
+
+  grid([0,3], [0,4]).bounding_box do
+    font 'Helvetica', size: 9
+    text Spree.t(:invoice, scope: :print_invoice), align: :right, style: :bold, size: 18
+    move_down 4
+    text Spree.t(:order_number, number: @order.number), align: :right
+    move_down 2
+    text I18n.l(@order.completed_at.to_date), align: :right
+  end
+end
+
+# CONTENT
+grid([1,0], [6,4]).bounding_box do
+
+  font 'Helvetica', size: 9
+
+  # address block on first page only
+  repeat(lambda { |pg| pg == 1 }) do
+    bill_address = @order.bill_address
+    ship_address = @order.ship_address
+
+    move_down 2
+    address_cell_billing  = make_cell(content: Spree.t(:billing_address), font_style: :bold)
+    address_cell_shipping = make_cell(content: Spree.t(:shipping_address), font_style: :bold)
+
+    billing =  "#{bill_address.firstname} #{bill_address.lastname}"
+    billing << "\n#{bill_address.address1}"
+    billing << "\n#{bill_address.address2}" unless bill_address.address2.blank?
+    billing << "\n#{bill_address.city}, #{bill_address.state_text} #{bill_address.zipcode}"
+    billing << "\n#{bill_address.country.name}"
+    billing << "\n#{bill_address.phone}"
+
+    shipping =  "#{ship_address.firstname} #{ship_address.lastname}"
+    shipping << "\n#{ship_address.address1}"
+    shipping << "\n#{ship_address.address2}" unless ship_address.address2.blank?
+    shipping << "\n#{ship_address.city}, #{ship_address.state_text} #{ship_address.zipcode}"
+    shipping << "\n#{ship_address.country.name}"
+    shipping << "\n#{ship_address.phone}"
+    shipping << "\n\n#{Spree.t(:via, scope: :print_invoice)} #{@order.shipments.first.shipping_method.name}"
+
+    data = [[address_cell_billing, address_cell_shipping], [billing, shipping]]
+    table(data, position: :center, column_widths: [270, 270])
+  end
+
+  move_down 10
+
+  header = [
+    make_cell(content: Spree.t(:sku)),
+    make_cell(content: Spree.t(:item_description)),
+    make_cell(content: Spree.t(:options)),
+    make_cell(content: Spree.t(:price)),
+    make_cell(content: Spree.t(:qty)),
+    make_cell(content: Spree.t(:total))
+  ]
+  data = [header]
+
+  @order.line_items.each do |item|
+    row = [
+      item.variant.product.sku,
+      item.variant.product.name,
+      item.variant.options_text,
+      item.single_display_amount.to_s,
+      item.quantity,
+      item.display_total.to_s
+    ]
+    data += [row]
+  end
+
+  table(data, header: true, position: :center, column_widths: [70, 200, 100, 65, 40, 65]) do
+    row(0).style align: :center, font_style: :bold
+    column(0..2).style align: :left
+    column(3..6).style align: :right
+  end
+
+  # TOTALS
+  move_down 10
+  totals = []
+
+  # Subtotal
+  totals << [make_cell(content: Spree.t(:subtotal)), @order.display_item_total.to_s]
+
+  # Adjustments
+  @order.all_adjustments.eligible.each do |adjustment|
+    totals << [make_cell(content: adjustment.label), adjustment.display_amount.to_s]
+  end
+
+  # Shipments
+  @order.shipments.each do |shipment|
+    totals << [make_cell(content: shipment.shipping_method.name), shipment.display_cost.to_s]
+  end
+
+  # Totals
+  totals << [make_cell(content: Spree.t(:order_total)), @order.display_total.to_s]
+
+  # Payments
+  total_payments = 0.0
+  @order.payments.each do |payment|
+    totals << [
+      make_cell(content: Spree.t(:payment_via,
+        gateway: (payment.source_type || Spree.t(:unprocessed, scope: :print_invoice)),
+        number: payment.identifier,
+        date: I18n.l(payment.updated_at.to_date, format: :long),
+        scope: :print_invoice)),
+      payment.display_amount.to_s
+    ]
+    total_payments += payment.amount
+  end
+
+  table(totals, column_widths: [475, 65]) do
+    row(0..6).style align: :right
+    column(0).style borders: [], font_style: :bold
+  end
+
+  move_down 30
+  text Spree::PrintInvoice::Config[:return_message], align: :right, size: 9
+end
+
+# FOOTER
+if Spree::PrintInvoice::Config[:use_footer]
+  repeat(:all) do
+    grid([7,0], [7,4]).bounding_box do
+
+      data = []
+      data << [ make_cell(content: Spree.t(:vat, scope: :print_invoice), colspan: 2, align: :center) ]
+      data << [ make_cell(content: '', colspan: 2) ]
+      data << [ make_cell(content: Spree::PrintInvoice::Config[:footer_left],  align: :left),
+                make_cell(content: Spree::PrintInvoice::Config[:footer_right], align: :right) ]
+
+      table(data, position: :center, column_widths: [270, 270]) do
+        row(0..2).style borders: []
+      end
+    end
+  end
+end
+
+# PAGE NUMBER
+if Spree::PrintInvoice::Config[:use_page_numbers]
+  string  = "#{Spree.t(:page, scope: :print_invoice)} <page> #{Spree.t(:of, scope: :print_invoice)} <total>"
+  options = {
+    at: [bounds.right - 155, 0],
+    width: 150,
+    align: :right,
+    start_count_at: 1,
+    color: '000000'
+  }
+  number_pages string, options
+end

data/app/views/spree/admin/orders/packaging_slip.pdf.prawn

@@ -0,0 +1,128 @@
+define_grid(columns: 5, rows: 8, gutter: 10)
+
+# HEADER
+repeat(:all) do
+  im = Rails.application.assets.find_asset(Spree::PrintInvoice::Config[:print_invoice_logo_path])
+  if File.exists? im
+    image im, vposition: :top, height: 40
+  end
+
+  grid([0,3], [0,4]).bounding_box do
+    font 'Helvetica', size: 9
+    text Spree.t(:packaging_slip, scope: :print_invoice), align: :right, style: :bold, size: 18
+    move_down 4
+
+    if Spree::PrintInvoice::Config.use_sequential_number? && @order.invoice_number.present?
+
+      text Spree.t(:invoice_number, number: @order.invoice_number, scope: :print_invoice), align: :right
+      move_down 2
+      text "#{Spree.t(:invoice_date)} #{I18n.l @order.invoice_date}", align: :right
+
+    else
+
+      text Spree.t(:order_number, number: @order.number), align: :right
+      move_down 2
+      text I18n.l(@order.completed_at.to_date), align: :right
+
+    end
+  end
+end
+
+# CONTENT
+grid([1,0], [6,4]).bounding_box do
+
+  font 'Helvetica', size: 9
+
+  # address block on first page only
+  repeat(lambda { |pg| pg == 1 }) do
+    bill_address = @order.bill_address
+    ship_address = @order.ship_address
+
+    move_down 2
+    address_cell_billing  = make_cell(content: Spree.t(:billing_address), font_style: :bold)
+    address_cell_shipping = make_cell(content: Spree.t(:shipping_address), font_style: :bold)
+
+    billing =  "#{bill_address.firstname} #{bill_address.lastname}"
+    billing << "\n#{bill_address.address1}"
+    billing << "\n#{bill_address.address2}" unless bill_address.address2.blank?
+    billing << "\n#{bill_address.city}, #{bill_address.state_text} #{bill_address.zipcode}"
+    billing << "\n#{bill_address.country.name}"
+    billing << "\n#{bill_address.phone}"
+
+    shipping =  "#{ship_address.firstname} #{ship_address.lastname}"
+    shipping << "\n#{ship_address.address1}"
+    shipping << "\n#{ship_address.address2}" unless ship_address.address2.blank?
+    shipping << "\n#{ship_address.city}, #{ship_address.state_text} #{ship_address.zipcode}"
+    shipping << "\n#{ship_address.country.name}"
+    shipping << "\n#{ship_address.phone}"
+    shipping << "\n\n#{Spree.t(:via, scope: :print_invoice)} #{@order.shipments.first.shipping_method.name}"
+
+    data = [[address_cell_billing, address_cell_shipping], [billing, shipping]]
+    table(data, position: :center, column_widths: [270, 270])
+  end
+
+  move_down 10
+
+  header =  [
+    make_cell(content: Spree.t(:sku)),
+    make_cell(content: Spree.t(:item_description)),
+    make_cell(content: Spree.t(:options)),
+    make_cell(content: Spree.t(:qty))
+  ]
+  data = [header]
+
+  @order.line_items.each do |item|
+    row = [
+      item.variant.product.sku,
+      item.variant.product.name,
+      item.variant.options_text,
+      item.quantity
+    ]
+    data += [row]
+  end
+
+  table(data, header: true, position: :center, column_widths: [70, 300, 130, 40]) do
+    row(0).style align: :center, font_style: :bold
+    column(0..2).style align: :left
+    column(3).style align: :center
+  end
+
+  move_down 30
+  text Spree::PrintInvoice::Config[:anomaly_message], align: :left, size: 9
+
+  move_down 20
+  bounding_box([0, cursor], width: 540, height: 250) do
+    transparent(0.5) { stroke_bounds }
+  end
+end
+
+# FOOTER
+if Spree::PrintInvoice::Config[:use_footer]
+  repeat(:all) do
+    grid([7,0], [7,4]).bounding_box do
+
+      data = []
+      data << [ make_cell(content: Spree.t(:vat, scope: :print_invoice) , colspan: 2, align: :center) ]
+      data << [ make_cell(content: '', colspan: 2) ]
+      data << [ make_cell(content: Spree::PrintInvoice::Config[:footer_left], align: :left),
+                make_cell(content: Spree::PrintInvoice::Config[:footer_right], align: :right) ]
+
+      table(data, position: :center, column_widths: [270, 270]) do
+        row(0..2).style borders: []
+      end
+    end
+  end
+end
+
+# PAGE NUMBER
+if Spree::PrintInvoice::Config[:use_page_numbers]
+  string  = "#{Spree.t(:page, scope: :print_invoice)} <page> #{Spree.t(:of, scope: :print_invoice)} <total>"
+  options = {
+    at: [bounds.right - 150, 0],
+    width: 150,
+    align: :right,
+    start_count_at: 1,
+    color: '000000'
+  }
+  number_pages string, options
+end