File: print_options.rb

package info (click to toggle)
ruby-selenium-webdriver 4.38.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,400 kB
  • sloc: ruby: 7,721; javascript: 125; makefile: 6
file content (93 lines) | stat: -rw-r--r-- 3,128 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# frozen_string_literal: true

# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

module Selenium
  module WebDriver
    # Represents options for printing a page.
    class PrintOptions
      DEFAULT_SCALE = 1.0
      DEFAULT_ORIENTATION = 'portrait'
      DEFAULT_PAGE_SIZE = {width: 21.0, height: 29.7}.freeze # A4 size in cm
      DEFAULT_MARGINS = {top: 1.0, bottom: 1.0, left: 1.0, right: 1.0}.freeze

      attr_accessor :orientation, :scale, :background, :page_ranges, :margins

      def initialize
        @orientation = DEFAULT_ORIENTATION
        @scale = DEFAULT_SCALE
        @background = false
        @page_ranges = nil
        @page_size = DEFAULT_PAGE_SIZE
        @margins = DEFAULT_MARGINS
      end

      # Converts the options to a hash format to be used by WebDriver.
      #
      # @return [Hash]
      def to_h
        options = {
          orientation: @orientation,
          scale: @scale,
          background: @background,
          pageRanges: @page_ranges,
          paperWidth: @page_size[:width],
          paperHeight: @page_size[:height],
          marginTop: @margins[:top],
          marginBottom: @margins[:bottom],
          marginLeft: @margins[:left],
          marginRight: @margins[:right]
        }

        options.compact
      end

      # Gets the current page size.
      #
      # @return [Hash] The current page size hash with :width and :height.
      attr_reader :page_size

      # Sets the page size. Can be a predefined symbol or custom size hash.
      #
      # @param [Symbol, Hash] value The predefined size (:letter, :legal, :a4, :tabloid) or a custom hash.
      def page_size=(value)
        predefined_sizes = {
          letter: {width: 21.59, height: 27.94},
          legal: {width: 21.59, height: 35.56},
          a4: {width: 21.0, height: 29.7},
          tabloid: {width: 27.94, height: 43.18}
        }

        case value
        when Symbol
          raise ArgumentError, "Invalid page size: #{value}" unless predefined_sizes.key?(value)

          @page_size = predefined_sizes[value]
        when Hash
          unless value.key?(:width) && value.key?(:height)
            raise ArgumentError, 'Custom page size must include :width and :height'
          end

          @page_size = value
        else
          raise ArgumentError, 'Page size must be a Symbol or a Hash'
        end
      end
    end
  end
end