origami-docspring 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19f9e88c0a715dfbcb8343816f50e90ec38dc34736798b915414a9e159cf242d
-  data.tar.gz: 31116ae16c58437b48a4f2a9a0e072cd5c17c040183691ae77444aa0e8ee7247
+  metadata.gz: ae3ff49d9ddd3a7ea7b42cfbf3af3c21ee83b98e33616333295498b9ce7e2f32
+  data.tar.gz: '095f51d19f7cf41a277b091d6e9355debd5f8e196559b1becb1341a4e51875d6'
 SHA512:
-  metadata.gz: b829b1b0c184b66307f0553e5760d81389305affafe3c0f75d4836e157bf2af1a063311bb8ef6e71c9cc77bcb4948f6210001b567f27cceba88f7cb7db0ee64d
-  data.tar.gz: 14406599d653682d4b584297296ed625de80ea415e8655d560a499a58c9404a4f2fd0c227ab68843bf592b1b5c4c13a01605045c3566b4f401270bb10063080e
+  metadata.gz: 02f1753212e4683f000ab1233a568c34e05a20ef7710169c39b016d2fbbb8d4b9fe6e340dff9c42aa9870fe533cac7e0e135ef2578781955d429554f60c33c56
+  data.tar.gz: 3add5450605ad469e08e8dda66302740c68697fb657652b17bce747e77aa6ee98e5126f5e9847986fd5c899ef03879d8c7e512fe52a6ef5e417cebec21825bb4

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+2.3.0 (2025-03-25)
+-----
+* Updated to support Ruby 3.2, 3.3, and 3.4
+* Migrated from Travis CI to GitHub Actions
+* Added missing dependencies (rexml, matrix)
+* Fixed issues with frozen string literals
+* Added pure Ruby RC4 implementation for compatibility with OpenSSL security levels
+* Improved IO handling in tests
+* Fixed various RuboCop warnings and updated code style
+
+2.2.0 (2025-03-25)
+-----
+* Bumped version to 2.2.0
+* Fixed Ruby 2.7 keyword arguments warnings
+* Renamed gem to origami-docspring
+* Fixed bug with hybrid xrefs
+* Updated pdfmetadata to output JSON
+
 2.1.0
 -----
 * Moved pdfwalker to a separate gem

data/examples/attachments/attachment.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -15,13 +16,12 @@ pdf = PDF.new
 
 # Embedding the file into the PDF.
 pdf.attach_file(DATA,
-    name: "README.txt",
-    filter: :ASCIIHexDecode
-)
+  name: "README.txt",
+  filter: :ASCIIHexDecode)
 
 contents = ContentStream.new
 contents.write "File attachment sample",
-    x: 150, y: 750, rendering: Text::Rendering::FILL, size: 30
+  x: 150, y: 750, rendering: Text::Rendering::FILL, size: 30
 
 pdf.append_page Page.new.setContents(contents)
 
@@ -29,7 +29,6 @@ pdf.onDocumentOpen Action::JavaScript <<JS
     this.exportDataObject({cName:"README.txt", nLaunch:2});
 JS
 
-
 pdf.save(OUTPUT_FILE)
 
 puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/attachments/nested_document.rb

@@ -1,17 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, '../../lib')
-    require 'origami'
+  $: << File.join(__dir__, '../../lib')
+  require 'origami'
 end
 include Origami
 
 require 'stringio'
 
 OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
-EMBEDDED_NAME = "#{('a'..'z').to_a.sample(8).join}.pdf"
+EMBEDDED_NAME = "#{("a".."z").to_a.sample(8).join}.pdf"
 
 #
 # Creates the nested document.
@@ -19,7 +20,7 @@ EMBEDDED_NAME = "#{('a'..'z').to_a.sample(8).join}.pdf"
 #
 output_str = StringIO.new
 PDF.write(output_str) do |pdf|
