grover 0.4.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21fdefff2c21b5341c4d824e0fd2b1a497f23636
-  data.tar.gz: 423949075eecb0abd2ba0ac9fa77493fa7131861
+  metadata.gz: 2ec8a1908f15407ef3d24ab28a2e211bee743b06
+  data.tar.gz: 96e00c18f6ebb1835e768807a6d9275aec88a95f
 SHA512:
-  metadata.gz: a5a62083e5deabebf8728033b0519d1ffadc7cd08683a5d1ad85e25fe490d83113d41db34db24bde1f4b89c0c709e0b46e424ee02ca23d96ff82f8fe79911e6d
-  data.tar.gz: 6fad9c43307155729a8425d1553953ae1ce22e75a2a12f7f6d6aa7c755e18339130205b36e9dbe3f379ac0a0e0b3bb1ff1c2e8b63ead6867669b9c64332cd789
+  metadata.gz: 62002773ddebdff4bcf9dcc0bc6a4fde4d68c5922e1ce14c5fb07704f815462fbf04b737a34402de2a240feb79d3eff816eb8d0e2e60ebe04f8b0e0a81259a21
+  data.tar.gz: 7016d579dcba337bf2beb558883ca0fec597e9d1b06f7dedecfd86fe63c6572be82a34cc9926a8dace39ab150f725f0a43c7f37f17ad4ab2bec2c3ccabc9bfee

data/lib/active_support_ext/object/deep_dup.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copied from active support
+# @see active_support/core_ext/object/duplicable.rb
+
+require 'active_support_ext/object/duplicable'
+
+class Object
+  # Returns a deep copy of object if it's duplicable. If it's
+  # not duplicable, returns +self+.
+  #
+  #   object = Object.new
+  #   dup    = object.deep_dup
+  #   dup.instance_variable_set(:@a, 1)
+  #
+  #   object.instance_variable_defined?(:@a) # => false
+  #   dup.instance_variable_defined?(:@a)    # => true
+  def deep_dup
+    duplicable? ? dup : self
+  end
+end
+
+class Array
+  # Returns a deep copy of array.
+  #
+  #   array = [1, [2, 3]]
+  #   dup   = array.deep_dup
+  #   dup[1][2] = 4
+  #
+  #   array[1][2] # => nil
+  #   dup[1][2]   # => 4
+  def deep_dup
+    map(&:deep_dup)
+  end
+end
+
+class Hash
+  # Returns a deep copy of hash.
+  #
+  #   hash = { a: { b: 'b' } }
+  #   dup  = hash.deep_dup
+  #   dup[:a][:c] = 'c'
+  #
+  #   hash[:a][:c] # => nil
+  #   dup[:a][:c]  # => "c"
+  def deep_dup
+    hash = dup
+    each_pair do |key, value|
+      if key.frozen? && key.is_a?(::String)
+        hash[key] = value.deep_dup
+      else
+        hash.delete(key)
+        hash[key.deep_dup] = value.deep_dup
+      end
+    end
+    hash
+  end
+end

