Merge pull request #125 from thinreports/make-editable-meta-data

allow any string to be set to the title of the PDF document metadata

Author: hidakatsuya

CHANGELOG.md

@@ -10,6 +10,7 @@ Breaking Changes:
 Enhancements:
 
 * Add Ruby 3.1, 3.2 support
+* Allow any string to be set to the title attribute of the PDF document metadata
 
 Notes:
 

lib/thinreports/basic_report/generator/pdf.rb

@@ -11,11 +11,12 @@ class PDF
 
         # @param [Thinreports::BasicReport::Report::Base] report
         # @param [Hash] security (nil)
-        def initialize(report, security: nil)
+        # @param [String] title (nil)
+        def initialize(report, security: nil, title: nil)
           report.finalize
 
           @report = report.internal
-          title = default_layout ? default_layout.format.report_title : nil
+          title ||= default_layout ? default_layout.format.report_title : nil
 
           @document = Document.new(title: title, security: security)
           @drawers = {}

lib/thinreports/basic_report/report/base.rb

@@ -149,13 +149,15 @@ def layout(id = nil)
 
         # @param [String] filename
         # @param [Hash] security (see http://prawnpdf.org/api-docs/2.0/Prawn/Document/Security.html#encrypt_document-instance_method)
+        # @param [String] title Value of the title attribute of the PDF document metadata.
+        #   if nil, the title of the default layout file is set.
         # @return [String]
         # @example Generate PDF data
         #   report.generate # => "%PDF-1.4...."
         # @example Create a PDF file
         #   report.generate(filename: 'foo.pdf')
-        def generate(filename: nil, security: nil)
-          Thinreports::BasicReport::Generator::PDF.new(self, security: security).generate(filename)
+        def generate(filename: nil, security: nil, title: nil)
+          Thinreports::BasicReport::Generator::PDF.new(self, security: security, title: title).generate(filename)
         end
 
         # @see Thinreports::BasicReport::Core::Shape::Manager::Target#list

test/basic_report/units/report/test_base.rb

@@ -125,7 +125,7 @@ def test_generate
     generator.expects(:generate).with('result.pdf')
 
     Thinreports::BasicReport::Generator::PDF.expects(:new)
-      .with(report, security: { owner_password: 'pass' })
+      .with(report, security: { owner_password: 'pass' }, title: nil)
       .returns(generator)
 
     report.generate(
@@ -134,6 +134,13 @@ def test_generate
     )
   end
 
+  def test_generate_when_title_argument_is_specified
+    report = Report::Base.new layout: @layout_file.path
+    pdf = report.generate(title: 'Custom title')
+
+    assert_equal 'Custom title', PDF::Reader.new(StringIO.new(pdf)).info[:Title]
+  end
+
   def test_page_should_return_the_current_page
     @report.use_layout(@layout_file.path)
     @report.start_new_page