pdfmult 1.0.0 → 1.1.0

data/README.md

@@ -11,6 +11,9 @@ If `pdfmult` succeeds in obtaining the page count it will rearrange all pages,
 if not, only the first page is processed
 (unless the page count was specified via command line option).
 
+If the `--latex` option is used, `pdflatex` is not run and
+a LaTeX file is created instead of a PDF.
+
 Examples
 --------
 
@@ -41,7 +44,7 @@ Installation
 
 Use `gem install pdfmult`.
 
-Or opy `lib/pdfmult.rb` under the name `pdfmult` into your search path.
+Or copy `lib/pdfmult.rb` under the name `pdfmult` into your search path.
 
 On a Linux system you can use `[sudo] rake install`
 to install `pdfmult` and its man page to `/usr/local`.
@@ -53,6 +56,8 @@ As of now, `pdfmult` has only been tested on a Linux system.
 
 - `pdfmult` is written in [Ruby][Ruby], so Ruby must be installed on your system.
 - `pdfmult` uses `pdflatex` with the `pdfpages` package, so both have to be installed on the system.
+  (If `pdfmult` can not find the `pdflatex` command on your system
+  you might want to use the `--latex` option.)
 - `pdfmult` tries to obtain the page count of PDF files with `pdfinfo`.
   If it fails, by default only the first page of a PDF file will be processed.
 

data/Rakefile

@@ -59,6 +59,6 @@ end
 
 
 desc 'Build gem'
-task :build do
+task :build => [MANPAGE] do
   sh "gem build #{gemspec_file}"
 end

data/lib/pdfmult.rb

@@ -20,6 +20,8 @@
 #
 # +pdfmult+ uses +pdflatex+ with the +pdfpages+ package,
 # so both have to be installed on the system.
+# If the --latex option is used, though, +pdflatex+ is not run
+# and a LaTeX file is created instead of a PDF.
 #
 # == Options
 #
@@ -30,6 +32,8 @@
 # -p, --pages:: Number of pages to convert.
 #               If given, +pdfmult+ does not try to obtain the page count from the source PDF.
 #
+# -l, --latex:: Create a LaTeX file instead of a PDF file (default: infile_NUMBER.tex).
+#
 # -h, --help:: Prints a brief help message and exits.
 #
 # -v, --version:: Prints a brief version information and exits.
@@ -57,8 +61,8 @@ require 'fileutils'
 module Pdfmult
 
   PROGNAME  = 'pdfmult'
-  VERSION   = '1.0.0'
-  DATE      = '2012-03-15'
+  VERSION   = '1.1.0'
+  DATE      = '2012-03-16'
   COPYRIGHT = "Copyright (C) 2011-2012 Marcus Stollsteimer.\n" +
               "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n" +
               "This is free software: you are free to change and redistribute it.\n" +
@@ -83,8 +87,9 @@ module Pdfmult
       options = {
         :number  => 2,
         :infile  => nil,
+        :latex   => false,
         :outfile => nil,
-        :pages => nil
+        :pages   => nil
       }
 
       opt_parser = OptionParser.new do |opt|
@@ -100,6 +105,11 @@ module Pdfmult
         opt.separator 'if not, only the first page is processed'
         opt.separator '(unless the page count was specified via command line option).'
         opt.separator ''
+        opt.separator 'pdfmult uses pdflatex with the pdfpages package,'
+        opt.separator 'so both have to be installed on the system.'
+        opt.separator 'If the --latex option is used, though, pdflatex is not run'
+        opt.separator 'and a LaTeX file is created instead of a PDF.'
+        opt.separator ''
         opt.separator 'Options'
         opt.separator ''
 
@@ -135,6 +145,10 @@ module Pdfmult
           options[:pages] = p
         end
 
+        opt.on('-l', '--latex', 'Create a LaTeX file instead of a PDF file (default: file_2.tex).') do
+          options[:latex] = true
+        end
+
         opt.separator ''
       end
       opt_parser.parse!(argv)
