oxen_printer 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2856583ac970726480283ef1ffcbc0443e0a902a
-  data.tar.gz: 5481a1caeae750b7caf77783d6533572b0f799f1
+  metadata.gz: b3926f0dc3bad41ffe690545fb03beea76eb5482
+  data.tar.gz: ed071ff53e49d90317bf37744b1bd9049cb05ec0
 SHA512:
-  metadata.gz: da1d19e301d9253df75b949376925d96c25be759385bbcfcf29b30aa5be020decd301dcc7c026b6cd567b4bc462f7d8aede878a20582a7bb09406fe75533edeb
-  data.tar.gz: 52dd2b0e5d641f417ba286f078f45fe41fbea96db9f6d31a85cbe293d1efae7f250c120f10fd2c4417ee18d3ef2c0499aeac390caac003b10ab50442ad6abadc
+  metadata.gz: 510a1ea5d4a260c6563a808778defa8da6eb6507191e34123c6e9669c62af4fb4be5515dd79ae795fe22890e388ff56fe9f2026a5ea5ef9c04b48105db0ee8d8
+  data.tar.gz: efb4fc3b9c431b712bf426bd424aae5cf3088a2c93986204ceea360d05d240038f743ad07e50e599cdbc7b04a4c29ce30f311a6cff8d70ed7c1174fa993b8a9b

data/app/controllers/oxen/printers_controller.rb

@@ -15,9 +15,9 @@ class Oxen::PrintersController < AbstractResourcesController
 
       opt = { items: {}}
       case params[:action]
-      when 'edit','update';    opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
-      when 'show';             opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
-      when 'index';            opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
+      when 'edit','update';#    opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
+      when 'show';         #    opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
+      when 'index';        #    opt[:items].merge! list: { ajax: 'get', icon: 'list', class: 'blue', url: "/admin/accounts/#{resource.account.id}" }
       end
 
       @fab_button_options = opt

data/app/mailers/printer_mailer.rb

@@ -1,7 +1,7 @@
 class PrinterMailer < ActionMailer::Base
   layout 'mailer'
 
-  def send_print usr, file
+  def send_print usr, file, msg=nil
     @usr = User.find(usr)
     fname = case file
     when /\/pdf.*$/; 'print%s.pdf' % DateTime.now.nsec
@@ -9,7 +9,7 @@ class PrinterMailer < ActionMailer::Base
     end
     attachments[fname] = File.read(file) unless file.blank?
     @logo = @usr.account.logos.first.image.url rescue ""
-    @msg = "Der er ikke defineret nogen printere til dette job, for dig - så jeg er nødt til at sende dig filen vedhæftet denne email! ;)Du bør kontakte din system administrator og bede om at der bliver oprettet en printer definition til denne printer jobtype, for dig!"
+    @msg = msg || "Der er ikke defineret nogen printere til dette job, for dig - så jeg er nødt til at sende dig filen vedhæftet denne email! ;)Du bør kontakte din system administrator og bede om at der bliver oprettet en printer definition til denne printer jobtype, for dig!"
 
     mail  from: 'no-reply@wheelstore.space',
           to: @usr.email,

data/config/locales/da.yml

@@ -9,3 +9,9 @@ da:
         cups_printer: 'Angiv navnet på den CUPS printer, der skal håndtere print'
         cups_cmd: 'Indfør den kommando som skal starte printjobbet ("lp -d $1 -o media=$2 $3" eller "lp -d $1 -o raw $2")'
         paper: 'Angiv papirformatet - exvis Letter, A4, 30x57mm, eller lignende'
+  output:
+    email:
+      email_sent: 'Udskriften dannet korrekt og email sendt!'
+      email_address_missing: 'Email adresse ikke fundet - udskrift ikke sendt!'
+    medium:
+      no_medium_found: 'Intet medie valgt?! Udskriften kunne ikke dannes!'

data/lib/action_printer.rb

@@ -1,6 +1,6 @@
 #encoding: utf-8
 class ActionPrinter < ActionView::Base
