spree_print_invoice 2.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6226ae4203203a3712b04b61f5aad9788404788a
+  data.tar.gz: 220792d7059a2ea3da797614f80cbb7318efd6ac
+SHA512:
+  metadata.gz: 237a2fb90f15da99d6e0278d0e3bd4a1ecee52cd2abca1f67bd6d282cba00bb4e16a9173b7b06e80347bd7525556e23779099e8bd21c32e3b55e6eefecd496d3
+  data.tar.gz: 1227d4ae8e10d3b3a00ec90a97ad8dd4628b47a2e303c591ce5641dd8a2f42df041e698e27ef64364ac50077a8df5edc3bba268c0b6e2688da245eba689a34aa

data/README.md

@@ -0,0 +1,48 @@
+SUMMARY
+=======
+
+*This is just a fork of spree/spree_print_invoice. There are no modifications apart from setting the version so I could push it to rubygems.
+
+This extension provides a "Print Invoice" button on the Admin Orders view screen which generates a PDF of the order details.
+
+ 
+INSTALLATION
+============
+
+1. The gem relies only on the prawn gem, to install you need to add the following lines to your Gemfile
+
+    gem 'spree_print_invoice' , :git => 'git://github.com/spree/spree_print_invoice.git'
+
+2. run bundler
+
+    bundle install
+  
+3. Enjoy! now displays the items variant options 
+
+Configuration
+==============
+
+1. 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")
+
+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. 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.
+
+Plans
+=====
+Next receipts and then product related stuff with barcodes.
+
+
+Contributions welcome
+
+Torsten

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

@@ -0,0 +1,13 @@
+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"
+        render :layout => false , :template => "spree/admin/orders/#{template}.pdf.prawn"
+      end
+    end
+  end
+end

data/app/models/spree/print_invoice_configuration.rb

@@ -0,0 +1,6 @@
+module Spree
+  class PrintInvoiceConfiguration < Preferences::Configuration
+    preference :print_invoice_logo_path, :string, :default => Spree::Config[:admin_interface_logo]
+    preference :print_buttons, :string, :default => 'invoice'  
+  end
+end

data/app/overrides/layouts_admin_print_buttons_decorator.rb

@@ -0,0 +1,5 @@
+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",
+                     :disabled => false)

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

@@ -0,0 +1,61 @@
+# Address Stuff
+
+bill_address = @order.bill_address
+ship_address = @order.ship_address
+anonymous = @order.email =~ /@example.net$/
+
+
+bounding_box [0,600], :width => 540 do
+  move_down 2
+  data = [[Prawn::Table::Cell.new( :text => Spree.t(:billing_address), :font_style => :bold ),
+                Prawn::Table::Cell.new( :text => Spree.t(:shipping_address), :font_style => :bold )]]
+
+  table data,
+    :position           => :center,
+    :border_width => 0.5,
+    :vertical_padding   => 2,
+    :horizontal_padding => 6,
+    :font_size => 9,
+    :border_style => :underline_header,
+    :column_widths => { 0 => 270, 1 => 270 }
+
+  move_down 2
+  horizontal_rule
+
+  bounding_box [0,0], :width => 540 do
+    move_down 2
+    if anonymous and Spree::Config[:suppress_anonymous_address]
+      data2 = [[" "," "]] * 6
+    else
+      data2 = [["#{bill_address.firstname} #{bill_address.lastname}", "#{ship_address.firstname} #{ship_address.lastname}"],
+            [bill_address.address1, ship_address.address1]]
+      data2 << [bill_address.address2, ship_address.address2] unless
+                bill_address.address2.blank? and ship_address.address2.blank?
+      data2 << ["#{@order.bill_address.zipcode} #{@order.bill_address.city}  #{(@order.bill_address.state ? @order.bill_address.state.abbr : "")} ",
+                  "#{@order.ship_address.zipcode} #{@order.ship_address.city} #{(@order.ship_address.state ? @order.ship_address.state.abbr : "")}"]
+      data2 << [bill_address.country.name, ship_address.country.name]
+      data2 << [bill_address.phone, ship_address.phone]
+      shipping_method_name = @order.shipments.map{|sh| sh.shipping_method.try(:name)}.compact.uniq.join(', ')
+      data2 << [shipping_method_name, shipping_method_name]
+    end
+
+    table data2,
+      :position           => :center,
+      :border_width => 0.0,
+      :vertical_padding   => 0,
+      :horizontal_padding => 6,
+      :font_size => 9,
+      :column_widths => { 0 => 270, 1 => 270 }
+  end
+
+  move_down 2
+
+  stroke do
+    line_width 0.5
+    line bounds.top_left, bounds.top_right
+    line bounds.top_left, bounds.bottom_left
+    line bounds.top_right, bounds.bottom_right
+    line bounds.bottom_left, bounds.bottom_right
+  end
+
+end

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

@@ -0,0 +1,6 @@
+font "Helvetica", :size => 8, :color => "#444444"
+move_down 10
+
+text Spree.t(:print_note)
+
+move_down 20

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