@@ -145,7 +159,8 @@ module Pdfmult
       options[:infile] = argv.pop
 
       # set output file unless set by option
-      options[:outfile] ||= options[:infile].gsub(/(.pdf)$/, '') + "_#{options[:number].to_s}.pdf"
+      ext = options[:latex] ? 'tex' : 'pdf'
+      options[:outfile] ||= options[:infile].gsub(/(.pdf)$/, '') + "_#{options[:number].to_s}.#{ext}"
 
       options
     end
@@ -272,19 +287,26 @@ module Pdfmult
         usage_fail(e.message)
       end
 
-      # tests
-      general_fail("`#{PDFLATEX}' seems not to be installed")  unless command_available?("#{PDFLATEX} --version")
-      general_fail("`pdfpages.sty' seems not to be installed")  unless command_available?("#{KPSEWHICH} pdfpages.sty")
-
-      # main body #
-
       infile = options[:infile]
       outfile = options[:outfile]
 
+      # test for pdflatex installation
+      unless options[:latex]
+        message = 'seems not to be installed (you might try using the -l option)'
+        general_fail("`#{PDFLATEX}' #{message}")  unless command_available?("#{PDFLATEX} --version")
+        general_fail("`pdfpages.sty' #{message}")  unless command_available?("#{KPSEWHICH} pdfpages.sty")
+      end
+
       # test input file
       usage_fail("no such file: `#{infile}'")  unless File.exist?(infile)
       usage_fail("specified input not of the type `file'")  unless File.ftype(infile) == 'file'
 
+      # test for existing output file
+      if File.exist?(outfile)
+        overwrite_ok = ask("File `#{outfile}' already exists. Overwrite?")
+        exit  unless overwrite_ok
+      end
+
       # set page number (get PDF info if necessary)
       pages = options[:pages]
       pages ||= PDFInfo.new(infile).page_count
@@ -293,15 +315,36 @@ module Pdfmult
       # create LaTeX document
       document = LaTeXDocument.new(infile, options[:number], pages)
 
-      Dir.mktmpdir('pdfmult') do |dir|
-        open("#{dir}/pdfmult.tex", 'w') do |f|
-          pdfpath = "#{dir}/pdfmult.pdf"
+      if options[:latex]
+        open(outfile, 'w') do |f|
           f.write(document.to_s)
-          f.flush
-          system("/usr/bin/pdflatex -output-directory #{dir} pdfmult.tex")
-          puts "Writing on #{outfile}."
-          FileUtils::mv(pdfpath, outfile)
         end
+      else
+        Dir.mktmpdir('pdfmult') do |dir|
+          open("#{dir}/pdfmult.tex", 'w') do |f|
+            pdfpath = "#{dir}/pdfmult.pdf"
+            f.write(document.to_s)
+            f.flush
+            system("#{PDFLATEX} -output-directory #{dir} pdfmult.tex")
+            puts "Writing on #{outfile}."
+            FileUtils::mv(pdfpath, outfile)
+          end
+        end
+      end
+    end
+
+    # Asks for yes or no (y/n).
+    #
+    # +question+ - string to be printed
+    #
+    # Returns +true+ if the answer is yes.
+    def self.ask(question) # :nodoc:
+      while true
+        print question + ' [y/n] '
+        reply = $stdin.gets.chomp.downcase  # $stdin: avoids gets / ARGV problem
+        return true   if reply == 'y'
+        return false  if reply == 'n'
+        puts "Please answer `y' or `n'."
       end
     end
 

data/man/pdfmult.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
-.TH PDFMULT "1" "March 2012" "pdfmult 1.0.0" "User Commands"
+.TH PDFMULT "1" "March 2012" "pdfmult 1.1.0" "User Commands"
 .SH NAME
 pdfmult \- puts multiple copies of a PDF page on one page
 .SH SYNOPSIS
@@ -15,6 +15,11 @@ The input PDF file may consist of several pages.
 If pdfmult succeeds in obtaining the page count it will rearrange all pages,
 if not, only the first page is processed
 (unless the page count was specified via command line option).