-
+ 
   include Exceptions
 
   attr_accessor :printer, :paper

data/lib/generators/printer/printer_generator.rb

@@ -17,11 +17,14 @@ class PrinterGenerator < Rails::Generators::NamedBase
   def create_migration_file
     migration_template 'printer.rb', 'db/migrate/create_printers.rb'
     # allow the clock to advance 1sec
-    sleep 1
+    sleep 2
     migration_template 'print_job.rb', 'db/migrate/create_print_jobs.rb'
     # allow the clock to advance 1sec
-    sleep 1
+    sleep 2
     migration_template 'printable.rb', 'db/migrate/create_printables.rb'
+    # allow the clock to advance 1sec
+    sleep 2
+    migration_template 'template.rb', 'db/migrate/create_templates.rb'
   end
 
 end

data/lib/oxen_printer/version.rb

@@ -1,3 +1,3 @@
 module OxenPrinter
-  VERSION = "0.3.4"
+  VERSION = "0.4.1"
 end

data/lib/print_drivers.rb

@@ -16,36 +16,32 @@ module PrintDrivers
 
     # build PDF or somehow prepare printer output
     def rendered_on(*args)
-      begin
-        update_column(:state, "rendering")
+      update_column(:state, "rendering")
 
-        # TODO 2013-06-08 set the action_printer with respect to the selected output & printer
-        action_printer = case print_driver
-        when :pdf, "pdf"
-          require 'oxen_printer/pdf_printer'
-          PdfPrinter.new(printer, paper)
-        when :cab, "cab"
-          require 'oxen_printer/cab_printer'
-          CabPrinter.new(printer, paper)
-        when :label, "label"
-          require 'oxen_printer/label_printer'
-          LabelPrinter.new(printer, paper)
-        when :html, "html"
-          require 'oxen_printer/html_printer'
-          HtmlPrinter.new(printer, paper)
-        when :csv, "csv"
-          require 'oxen_printer/csv_printer'
-          CsvPrinter.new(printer, paper)
-        end
-      rescue => e
-        logit :error, "assigning printer driver failed - #{e.message}"
-        return nil
+      # TODO 2013-06-08 set the action_printer with respect to the selected output & printer
+      action_printer = case print_driver
+      when :pdf, "pdf"
+        require 'oxen_printer/pdf_printer'
+        PdfPrinter.new(printer, paper)
+      when :cab, "cab"
+        require 'oxen_printer/cab_printer'
+        CabPrinter.new(printer, paper)
+      when :label, "label"
+        require 'oxen_printer/label_printer'
+        LabelPrinter.new(printer, paper)
+      when :html, "html"
+        require 'oxen_printer/html_printer'
+        HtmlPrinter.new(printer, paper)
+      when :csv, "csv"
+        require 'oxen_printer/csv_printer'
+        CsvPrinter.new(printer, paper)
       end
 
       # print_job.action_printer.printer = print_job.printer
       # print_job.cycle if
       return action_printer if action_printer.do_render(self,args)
-      nil
+      update_column(:state, 'error rendering')
+      raise PrintJobRenderingError
     end
 
     #
@@ -65,16 +61,13 @@ module PrintDrivers
     end
 
     def send_with action_printer, context
-      begin
-        update_column(:state, 'sending')
-        if action_printer && action_printer.send_print_file( context)
-          update_column(:state, 'done')
-          action_printer.file_path
-        else
-          update_column(:state, 'error sending')
-          raise PrintJobPrintingError
-        end
-      rescue => e
+      update_column(:state, 'sending')
+      if action_printer && action_printer.send_print_file( context)
+        update_column(:state, 'done')
+        action_printer.file_path
+      else
+        update_column(:state, 'error sending')
+        raise PrintJobPrintingError
       end
     end
 

data/lib/print_engine.rb

@@ -11,6 +11,43 @@
 # http://rarlindseysmash.com/posts/config-and-generators-in-gems
 #
 
