ghtml2pdf 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f6922a9478fbccfc04fb8f995314d4916b8a09d
-  data.tar.gz: bd10e27b1cf116ec4d90894109870efe4218c2df
+SHA256:
+  metadata.gz: d8ed90969dd11591a30db9663b9b3de084cca0ca4206e19db2979bdc52866441
+  data.tar.gz: b12829fe5f6dff6132d1a04d43c3ab8bde1820b35238b4104a27c9ec5d0093f4
 SHA512:
-  metadata.gz: 235563288c6b44762ce66943749165a5a452e730dee5ff121f7ab437baac070c090c416d106a6117d639547d5d84a6ce9a55da0284806b163c6f049f2dee9b2a
-  data.tar.gz: 4a2177d0c82a7f6aea373a692375acc719b5bc37a99b526138d184c86fcf25157b55c1360e5e32f1259aac58f96ff403391d3e7be9ee0784b87c0ba6e60b30b1
+  metadata.gz: 5737bba0d02f6dfb85758b8451285109a5f093bec53cabd0bdcaaa06ab300f2cc816d3c95bd6270f600eb970ca812bb3b413d45db07a32ef119dbeb110e469bd
+  data.tar.gz: 76c6ea83c528d5ea9d191cffc93f5836eae568a481346e1bba8566b4c02f2620b23bdc3a5a51eb41d96423e0169f1685b1f8252e7c76407fa6eb72af03e07c6c

data/Changelog.md

@@ -1,4 +1,24 @@
-# Change log
+# Changelog
+
+## 0.4.0 / 2021-08-11
+
+* Target Ruby 2.5 and up
+* Update dependency on GirFFI-Gtk and GirFFI
+* Stop using Headless; This gem now needs an active graphical session to run
+
+## 0.3.1 / 2019-02-13
+
+* Update dependency on GirFFI-Gtk
+
+## 0.3.0 / 2017-03-25
+
+* Update dependency on GirFFI-Gtk
+* Target Ruby 2.3 and up
+
+## 0.2.0 / 2016-02-06
+
+* Set wider margins by default
+* Allow setting all margins from the command line
 
 ## 0.1.1 / 2016-02-06
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Matijs van Zuijlen
+Copyright (c) 2015-2018 Matijs van Zuijlen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -44,12 +44,13 @@ Or install it yourself as:
 
     $ gem install ghtml2pdf
 
-You will also need to install the WebKit2GTK+, the Gtk+ bindings for WebKit2,
-and gobject-introspection.
+You will also need to install WebKit2GTK+, the Gtk+ bindings for WebKit2,
+and GObject Introspection. You should probably also install AT-Spi 2 to
+avoid some annoying warning messages.
 
 On Debian and Ubuntu, this can be accomplished by installing the packages
-`libgirepository1.0-dev`, `gobject-introspection` should be enough to get
-`rake test` working.
+`libgirepository-1.0-1`, `gir1.2-gtk-3.0`, `gir1.2-webkit2-3.0` or
+`gir1.2-webkit2-4.0`, and `at-spi2-core`. You may also need to install ...
 
 ## Usage
 

data/bin/ghtml2pdf

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'ghtml2pdf'
-require 'headless'
+require "ghtml2pdf"
 
-Headless.ly do
-  GHtml2Pdf.run(ARGV)
-end
+GHtml2Pdf.run(ARGV)

data/lib/ghtml2pdf.rb

@@ -1,5 +1,7 @@
-require 'ghtml2pdf/version'
-require 'ghtml2pdf/application'
+# frozen_string_literal: true
+
+require "ghtml2pdf/version"
+require "ghtml2pdf/application"
 
 # Main entry point for GHtml2Pdf.
 module GHtml2Pdf

data/lib/ghtml2pdf/application.rb

@@ -1,83 +1,119 @@
-require 'gir_ffi-gtk3'
-require_relative 'argument_parser'
+# frozen_string_literal: true
 