-    pdf.onDocumentOpen Action::JavaScript "app.alert('Hello world!');" 
+  pdf.onDocumentOpen Action::JavaScript "app.alert('Hello world!');"
 end
 
 output_str.rewind

data/examples/encryption/encryption.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -19,7 +20,7 @@ pdf = PDF.new.encrypt(cipher: 'aes', key_size: 256)
 
 contents = ContentStream.new
 contents.write "Encrypted document sample",
-    x: 100, y: 750, rendering: Text::Rendering::STROKE, size: 30
+  x: 100, y: 750, rendering: Text::Rendering::STROKE, size: 30
 
 pdf.append_page Page.new.setContents(contents)
 

data/examples/events/events.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -16,9 +17,9 @@ page = Page.new
 
 contents = ContentStream.new
 contents.write "Pass your mouse over the square",
-    x: 180, y: 750, size: 15
+  x: 180, y: 750, size: 15
 
-page.setContents( contents )
+page.setContents(contents)
 
 onpageopen = Action::JavaScript "app.alert('Page Opened');"
 onpageclose = Action::JavaScript "app.alert('Page Closed');"
@@ -45,7 +46,7 @@ rect_coord = Rectangle[llx: 270, lly: 700, urx: 330, ury: 640]
 # Just draw a yellow rectangle.
 rect = Annotation::Square.new
 rect.Rect = rect_coord
-rect.IC = [ 255, 255, 0 ]
+rect.IC = [255, 255, 0]
 
 # Creates a new annotation which will catch mouse actions.
 annot = Annotation::Screen.new

data/examples/flash/flash.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -23,13 +24,13 @@ swf = pdf.attach_file(SWF_PATH)
 
 # Creating a Flash annotation on the page.
 pdf.append_page do |page|
-    annot = page.add_flash_application(swf,
-                                       windowed: true,
-                                       navigation_pane: true,
-                                       toolbar: true)
+  annot = page.add_flash_application(swf,
+    windowed: true,
+    navigation_pane: true,
+    toolbar: true)
 
-    # Setting the player position on the page.
-    annot.Rect = Rectangle.new [204, 573, 403, 718]
+  # Setting the player position on the page.
+  annot.Rect = Rectangle.new [204, 573, 403, 718]
 end
 
 pdf.save(OUTPUT_FILE)

data/examples/forms/javascript.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -21,26 +22,26 @@ pdf = PDF.new.append_page(page = Page.new)
 contents = ContentStream.new.setFilter(:FlateDecode)
 
 contents.write "Write your JavaScript below and run it",
-    x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
-    fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
+  x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
+  fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
 
 contents.write "You need at least Acrobat Reader 8 to use this document.",
-    x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
+  x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
 
 contents.write "\nGenerated with Origami #{Origami::VERSION}.",