+#
+#
+# ARGS                            # first value is default
+#
+#   collation                     # 'list' | 'record'
+#   paper                         # 'A4' | 'label' | ...
+#   template                      # '' | 'slip' | 'quote'
+#   cmd                           # '' | 'print_label' - a particular method on the printing_class
+#
+# PRINTPROMPT
+#   print[medium]                 # 'display' | 'email' | 'printer' | 'download'
+#   print[output_type]            # 'html' | 'pdf' | 'text'
+#   print[printer]                # what printer to send output to
+#   print[email_to]               # email address
+#   print[message]                # body of email
+#   print[range]                  # which pages should print
+#   print[copies]                 # number of copies
+#
+# PRINTJOB
+#   id,
+#   account_id,                   # what 'system' / customer
+#   printer_id,                   # on what printer
+#   printed_by_id,                # what id has the printed_by entity
+#   printed_by_type,              # what entity - like user
+#   view_template_path,           # what template
+#   name,                         # label the job
+#   printing_class,               # what entity provides the data
+#   print_driver,                 # what 'driver' - like :pdf, :cab, :zebra, :csv, :html, etc
+#   print_format,                 # data collation - like 'record', 'list'
+#   state,                        # record the progress
+#   paper,                        # what material - like 'label32x42', 'A4', etc
+#   copies,                       # number of identical prints
+#   print_sql,                    # how to find what will be printed
+#   created_at,
+#   updated_at
+#
+#
 
 #
 module PrintEngine
@@ -20,24 +57,10 @@ module PrintEngine
   def self.included(base)
 
     #
-    # find the best printer for the job
-    def base.default_printer usr, printer_name, paper=nil
-      if printer_name=="default"
-        if paper.nil?
-          printer = (usr.printers.empty? ? nil : usr.printers.active.preferred_printer.first) or raise NoPreferredPrintersFound.new('No preferred printers were found!')
-        else
-          printer = (usr.printers.empty? ? nil : (usr.printers.active.preferred_printer.on_paper(paper).first || usr.printers.on_paper(paper).first ) ) or raise NoPreferredPrintersFound.new('No preferred printers were found!')
-        end
-      else
-        printer = Printer.active.find_by( 'name like ?',  "%#{printer_name.downcase}%")
-      end
-      # usr.printers.where{ (printownerables.preferred==true) & (printownerables.preferred==true) }
-
-      # raise PrintJobPrinterNotAvailableError
-      printer || Printer.first
-    rescue NoPreferredPrintersFound
-      logit :error, 'No preferred printers found! Sending PDF by email to %s (%s) ' % [usr.name,usr.email]
-      Printer.create paper: paper, command: 'email', name: 'tmp printer - will be deleted shortly - DONT TOUCH!!', account_id: usr.account.id
+    def base.print_list(options={})
+      options = set_print_job_defaults options[:resources], options
+      options[:print_job][:print_format]        =   options[:print][:collation] || 'list'
+      pj = print options[:resources], options
     end
 
     #
@@ -51,77 +74,82 @@ module PrintEngine
     # and the PrintJob will be enqueued in the delayed_job queue called 'printing'.
     # cycle_error will be called in print_job.rb if it cannot be enqueued sucessfully.
     def base.print( resources, params )