@@ -0,0 +1,13 @@
+# To get a simple text, use the line below with your own footer_message
+#  text_box footer_message, :at => [margin_box.left -10, margin_box.bottom + 40], :size => 8 , :position => :left
+
+repeat :all do
+  table [[Prawn::Table::Cell.new( :text => Spree.t(:footer_left), :font_style => :bold ),
+            Prawn::Table::Cell.new( :text => Spree.t(:footer_left2)),
+            Prawn::Table::Cell.new( :text => Spree.t(:footer_right), :font_style => :bold ),
+            Prawn::Table::Cell.new( :text => Spree.t(:footer_right2))]],
+            :border_width => 0,
+            :vertical_padding   => 2,
+            :font_size => 9,
+            :column_widths => { 0 => 80, 1 => 190, 2 => 75, 3 => 190 }
+end

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

@@ -0,0 +1,8 @@
+fill_color "E99323"
+if @hide_prices
+  text Spree.t(:packaging_slip), :align => :right, :style => :bold, :size => 18
+else
+  text Spree.t(:customer_invoice), :align => :right, :style => :bold, :size => 18
+end
+fill_color "000000"
+

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

@@ -0,0 +1,67 @@
+if @hide_prices
+  @column_widths = { 0 => 100, 1 => 165, 2 => 75, 3 => 75 }
+  @align = { 0 => :left, 1 => :left, 2 => :right, 3 => :right }
+else
+  @column_widths = { 0 => 75, 1 => 205, 2 => 75, 3 => 50, 4 => 75, 5 => 60 }
+  @align = { 0 => :left, 1 => :left, 2 => :left, 3 => :right, 4 => :right, 5 => :right}
+end
+
+# Line Items
+bounding_box [0,cursor], :width => 540, :height => 430 do
+  move_down 2
+  header =  [Prawn::Table::Cell.new( :text => Spree.t(:sku), :font_style => :bold),
+                Prawn::Table::Cell.new( :text => Spree.t(:item_description), :font_style => :bold ) ]
+  header <<  Prawn::Table::Cell.new( :text => Spree.t(:options), :font_style => :bold )
+  header <<  Prawn::Table::Cell.new( :text => Spree.t(:price), :font_style => :bold ) unless @hide_prices
+  header <<  Prawn::Table::Cell.new( :text => Spree.t(:qty), :font_style => :bold, :align => 1 )
+  header <<  Prawn::Table::Cell.new( :text => Spree.t(:total), :font_style => :bold ) unless @hide_prices
+
+  table [header],
+    :position           => :center,
+    :border_width => 1,
+    :vertical_padding   => 2,
+    :horizontal_padding => 6,
+    :font_size => 9,
+    :column_widths => @column_widths ,
+    :align => @align
+
+  move_down 4
+
+  bounding_box [0,cursor], :width => 540 do
+    move_down 2
+    content = []
+    @order.line_items.each do |item|
+      row = [ item.variant.product.sku, item.variant.product.name]
+      row << item.variant.option_values.map {|ov| "#{ov.option_type.presentation}: #{ov.presentation}"}.concat(item.respond_to?('ad_hoc_option_values') ? item.ad_hoc_option_values.map {|pov| "#{pov.option_value.option_type.presentation}: #{pov.option_value.presentation}"} : []).join(', ')
+      row << item.single_display_amount.to_s unless @hide_prices
+      row << item.quantity
+      row << item.display_total.to_s unless @hide_prices
+      content << row
+    end
+
+
+    table content,
+      :position           => :center,
+      :border_width => 0.5,
+      :vertical_padding   => 5,
+      :horizontal_padding => 6,
+      :font_size => 9,
+      :column_widths => @column_widths ,
+      :align => @align
+  end
+
+  font "Helvetica", :size => 9
+
+  render :partial => "totals" unless @hide_prices
+
+  move_down 2
+
+  stroke do
+    line_width 0.5
+    line bounds.top_left, bounds.top_right
+    line bounds.top_left, bounds.bottom_left
+    line bounds.top_right, bounds.bottom_right
+    line bounds.bottom_left, bounds.bottom_right
+  end
+
+end

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

@@ -0,0 +1,35 @@
+require 'prawn/layout'
+
+font "Helvetica"
+
+im = Rails.application.assets.find_asset(Spree::PrintInvoice::Config[:print_invoice_logo_path])
+image im , :at => [0,720] #, :scale => 0.35
+
+fill_color "E99323"
+if @hide_prices
+  text Spree.t(:packaging_slip), :align => :right, :style => :bold, :size => 18
+else
+  text Spree.t(:customer_invoice), :align => :right, :style => :bold, :size => 18
+end
+fill_color "000000"
+
+move_down 4
+
+font "Helvetica",  :size => 9,  :style => :bold
+text "#{Spree.t(:order_number)} #{@order.number}", :align => :right
+
+move_down 2
+font "Helvetica", :size => 9
+text "#{I18n.l @order.completed_at.to_date}", :align => :right
+
+
+render :partial => "address"
+
+move_down 30
+
+render :partial => "line_items_box"
+
+move_down 8
+
+# Footer
+# render :partial => "footer"

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

