pdf_editor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b1b62c38f16c894a3346eb4a497c550164ccc26
+  data.tar.gz: 3645b303f8f571981dc741d8fab15fd1e0747a8c
+SHA512:
+  metadata.gz: 3a5a99102a50b09523bb1af5165c705dd0c6e272b284a5c1494fa70f7d7a4dc0813304d1f889194b2efe65d3a97f4af0db0257052e39e9664609872af9f2310e
+  data.tar.gz: 42ac888243b6808e95617ee0e6e88e87097f5396d20ce54cc86472d4e8a9a981da1fb5aab45702a33c9a5af0d68b64e2ed574c3acddcfb343681ceaa0b7ef72f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'active_pdftk',   git: 'git@github.com:tcocca/active_pdftk.git'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 bradwheel
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,29 @@
+# PdfEditor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pdf_editor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdf_editor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pdf_editor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/pdf_editor.rb

@@ -0,0 +1,17 @@
+require 'pdf_editor/version'
+require 'pdf_editor/mixins/prawn_dsl'
+require 'pdf_editor/mixins/errors'
+require 'pdf_editor/mixins/pdf_runner'
+require 'pdf_editor/mixins/service'
+require 'pdf_editor/title_page'
+require 'pdf_editor/table_of_contents'
+require 'pdf_editor/shuffle'
+require 'pdf_editor/rotate_page'
+require 'pdf_editor/resource'
+require 'pdf_editor/reorder'
+require 'pdf_editor/remove_pages'
+require 'pdf_editor/merge'
+require 'pdf_editor/bundle'
+
+module PdfEditor
+end

data/lib/pdf_editor/bundle.rb

@@ -0,0 +1,77 @@
+require_relative 'title_page'
+require_relative 'table_of_contents'
+require_relative 'merge'
+require_relative 'resource'
+require_relative 'mixins/service'
+
+module PdfEditor
+  class Bundle
+    include PdfEditor::Service
+
+    attr_reader :title, :resources, :with_toc, :with_title_pages
+
+    def post_init
+      @resources         = args.fetch(:resources, [])
+      @ready_for_toc     = []
+      @table_of_contents = nil
+
+      @title             = args.fetch(:title, '')
+      @with_toc          = args.fetch(:with_toc, true)
+      @with_title_pages  = args.fetch(:with_title_pages, true)
+    end 
+
+    def call
+      create_title_pages
+      create_table_of_contents
+      bundle_documents
+    end
+
+    private
+
+    attr_accessor :ready_for_toc, :table_of_contents
+
+    def bundle_documents
+      bundle_resources = ready_for_toc
+      bundle_resources.unshift(table_of_contents) if table_of_contents 
+      PdfEditor::Merge.call({resources: bundle_resources})
+    end
+
+    def create_table_of_contents
+      return if ready_for_toc.empty?
+      return unless with_toc
+
+      self.table_of_contents = PdfEditor::TableOfContents.call({resources: ready_for_toc})
+    end
+
+    def create_title_pages
+      ready_for_toc.clear
+
+      if with_title_pages
+
+        resources.each do |resource|
+          new_resource = merge_resource_with_title_page(resource)
+          ready_for_toc << new_resource
+        end
+
+      else
+        self.ready_for_toc = resources.dup
+      end
+
+      ready_for_toc
+    end
+
+
+    def merge_resource_with_title_page(resource)
+      title_page_resource = create_title_page(resource)
+      PdfEditor::Merge.call({
+        resources: [title_page_resource, resource], 
+        merged_name: title_page_resource.name
+      })
+    end
+
+    def create_title_page(resource)
+      PdfEditor::TitlePage.call({title: resource.name})
+    end
+
+  end
+end

data/lib/pdf_editor/merge.rb

@@ -0,0 +1,47 @@
+require_relative 'resource'
+require_relative 'mixins/service'
+require_relative 'mixins/pdf_runner'
+require_relative 'mixins/errors'
+
+module PdfEditor
+  class Merge
+    include PdfEditor::Service
+    include PdfEditor::PdfRunner
+    include PdfEditor::Errors
+
+    attr_reader :resources, :merged_name
+
+    def post_init
+      @resources   = args.fetch(:resources, [])
+      @merged_name = args.fetch(:merged_name, nil)
+    end
+
+    def call
+      if resources.empty?
+        raise Errors::ResourcesEmptyError, 
+              'There must be at least one resource to merge'
+      end
+      PdfEditor::Resource.new(
+        create_tempfile {run_command},
+        merged_name
+      )
+    end
+
+    private
+
+    def run_command
+      read_from_io do 
+        pdf_runner.cat(format_command)
+      end
+    rescue ::ActivePdftk::CommandError => e 
+      raise InvalidInputError, e.message
+    end
+
+    def format_command
+      resources.map do |resource|
+        {:pdf => resource.path}
+      end
+    end
+
+  end
+end

data/lib/pdf_editor/mixins/errors.rb

@@ -0,0 +1,14 @@
+module PdfEditor
+  module Errors
+
+    InvalidPDFError        = Class.new(StandardError)
+    InvalidInputError      = Class.new(StandardError)
+    PageCountError         = Class.new(StandardError)
+    PageRangeError         = Class.new(StandardError)
+    TitlePageTitleError    = Class.new(StandardError)
+    ResourcesEmptyError    = Class.new(StandardError)
+    PageOrderInvalidError  = Class.new(StandardError)
+    ArgumentMissingError   = Class.new(StandardError)
+    
+  end
+end