-      begin
-        pj = create_print_job( resources, params )
-        return false unless pj
-      rescue PrintJobResourceError
-        base.logit :error, 'PrintJob could not be created - no records!?'
-        return false
-
-      rescue PrintJobPrinterNotAvailableError
-        logit :error, 'PrintJob could not be created - the user has no printers attached!!'
-        return false
-
-      end
-
-      begin
-        if Rails.env=='development' or pj.download
-          return pj if pj.perform params
-        else
-          user = User.find(pj.printed_by_id)
-          BackgroundPrinterJob.perform_later pj, queue: "printing", account_id: user.account.id
-          # Delayed::Job.enqueue pj, :queue => 'printing'
-          # pj.cycle if Delayed::Job.enqueue pj, :queue => 'printing'
-          # If you comment out above line and use below line with pj.perform instead, you thereby surpass delayed_job, and thus don't have to wait for it
-          # pj.perform
-          return pj
-        end
-      rescue => e
-        # self.logit :error, 'PrintJob could not be enqueued'
-        pj.update_columns( state: "could not be queued for printing - #{e}" )
-        return nil
+      pj = create_print_job( resources, params )
+      if Rails.env=='development' or pj.download
+        return pj.perform params
+      else
+        user = User.find(pj.printed_by_id)
+        BackgroundPrinterJob.perform_later pj, queue: "printing", account_id: user.account.id
+        # Delayed::Job.enqueue pj, :queue => 'printing'
+        # pj.cycle if Delayed::Job.enqueue pj, :queue => 'printing'
+        # If you comment out above line and use below line with pj.perform instead, you thereby surpass delayed_job, and thus don't have to wait for it
+        # pj.perform
+        return pj
       end
     end
 
     #
     #
     def base.create_print_job( resources, params )
-      printer_name = params.delete(:printer_name) || "default"
       params = ActionController::Parameters.new( params) unless params.class == ActionController::Parameters
-      params = set_print_job_defaults(resources,params, printer_name)
-      return nil if params[:print_job][:printer_id].nil?
-      PrintJob.create( params[:print_job].permit(:download, :snap_shot, :account_id, :printer_id, :printed_by_id, :printed_by_type, :view_template_path, :name, :printing_class, :print_driver, :print_format, :paper, :copies, :state, :print_sql) )
+      pj=PrintJob.create( params_permit(params) )
+      raise PrintJobNotCreatedError.new('arguments not permitted!') unless pj
+      pj
+    end
+
+    def base.params_permit(params)
+      params[:print_job].permit(:download, :snap_shot, :account_id, :printer_id, :printed_by_id,
+        :printed_by_type, :view_template_path, :printing_class, :name, :print_driver, :print_format, :paper, :copies, :state, :print_sql)
     end
 
     # Sets print_job defaults using the provided params
     # and looks up any print_job settings to be tweaked
     # as per klass and user
-    def base.set_print_job_defaults(resources, params, printer_name)
-      klass = resources.first.class.to_s rescue "class not found!"
-      params[:print_job] ||= {}
-      params[:user] ||= User.first
-      user = params[:user]
-      params[:print_job][:account_id]           ||= user.account.id
-      params[:print_job][:paper]                ||= nil
-      params[:print_job][:printer_id]           ||= self.default_printer(user,printer_name,params[:print_job][:paper]).id
-      params[:print_job][:printed_by_id]        = user.id
-      params[:print_job][:printed_by_type]      = user.class.to_s
-      params[:print_job][:name]                 ||= "#{klass} print at #{I18n.l Time.now, format: :short_date }"
-      params[:print_job][:printing_class]       ||= klass
-      params[:print_job][:print_driver]         ||= :pdf
-      params[:print_job][:copies]               ||= 1
-      params[:print_job][:print_format]         ||= "list"
-      params[:print_job][:state]                = "drafted"
-      params[:print_job][:snap_shot]            ||= false
-      params[:print_job][:print_sql]            = set_resource_sql(resources,params)
-
+    def base.set_print_job_defaults(resources, options)
+      klass = self.to_s #resources.first.class.to_s rescue "class not found!"
+      pb = options[:printed_by]
+      printer_name = options[:print].delete(:printer) || "default"
+
+      options[:print_job][:printer_id]          ||= self.default_printer(pb,printer_name,options[:print_job][:paper]).id
+      options[:print_job][:state]               = "drafted"
+      options[:print_job][:snap_shot]           ||= false
+      options[:print_job][:print_sql]           = set_resource_sql(resources,options)
+      options[:print_job]                       ||= {}
+      options[:print_job][:printing_class]      ||= klass
+      options[:print_job][:account_id]          ||= pb.account.id
+      options[:print_job][:printed_by_id]       = pb.id
+      options[:print_job][:printed_by_type]     = pb.class.to_s
+      options[:print_job][:name]                ||= "#{klass} print at #{I18n.l Time.now, format: :short_date }"
+      options[:print_job][:copies]              ||= 1
+      options[:context]                         ||= ""
+      options[:print_job][:download]            =   options[:print][:medium]=="download" || false
+      # options[:print_job][:view_template_path]  =   find_template( options[:print][:template], options[:print][:paper] ) || options[:print_job][:view_template_path]
+      #
       # this is what we ultimately return
