jasper-command-line 0.4.0 → 0.4.1

data/Gemfile

@@ -1,7 +1,4 @@
-source :rubygems
+source 'http://production.cf.rubygems.org'
+# source :rubygems
 
-gemspec
-
-gem 'activesupport', '>= 3.2.0'
-gem 'rjb',           '1.4.3'
-gem 'builder',       '>= 3.0.3'
+gemspec

data/README.md

@@ -3,12 +3,18 @@ jasper-command-line
 
 Print a jasper document via the command line
 
-**Disclaimer**: This is almost completely based on the great work by [Fortes Informática](https://github.com/fortesinformatica), with the gem [jasper-rails](https://github.com/fortesinformatica/jasper-rails). I built this out of  necessity for a project that wouldn't run [jasper-rails](https://github.com/fortesinformatica/jasper-rails) on top of Ubuntu + nginx + Passenger.
+### Disclaimer:
+This is almost completely based on the great work by [Fortes Informática](https://github.com/fortesinformatica), with the gem [jasper-rails](https://github.com/fortesinformatica/jasper-rails). I built this out of  necessity for a project that wouldn't run [jasper-rails](https://github.com/fortesinformatica/jasper-rails) on top of Ubuntu + nginx + Passenger.
 
 This gem embeds the .jar files provided by [jasper-rails](https://github.com/fortesinformatica/jasper-rails), so you don't need to include the gem ([jasper-rails](https://github.com/fortesinformatica/jasper-rails) requires the whole Ruby on Rails framework, which isn't necessary in this case).
 
 It also embeds the .jar files needed to digitally sign the PDF, if necessary. The PDF files are signed using [PortableSigner](http://portablesigner.sourceforge.net) by [Peter Pfläging](peter.pflaeging@wien.gv.at). All credit for the digital signature code goes to him.
 
+### Other acknowledgements:
+
+* [Prawn](http://prawn.majesticseacreature.com), a "Fast, Nimble PDF Writer for Ruby"
+* [Henrik Nyh](http://henrik.nyh.se/) for the auto-print addition to Prawn, [prawn-print](https://github.com/barsoom/prawn-print).
+
 ## Dependencies
 
 * You need a Java Virtual Machine installed and set up in order to use this gem.
@@ -34,24 +40,28 @@ gem "jasper-command-line"
 ## Using jasper-command-line
 
 ```
-jasper-command-line [options]
+Usage: jasper-command-line [options]
 
 Options:
---jasper /path/to/file     The .jasper file to load (if one doesn't exist, it is
-                           compiled from the .jrxml file with the same name and
-                           on the same location)
---data-file /path/to/file  The .xml file to load the data from
---copies number            The number of copies to generate
---locale locale            The locale to use in the report (in the format xx-YY)
---param key=value          Adds the parameter with name key with the value value
-                           (can be defined multiple times)
+    -j, --jasper file                The .jasper file to load (if one doesn't exist, it is compiled from the .jrxml file with the same name and on the same location)
+    -d, --data-file file             The .xml file to load the data from
+    -c, --copies number              The number of copies to generate
+    -l, --locale locale              The locale to use in the report (in the format xx-YY)
+        --param name=value           Adds the parameter with name key with the value value (can be defined multiple times)
+
+Printing options:
+    -p, --print                      Whether to generate a PDF file that automatically opens the print dialog when opened in Acrobat Reader
+    -P, --print-silent               Whether to generate a PDF file that automatically prints to the default printer when opened in Acrobat Reader
 
 Digital signature options:
---sign-key-file /path/to/file  The location of the PKCS12 file to
-                               digitally sign the PDF with
---sign-password password       The password for the PKCS12 file
---sign-location location       The location of the signature
---sign-reason reason           The reason for signing the PDF
+        --sign-key-file file         The location of the PKCS12 file to digitally sign the PDF with
+        --sign-location location     The location data for the signature
+        --sign-password password     The password for the PKCS12 file
+        --sign-reason reason         The reason for signing the PDF
+
+Common options:
+    -h, --help                       Show this message
+        --version                    Show version
 ```
 
 ## LICENSE

data/jasper-command-line.gemspec

@@ -13,14 +13,16 @@ Gem::Specification.new do |s|
   s.summary     = "Use jasper-rails from the command line."
   s.description = "Use jasper-rails from the command line."
 
-  s.add_dependency('rjb', '1.4.3')
-  s.add_dependency('builder', '>= 3.0.2')
-  s.add_dependency('activesupport', '>= 3.2.0')
-  s.add_development_dependency("rspec", "~> 2.7")
-  s.add_development_dependency("rake", "~> 0.9.2")
+  s.add_dependency 'rjb', '1.4.3'
+  s.add_dependency 'builder', '>= 3.0.3'
+  s.add_dependency 'activesupport', '>= 3.2.0'
+  s.add_dependency 'prawn', '>= 0.12.0'
+
+  s.add_development_dependency "rspec", "~> 2.7"
+  s.add_development_dependency "rake", "~> 0.9.2"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-end
+end

data/lib/jasper-command-line.rb

@@ -7,6 +7,8 @@ require 'tempfile'
 require 'jasper-command-line/version'
 require 'jasper-command-line/command_line'
 require 'jasper-command-line/jasper'
+require 'prawn'
+require 'jasper-command-line/prawn-js'
 
 module JasperCommandLine
   def self.logger=(log)

data/lib/jasper-command-line/command_line.rb

@@ -4,141 +4,135 @@ module JasperCommandLine
       begin
         options = parse_arguments(args)
 
-        if !options
-          puts "Usage:"
-          puts ""
-          puts "jasper-command-line [options]"
-          puts ""
-          puts "Options:"
-          puts ""
-          puts "--jasper /path/to/file     The .jasper file to load (if one doesn't exist, it is"
-          puts "                           compiled from the .jrxml file with the same name and"
-          puts "                           on the same location)"
-          puts "--data-file /path/to/file  The .xml file to load the data from"
-          puts "--copies number            The number of copies to generate"
-          puts "--locale locale            The locale to use in the report (in the format xx-YY)"
-          puts "--param key=value          Adds the parameter with name key with the value value"
-          puts "                           (can be defined multiple times)"
-          puts ""
-          puts "Digital signature options:"
-          puts "--sign-key-file /path/to/file  The location of the PKCS12 file to"
-          puts "                               digitally sign the PDF with"
-          puts "--sign-password password       The password for the PKCS12 file"
-          puts "--sign-location location       The location of the signature"
-          puts "--sign-reason reason           The reason for signing the PDF"
-        else
-          if options[:jasper_file]
-            jasper_file = options.delete :jasper_file
-            data = options.delete :data
-            params = options.delete :params
-
-            if options[:signature]
-              if options[:signature][:key_file] && !options[:signature][:password]
-                raise ArgumentError.new("Password not supplied for certificate")
-              end
+        if options[:jasper_file]
+          jasper_file = options.delete :jasper_file
+          data = options.delete :data
+          params = options.delete :params
+
+          if options[:signature]
+            if options[:signature][:key_file] && !options[:signature][:password]
+              raise ArgumentError.new("Password not supplied for certificate")
             end
-
-            puts JasperCommandLine::Jasper::render_pdf(jasper_file, data, params, options)
           end
+
+          puts JasperCommandLine::Jasper::render_pdf(jasper_file, data, params, options)
         end
-      rescue ArgumentError => e
+
+        exit 0
+      rescue OptionParser::InvalidOption => e
         puts "Error: #{e.message}"
+        exit 1
       rescue => e
         puts "Error: #{e.message}"
-        puts e.backtrace
+        exit 2
       end
     end
 
     private
 
       def parse_arguments(arguments)
+        require 'optparse'
+        require 'optparse/time'
+        require 'ostruct'
+
         data = {
           :params => {}
         }
 
-        return false unless arguments.any?
-
-        i = 0
-
-        while i < arguments.length
-          argument = arguments[i]
-
-          case get_option(argument)
-            when 'data'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Data not found") if get_option(argument_data)
-                data[:data] = argument_data
-              end
-
-            when 'data-file'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Data file not found: #{argument_data}") unless File.exists?(argument_data)
-                data[:data] = File.read argument_data
-              end
-
-            when 'param'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Invalid param format: #{argument_data}") unless argument_data =~ /(.*?)=(.*)/
-                data[:params][$1] = $2
-              end
-
-            when 'jasper'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("File not found: #{argument_data}") unless File.exists?(argument_data) || File.exists?(argument_data.gsub(/\.jasper$/, '.jrxml'))
-                data[:jasper_file] = argument_data
-              end
-
-            when 'copies'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Invalid number of copies: #{argument_data}") unless argument_data =~ /^[1-9][0-9]*$/
-                data[:copies] = argument_data.to_i
-
-                raise ArgumentError.new("Ghostscript isn't available. Merging is not possible") if data[:copies] > 1 && !JasperCommandLine.ghostscript_available?
-              end
-
-            when 'locale'
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Invalid locale: #{argument_data}") unless argument_data =~ /^[a-z]{2}-[A-Za-z0-9]{2,3}$/
-                data[:locale] = {
-                  :language => argument_data.strip.split('-').first,
-                  :sub_language => argument_data.strip.split('-').last
-                }
-              end
-
-            when 'sign-key-file'
-              # Sign document with file
-              i = get_option_data(arguments, i) do |argument_data|
-                raise ArgumentError.new("Signature key file not found: #{argument_data}") unless File.exists?(argument_data)
-                data[:signature] ||= {}
-                data[:signature][:key_file] = argument_data
-              end
-
-            when 'sign-location'
-              # Location to set on the signature
-              i = get_option_data(arguments, i) do |argument_data|
-                data[:signature] ||= {}
-                data[:signature][:location] = argument_data
-              end
-
-            when 'sign-password'
-              # Password to open the signature key file
-              i = get_option_data(arguments, i) do |argument_data|
-                data[:signature] ||= {}
-                data[:signature][:password] = argument_data
-              end
-
-            when 'sign-reason'
-              # Reason to set on the signature
-              i = get_option_data(arguments, i) do |argument_data|
-                data[:signature] ||= {}
-                data[:signature][:reason] = argument_data
-              end
-
-            else
-              i += 1
-          end
+        # Default to the help message
+        arguments << '--help' if arguments.empty?
+
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: jasper-command-line [options]"
         end
 
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on('-j', '--jasper file', "The .jasper file to load (if one doesn't exist, it is compiled from the .jrxml file with the same name and on the same location)") do |file|
+          raise ArgumentError.new("File not found: #{file}") unless File.exists?(file) || File.exists?(file.gsub(/\.jasper$/, '.jrxml'))
+          data[:jasper_file] = file
+        end
+
+        opts.on('-d', '--data-file file', "The .xml file to load the data from") do |file|
+          raise ArgumentError.new("Data file not found: #{file}") unless File.exists?(file)
+          data[:data] = File.read file
+        end
+
+        opts.on('-c', '--copies number', Integer, "The number of copies to generate") do |i|
+          data[:copies] = i
+          raise ArgumentError.new("Ghostscript isn't available. Merging is not possible") if data[:copies] > 1 && !JasperCommandLine.ghostscript_available?
+        end
+
+        opts.on('-l', '--locale locale', "The locale to use in the report (in the format xx-YY)") do |locale|
+          raise ArgumentError.new("Invalid locale format: #{locale}") unless locale =~ /([a-z]{2})-([A-Z]{2})/
+          data[:locale] = { language: $1, sub_language: $2 }
+        end
+
+        opts.on('--param name=value', "Adds the parameter with name key with the value value (can be defined multiple times)") do |parameter|
+          raise ArgumentError.new("Invalid param format: #{parameter}") unless parameter =~ /([^\s]+)=(.*)/
+          data[:params][$1] = $2
+        end
+
+        opts.separator ""
+        opts.separator "Printing options:"
+
+        opts.on('-p', '--print', "Whether to generate a PDF file that automatically opens the print dialog when opened in Acrobat Reader") do
+          raise ArgumentError.new("Can't supply both --print and --print-silent") if data[:print_silent]
+          data[:print] = true
+        end
+
+        opts.on('-P', '--print-silent', "Whether to generate a PDF file that automatically prints to the default printer when opened in Acrobat Reader") do
+          raise ArgumentError.new("Can't supply both --print and --print-silent") if data[:print]
+          data[:print_silent] = true
+        end
+
+        opts.separator ""
+        opts.separator "Digital signature options:"
+
+        opts.on('--sign-key-file file', "The location of the PKCS12 file to digitally sign the PDF with") do |file|
+          # Sign document with file
+          raise ArgumentError.new("Signature key file not found: #{file}") unless File.exists?(file)
+          data[:signature] ||= {}
+          data[:signature][:key_file] = file
+        end
+
+        opts.on('--sign-location location', "The location data for the signature") do |location|
+          # Location to set on the signature
+          data[:signature] ||= {}
+          data[:signature][:location] = location
+        end
+
+        opts.on('--sign-password password', "The password for the PKCS12 file") do |password|
+          # Password to open the signature key file
+          data[:signature] ||= {}
+          data[:signature][:password] = password
+        end
+
+        opts.on('--sign-reason reason', "The reason for signing the PDF") do |reason|
+          # Reason to set on the signature
+          data[:signature] ||= {}
+          data[:signature][:reason] = reason
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        # Another typical switch to print the version.
+        opts.on_tail("--version", "Show version") do
+          puts JasperCommandLine::VERSION
+          exit
+        end
+
+        opts.parse! arguments
+
         return data
       end
 

data/lib/jasper-command-line/jasper.rb

@@ -20,8 +20,6 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 module JasperCommandLine
   module Jasper
     def self.render_pdf(jasper_file, datasource, parameters, options)
@@ -95,6 +93,19 @@ module JasperCommandLine
           file = copy_file
         end
 
+        if options[:print] || options[:print_silent]
+          temp_file = Tempfile.new(['pdf-', '.pdf'])
+          file2 = temp_file.path
+          temp_file.close!
+
+          ::Prawn::Document.generate(file2, template: file) do |pdf|
+            pdf.print if options[:print]
+            pdf.print_silent if options[:print_silent]
+          end
+
+          file = file2
+        end
+
         # Digitally sign the file, if necessary
         if sign_options
           temp_signed_file = Tempfile.new(['signed-pdf-', '.pdf'])

data/lib/jasper-command-line/prawn-js.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+#
+# js.rb : Implements embeddable Javascript support for PDF
+#
+# Copyright March 2009, James Healy. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE file for details.
+
+module JasperCommandLine
+  module Prawn
+    module JS
+      # The maximum number of children to fit into a single node in the JavaScript tree.
+      NAME_TREE_CHILDREN_LIMIT = 20 #:nodoc:
+
+      # add a Javascript fragment that will execute when the document is opened.
+      #
+      # There can only be as many fragments as required. Calling this function
+      # multiple times will append the new fragment to the list.
+      #
+      def add_docopen_js(name, script)
+        obj = ref!(:S => :JavaScript, :JS => script)
+        javascript.data.add(name, obj)
+      end
+
+      def print
+        print_with_auto_to_printer false, nil
+      end
+
+      def print_silent
+        print_with_auto_to_printer true, nil
+      end
+
+      def print_with_auto_to_printer(auto, printer)
+        js = [
+          'var pp = this.getPrintParams();',
+          interactive_js(auto),
+          select_printer_js(printer),
+          'this.print(pp);'
+        ]
+
+        add_docopen_js "print", js.join(' ')
+      end
+
+      def interactive_js(auto)
+        "pp.interactive = pp.constants.interactionLevel.silent;" if auto
+      end
+
+      def select_printer_js(printer)
+        if printer
+          escaped_printer = printer.gsub('"') { "\\#$0" }
+
+          [
+            'var names = app.printerNames;',
+            'var regex = new RegExp("#{escaped_printer}", "i");',
+            'for (var i = 0; i < names.length; i++) {',
+              'if (names[i].match(regex)) {',
+                'pp.printerName = names[i];',
+                'break;',
+              '}',
+            '}'
+          ].join(' ')
+        else
+          'pp.printerName = "";'
+        end
+      end
+
+      # create or access the Javascript Name Tree in the document names dict.
+      # See section 3.6.3 and table 3.28 in the PDF spec.
+      #
+      def javascript
+        names.data[:JavaScript] ||= ref!(::Prawn::Core::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT))
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+::Prawn::Document.send(:include, JasperCommandLine::Prawn::JS)

data/lib/jasper-command-line/version.rb

@@ -1,3 +1,3 @@
 module JasperCommandLine
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jasper-command-line
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rjb
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +141,7 @@ files:
 - lib/jasper-command-line/java/jcommon-1.0.15.jar
 - lib/jasper-command-line/java/jfreechart-1.0.12.jar
 - lib/jasper-command-line/java/xalan.jar
+- lib/jasper-command-line/prawn-js.rb
 - lib/jasper-command-line/version.rb
 homepage: http://github.com/gokuu/jasper-command-line
 licenses: []