data/lib/active_support_ext/object/duplicable.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+# Copied from active support
+# @see active_support/core_ext/object/duplicable.rb
+
+#--
+# Most objects are cloneable, but not all. For example you can't dup methods:
+#
+#   method(:puts).dup # => TypeError: allocator undefined for Method
+#
+# Classes may signal their instances are not duplicable removing +dup+/+clone+
+# or raising exceptions from them. So, to dup an arbitrary object you normally
+# use an optimistic approach and are ready to catch an exception, say:
+#
+#   arbitrary_object.dup rescue object
+#
+# Rails dups objects in a few critical spots where they are not that arbitrary.
+# That rescue is very expensive (like 40 times slower than a predicate), and it
+# is often triggered.
+#
+# That's why we hardcode the following cases and check duplicable? instead of
+# using that rescue idiom.
+#++
+class Object
+  # Can you safely dup this object?
+  #
+  # False for method objects;
+  # true otherwise.
+  def duplicable?
+    true
+  end
+end
+
+class NilClass
+  begin
+    nil.dup
+  rescue TypeError
+    # +nil+ is not duplicable:
+    #
+    #   nil.duplicable? # => false
+    #   nil.dup         # => TypeError: can't dup NilClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class FalseClass
+  begin
+    false.dup
+  rescue TypeError
+    # +false+ is not duplicable:
+    #
+    #   false.duplicable? # => false
+    #   false.dup         # => TypeError: can't dup FalseClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class TrueClass
+  begin
+    true.dup
+  rescue TypeError
+    # +true+ is not duplicable:
+    #
+    #   true.duplicable? # => false
+    #   true.dup         # => TypeError: can't dup TrueClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Symbol
+  begin
+    :symbol.dup # Ruby 2.4.x.
+    'symbol_from_string'.to_sym.dup # Some symbols can't `dup` in Ruby 2.4.0.
+  rescue TypeError
+    # Symbols are not duplicable:
+    #
+    #   :my_symbol.duplicable? # => false
+    #   :my_symbol.dup         # => TypeError: can't dup Symbol
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Numeric
+  begin
+    1.dup
+  rescue TypeError
+    # Numbers are not duplicable:
+    #
+    #  3.duplicable? # => false
+    #  3.dup         # => TypeError: can't dup Integer
+    def duplicable?
+      false
+    end
+  end
+end
+
+require 'bigdecimal'
+class BigDecimal
+  # BigDecimals are duplicable:
+  #
+  #   BigDecimal("1.2").duplicable? # => true
+  #   BigDecimal("1.2").dup         # => #<BigDecimal:...,'0.12E1',18(18)>
+  def duplicable?
+    true
+  end
+end
+
+class Method
+  # Methods are not duplicable:
+  #
+  #  method(:puts).duplicable? # => false
+  #  method(:puts).dup         # => TypeError: allocator undefined for Method
+  def duplicable?
+    false
+  end
+end
+
+class Complex
+  begin
+    Complex(1).dup
+  rescue TypeError
+    # Complexes are not duplicable:
+    #
+    #   Complex(1).duplicable? # => false
+    #   Complex(1).dup         # => TypeError: can't copy Complex
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Rational
+  begin
+    Rational(1).dup
+  rescue TypeError
+    # Rationals are not duplicable:
+    #
+    #   Rational(1).duplicable? # => false
+    #   Rational(1).dup         # => TypeError: can't copy Rational
+    def duplicable?
+      false
+    end
+  end
+end

data/lib/grover.rb

@@ -1,12 +1,14 @@
 require 'grover/version'
 
 require 'grover/utils'
+require 'active_support_ext/object/deep_dup'
+
 require 'grover/html_preprocessor'
 require 'grover/middleware'
 require 'grover/configuration'
 
-require 'schmooze'
 require 'nokogiri'
+require 'schmooze'
 
 #
 # Grover interface for converting HTML to PDF
@@ -58,6 +60,8 @@ class Grover
     <div class='text right'><span class='pageNumber'></span>/<span class='totalPages'></span></div>
   HTML
 
+  attr_reader :front_cover_path, :back_cover_path
+
   #
   # @param [String] url URL of the page to convert
   # @param [Hash] options Optional parameters to pass to PDF processor
@@ -65,8 +69,11 @@ class Grover
   #
   def initialize(url, options = {})
     @url = url
-    @options = Grover.configuration.options.merge options
-    @root_path = @options.delete :root_path
+    @options = combine_options options
+
+    @root_path = @options.delete 'root_path'
+    @front_cover_path = @options.delete 'front_cover_path'
+    @back_cover_path = @options.delete 'back_cover_path'
   end
 
   #
@@ -76,10 +83,30 @@ class Grover
   # @return [String] The resulting PDF data
   #
   def to_pdf(path = nil)
-    result = processor.convert_pdf @url, normalized_options(path)
+    normalized_options = Utils.normalize_object @options
+    normalized_options['path'] = path if path.is_a? ::String
+    result = processor.convert_pdf @url, normalized_options
     result['data'].pack('c*')
   end
 
+  #
+  # Returns whether a front cover (request) path has been specified in the options
+  #
+  # @return [Boolean] Front cover path is configured
+  #
+  def show_front_cover?
+    front_cover_path.is_a?(::String) && front_cover_path.start_with?('/')
+  end
+
+  #
+  # Returns whether a back cover (request) path has been specified in the options
+  #
+  # @return [Boolean] Back cover path is configured
+  #
+  def show_back_cover?
+    back_cover_path.is_a?(::String) && back_cover_path.start_with?('/')
+  end
+
   #
   # Instance inspection
   #
@@ -113,11 +140,16 @@ class Grover
     Processor.new(root_path)
   end
 
-  def base_options
-    options = {}
-    @options.each { |k, v| options[k.to_s] = v }
-    options.merge! meta_options unless url_source?
-    options
+  def combine_options(options)
+    combined = Utils.deep_stringify_keys Grover.configuration.options
+    Utils.deep_merge! combined, Utils.deep_stringify_keys(options)
+    Utils.deep_merge! combined, meta_options unless url_source?
+
+    fix_templates! combined
+    fix_boolean_options! combined
+    fix_numeric_options! combined
+
+    combined
   end
 
   #
@@ -144,17 +176,6 @@ class Grover
     @url.match(/^http/i)
   end
 
