gridify_pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aa5788c76c75bdb565c4cca84180995eac449b3df985f863ba3f3b4c1dd43da
+  data.tar.gz: f3f8c87877bc1b6247695a912c3e8f58c96a411383c46205a99897070e09c916
+SHA512:
+  metadata.gz: 18cd69f39291031d2ea21dc5937a2677eaeb8be2d2b94b28c18072a909ae77e396349729c4db20e1501f99aa2cc37db5c89f9657e3ac0e9e58950c173d966df4
+  data.tar.gz: f6bf1c0f0890fd552a06dd94be2ba3e7582823937b0709e8962cfc9e899ed9edbe27080f2a0fd15c3ab27901181b57b454528bc02758e4e4dbeb298a885d8c92

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    gridify_pdf (0.1.0)
+      combine_pdf (~> 1.0.0)
+      prawn (~> 2.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bigdecimal (3.1.8)
+    combine_pdf (1.0.26)
+      matrix
+      ruby-rc4 (>= 0.1.5)
+    diff-lcs (1.5.1)
+    matrix (0.4.2)
+    pdf-core (0.10.0)
+    prawn (2.5.0)
+      matrix (~> 0.4)
+      pdf-core (~> 0.10.0)
+      ttfunk (~> 1.8)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    ruby-rc4 (0.1.5)
+    ttfunk (1.8.0)
+      bigdecimal (~> 3.1)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  gridify_pdf!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jonathan Hooper
+
+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,49 @@
+# gridify_pdf
+
+This is a tool that I wrote to lay a grid over PDF files.
+
+I was working on an app that adds text boxes to PDFs using [Prawn](https://github.com/prawnpdf/prawn) and [CombinePDF](https://github.com/boazsegev/combine_pdf). I got frustrated with the guess-and-check method to find the right coordinates.
+
+Given a PDF that looks like this:
+
+![A PDF without a grid overlay](https://raw.githubusercontent.com/jmhooper/gridify_pdf/refs/heads/main/docs/before.png)
+
+It will make this:
+
+![A PDF with a grid overlay](https://raw.githubusercontent.com/jmhooper/gridify_pdf/refs/heads/main/docs/after.png)
+
+## Installation
+
+This can be installed with RubyGems:
+
+```
+gem install gridify_pdf
+```
+
+## CLI
+
+This is primarily intended to be used as a CLI tool
+
+This will read the file at `document.pdf` and output a version with a grid overlay at `gridified_document.pdf`.
+
+```shell
+gridify_pdf document.pdf gridified_document.pdf
+```
+
+You can also have the PDF written to a temporary file and opened in your default PDF viewer:
+
+```shell
+gridify_pdf document.pdf --open
+```
+
+## Usage in code
+
+If, for some reason, you want to use this tool in your own code, that is also possible:
+
+```ruby
+require 'gridify_pdf'
+
+input = File.read('input.pdf')
+result = GridifyPdf::Gridifier.new(input).gridify
+File.write('output.pdf', result)
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/gridify_pdf

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'tempfile'
+
+require_relative '../lib/gridify_pdf'
+
+options = GridifyPdf::Options.build_options_with_defaults
+
+OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+    Usage: gridify_pdf [input_file] [output_file] [options]"
+
+    If no input file is provided input is read from STDIN.
+    If no output file is provide output is written to STDOUT.
+  BANNER
+
+  opts.on('--cell-width=CELL_WIDTH', 'Specify the cell width for the overlay grid') do |cell_width|
+    options.cell_width = cell_width.to_i
+  end
+
+  opts.on('--open', 'Open the overlay PDF once done') do
+    options.open_after_gridification = true
+  end
+
+  opts.on('-h', '--help', 'Print this help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+if ARGV[0]
+  options.input = File.open(ARGV[0], 'r')
+end
+
+if ARGV[1]
+  options.output = File.open(ARGV[1], 'w+')
+elsif options.open_after_gridification
+  require 'securerandom'
+  tmp_file_path = File.join('/tmp', "gridified_pdf_#{SecureRandom.alphanumeric(24)}.pdf")
+  options.output = File.open(tmp_file_path, 'w+')
+end
+
+result = GridifyPdf::Gridifier.new(
+  options.input.read,
+  cell_width: options.cell_width,
+).gridify
+options.output.write(result)
+
+if options.open_after_gridification
+  case RUBY_PLATFORM
+  when /darwin/
+    # macOS
+    system("open", options.output.path)
+  when /linux/
+    # Linux
+    system("xdg-open", options.output.path)
+  when /win32|mingw32|cygwin/
+    # Windows
+    system("start", options.output.path)
+  else
+    raise "Unsupported platform: #{RUBY_PLATFORM}"
+  end
+end
+
+options.input.close unless options.input == STDIN
+options.output.close unless options.output == STDOUT

data/lib/gridify_pdf/gridifier.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GridifyPdf
+  class Gridifier
+    attr_reader :input, :cell_width
+
+    def initialize(input, cell_width: 50)
+      @input = input
+      @cell_width = cell_width
+    end
+
+    def gridify
+      output_pdf = CombinePDF.new
+      parsed_input.pages.each do |input_page|
+        output_pdf << input_page
+      end
+
+      parsed_overlay = CombinePDF.parse(overlay_document.render)
+      parsed_overlay.pages.slice(1..).each_with_index do |overlay_page, index|
+        output_pdf.pages[index] << overlay_page
+      end
+
+      output_pdf.to_pdf
+    end
+
+    private
+
+    def overlay_document
+      @overlay_document ||= Prawn::Document.new(margin: 0).tap do |pdf|
+        parsed_input.pages.each do |input_page|
+          media_box = input_page[:MediaBox]
+          page_width = media_box[2] - media_box[0]
+          page_height = media_box[3] - media_box[1]
+
+          pdf.start_new_page(size: [page_width, page_height])
+
+          (0..(page_height + cell_width)).step(cell_width) do |y|
+            (0..(page_width + cell_width)).step(cell_width) do |x|
+              pdf.dash(1, space: 9)
+              pdf.stroke_rectangle [x, y], cell_width, cell_width
+              pdf.draw_text "(#{x}, #{y})", at: [x + 5, y - 10], size: 5
+            end
+          end
+        end
+      end
+    end
+
+    def parsed_input
+      @parsed_input ||= CombinePDF.parse(input)
+    end
+  end
+end

data/lib/gridify_pdf/options.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GridifyPdf
+  Options = Struct.new(
+    :cell_width,
+    :input,
+    :output,
+    :open_after_gridification,
+    keyword_init: true,
+  ) do
+    def self.build_options_with_defaults(
+      input: STDIN,
+      output: STDOUT,
+      cell_width: 50,
+      open_after_gridification: false
+    )
+      self.new(input:, output:, cell_width:, open_after_gridification:)
+    end
+  end
+end

data/lib/gridify_pdf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GridifyPdf
+  VERSION = "0.1.0"
+end

data/lib/gridify_pdf.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "gridify_pdf/version"
+
+require 'prawn'
+require 'combine_pdf'
+
+require_relative 'gridify_pdf/gridifier'
+require_relative 'gridify_pdf/options'
+
+module GridifyPdf
+end

data/sig/gridify_pdf.rbs

@@ -0,0 +1,4 @@
+module GridifyPdf
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gridify_pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Hooper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: combine_pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
+email:
+- jon9820@gmail.com
+executables:
+- gridify_pdf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/after.png
+- docs/before.png
+- exe/gridify_pdf
+- lib/gridify_pdf.rb
+- lib/gridify_pdf/gridifier.rb
+- lib/gridify_pdf/options.rb
+- lib/gridify_pdf/version.rb
+- sig/gridify_pdf.rbs
+- tmp/.keep
+homepage: https://gihub.com/jmhooper/gridify_pdf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gihub.com/jmhooper/gridify_pdf
+  source_code_uri: https://gihub.com/jmhooper/gridify_pdf
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.5
+signing_key:
+specification_version: 4
+summary: Add gridlines to PDF documents
+test_files: []