data/lib/pdf_editor/mixins/pdf_runner.rb

@@ -0,0 +1,11 @@
+require 'active_pdftk'
+
+module PdfEditor
+  module PdfRunner
+
+    def pdf_runner
+      @pdf_runner ||= ::ActivePdftk::Wrapper.new
+    end
+
+  end
+end

data/lib/pdf_editor/mixins/prawn_dsl.rb

@@ -0,0 +1,31 @@
+require 'prawn'
+
+module PdfEditor
+  module PrawnDSL
+
+    def document
+      @document ||= Prawn::Document.new
+    end
+
+    def update_pdf(&b)
+      instance_eval(&b)
+    end
+
+    def to_pdf
+      document.render
+    end
+
+    def save_to_file(file_name)
+      document.render_file(file_name)
+    end
+
+    def respond_to_missing?(method_sym, include_private=false)
+      document.respond_to_missing?(method_sym, include_private) || super
+    end
+
+    def method_missing(method, *args, &b)
+      document.send(method, *args, &b)
+    end
+
+  end
+end

data/lib/pdf_editor/mixins/service.rb

@@ -0,0 +1,57 @@
+require 'tempfile'
+
+module PdfEditor
+  module Service
+
+    InterfaceNotImplementedError = Class.new(StandardError)
+    MustPassBlockToAsTempfile    = Class.new(StandardError)
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def initialize(args={})
+      @args = args
+      post_init
+    end
+
+    # overwrite to use the args hash
+    def post_init
+    end
+
+    def call
+      raise InterfaceNotImplementedError, 'Service Interface requires call to be defined'
+    end
+
+    private def args
+      @args
+    end
+
+    private def create_tempfile 
+      tempfile = ::Tempfile.open(['', '.pdf'])
+      begin 
+        file_contents = yield tempfile.path
+        tempfile.write(file_contents)
+      ensure
+        tempfile.close
+      end
+      tempfile
+    end
+
+    private def read_from_io
+      io = yield
+      io.rewind
+      return io.read
+    end
+
+    module ClassMethods
+
+      def call(args={})
+        service = new(args)
+        service.call
+      end
+
+    end
+
+  end
+end

data/lib/pdf_editor/remove_pages.rb

@@ -0,0 +1,47 @@
+require_relative 'shuffle'
+
+module PdfEditor
+  class RemovePages < Shuffle
+
+    #
+    # Page order has a unique set of members and
+    # is sorted. This allows pdftk to not burst
+    # the document into single pages where possible.
+    #
+
+    def post_init
+      super
+      @page_order = @page_order.uniq.sort
+    end
+
+    private
+
+    def format_command
+      consecutive_pages = find_consecutives
+      consecutive_pages.map do |sub_arr|
+        {
+          :pdf => resource.path,
+          :start => sub_arr.first,
+          :end => sub_arr.last
+        }
+      end
+    end
+
+    def find_consecutives
+      enum = page_order.to_enum
+      result, consecutives = [], []
+      
+      loop do 
+        consecutives << enum.next 
+        unless enum.peek == consecutives.last.succ
+          result << consecutives
+          consecutives = []
+        end
+      end
+      
+      result << consecutives unless consecutives.empty?
+      result
+    end
+
+  end
+end

data/lib/pdf_editor/reorder.rb

@@ -0,0 +1,19 @@
+require_relative 'shuffle'
+
+module PdfEditor
+  class Reorder < Shuffle
+
+    # 
+    # Page order requires a unique set of members
+    # and is not sorted.
+    #
+
+    def post_init
+      super
+      @page_order = @page_order.uniq
+    end
+
+  end
+
+
+end

data/lib/pdf_editor/resource.rb

@@ -0,0 +1,59 @@
+require 'pdf/reader'
+require_relative 'mixins/errors'
+
+module PdfEditor
+  class Resource
+    include PdfEditor::Errors
+
+    #
+    # Object that contains a tempfile and other pertinent
+    # info about that file, such as it's name and page count. 
+    # All methods are delegated to file that aren't found in
+    # Resource.
+    #
+
+    attr_reader :file, :name
+
+    def initialize(file, name=nil)
+      @file = file
+      @name = name 
+    end
+
+    def read(length=nil)
+      open_file do |f|
+        f.rewind
+        f.read(length)
+      end
+    end
+
+    def open_file
+      begin 
+        file.open if file.closed? 
+        yield file
+      ensure
+        file.close 
+      end
+    end
+
+    def write(contents)
+      file.write(contents)
+    end
+
+    def page_count
+      open_file do |f|
+        ::PDF::Reader.new(f).page_count
+      end
+    rescue PDF::Reader::MalformedPDFError => e 
+      raise Errors::InvalidPDFError, e.message
+    end
+
+    def respond_to_missing?(method_sym, include_private=false)
+      file.respond_to?(method_sym, include_private) || super
+    end
+
+    def method_missing(method, *args, &b)
+      file.send(method, *args, &b)
+    end
+
+  end
+end