oxen_printer 0.0.3

data/lib/print_engine.rb

@@ -0,0 +1,135 @@
+# encoding: UTF-8
+#/* - - - - - - - - - - - - - - - - - - - - -
+#
+#   Title : WEB Appliances Crest Inc, Web Form Framework
+#   Author : Enrique Phillips
+#   URL : http://www.wac.bz
+#
+#- - - - - - - - - - - - - - - - - - - - - */
+# the <b>PrintEngine</b> module ...
+
+# TODO build the print_engine as a Gem
+# http://rarlindseysmash.com/posts/config-and-generators-in-gems
+#
+
+
+#
+module PrintEngine
+
+  include Exceptions
+
+  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
+    #   Printer.new
+    end
+
+    #
+    # def base.default_print_template_path(params,usr)
+    #   # TODO 2013-09-02 - select template according to the user/employee
+    #   params[:print_job][:view_template_path] || "/test.html.haml"
+    # end
+
+    # Creates the PrintJob for any model in need of printing
+    # If creating the PrintJob is successful, cycle will be called in print_job.rb
+    # 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
+      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) )
+    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)
+
+      # this is what we ultimately return
+      params
+    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?
+      params[:print_job][:snap_shot] ? resources.to_yaml : (resources.class==Array ? array_to_arel(resources) : resources.to_sql)
+    end
+
+    def base.array_to_arel resources
+      arel_instance = Arel::Table.new(resources.first.class.table_name)
+      ar_rel = resources.first.class
+      ar_rel.where(arel_instance[:id].in(resources.map(&:id)).to_sql).to_sql
+    end
+
+  end
+
+end

data/lib/tasks/oxen_printer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :abstracted do
+#   # Task goes here
+# end

data/oxen_printer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oxen_printer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oxen_printer"
+  spec.version       = OxenPrinter::VERSION
+  spec.authors       = ["Walther H Diechmann"]
+  spec.email         = ["walther@diechmann.net"]
+  spec.summary       = %q{oxen_printer provides printer and print_job management.}
+  spec.description   = %q{oxen_printer manages printers and print_jobs - as a front end to CUPS printers.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oxen_job"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: oxen_printer
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Walther H Diechmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oxen_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: oxen_printer manages printers and print_jobs - as a front end to CUPS
+  printers.
+email:
+- walther@diechmann.net
+executables:
+- rails
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/oxen/print_jobs_controller.rb
+- app/controllers/oxen/printers_controller.rb
+- app/jobs/background_printer_job.rb
+- app/models/ox_print_job.rb
+- app/models/ox_printable.rb
+- app/models/ox_printer.rb
+- app/policies/oxen/print_job_policy.rb
+- app/views/oxen/print_jobs/_form.html.haml
+- app/views/oxen/print_jobs/_print_job.html.haml
+- app/views/oxen/print_jobs/_print_jobs.html.haml
+- app/views/oxen/print_jobs/_printer_print_job.html.haml
+- app/views/oxen/print_jobs/_printer_print_jobs.html.haml
+- app/views/oxen/print_jobs/_show.html.haml
+- app/views/oxen/printers/_account_printer.html.haml
+- app/views/oxen/printers/_account_printers.html.haml
+- app/views/oxen/printers/_form.html.haml
+- app/views/oxen/printers/_new.html.haml
+- app/views/oxen/printers/_printer.html.haml
+- app/views/oxen/printers/_printers.html.haml
+- app/views/oxen/printers/_user_printer.html.haml
+- app/views/oxen/printers/_user_printers.html.haml
+- app/views/oxen/printers/create.html.haml
+- bin/rails
+- config/locales/da.yml
+- config/routes.rb
+- lib/action_printer.rb
+- lib/c4_label_print_provider.rb
+- lib/generators/printer/install_generator.rb
+- lib/generators/printer/printer_generator.rb
+- lib/generators/printer/templates/print_job.rb
+- lib/generators/printer/templates/printable.rb
+- lib/generators/printer/templates/printer.rb
+- lib/java_pdf/LICENSE
+- lib/java_pdf/LICENSE-LGPL-2.1.txt
+- lib/java_pdf/LICENSE-W3C-TEST
+- lib/java_pdf/README
+- lib/java_pdf/about.jar
+- lib/java_pdf/barbecue-1.5-beta1.jar
+- lib/java_pdf/barcodeprinter.jar
+- lib/java_pdf/browser.jar
+- lib/java_pdf/core-renderer-minimal.jar
+- lib/java_pdf/core-renderer.jar
+- lib/java_pdf/docbook.jar
+- lib/java_pdf/iText-2.0.8.jar
+- lib/java_pdf/itext-paulo-155.jar
+- lib/java_pdf/lib/LICENSE
+- lib/java_pdf/lib/LICENSE-LGPL-2.1.txt
+- lib/java_pdf/lib/LICENSE-W3C-TEST
+- lib/java_pdf/lib/README
+- lib/java_pdf/lib/core-renderer-minimal.jar
+- lib/java_pdf/lib/core-renderer.jar
+- lib/java_pdf/lib/iText-2.0.8.jar
+- lib/java_pdf/lib/itext-paulo-155.jar
+- lib/java_pdf/lib/minium.jar
+- lib/java_pdf/minium.jar
+- lib/java_pdf/pd4ml_demo.jar
+- lib/java_pdf/ss_css2.jar
+- lib/java_pdf/svg.jar
+- lib/oxen_printer.rb
+- lib/oxen_printer/cab_printer.rb
+- lib/oxen_printer/csv_printer.rb
+- lib/oxen_printer/engine.rb
+- lib/oxen_printer/html_printer.rb
+- lib/oxen_printer/label_printer.rb
+- lib/oxen_printer/pdf_printer.rb
+- lib/oxen_printer/version.rb
+- lib/print_drivers.rb
+- lib/print_engine.rb
+- lib/tasks/oxen_printer_tasks.rake
+- oxen_printer.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: oxen_printer provides printer and print_job management.
+test_files: []