[rb] Add PrintOptions Implementation for Ruby WebDriver (#15158)

Author: yvsvarma

rb/lib/selenium/webdriver/common.rb

@@ -87,6 +87,7 @@
 require 'selenium/webdriver/common/driver_extensions/has_launching'
 require 'selenium/webdriver/common/driver_extensions/has_fedcm_dialog'
 require 'selenium/webdriver/common/keys'
+require 'selenium/webdriver/common/print_options'
 require 'selenium/webdriver/common/profile_helper'
 require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/takes_screenshot'

rb/lib/selenium/webdriver/common/print_options.rb

@@ -0,0 +1,94 @@
+# 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

rb/spec/unit/selenium/webdriver/common/print_options_spec.rb

@@ -0,0 +1,85 @@
+# 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.
+
+
+require File.expand_path('../spec_helper', __dir__)
+require 'selenium/webdriver/common/print_options'
+
+
+module Selenium
+  module WebDriver
+    describe PrintOptions do
+      let(:options) { PrintOptions.new }
+
+      it 'has default values' do
+        expect(options.orientation).to eq('portrait')
+        expect(options.scale).to eq(1.0)
+        expect(options.background).to be(false)
+        expect(options.page_size).to eq({ width: 21.0, height: 29.7 })
+        expect(options.margins).to eq({ top: 1.0, bottom: 1.0, left: 1.0, right: 1.0 })
+      end
+
+      it 'can set custom page size' do
+        custom_size = { width: 25.0, height: 30.0 }
+        options.page_size = custom_size
+        expect(options.page_size).to eq(custom_size)
+      end
+
+      it 'can set predefined page sizes using symbols' do
+        options.page_size = :a4
+        expect(options.page_size).to eq({ width: 21.0, height: 29.7 })
+
+        options.page_size = :legal
+        expect(options.page_size).to eq({ width: 21.59, height: 35.56 })
+
+        options.page_size = :tabloid
+        expect(options.page_size).to eq({ width: 27.94, height: 43.18 })
+
+        options.page_size = :letter
+        expect(options.page_size).to eq({ width: 21.59, height: 27.94 })
+      end
+
+      it 'raises an error for unsupported predefined page size symbols' do
+        expect { options.page_size = :invalid }.to raise_error(ArgumentError, /Invalid page size/)
+      end
+
+      it 'can convert to a hash' do
+        options.scale = 0.5
+        options.background = true
+        options.page_ranges = '1-3'
+        hash = options.to_h
+
+        expect(hash).to eq(
+          {
+            orientation: 'portrait',
+            scale: 0.5,
+            background: true,
+            pageRanges: '1-3',
+            paperWidth: 21.0,
+            paperHeight: 29.7,
+            marginTop: 1.0,
+            marginBottom: 1.0,
+            marginLeft: 1.0,
+            marginRight: 1.0
+          }
+        )
+      end
+    end
+  end
+end