-GirFFI.setup :WebKit2, '4.0'
+require "gir_ffi-gtk3"
+require "ghtml2pdf/argument_parser"
+require "ghtml2pdf/print_settings"
+
+GirFFI.setup :WebKit2
 
 module GHtml2Pdf
   # Main GHtml2Pdf application. Orchestrates the Gtk+ objects needed to load
   # and print a web page to PDF.
   class Application
-    attr_reader :input, :output
-
     def initialize(argv)
-      argument_parser = ArgumentParser.new(argv)
-      @input = argument_parser.input
-      @output = argument_parser.output
+      @argument_parser = ArgumentParser.new(argv)
+      default_web_context.set_process_model :multiple_secondary_processes
     end
 
     def run
-      web_view.signal_connect 'load-changed' do |_, event, _|
+      setup_signal_handlers
+      load_uri
+      Gtk.main
+      destroy_view
+    end
+
+    private
+
+    attr_reader :argument_parser
+
+    def setup_signal_handlers
+      web_view.signal_connect "load-changed" do |_, event, _|
         case event
         when :finished
           print_operation.print
-          sleep 2
-          Gtk.main_quit
         end
       end
 
-      web_view.load_uri(input_uri)
+      print_operation.signal_connect "finished" do |*_args|
+        Gtk.main_quit
+      end
+    end
 
-      Gtk.main
+    def load_uri
+      web_view.load_uri(input_uri)
+    end
 
+    def destroy_view
       web_view.destroy
     end
 
-    private
+    def top_margin
+      @top_margin ||= argument_parser.top_margin || Unit.new("2cm")
+    end
+
+    def bottom_margin
+      @bottom_margin ||= argument_parser.bottom_margin || Unit.new("3cm")
+    end
+
+    def left_margin
+      @left_margin ||= argument_parser.left_margin || Unit.new("2cm")
+    end
+
+    def right_margin
+      @right_margin ||= argument_parser.right_margin || Unit.new("2cm")
+    end
 
     def print_operation
-      WebKit2::PrintOperation.new(web_view).tap do |operation|
+      @print_operation ||= WebKit2::PrintOperation.new(web_view).tap do |operation|
         operation.page_setup = page_setup
         operation.print_settings = print_settings
       end
     end
 
     def page_setup
-      Gtk::PageSetup.new.tap do |setup|
+      @page_setup ||= Gtk::PageSetup.new.tap do |setup|
         setup.set_paper_size Gtk::PaperSize.new Gtk::PAPER_NAME_A4
+        setup.set_top_margin top_margin_in_mm, :mm
+        setup.set_bottom_margin bottom_margin_in_mm, :mm
+        setup.set_left_margin left_margin_in_mm, :mm
+        setup.set_right_margin right_margin_in_mm, :mm
       end
     end
 
-    def web_context
-      @web_context || WebKit2::WebContext.new.tap do |context|
-        context.set_process_model :multiple_secondary_processes
-      end
+    def top_margin_in_mm
+      top_margin.convert_to("mm").scalar
+    end
+
+    def bottom_margin_in_mm
+      bottom_margin.convert_to("mm").scalar
+    end
+
+    def left_margin_in_mm
+      left_margin.convert_to("mm").scalar
+    end
+
+    def right_margin_in_mm
+      right_margin.convert_to("mm").scalar
+    end
+
+    def default_web_context
+      @default_web_context ||= WebKit2::WebContext.get_default
     end
 
     def web_view
-      @web_view ||= WebKit2::WebView.new_with_context web_context
+      @web_view ||= WebKit2::WebView.new
     end
 
     def print_settings
-      Gtk::PrintSettings.new.tap do |settings|
-        settings.set_number_up 1
-        settings.set_reverse false
-        settings.set_print_pages :all
-        settings.set 'output-uri', output_uri
-        settings.set 'output-file-format', 'pdf'
-        settings.set_collate false
-        settings.set_n_copies 1
-        settings.set_printer 'Print to File'
-        settings.set_page_set :all
-        settings.set_scale 100.0
-      end
+      @print_settings ||= PrintSettings.new.tap { |it| it.output_uri = output_uri }
     end
 
     def output_uri
-      "file://#{File.expand_path(output)}"
+      "file://#{File.expand_path(argument_parser.output)}"
     end
 
     def input_uri