-  def normalized_options(path)
-    options = base_options
-
-    fix_templates! options
-    fix_boolean_options! options
-    fix_numeric_options! options
-    options['path'] = path if path
-
-    Utils.normalize_object options
-  end
-
   def fix_templates!(options)
     display_url = options.delete 'display_url'
     return unless display_url
@@ -162,7 +183,7 @@ class Grover
     options['footer_template'] ||= DEFAULT_FOOTER_TEMPLATE
 
     %w[header_template footer_template].each do |key|
-      next unless options[key].is_a? String
+      next unless options[key].is_a? ::String
 
       options[key] = options[key].gsub(DISPLAY_URL_PLACEHOLDER, display_url)
     end

data/lib/grover/middleware.rb

@@ -1,3 +1,5 @@
+require 'combine_pdf'
+
 class Grover
   #
   # Rack middleware for catching PDF requests and returning the upstream HTML as a PDF
@@ -44,11 +46,36 @@ class Grover
     end
 
     def convert_to_pdf(response)
+      grover = create_grover_for_response(response)
+      if grover.show_front_cover? || grover.show_back_cover?
+        add_cover_content grover
+      else
+        grover.to_pdf
+      end
+    end
+
+    def create_grover_for_response(response)
       body = response.respond_to?(:body) ? response.body : response.join
       body = body.join if body.is_a?(Array)
 
       body = HTMLPreprocessor.process body, root_url, protocol
-      Grover.new(body, display_url: request_url).to_pdf
+      Grover.new(body, display_url: request_url)
+    end
+
+    def add_cover_content(grover)
+      pdf = CombinePDF.parse grover.to_pdf
+      pdf >> fetch_cover_pdf(grover.front_cover_path) if grover.show_front_cover?
+      pdf << fetch_cover_pdf(grover.back_cover_path) if grover.show_back_cover?
+      pdf.to_pdf
+    end
+
+    def fetch_cover_pdf(path)
+      temp_env = env.deep_dup
+      temp_env['PATH_INFO'], temp_env['QUERY_STRING'] = path.split '?'
+      _, _, response = @app.call(temp_env)
+      response.close if response.respond_to? :close
+      grover = create_grover_for_response response
+      CombinePDF.parse grover.to_pdf
     end
 
     def update_headers(headers, body)

data/lib/grover/utils.rb

@@ -23,7 +23,8 @@ class Grover
     #
     # Remove minimum spaces from the front of all lines within a string
     #
-    # Based on active_support/core_ext/string/strip.rb
+    # Based on active support
+    # @see active_support/core_ext/string/strip.rb
     #
     def self.strip_heredoc(string, inline: false)
       string = string.gsub(/^#{string.scan(/^[ \t]*(?=\S)/).min}/, ''.freeze)
@@ -44,18 +45,54 @@ class Grover
     end
 
     #
-    # Recursively normalizes hash objects with camelized string keys
+    # Deep transform the keys in an object (Hash/Array)
     #
-    def self.normalize_object(object)
-      if object.is_a? Hash
-        object.each_with_object({}) do |(k, v), acc|
-          acc[normalize_key(k)] = normalize_object(v)
+    # Copied from active support
+    # @see active_support/core_ext/hash/keys.rb
+    #
+    def self.deep_transform_keys_in_object(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys_in_object(value, &block)
         end
+      when Array
+        object.map { |e| deep_transform_keys_in_object(e, &block) }
       else
         object
       end
     end
 
+    #
+    # Deep transform the keys in the hash to strings
+    #
+    def self.deep_stringify_keys(hash)
+      deep_transform_keys_in_object hash, &:to_s
+    end
+
+    #
+    # Deep merge a hash with another hash
+    #
+    # Based on active support
+    # @see active_support/core_ext/hash/deep_merge.rb
+    #
+    def self.deep_merge!(hash, other_hash)
+      hash.merge!(other_hash) do |_, this_val, other_val|
+        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          deep_merge! this_val.dup, other_val
+        else
+          other_val
+        end
+      end
+    end
+
+    #
+    # Recursively normalizes hash objects with camelized string keys
+    #
+    def self.normalize_object(object)
+      deep_transform_keys_in_object(object) { |k| normalize_key(k) }
+    end
+
     #
     # Normalizes hash keys into camelized strings, including up-casing known acronyms
     #

data/lib/grover/version.rb

@@ -1,3 +1,3 @@
 class Grover
-  VERSION = '0.4.4'.freeze
+  VERSION = '0.5.1'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: combine_pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/active_support_ext/object/deep_dup.rb
+- lib/active_support_ext/object/duplicable.rb
 - lib/grover.rb
 - lib/grover/configuration.rb
 - lib/grover/html_preprocessor.rb