pdf-toolkit 0.5.0 → 1.0.0.rc1

data/README.md

@@ -0,0 +1,42 @@
+# pdf-toolkit - A ruby interface to pdftk
+
+pdf-toolkit allows you to access pdf metadata in read-write in a very simple 
+way, through the [`pdftk` commandline tool](http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/).
+
+A typical usecase is as follows:
+
+    my_pdf = PDF::Toolkit.open("somefile.pdf")
+    my_pdf.updated_at = Time.now # ModDate
+    my_pdf["SomeAttribute"] = "Some value"
+    my_pdf.save!
+    
+    class MyDocument < PDF::Toolkit
+      info_accessor :some_attribute
+      def before_save
+        self.updated_at = Time.now
+      end
+    end
+    my_pdf = MyDocument.open("somefile.pdf")
+    my_pdf.some_attribute = "Some value"
+    my_pdf.save!
+
+## Note about this version
+
+This is a prerelease 1.0.0.rc1 version on an almost abandonned project. The main
+difference (broken API) with the 0.5.0 branch is that support for ActiveRecord 
+has been entirely removed (mostly because the implementation was ugly so far).
+If you use pdf-toolkit and would like activerecord to be included in 1.0.0, 
+please just tell us and we'll add it. If you upgrade from 0.5.0 to 1.0.0.rc1 and 
+something else goes wrong, please report the issue on github.
+
+## Contributors
+
+* Tim Pope is the original author of pdf-toolkit
+* Preston Marshall ported the project to github
+* Bernard Lambeau is the current maintainer
+
+Please report issues on [github](https://github.com/blambeau/pdf-toolkit/issues)
+
+## Licence
+
+pdf-toolkit is released under a MIT licence. See LICENCE.md

data/Rakefile

@@ -1,41 +1,19 @@
-begin
-  require 'rubygems'
-rescue LoadError
-end
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/contrib/sshpublisher'
-require 'rake/contrib/rubyforgepublisher'
-require File.join(File.dirname(__FILE__), 'lib', 'pdf', 'toolkit')
-
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-PKG_NAME      = 'pdf-toolkit'
-PKG_VERSION   = PDF::Toolkit::PDF_TOOLKIT_VERSION
-PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
-# PKG_DESTINATION = ENV["PKG_DESTINATION"] || "../#{PKG_NAME}"
-
-# RELEASE_NAME  = "REL #{PKG_VERSION}"
-
-RUBY_FORGE_PROJECT = PKG_NAME
-RUBY_FORGE_USER    = "tpope"
 
 desc "Default task: test"
 task :default => [ :test ]
 
-
 # Run the unit tests
+require 'rake/testtask'
 Rake::TestTask.new { |t|
-  t.libs << "test"
+  t.libs << "lib" << "test"
   t.test_files = Dir['test/*_test.rb'] + Dir['test/test_*.rb']
   t.verbose = true
 }
 
-
 # Generate the RDoc documentation
-Rake::RDocTask.new { |rdoc|
+require 'rdoc/task'
+RDoc::Task.new { |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.rdoc_files.add('lib')
   rdoc.main     = "PDF::Toolkit"
@@ -43,63 +21,12 @@ Rake::RDocTask.new { |rdoc|
   rdoc.options << '--inline-source'
 }
 
-
 # Create compressed packages
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = PKG_NAME
-  s.summary = 'A wrapper around pdftk to allow PDF metadata manipulation'
-  s.description = 'PDF::Toolkit provides a simple interface for querying and unpdation PDF metadata like the document Author and Title.'
-  s.version = PKG_VERSION
-
-  s.author = 'Tim Pope'
-  s.email = 'ruby@tp0pe.inf0'.gsub(/0/,'o')
-  s.rubyforge_project = RUBY_FORGE_PROJECT
-  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
-
-  s.has_rdoc = true
-  # s.requirements << 'none'
-  s.require_path = 'lib'
-
-  s.add_dependency('activesupport')
-
-  s.files = [ "Rakefile", "README", "setup.rb" ]
-  s.files = s.files + Dir.glob( "lib/**/*.rb" )
-  s.files = s.files + Dir.glob( "test/**/*" ).reject { |item| item.include?( "\.svn" ) }
-end
-
-Rake::GemPackageTask.new(spec) do |p|
+require 'rubygems/package_task'
+spec = eval(File.read("pdf-toolkit.gemspec"), binding, "pdf-toolkit.gemspec")
+Gem::PackageTask.new(spec) do |p|
   p.gem_spec = spec
   p.need_tar = true
   p.need_zip = true
 end
 
-# Publish documentation
-desc "Publish the API documentation"
-task :pdoc => [:rerdoc] do 
-  # Rake::RubyForgePublisher.new(RUBY_FORGE_PROJECT,RUBY_FORGE_USER).upload
-  Rake::SshDirPublisher.new("rubyforge.org", "/var/www/gforge-projects/#{PKG_NAME}", "doc").upload
-end
-
-desc "Publish the release files to RubyForge."
-task :release => [ :package ] do
-  `rubyforge login`
-
-  for ext in %w( gem tgz zip )
-    release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
-    puts release_command
-    system(release_command)
-  end
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |t|
-    t.test_files = Dir['test/*_test.rb'] + Dir['test/test_*.rb']
-    t.verbose = true
-    t.rcov_opts << "--text-report"
-    # t.rcov_opts << "--exclude \\\\A/var/lib/gems"
-    t.rcov_opts << "--exclude '/(active_record|active_support)\\b'"
-  end
-rescue LoadError
-end

data/lib/pdf/toolkit.rb

@@ -1,28 +1,5 @@
-# Copyright (c) 2006 Tim Pope
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# 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.
-
-require 'rubygems' rescue nil
 require 'tempfile'
 require 'forwardable'
-require 'active_support'
 
 # Certain existing libraries have a PDF class; no sense in being unnecessarily
 # incompatible.
@@ -55,8 +32,7 @@ end unless defined? PDF
 #
 # PDF::Toolkit requires +pdftk+, which is available from
 # http://www.accesspdf.com/pdftk.  For full functionality, also install
-# +xpdf+ from http://www.foolabs.com/xpdf.  ActiveSupport (from Ruby on Rails)
-# is also required but this dependency may be removed in the future.
+# +xpdf+ from http://www.foolabs.com/xpdf.
 #
 # == Limitations
 #
@@ -65,12 +41,15 @@ end unless defined? PDF
 #
 # +pdftk+ requires the owner password, even for simply querying the document.
 class PDF::Toolkit
-
-  PDF_TOOLKIT_VERSION = "0.5.0"
   extend Forwardable
-  class Error < ::StandardError #:nodoc:
-  end
-  class ExecutionError < Error #:nodoc:
+
+  VERSION = "1.0.0.rc1"
+
+  # Raised when something fails with the toolkit
+  class Error < ::StandardError; end
+
+  # Raised when an invocation of `pdftk` fails under the cover
+  class ExecutionError < Error
     attr_reader :command, :exit_status
     def initialize(msg = nil, cmd = nil, exit_status = nil)
       super(msg)
@@ -78,139 +57,15 @@ class PDF::Toolkit
       @exit_status = exit_status
     end
   end
-  class FileNotSaved < Error #:nodoc:
-  end
-
-  class <<self
-
-    # Add an accessor for a key.  If the key is omitted, defaults to a
-    # camelized version of the accessor (+foo_bar+ becomes +FooBar+).  The
-    # example below illustrates the defaults.
-    #
-    #   class MyDocument < PDF::Toolkit
-    #     info_accessor :created_at, "CreationDate"
-    #     info_accessor :updated_at, "ModDate"
-    #     info_accessor :author
-    #     [:subject, :title, :keywords, :producer, :creator].each do |key|
-    #       info_accessor key
-    #     end
-    #   end
-    #
-    #   MyDocument.open("document.pdf").created_at
-    def info_accessor(accessor_name, info_key = nil)
-      info_key ||= camelize_key(accessor_name)
-      read_inheritable_attribute(:info_accessors)[accessor_name] = info_key
-      define_method accessor_name do
-        self[info_key]
-      end
-      define_method "#{accessor_name}=" do |value|
-        self[info_key] = value
-      end
-    end
-
-    # Invoke +pdftk+ with the given arguments, plus +dont_ask+.  If :mode or
-    # a block is given, IO::popen is called.  Otherwise, Kernel#system is
-    # used.
-    #
-    #   result = PDF::Toolkit.pdftk(*%w(foo.pdf bar.pdf cat output baz.pdf))
-    #   io = PDF::Toolkit.pdftk("foo.pdf","dump_data","output","-",:mode => 'r')
-    #   PDF::Toolkit.pdftk("foo.pdf","dump_data","output","-") { |io| io.read }
-    def pdftk(*args,&block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      args << "dont_ask"
-      args << options
-      result = call_program(executables[:pdftk],*args,&block)
-      return block_given? ? $?.success? : result
-    end
-
-    # Invoke +pdftotext+.  If +outfile+ is omitted, returns an +IO+ object for
-    # the output.
-    def pdftotext(file,outfile = nil,&block)
-      call_program(executables[:pdftotext],file,
-        outfile||"-",:mode => (outfile ? nil : 'r'),&block)
-    end
-
-    # This method will +require+ and +include+ validations, callbacks, and
-    # timestamping from +ActiveRecord+.  Use at your own risk.
-    def loot_active_record
-      require 'active_support'
-      require 'active_record'
-      # require 'active_record/validations'
-      # require 'active_record/callbacks'
-      # require 'active_record/timestamp'
-
-      unless defined? @@looted_active_record
-        @@looted_active_record = true
-        meta = (class <<self; self; end)
-        alias_method :initialize_ar_hack, :initialize
-        include ActiveRecord::Validations
-        include ActiveRecord::Callbacks
-        include ActiveRecord::Timestamp
-        alias_method :initialize, :initialize_ar_hack
-
-        cattr_accessor :record_timestamps # nil by default
-
-        meta.send(:define_method,:default_timezone) do
-          defined? ActiveRecord::Base ?  ActiveRecord::Base.default_timezone : :local
-        end
-      end
-      self
-    end
 
-    def human_attribute_name(arg) #:nodoc:
-      defined? ActiveRecord::Base ? ActiveRecord::Base.human_attribute_name(arg) : arg.gsub(/_/,' ')
-    end
+  # Raised when a .pdf file cannot be saved
+  class FileNotSaved < Error; end
 
-    private
+  require 'pdf/toolkit/native'
+  extend Native
 
-    def instantiate(*args) #:nodoc:
-      raise NoMethodError, "stub method `instantiate' called for #{self}:#{self.class}"
-    end
-
-    def call_program(*args,&block)
-      old_stream = nil
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      options[:mode] ||= 'r' if block_given?
-      unless options[:silence_stderr] == false
-        old_stream = STDERR.dup
-        STDERR.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
-        STDERR.sync = true
-      end
-      if options[:mode]
-        command = (args.map {|arg| %{"#{arg.gsub('"','\\"')}"}}).join(" ")
-        retval = IO.popen(command,options[:mode],&block)
-        retval
-      else
-        system(*args)
-      end
-    ensure
-      STDERR.reopen(old_stream) if old_stream
-    end
-
-    def camelize_key(key)
-      if key.to_s.respond_to?(:camelize)
-        key.to_s.camelize
-      else
-        key.to_s.gsub(/_+([^_])/) {$1.upcase}.sub(/^./) {|l|l.upcase}
-      end
-    end
-
-  end
-
-  class_inheritable_accessor :executables, :default_permissions, :default_input_password
-  class_inheritable_accessor :default_owner_password, :default_user_password
-  protected                  :default_owner_password=, :default_user_password=
-  # self.pdftk = "pdftk"
-  self.executables = Hash.new {|h,k| k.to_s.dup}
-  write_inheritable_attribute :info_accessors, Hash.new { |h,k|
-    if h.has_key?(k.to_s.to_sym)
-      h[k.to_s.to_sym]
-    elsif k.kind_of?(Symbol)
-      camelize_key(k)
-    else
-      k.dup
-    end
-  }
+  require 'pdf/toolkit/class_methods'
+  extend ClassMethods
 
   info_accessor :created_at, "CreationDate"
   info_accessor :updated_at, "ModDate"
@@ -225,30 +80,29 @@ class PDF::Toolkit
   def self.open(filename,input_password = nil)
     object = new(filename,input_password)
     object.reload
-    object
+    block_given? ? yield(object) : object
   end
 
   # Like +open+, only the attributes are lazily loaded.  Under most
   # circumstances,  +open+ is preferred.
-  def initialize(filename,input_password = nil)
-    @filename = if filename.respond_to?(:to_str)
-                  filename.to_str
-                elsif filename.kind_of?(self.class)
-                  filename.instance_variable_get("@filename")
-                elsif filename.respond_to?(:path)
-                  filename.path
-                else
-                  filename
-                end
+  def initialize(filename, input_password = nil)
+    coercer = [:to_path, :to_str, :path].find{|meth| filename.respond_to? meth}
+    @filename = coercer ? filename.send(coercer) : filename
+
     @input_password = input_password || default_input_password
     @owner_password = default_owner_password
     @user_password  = default_user_password
-    @permissions = default_permissions || []
-    @new_info = {}
-    callback(:after_initialize) if respond_to?(:after_initialize) && respond_to?(:callback)
-    # reload
+    @permissions    = default_permissions || []
+    @new_info       = {}
+
+    run_callbacks_for(:after_initialize)
   end
 
+  def_delegators :"self.class", :default_input_password,
+                                :default_owner_password,
+                                :default_user_password,
+                                :default_permissions
+
   attr_reader :pdf_ids, :permissions
   attr_writer :owner_password, :user_password
 
@@ -256,13 +110,13 @@ class PDF::Toolkit
     read_data unless @pages
     @pages
   end
-
   alias pages page_count
 
   # Path to the file.
   def path
     @new_filename || @filename
   end
+  alias :to_path :path
 
   # Retrieve the file's version as a symbol.
   #
@@ -289,8 +143,6 @@ class PDF::Toolkit
   end
 
   # Like +save+, only raise an exception if the operation fails.
-  #
-  # TODO: ensure no ActiveRecord::RecordInvalid errors make it through.
   def save!
     if save
       self
@@ -313,8 +165,6 @@ class PDF::Toolkit
     @new_filename = filename
     save!
     self
-  rescue ActiveRecord::RecordInvalid
-    raise FileNotSaved
   end
 
   # Invoke +pdftotext+ on the file and return an +IO+ object for reading the
@@ -329,8 +179,6 @@ class PDF::Toolkit
     "#<#{self.class}:#{path}>"
   end
 
-# Enumerable/Hash methods {{{1
-
   # Create a hash from the file's metadata.
   def to_hash
     ensure_loaded
@@ -356,7 +204,6 @@ class PDF::Toolkit
     @info[key.to_s]
   end
 
-
   # Write a metadata attribute.
   #
   #   my_pdf["Author"] = author
@@ -423,27 +270,8 @@ class PDF::Toolkit
     self
   end
 
-# }}}1
-
   protected
 
-=begin
-  def method_missing(method,*args)
-    args_needed = method.to_s.last == "=" ? 1 : 0
-    if args.length != args_needed
-      raise ArgumentError,
-      "wrong number of arguments (#{args.length} for #{args_needed})"
-    end
-    ensure_loaded
-    attribute = lookup_key(method.to_s.chomp("=").to_sym)
-    if method.to_s.last == "="
-      self[attribute] = args.first
-    else
-      self[attribute]
-    end
-  end
-=end
-
   def read_attribute(key)
     self[key]
   end
@@ -460,7 +288,7 @@ class PDF::Toolkit
   end
 
   def lookup_key(key)
-    return self.class.read_inheritable_attribute(:info_accessors)[key]
+    return self.class.info_accessors[key]
   end
 
   def call_pdftk_on_file(*args,&block)
@@ -471,48 +299,8 @@ class PDF::Toolkit
     self.class.send(:pdftk,*args,&block)
   end
 
-  def cast_field(field)
-    case field
-    when /^D:(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)([-+].*)?$/
-      parse_time(field)
-    when /^\d+$/
-      field.to_i
-    else
-      field
-    end
-  end
-
-  def parse_time(string)
-    if string =~ /^D:(\d{4})(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)([-+].*)?$/
-      date = $~[1..6].map {|n|n.to_i}
-      tz = $7
-      time = Time.utc(*date)
-      tz_match = tz.match(/^([+-])(\d{1,2})(?:'(\d\d)')?$/) if tz
-      if tz_match
-        direction, hours, minutes = tz_match[1..3]
-        offset = (hours.to_i*60+minutes.to_i)*60
-        # Go the *opposite* direction
-        time += (offset == "+" ? -offset : offset)
-      end
-      time.getlocal
-    else
-      string
-    end
-  end
-
-  def format_field(field)
-    format_time(field)
-  end
-
-  def format_time(time)
-    if time.kind_of?(Time)
-      string = ("D:%04d"+"%02d"*5) % time.to_a[0..5].reverse
-      string += (time.utc_offset < 0 ? "-" : "+")
-      string += "%02d'%02d'" % [time.utc_offset.abs/3600,(time.utc_offset.abs/60)%60]
-    else
-      time
-    end
-  end
+  require 'pdf/toolkit/coercions'
+  include Coercions
 
   def read_data
     last = nil
@@ -615,21 +403,10 @@ class PDF::Toolkit
   def create_or_update #:nodoc:
     run_callbacks_for(:before_save)
     result = new_record? ? create : update
-    if result
-      # run_callbacks_for(:after_save)
-    end
+    # run_callbacks_for(:after_save) if result
     result
   end
 
-  def respond_to_without_attributes?(method)
-    respond_to?(method)
-  end
-
-  def destroy
-    raise NoMethodError, "stub method `destroy' called for #{self}:#{self.class}"
-    # File.unlink(@filename); self.freeze!
-  end
-
   def cleanup
     if @info
       # Create a new hash on purpose