-    color: Graphics::Color::RGB.new(0, 0, 255)
+  color: Graphics::Color::RGB.new(0, 0, 255)
 
 contents.draw_rectangle(45, 35, 320, 60,
-                        line_width: 2.0, dash: Graphics::DashPattern.new([3]),
-                        fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
+  line_width: 2.0, dash: Graphics::DashPattern.new([3]),
+  fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
 
 page.Contents = contents
 
 ml = Template::MultiLineEdit.new('scriptedit', x: 50, y: 280, width: 500, height: 400)
-ml.V = <<JS
-console.show();
-console.println('Script entry point');
-app.alert("Hello");
+ml.V = <<~JS
+  console.show();
+  console.println('Script entry point');
+  app.alert("Hello");
 JS
 
 button = Template::Button.new("Run!", x: 490, y: 240, width: 60, height: 30)

data/examples/forms/xfa.rb

@@ -1,10 +1,11 @@
-#!/usr/bin/ruby 
+#!/usr/bin/ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -20,62 +21,62 @@ OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
 # XDP Packet holding the Form.
 #
 class SampleXDP < XDP::Package
-    def initialize(script = "")
-        super()
-
-        self.root.add_element(create_config_packet)
-        self.root.add_element(create_template_packet(script))
-        self.root.add_element(create_datasets_packet)
-    end
-
-    def create_config_packet
-        config = XDP::Packet::Config.new
-
-        present = config.add_element(XFA::Element.new("present"))
-        pdf = present.add_element(XFA::Element.new("pdf"))
-        interactive = pdf.add_element(XFA::Element.new("interactive"))
-        interactive.text = 1
-
-        config
-    end
-
-    def create_template_packet(script)
-        template = XDP::Packet::Template.new
-
-        form1 = template.add_subform(layout: 'tb', name: 'form1')
-        form1.add_pageSet
-        form1.add_event(activity: 'initialize', name: 'event__ready')
-             .add_script(contentType: 'application/x-formcalc')
-             .text = script
-
-        subform = form1.add_subform
-
-        button = subform.add_field(name: 'Button1')
-        button.add_ui.add_button(highlight: 'inverted')
-        btncaption = button.add_caption
-        btncaption.add_value.add_text.text = "Send!"
-        btncaption.add_para(vAlign: 'middle', hAlign: 'center')
-        button.add_bind(match: 'none')
-        button.add_event(activity: 'click', name: 'event__click')
-              .add_script(contentType: 'application/x-formcalc')
-              .text = script
-
-        txtfield = subform.add_field(name: 'TextField1')
-        txtfield.add_ui.add_textEdit.add_border.add_edge(stroke: 'lowered')
-
-        template
-    end
-
-    def create_datasets_packet
-        datasets = XDP::Packet::Datasets.new
-        data = datasets.add_element(XDP::Packet::Datasets::Data.new)
-
-        data.add_element(XFA::Element.new('form1'))
-            .add_element(XFA::Element.new('TextField1'))
-            .text = '$host.messageBox("Hello from FormCalc!")'
-
-        datasets
-    end
+  def initialize(script = "")
+    super()
+
+    root.add_element(create_config_packet)
+    root.add_element(create_template_packet(script))
+    root.add_element(create_datasets_packet)
+  end
+
+  def create_config_packet
+    config = XDP::Packet::Config.new
+
+    present = config.add_element(XFA::Element.new("present"))
+    pdf = present.add_element(XFA::Element.new("pdf"))
+    interactive = pdf.add_element(XFA::Element.new("interactive"))
+    interactive.text = 1
+
+    config
+  end
+
+  def create_template_packet(script)
+    template = XDP::Packet::Template.new
+
+    form1 = template.add_subform(layout: 'tb', name: 'form1')
+    form1.add_pageSet
+    form1.add_event(activity: 'initialize', name: 'event__ready')
+      .add_script(contentType: 'application/x-formcalc')
+      .text = script
+
+    subform = form1.add_subform
+
+    button = subform.add_field(name: 'Button1')
+    button.add_ui.add_button(highlight: 'inverted')
+    btncaption = button.add_caption
+    btncaption.add_value.add_text.text = "Send!"
+    btncaption.add_para(vAlign: 'middle', hAlign: 'center')
+    button.add_bind(match: 'none')
+    button.add_event(activity: 'click', name: 'event__click')
+      .add_script(contentType: 'application/x-formcalc')
+      .text = script
+
+    txtfield = subform.add_field(name: 'TextField1')
+    txtfield.add_ui.add_textEdit.add_border.add_edge(stroke: 'lowered')
+
+    template
+  end
+
+  def create_datasets_packet
+    datasets = XDP::Packet::Datasets.new
+    data = datasets.add_element(XDP::Packet::Datasets::Data.new)
+
+    data.add_element(XFA::Element.new('form1'))
+      .add_element(XFA::Element.new('TextField1'))
+      .text = '$host.messageBox("Hello from FormCalc!")'
+
+    datasets
+  end
 end
 
 pdf = PDF.new.append_page(page = Page.new)
@@ -83,18 +84,18 @@ pdf = PDF.new.append_page(page = Page.new)
 contents = ContentStream.new.setFilter(:FlateDecode)
 
 contents.write "Write your FormCalc below and run it",
-    x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
-    fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
+  x: 100, y: 750, size: 24, rendering: Text::Rendering::FILL,
+  fill_color: Graphics::Color::RGB.new(0xFF, 0x80, 0x80)
 
 contents.write "You need at least Acrobat Reader 8 to use this document.",
-    x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
+  x: 50, y: 80, size: 12, rendering: Text::Rendering::FILL
 
 contents.write "\nGenerated with Origami #{Origami::VERSION}.",
-    color: Graphics::Color::RGB.new(0, 0, 255)
+  color: Graphics::Color::RGB.new(0, 0, 255)
 
 contents.draw_rectangle(45, 35, 320, 60,
-                        line_width: 2.0, dash: Graphics::DashPattern.new([3]),
-                        fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
+  line_width: 2.0, dash: Graphics::DashPattern.new([3]),
+  fill: false, stroke: true, stroke_color: Graphics::Color::GrayScale.new(0.7))
 
 page.Contents = contents
 

data/examples/javascript/hello_world.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "/../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "/../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -16,7 +17,7 @@ OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
 
 # Creating a new file
 PDF.new
-   .onDocumentOpen(Action::JavaScript 'app.alert("Hello world");')
-   .save(OUTPUT_FILE)
+  .onDocumentOpen(Action::JavaScript('app.alert("Hello world");'))
+  .save(OUTPUT_FILE)
 
 puts "PDF file saved as #{OUTPUT_FILE}."

data/examples/javascript/js_emulation.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "/../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "/../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -14,40 +15,39 @@ include Origami
 
 if defined?(PDF::JavaScript::Engine)
 
-    # Creating a new file
-    pdf = PDF.new
+  # Creating a new file
+  pdf = PDF.new
 
-    # Embedding the file into the PDF.
-    pdf.attach_file(DATA,
-        name: "README.txt",
-        filter: :ASCIIHexDecode
-    )
+  # Embedding the file into the PDF.
+  pdf.attach_file(DATA,
+    name: "README.txt",
+    filter: :ASCIIHexDecode)
 
-    # Example of JS payload
-    pdf.onDocumentOpen Action::JavaScript <<-JS
+  # Example of JS payload
+  pdf.onDocumentOpen Action::JavaScript <<-JS
         if ( app.viewerVersion == 8 )
           eval("this.exportDataObject({cName:'README.txt', nLaunch:2});");
         this.closeDoc();
-    JS
+  JS
 
-    # Tweaking the engine options
-    pdf.js_engine.options[:log_method_calls] = true
-    pdf.js_engine.options[:viewerVersion] = 10
+  # Tweaking the engine options
+  pdf.js_engine.options[:log_method_calls] = true
+  pdf.js_engine.options[:viewerVersion] = 10
 
-    # Hooking eval()
-    pdf.js_engine.hook 'eval' do |eval, expr|
-        puts "Hook: eval(#{expr.inspect})"
-        eval.call(expr) # calling the real eval method
-    end
+  # Hooking eval()
+  pdf.js_engine.hook 'eval' do |eval, expr|
+    puts "Hook: eval(#{expr.inspect})"
+    eval.call(expr) # calling the real eval method
+  end
 
-    # Example of inline JS evaluation
-    pdf.eval_js 'console.println(util.stringFromStream(this.getDataObjectContents("README.txt")))'
+  # Example of inline JS evaluation
+  pdf.eval_js 'console.println(util.stringFromStream(this.getDataObjectContents("README.txt")))'
 
-    # Executes the string as a JS script
-    pdf.Catalog.OpenAction[:JS].eval_js
+  # Executes the string as a JS script
+  pdf.Catalog.OpenAction[:JS].eval_js
 
 else
-    abort "JavaScript support not found. You need to install therubyracer gem."
+  abort "JavaScript support not found. You need to install therubyracer gem."
 end
 
 __END__

data/examples/loop/goto.rb

@@ -1,30 +1,31 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
-OUTPUT_FILE = "#{File.basename(__FILE__, '.rb')}.pdf"
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
 
 pdf = PDF.new
 
 50.times do |n|
-    pdf.append_page do |page|
-        contents = ContentStream.new
-        contents.write "page #{n+1}",
-            x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
+  pdf.append_page do |page|
+    contents = ContentStream.new
+    contents.write "page #{n + 1}",
+      x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
 
-        page.Contents = contents
-    end
+    page.Contents = contents
+  end
 end
 
 pages = pdf.pages
 pages.each_with_index do |page, index|
-    page.onOpen Action::GoTo Destination::GlobalFit[pages[(index + 1) % pages.size]]
+  page.onOpen Action::GoTo Destination::GlobalFit[pages[(index + 1) % pages.size]]
 end
 
 pdf.save(OUTPUT_FILE)

data/examples/loop/named.rb

@@ -1,31 +1,32 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
-OUTPUT_FILE = "#{File.basename(__FILE__, '.rb')}.pdf"
+OUTPUT_FILE = "#{File.basename(__FILE__, ".rb")}.pdf"
 
 pdf = PDF.new
 
 50.times do |n|
-    pdf.append_page do |page|
-        contents = ContentStream.new
-        contents.write "page #{n+1}",
-            x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
-
-        page.Contents = contents
-
-        if n != 49
-            page.onOpen Action::Named::NEXT_PAGE
-        else
-            page.onOpen Action::Named::FIRST_PAGE
-        end
+  pdf.append_page do |page|
+    contents = ContentStream.new
+    contents.write "page #{n + 1}",
+      x: 250, y: 450, rendering: Text::Rendering::FILL, size: 30
+
+    page.Contents = contents
+
+    if n != 49
+      page.onOpen Action::Named::NEXT_PAGE
+    else
+      page.onOpen Action::Named::FIRST_PAGE
     end
+  end
 end
 
 pdf.save(OUTPUT_FILE)

data/examples/signature/signature.rb

@@ -1,12 +1,13 @@
 #!/usr/bin/ruby
+# frozen_string_literal: true
 
 require 'openssl'
 
 begin
-    require 'origami'
+  require 'origami'
 rescue LoadError
-    $: << File.join(__dir__, "../../lib")
-    require 'origami'
+  $: << File.join(__dir__, "../../lib")
+  require 'origami'
 end
 include Origami
 
@@ -34,12 +35,12 @@ cert.add_extension extension_factory.create_extension('keyUsage', 'digitalSignat
 cert.add_extension extension_factory.create_extension('subjectKeyIdentifier', 'hash')
 
 cert.issuer = name
-cert.sign key, OpenSSL::Digest::SHA256.new
+cert.sign key, OpenSSL::Digest.new('SHA256')
 
 # Create the PDF contents
 contents = ContentStream.new.setFilter(:FlateDecode)
 contents.write OUTPUT_FILE,
-    x: 350, y: 750, rendering: Text::Rendering::STROKE, size: 30
+  x: 350, y: 750, rendering: Text::Rendering::STROKE, size: 30
 
 pdf = PDF.new
 page = Page.new.setContents(contents)
@@ -52,12 +53,11 @@ page.add_annotation(sig_annot)
 
 # Sign the PDF with the specified keys
 pdf.sign(cert, key,
-    method: 'adbe.pkcs7.detached',
-    annotation: sig_annot,
-    location: "France",
-    contact: "gdelugre@localhost",
-    reason: "Signature sample"
-)
+  method: 'adbe.pkcs7.detached',
+  annotation: sig_annot,
+  location: "France",
+  contact: "gdelugre@localhost",
+  reason: "Signature sample")
 
 # Save the resulting file
 pdf.save(OUTPUT_FILE)