rename background_rgba_color to background_color with RGBA class

Author: Mifrill

README.md

@@ -346,7 +346,7 @@ browser.screenshot(path: "google.jpg") # => 30902
 # Save to Base64 the whole page not only viewport and reduce quality
 browser.screenshot(full: true, quality: 60) # "iVBORw0KGgoAAAANSUhEUgAABAAAAAMACAYAAAC6uhUNAAAAAXNSR0IArs4c6Q...
 # Save with specific background color
-browser.screenshot(background_rgba_color: [0, 0, 0, 0.0]) 
+browser.screenshot(background_color: Ferrum::RGBA.new(0, 0, 0, 0.0)) 
 ```
 
 #### pdf(\*\*options) : `String` | `Integer`

lib/ferrum/page/screenshot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ferrum/rbga"
+
 module Ferrum
   class Page
     module Screenshot
@@ -27,7 +29,7 @@ module Screenshot
       def screenshot(**opts)
         path, encoding = common_options(**opts)
         options = screenshot_options(path, **opts)
-        data = capture_screenshot(options, opts[:full], opts[:background_rgba_color])
+        data = capture_screenshot(options, opts[:full], opts[:background_color])
         return data if encoding == :base64
 
         bin = Base64.decode64(data)
@@ -123,21 +125,9 @@ def screenshot_options(path = nil, format: nil, scale: 1.0, **opts)
           options[:clip].merge!(scale: scale)
         end
 
-        if validate_background_rgba_color(opts[:background_rgba_color])
-          raise ArgumentError, "Specify :background_rgba_color as [R,G,B,A] array"
-        end
-
         options
       end
 
-      def validate_background_rgba_color(option)
-        option && !(
-          option.is_a?(Array) &&
-            option.size == 4 &&
-            option.all? { |value| value.is_a?(Numeric) }
-        )
-      end
-
       def get_bounding_rect(selector)
         rect = evaluate_async(%Q(
           const rect = document
@@ -174,15 +164,16 @@ def maybe_resize_fullscreen(full)
         resize(width: width, height: height) if full
       end
 
-      def with_background_color(background_rgba_color)
-        if background_rgba_color
-          r, g, b, a = background_rgba_color
-          command('Emulation.setDefaultBackgroundColorOverride', color: { r: r, g: g, b: b, a: a })
+      def with_background_color(color)
+        if color
+          raise ArgumentError, "Accept Ferrum::RGBA class only" unless color.is_a?(RGBA)
+
+          command('Emulation.setDefaultBackgroundColorOverride', color: color.to_h)
         end
 
         yield
       ensure
-        command('Emulation.setDefaultBackgroundColorOverride') if background_rgba_color
+        command('Emulation.setDefaultBackgroundColorOverride') if color
       end
     end
   end

spec/screenshot_spec.rb

@@ -3,6 +3,7 @@
 require "image_size"
 require "pdf/reader"
 require "chunky_png"
+require "ferrum/rbga"
 
 module Ferrum
   describe Browser do
@@ -176,44 +177,27 @@ def create_screenshot(**options)
           end
         end
 
-        context 'background_rgba_color option' do
-          shared_examples 'background_rgba_color ArgumentError' do
-            it 'raises ArgumentError with message' do
-              browser.go_to
-              expect {
-                browser.screenshot(path: file, background_rgba_color: background_rgba_color)
-              }.to raise_exception(ArgumentError, 'Specify :background_rgba_color as [R,G,B,A] array')
-            end
-          end
-
-          include_examples 'background_rgba_color ArgumentError' do
-            let(:background_rgba_color) do
-              r, g, b = 0, 0, 0
-              [r, g, b]
-            end
-          end
-
-          include_examples 'background_rgba_color ArgumentError' do
-            let(:background_rgba_color) { '#FFF' }
-          end
-
-          include_examples 'background_rgba_color ArgumentError' do
-            let(:background_rgba_color) { %w[0 0 0 0] }
-          end
-
+        describe 'background_color option' do
           it 'supports screenshotting page with the specific background color' do
             begin
               file = PROJECT_ROOT + "/spec/tmp/screenshot.jpeg"
               browser.go_to
               browser.screenshot(path: file)
               content = File.read(file)
-              browser.screenshot(path: file, background_rgba_color: [0, 0, 0, 0.0])
+              browser.screenshot(path: file, background_color: RGBA.new(0, 0, 0, 0.0))
               content_with_specific_bc = File.read(file)
               expect(content).not_to eq(content_with_specific_bc)
             ensure
               FileUtils.rm_f([file])
             end
           end
+
+          it 'raises ArgumentError with proper message' do
+            browser.go_to
+            expect {
+              browser.screenshot(path: file, background_color: '#FFF')
+            }.to raise_exception(ArgumentError, 'Accept Ferrum::RGBA class only')
+          end
         end
 
         shared_examples "when scale is set" do