-      params
+      options
+    end
+
+    #
+    # find the best printer for the job
+    def base.default_printer usr, printer_name, paper=nil
+      if printer_name=="default"
+        if paper.nil?
+          printer = (usr.printers.empty? ? nil : usr.printers.active.preferred_printer.first) or raise NoPreferredPrintersFound.new('No preferred printers found!')
+        else
+          printer = (usr.printers.empty? ? nil : (usr.printers.active.preferred_printer.on_paper(paper).first || usr.printers.on_paper(paper).first ) ) or raise NoPreferredPrintersFound.new('No preferred printers found!')
+        end
+      else
+        printer = Printer.active.find_by( 'name like ?',  "%#{printer_name.downcase}%")
+      end
+      # usr.printers.where{ (printownerables.preferred==true) & (printownerables.preferred==true) }
+
+      # raise PrintJobPrinterNotAvailableError
+      printer || Printer.first
     end
 
     def base.set_resource_sql(resources,params)
       return resources if resources.class == String && resources.downcase =~ /select/
-      raise PrintJobResourceError unless resources.respond_to?(:any?) and resources.any?
+      raise PrintJobResourceError.new('No items found to print?!') unless resources.respond_to?(:any?) and resources.any?
       params[:print_job][:snap_shot] ? resources.to_yaml : (resources.class==Array ? array_to_arel(resources) : resources.to_sql)
     end
 
@@ -132,5 +160,56 @@ module PrintEngine
     end
 
   end
+  #
+  #
+  # # list_title
+  # def list_title
+  #   self.respond_to?( "name") ? self.name : "please define list_title on model (#{self.class.to_s})!"
+  # end
+  #
+  # # implement on relevant models
+  def find_template template, paper="A4"
+    raise 'you have to implement "def find_template(paper)" on your Model'
+    # 'label.html.haml'
+  end
+  #
+  #
+  #
+  # def set_print_defaults options
+  #   options[:context]                         ||= ""
+  #   options[:print_job][:download]            =   options[:print][:medium]=="download" || false
+  #   options[:print_job][:print_driver]        =   spot_the_driver(options)
+  #   options[:print_job][:paper]               =   options[:paper] || "A4"
+  #   options[:print_job][:view_template_path]  =   find_template( options[:template], options[:paper] ) || params[:print_job][:view_template_path]
+  #   options
+  # end
+  #
+
+  def print_label(options={})
+    options = self.class.set_print_job_defaults [self], options
+    options[:print_job][:print_driver]        =   options[:print][:print_driver] || :cab
+    options[:print_job][:paper]               =   options[:print][:paper] || "label"
+    options[:print_job][:print_format]        =   options[:print][:collation] || 'record'
+    options[:print_job][:view_template_path]  =   "stock_items/print/zebra_stock_items_label.html.haml"
+
+    pj = self.class.print [self], options
+  end
+
+
+  # options[:print][:printer_name] = options[:print][:printer_name] || ''
+  # options[:user] = options[:user] || current_user
+
+
+  def print_record(options={})
+    options = self.class.set_print_job_defaults [self], options
+    options[:print_job][:print_driver]        =   options[:print][:print_driver] || :pdf
+    options[:print_job][:paper]               =   options[:print][:paper] || "A4"
+    options[:print_job][:print_format]        =   options[:print][:collation] || 'record'
+    options[:print_job][:view_template_path]  =   "stock_items/print/slip.html.haml"
+
+    pj = self.class.print [self], options
+  end
+
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxen_printer
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Walther H Diechmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oxen_job