+.PP
+pdfmult uses pdflatex with the pdfpages package,
+so both have to be installed on the system.
+If the \fB\-\-latex\fR option is used, though, pdflatex is not run
+and a LaTeX file is created instead of a PDF.
 .SH OPTIONS
 .TP
 \fB\-n\fR, \fB\-\-number\fR NUMBER
@@ -27,6 +32,9 @@ Output file (default: file_2.pdf).
 Number of pages to convert.
 If given, pdfmult does not try to obtain the page count from the source PDF.
 .TP
+\fB\-l\fR, \fB\-\-latex\fR
+Create a LaTeX file instead of a PDF file (default: file_2.tex).
+.TP
 \fB\-h\fR, \fB\-\-help\fR
 Prints a brief help message and exits.
 .TP

data/pdfmult.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |s|
   s.rubyforge_project = 'pdfmult'
 
   s.description = 'pdfmult is a command line tool that rearranges ' +
-                  'multiple copies of a PDF page (shrunken) on one page.'
+                  'multiple copies of a PDF page (shrunken) on one page. ' +
+                  'It is a wrapper for pdflatex with the pdfpages package.'
   s.summary = 'pdfmult - puts multiple copies of a PDF page on one page'
 
   s.authors = ['Marcus Stollsteimer']

data/test/test_latex_document.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# test_latex_document.rb: Unit tests for the pdfmult script.
+#
+# Copyright (C) 2011-2012 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pdfmult'
+
+
+describe Pdfmult::LaTeXDocument do
+
+  it 'should return the expected LaTeX code' do
+    document = Pdfmult::LaTeXDocument.new('sample.pdf', 8, 3)
+    document.to_s.split(/\n/)[0].must_equal "\\documentclass[a4paper,landscape]{article}"
+    document.to_s.split(/\n/)[-2].must_equal "\\includepdf[pages={3,3,3,3,3,3,3,3},nup=4x2]{sample.pdf}%"
+  end
+end

data/test/{test_pdfmult.rb → test_optionparser.rb}

@@ -1,5 +1,5 @@
 #!/usr/bin/ruby -w
-# test_pdfmult: Unit tests for the pdfmult script.
+# test_optionparser.rb: Unit tests for the pdfmult script.
 #
 # Copyright (C) 2011-2012 Marcus Stollsteimer
 
@@ -7,11 +7,6 @@ require 'minitest/spec'
 require 'minitest/autorun'
 require 'pdfmult'
 
-PROGNAME    = 'test_pdfmult.rb'
-PROGVERSION = '0.0.1'
-
-SRCPATH = File.dirname(__FILE__)
-
 
 describe Pdfmult::Optionparser do
 
@@ -21,7 +16,8 @@ describe Pdfmult::Optionparser do
       :infile => 'sample.pdf',
       :outfile => 'sample_2.pdf',
       :number => 2,
-      :pages => nil
+      :pages => nil,
+      :latex => false
     }
     options.must_equal expected
   end
@@ -46,6 +42,12 @@ describe Pdfmult::Optionparser do
     options[:pages].must_equal 4
   end
 
+  it 'should recognize the -l option and set the corresponding output filename' do
+    options = Pdfmult::Optionparser.parse!(['sample.pdf', '-l'])
+    options[:outfile].must_equal 'sample_2.tex'
+    options[:latex].must_equal true
+  end
+
   it 'should only accept positive -p option values' do
     lambda { Pdfmult::Optionparser.parse!(['sample.pdf', '-p', '0.5']) }.must_raise OptionParser::InvalidArgument
     lambda { Pdfmult::Optionparser.parse!(['sample.pdf', '-p', '0']) }.must_raise OptionParser::InvalidArgument
@@ -62,38 +64,3 @@ describe Pdfmult::Optionparser do
     lambda { Pdfmult::Optionparser.parse!(['-x']) }.must_raise OptionParser::InvalidOption
   end
 end