-      "file://#{File.expand_path(input)}"
+      "file://#{File.expand_path(argument_parser.input)}"
     end
   end
 end

data/lib/ghtml2pdf/argument_parser.rb

@@ -1,15 +1,68 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "ruby-units"
+
 module GHtml2Pdf
   # Error class raised for missing arguments
   class MissingArgument < StandardError; end
 
   # Parses the command line arguments
   class ArgumentParser
-    attr_reader :input, :output
+    attr_reader :input, :output, :top_margin, :bottom_margin, :left_margin, :right_margin
 
     def initialize(argv)
+      setup_banner
+      setup_margin_options
+      setup_help_message
+      parser.parse! argv
       @input, @output, = argv
-      raise MissingArgument, 'An input filename is required' unless @input
-      raise MissingArgument, 'An output filename is required' unless @output
+      raise MissingArgument, "An input filename is required" unless @input
+      raise MissingArgument, "An output filename is required" unless @output
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new
+    end
+
+    def setup_banner
+      parser.banner = "Usage: #{parser.program_name} [options] INFILE OUTFILE"
+    end
+
+    def setup_margin_options
+      parser.on("--top-margin MARGIN", "Set top margin") { |val| self.top_margin = val }
+      parser.on("--bottom-margin MARGIN", "Set bottom margin") do |val|
+        self.bottom_margin = val
+      end
+      parser.on("--left-margin MARGIN", "Set left margin") { |val| self.left_margin = val }
+      parser.on("--right-margin MARGIN", "Set right margin") do |val|
+        self.right_margin = val
+      end
+    end
+
+    def setup_help_message
+      parser.on_tail("-h", "--help", "Show this message") do
+        puts parser
+        exit
+      end
+    end
+
+    def top_margin=(val)
+      @top_margin = Unit.new(val)
+    end
+
+    def bottom_margin=(val)
+      @bottom_margin = Unit.new(val)
+    end
+
+    def left_margin=(val)
+      @left_margin = Unit.new(val)
+    end
+
+    def right_margin=(val)
+      @right_margin = Unit.new(val)
     end
   end
 end

data/lib/ghtml2pdf/print_settings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "gir_ffi-gtk3"
+
+module GHtml2Pdf
+  # Specialized PrintSettings class for printing to a file.
+  class PrintSettings < Gtk::PrintSettings
+    def initialize
+      super
+      set_number_up 1
+      set_reverse false
+      set_print_pages :all
+      set "output-file-format", "pdf"
+      set_collate false
+      set_n_copies 1
+      set_printer "Print to File"
+      set_page_set :all
+      set_scale 100.0
+    end
+
+    def output_uri=(uri)
+      set "output-uri", uri
+    end
+  end
+end

data/lib/ghtml2pdf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GHtml2Pdf
-  VERSION = '0.1.1'
+  VERSION = "0.4.0"
 end

metadata

@@ -1,71 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: ghtml2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matijs van Zuijlen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gir_ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: gir_ffi-gtk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
-  name: headless
+  name: ruby-units
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,63 +137,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 1.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 1.18.1
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
-description: "\n    Clean Ruby implemenentation of a HTML to PDF\n    converter based
-  on WebKit, WebKit2GTK+ and GirFFI\n  "
+        version: 2.4.0
+description: Clean Ruby implemenentation of a HTML to PDF converter based on WebKit,
+  WebKit2GTK+ and GirFFI
 email:
 - matijs@matijs.net
 executables:
@@ -152,12 +208,16 @@ files:
 - lib/ghtml2pdf.rb
 - lib/ghtml2pdf/application.rb
 - lib/ghtml2pdf/argument_parser.rb
+- lib/ghtml2pdf/print_settings.rb
 - lib/ghtml2pdf/version.rb
 homepage: https://github.com/mvz/ghtml2pdf
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/mvz/ghtml2pdf
+  source_code_uri: https://github.com/mvz/ghtml2pdf
+  changelog_uri: https://github.com/mvz/ghtml2pdf/blob/master/Changelog.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,16 +225,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: HTML to PDF converter based on WebKit2GTK+
 test_files: []