@@ -0,0 +1,7 @@
+<% if @order and @order.completed_at? %>
+  <% buttons = Spree::PrintInvoice::Config[:print_buttons]
+     buttons = buttons.split(",").collect{|b| b.strip } %>
+  <%  buttons.each do |button| %>
+    <li><%= link_to(Spree.t(button.to_s + "_print"), spree.admin_order_path(@order, :pdf , :template => button), :class => "button icon-print") %></li>
+  <% end %>
+<% end %>  

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

@@ -0,0 +1,21 @@
+totals = []
+
+totals << [Prawn::Table::Cell.new( :text => Spree.t(:subtotal), :font_style => :bold), @order.display_item_total.to_s]
+
+@order.adjustments.each do |charge|
+  totals << [Prawn::Table::Cell.new( :text => charge.label + ":", :font_style => :bold), charge.display_amount.to_s]
+end
+
+totals << [Prawn::Table::Cell.new( :text => Spree.t(:order_total), :font_style => :bold), @order.display_total.to_s]
+
+bounding_box [bounds.right - 500, bounds.bottom + (totals.length * 18)], :width => 500 do
+  table totals,
+    :position => :right,
+    :border_width => 0,
+    :vertical_padding   => 2,
+    :horizontal_padding => 6,
+    :font_size => 9,
+    :column_widths => { 0 => 425, 1 => 75 } ,
+    :align => { 0 => :right, 1 => :right }
+
+end

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

@@ -0,0 +1,2 @@
+render :partial => "print"
+

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

@@ -0,0 +1,3 @@
+@hide_prices = params[:template] == "packaging_slip"
+
+render :partial => "print"

data/config/routes.rb

@@ -0,0 +1,11 @@
+Spree::Core::Engine.routes.append do
+
+  namespace :admin do
+    resources :orders do
+      member do
+        get :show
+      end
+    end
+  end
+
+end

data/lib/prawn_handler.rb

@@ -0,0 +1,29 @@
+require 'prawn'
+
+module ActionView
+  module Template::Handlers
+    class Prawn 
+      def self.register!
+        Template.register_template_handler :prawn, self
+      end
+            
+      def self.call(template)
+        %(extend #{DocumentProxy}; #{template.source}; pdf.render)
+      end
+      
+      module DocumentProxy
+        def pdf
+          @pdf ||= ::Prawn::Document.new
+        end
+        
+      private
+      
+        def method_missing(method, *args, &block)
+          pdf.respond_to?(method) ? pdf.send(method, *args, &block) : super
+        end
+      end
+    end
+  end
+end
+
+ActionView::Template::Handlers::Prawn.register!

data/lib/spree_print_invoice.rb

@@ -0,0 +1,10 @@
+require 'spree_print_invoice/engine'
+require 'prawn_handler'
+
+module Spree
+  module PrintInvoice
+    def self.config(&block)
+      yield(Spree::PrintInvoice::Config)
+    end
+  end
+end

data/lib/spree_print_invoice/engine.rb

@@ -0,0 +1,25 @@
+module SpreePrintInvoice
+  class Engine < Rails::Engine
+    engine_name 'spree_print_invoice'
+    
+    initializer "spree.print_invoice.environment", :before => :load_config_initializers do |app|
+      Spree::PrintInvoice::Config = Spree::PrintInvoiceConfiguration.new
+    end
+    
+    initializer "spree.print_invoice.mimetypes" do |app|
+      Mime::Type.register('application/pdf', :pdf) unless Mime::Type.lookup_by_extension(:pdf)
+    end
+    
+    def self.activate
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+
+    end
+
+    config.autoload_paths += %W(#{config.root}/lib)
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: spree_print_invoice
+version: !ruby/object:Gem::Version
+  version: 2.1.3
+platform: ruby
+authors:
+- Spree Community
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/prawn_handler.rb
+- lib/spree_print_invoice/engine.rb
+- lib/spree_print_invoice.rb
+- app/controllers/spree/admin/orders_controller_decorator.rb
+- app/models/spree/print_invoice_configuration.rb
+- app/overrides/layouts_admin_print_buttons_decorator.rb
+- app/views/spree/admin/orders/_address.pdf.prawn
+- app/views/spree/admin/orders/_bye.pdf.prawn
+- app/views/spree/admin/orders/_footer.pdf.prawn
+- app/views/spree/admin/orders/_header.pdf.prawn
+- app/views/spree/admin/orders/_line_items_box.pdf.prawn
+- app/views/spree/admin/orders/_print.pdf.prawn
+- app/views/spree/admin/orders/_print_buttons.html.erb
+- app/views/spree/admin/orders/_totals.pdf.prawn
+- app/views/spree/admin/orders/invoice.pdf.prawn
+- app/views/spree/admin/orders/packaging_slip.pdf.prawn
+- config/routes.rb
+homepage: https://github.com/spree/spree_print_invoice
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Print invoices from a spree order
+test_files: []