-
-
-describe Pdfmult::LaTeXDocument do
-
-  it 'should return the expected LaTeX code' do
-    document = Pdfmult::LaTeXDocument.new('sample.pdf', 8, 3)
-    document.to_s.split(/\n/)[0].must_equal "\\documentclass[a4paper,landscape]{article}"
-    document.to_s.split(/\n/)[-2].must_equal "\\includepdf[pages={3,3,3,3,3,3,3,3},nup=4x2]{sample.pdf}%"
-  end
-end
-
-
-describe Pdfmult::PDFInfo do
-
-  before do
-    @sample_pdf = File.expand_path("#{SRCPATH}/sample.pdf")
-  end
-
-  describe 'when asked about the page count' do
-    it 'should return the page count for existing file and system tool' do
-      infocmd = Pdfmult::PDFInfo::PDFINFOCMD
-      skip("Skipped: `#{infocmd}' not available on the system")  unless Pdfmult::PDFInfo.infocmd_available?
-      Pdfmult::PDFInfo.new(@sample_pdf).page_count.must_equal 3
-      Pdfmult::PDFInfo.new(@sample_pdf, :pdfinfocmd => infocmd).page_count.must_equal 3
-    end
-
-    it 'should return nil for non-existent files' do
-      Pdfmult::PDFInfo.new('not_a_file.pdf').page_count.must_be_nil
-    end
-
-    it "should return nil for non-existent `pdfinfo' system tool" do
-      Pdfmult::PDFInfo.new(@sample_pdf, :pdfinfocmd => 'not_a_command').page_count.must_be_nil
-    end
-  end
-end

data/test/test_pdfinfo.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# test_pdfinfo.rb: Unit tests for the pdfmult script.
+#
+# Copyright (C) 2011-2012 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pdfmult'
+
+SRCPATH = File.dirname(__FILE__)
+
+
+describe Pdfmult::PDFInfo do
+
+  before do
+    @sample_pdf = File.expand_path("#{SRCPATH}/sample.pdf")
+  end
+
+  describe 'when asked about the page count' do
+    it 'should return the page count for existing file and system tool' do
+      infocmd = Pdfmult::PDFInfo::PDFINFOCMD
+      skip("Skipped: `#{infocmd}' not available on the system")  unless Pdfmult::PDFInfo.infocmd_available?
+      Pdfmult::PDFInfo.new(@sample_pdf).page_count.must_equal 3
+      Pdfmult::PDFInfo.new(@sample_pdf, :pdfinfocmd => infocmd).page_count.must_equal 3
+    end
+
+    it 'should return nil for non-existent files' do
+      Pdfmult::PDFInfo.new('not_a_file.pdf').page_count.must_be_nil
+    end
+
+    it "should return nil for non-existent `pdfinfo' system tool" do
+      Pdfmult::PDFInfo.new(@sample_pdf, :pdfinfocmd => 'not_a_command').page_count.must_be_nil
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pdfmult
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Marcus Stollsteimer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-15 00:00:00 Z
+date: 2012-03-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: pdfmult is a command line tool that rearranges multiple copies of a PDF page (shrunken) on one page.
+description: pdfmult is a command line tool that rearranges multiple copies of a PDF page (shrunken) on one page. It is a wrapper for pdflatex with the pdfpages package.
 email: sto.mar@web.de
 executables: 
 - pdfmult
@@ -65,8 +65,10 @@ files:
 - bin/pdfmult
 - lib/pdfmult.rb
 - man/pdfmult.1
+- test/test_pdfinfo.rb
+- test/test_latex_document.rb
 - test/sample.tex
-- test/test_pdfmult.rb
+- test/test_optionparser.rb
 - test/sample.pdf
 homepage: https://github.com/stomar/pdfmult/
 licenses: 
@@ -102,4 +104,6 @@ signing_key:
 specification_version: 3
 summary: pdfmult - puts multiple copies of a PDF page on one page
 test_files: 
-- test/test_pdfmult.rb
+- test/test_pdfinfo.rb
+- test/test_latex_document.rb
+- test/test_optionparser.rb