chunky_png 1.3.8 → 1.4.0

data/lib/chunky_png/canvas/masking.rb

@@ -1,13 +1,13 @@
+# frozen-string-literal: true
+
 module ChunkyPNG
   class Canvas
-    
     # The ChunkyPNG::Canvas::Masking module defines methods to perform masking
     # and theming operations on a {ChunkyPNG::Canvas}. The module is included into the Canvas class so all
     # these methods are available on every canvas.
     #
     # @see ChunkyPNG::Canvas
     module Masking
-
       # Creates a new image, based on the current image but with a new theme color.
       #
       # This method will replace one color in an image with another image. This is done by
@@ -21,8 +21,8 @@ module ChunkyPNG
       # @param [Integer] old_theme_color The original theme color in this image.
       # @param [Integer] new_theme_color The color to replace the old theme color with.
       # @param [Integer] bg_color The background color on which the theme colored pixels are placed.
-      # @param [Integer] tolerance The tolerance level to use when extracting the mask image. Five is 
-      #    the default; increase this if the masked image does not extract all the required pixels, 
+      # @param [Integer] tolerance The tolerance level to use when extracting the mask image. Five is
+      #    the default; increase this if the masked image does not extract all the required pixels,
       #    decrease it if too many pixels get extracted.
       # @return [ChunkyPNG::Canvas] Returns itself, but with the theme colored pixels changed.
       # @see #change_theme_color!
@@ -30,9 +30,9 @@ module ChunkyPNG
       def change_theme_color!(old_theme_color, new_theme_color, bg_color = ChunkyPNG::Color::WHITE, tolerance = 5)
         base, mask = extract_mask(old_theme_color, bg_color, tolerance)
         mask.change_mask_color!(new_theme_color)
-        self.replace!(base.compose!(mask))
+        replace!(base.compose!(mask))
       end
-      
+
       # Creates a base image and a mask image from an original image that has a particular theme color.
       # This can be used to easily change a theme color in an image.
       #
@@ -40,16 +40,16 @@ module ChunkyPNG
       # these in a mask image. All the other pixels will be stored in a base image. Both images will be
       # of the exact same size as the original image. The original image will be left untouched.
       #
-      # The color of the mask image can be changed with {#change_mask_color!}. This new mask image can 
-      # then be composed upon the base image to create an image with a new theme color. A call to 
+      # The color of the mask image can be changed with {#change_mask_color!}. This new mask image can
+      # then be composed upon the base image to create an image with a new theme color. A call to
       # {#change_theme_color!} will perform this in one go.
       #
       # @param [Integer] mask_color The current theme color.
       # @param [Integer] bg_color The background color on which the theme colored pixels are applied.
-      # @param [Integer] tolerance The tolerance level to use when extracting the mask image. Five is 
-      #    the default; increase this if the masked image does not extract all the required pixels, 
+      # @param [Integer] tolerance The tolerance level to use when extracting the mask image. Five is
+      #    the default; increase this if the masked image does not extract all the required pixels,
       #    decrease it if too many pixels get extracted.
-      # @return [Array<ChunkyPNG::Canvas, ChunkyPNG::Canvas>] An array with the base canvas and the mask 
+      # @return [Array<ChunkyPNG::Canvas, ChunkyPNG::Canvas>] An array with the base canvas and the mask
       #    canvas as elements.
       # @see #change_theme_color!
       # @see #change_mask_color!
@@ -66,10 +66,10 @@ module ChunkyPNG
             base_pixels << pixel
           end
         end
-        
-        [ self.class.new(width, height, base_pixels), self.class.new(width, height, mask_pixels) ]
+
+        [self.class.new(width, height, base_pixels), self.class.new(width, height, mask_pixels)]
       end
-      
+
       # Changes the color of a mask image.
       #
       # This method works on a canvas extracted out of another image using the {#extract_mask} method.

data/lib/chunky_png/canvas/operations.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module ChunkyPNG
   class Canvas
     # The ChunkyPNG::Canvas::Operations module defines methods to perform
@@ -15,8 +17,8 @@ module ChunkyPNG
       # the current instance intact, use {#grayscale} instead.
       #
       # @return [ChunkyPNG::Canvas] Returns itself, converted to grayscale.
-      # @see {#grayscale}
-      # @see {ChunkyPNG::Color#to_grayscale}
+      # @see #grayscale
+      # @see ChunkyPNG::Color#to_grayscale
       def grayscale!
         pixels.map! { |pixel| ChunkyPNG::Color.to_grayscale(pixel) }
         self
@@ -29,8 +31,8 @@ module ChunkyPNG
       #
       # @return [ChunkyPNG::Canvas] A copy of the canvas, converted to
       #   grayscale.
-      # @see {#grayscale!}
-      # @see {ChunkyPNG::Color#to_grayscale}
+      # @see #grayscale!
+      # @see ChunkyPNG::Color#to_grayscale
       def grayscale
         dup.grayscale!
       end
@@ -56,11 +58,14 @@ module ChunkyPNG
 
         for y in 0...other.height do
           for x in 0...other.width do
-            set_pixel(x + offset_x,
-                      y + offset_y,
-                      ChunkyPNG::Color.compose(other.get_pixel(x, y),
-                                               get_pixel(x + offset_x,
-                                                         y + offset_y)))
+            set_pixel(
+              x + offset_x,
+              y + offset_y,
+              ChunkyPNG::Color.compose(
+                other.get_pixel(x, y),
+                get_pixel(x + offset_x, y + offset_y)
+              )
+            )
           end
         end
         self
@@ -169,17 +174,16 @@ module ChunkyPNG
       #   coordinates are bigger then the original image.
       def crop!(x, y, crop_width, crop_height)
         if crop_width + x > width
-          raise ChunkyPNG::OutOfBounds, 'Original image width is too small!'
+          raise ChunkyPNG::OutOfBounds, "Original image width is too small!"
         end
         if crop_height + y > height
-          raise ChunkyPNG::OutOfBounds, 'Original image height is too small!'
+          raise ChunkyPNG::OutOfBounds, "Original image height is too small!"
         end
 
         if crop_width == width && x == 0
           # We only need to crop off the top and/or bottom, so we can take a
           # shortcut.
-          replace_canvas!(crop_width, crop_height,
-                          pixels.slice(y * width, width * crop_height))
+          replace_canvas!(crop_width, crop_height, pixels.slice(y * width, width * crop_height))
         else
           new_pixels = []
           for cy in 0...crop_height do
@@ -221,8 +225,8 @@ module ChunkyPNG
         self
       end
 
-      alias_method :flip!, :flip_horizontally!
-      alias_method :flip,  :flip_horizontally
+      alias flip! flip_horizontally!
+      alias flip flip_horizontally
 
       # Flips the image vertically, leaving the original intact.
       #
@@ -253,8 +257,8 @@ module ChunkyPNG
         self
       end
 
-      alias_method :mirror!, :flip_vertically!
-      alias_method :mirror,  :flip_vertically
+      alias mirror! flip_vertically!
+      alias mirror flip_vertically
 
       # Returns a new canvas instance that is rotated 90 degrees clockwise.
       #
@@ -278,8 +282,8 @@ module ChunkyPNG
         replace_canvas!(height, width, new_pixels)
       end
 
-      alias_method :rotate_clockwise,  :rotate_right
-      alias_method :rotate_clockwise!, :rotate_right!
+      alias rotate_clockwise rotate_right
+      alias rotate_clockwise! rotate_right!
 
       # Returns an image that is rotated 90 degrees counter-clockwise.
       #
@@ -305,8 +309,8 @@ module ChunkyPNG
         replace_canvas!(height, width, new_pixels)
       end
 
-      alias_method :rotate_counter_clockwise,  :rotate_left
-      alias_method :rotate_counter_clockwise!, :rotate_left!
+      alias rotate_counter_clockwise rotate_left
+      alias rotate_counter_clockwise! rotate_left!
 
       # Rotates the image 180 degrees.
       #
@@ -389,11 +393,11 @@ module ChunkyPNG
       #   applied.
       # @raise [ChunkyPNG::OutOfBounds] when the other image doesn't fit.
       def check_size_constraints!(other, offset_x, offset_y)
-        if width  < other.width  + offset_x
-          raise ChunkyPNG::OutOfBounds, 'Background image width is too small!'
+        if width < other.width + offset_x
+          raise ChunkyPNG::OutOfBounds, "Background image width is too small!"
         end
         if height < other.height + offset_y
-          raise ChunkyPNG::OutOfBounds, 'Background image height is too small!'
+          raise ChunkyPNG::OutOfBounds, "Background image height is too small!"
         end
       end
     end

data/lib/chunky_png/canvas/png_decoding.rb

@@ -1,6 +1,7 @@
+# frozen-string-literal: true
+
 module ChunkyPNG
   class Canvas
-
     # The PNGDecoding contains methods for decoding PNG datastreams to create a
     # Canvas object. The datastream can be provided as filename, string or IO
     # stream.
@@ -26,9 +27,8 @@ module ChunkyPNG
     # combined to form the original images.
     #
     # @see ChunkyPNG::Canvas::PNGEncoding
-    # @see http://www.w3.org/TR/PNG/ The W3C PNG format specification
+    # @see https://www.w3.org/TR/PNG/ The W3C PNG format specification
     module PNGDecoding
-
       # Decodes a Canvas from a PNG encoded string.
       # @param [String] str The string to read from.
       # @return [ChunkyPNG::Canvas] The canvas decoded from the PNG encoded string.
@@ -36,7 +36,7 @@ module ChunkyPNG
         from_datastream(ChunkyPNG::Datastream.from_blob(str))
       end
 
-      alias_method :from_string, :from_blob
+      alias from_string from_blob
 
       # Decodes a Canvas from a PNG encoded file.
       # @param [String] filename The file to read from.
@@ -52,7 +52,7 @@ module ChunkyPNG
         from_datastream(ChunkyPNG::Datastream.from_io(io))
       end
 
-      alias_method :from_stream, :from_io
+      alias from_stream from_io
 
       # Decodes the Canvas from a PNG datastream instance.
       # @param [ChunkyPNG::Datastream] ds The datastream to decode.
@@ -85,7 +85,7 @@ module ChunkyPNG
       # color mode and interlacing mode.
       # @param [String] stream The pixelstream to read from.
       # @param [Integer] width The width of the image.
-      # @param [Integer] width The height of the image.
+      # @param [Integer] height The height of the image.
       # @param [Integer] color_mode The color mode of the encoded pixelstream.
       # @param [Integer] depth The bit depth of the pixel samples.
       # @param [Integer] interlace The interlace method of the encoded pixelstream.
@@ -96,13 +96,13 @@ module ChunkyPNG
         raise ChunkyPNG::ExpectationFailed, "This palette is not suitable for decoding!" if decoding_palette && !decoding_palette.can_decode?
 
         image = case interlace
-          when ChunkyPNG::INTERLACING_NONE;  decode_png_without_interlacing(stream, width, height, color_mode, depth, decoding_palette)
-          when ChunkyPNG::INTERLACING_ADAM7; decode_png_with_adam7_interlacing(stream, width, height, color_mode, depth, decoding_palette)
+          when ChunkyPNG::INTERLACING_NONE  then decode_png_without_interlacing(stream, width, height, color_mode, depth, decoding_palette)
+          when ChunkyPNG::INTERLACING_ADAM7 then decode_png_with_adam7_interlacing(stream, width, height, color_mode, depth, decoding_palette)
           else raise ChunkyPNG::NotSupported, "Don't know how the handle interlacing method #{interlace}!"
         end
 
         image.pixels.map! { |c| c == transparent_color ? ChunkyPNG::Color::TRANSPARENT : c } if transparent_color
-        return image
+        image
       end
 
       protected
@@ -147,7 +147,7 @@ module ChunkyPNG
       #        the value will be modded by 2 to enforce this.
       # @return [Integer] The extracted 4bit value (0..15)
       def decode_png_extract_4bit_value(byte, index)
-        (index & 0x01 == 0) ? ((byte & 0xf0) >> 4) : (byte & 0x0f)
+        index & 0x01 == 0 ? ((byte & 0xf0) >> 4) : (byte & 0x0f)
       end
 
       # Extract 2 consecutive bits from a byte.
@@ -205,7 +205,6 @@ module ChunkyPNG
         value == 0x01 ? 0xff : 0x00
       end
 
-
       # Decodes a scanline of a 1-bit, indexed image into a row of pixels.
       # @param [String] stream The stream to decode from.
       # @param [Integer] pos The position in the stream on which the scanline starts (including the filter byte).
@@ -259,17 +258,21 @@ module ChunkyPNG
       def decode_png_pixels_from_scanline_truecolor_alpha_16bit(stream, pos, width, _decoding_palette)
         pixels = []
         stream.unpack("@#{pos + 1}n#{width * 4}").each_slice(4) do |r, g, b, a|
-          pixels << ChunkyPNG::Color.rgba(decode_png_resample_16bit_value(r), decode_png_resample_16bit_value(g),
-                                          decode_png_resample_16bit_value(b), decode_png_resample_16bit_value(a))
+          pixels << ChunkyPNG::Color.rgba(
+            decode_png_resample_16bit_value(r),
+            decode_png_resample_16bit_value(g),
+            decode_png_resample_16bit_value(b),
+            decode_png_resample_16bit_value(a),
+          )
         end
-        return pixels
+        pixels
       end
 
       # Decodes a scanline of an 8-bit, true color image into a row of pixels.
       # @params (see #decode_png_pixels_from_scanline_indexed_1bit)
       # @return (see #decode_png_pixels_from_scanline_indexed_1bit)
       def decode_png_pixels_from_scanline_truecolor_8bit(stream, pos, width, _decoding_palette)
-        stream.unpack("@#{pos + 1}" << ('NX' * width)).map { |c| c | 0x000000ff }
+        stream.unpack("@#{pos + 1}#{"NX" * width}").map { |c| c | 0x000000ff }
       end
 
       # Decodes a scanline of a 16-bit, true color image into a row of pixels.
@@ -280,7 +283,7 @@ module ChunkyPNG
         stream.unpack("@#{pos + 1}n#{width * 3}").each_slice(3) do |r, g, b|
           pixels << ChunkyPNG::Color.rgb(decode_png_resample_16bit_value(r), decode_png_resample_16bit_value(g), decode_png_resample_16bit_value(b))
         end
-        return pixels
+        pixels
       end
 
       # Decodes a scanline of an 8-bit, grayscale image with transparency into a row of pixels.
@@ -298,7 +301,7 @@ module ChunkyPNG
         stream.unpack("@#{pos + 1}n#{width * 2}").each_slice(2) do |g, a|
           pixels << ChunkyPNG::Color.grayscale_alpha(decode_png_resample_16bit_value(g), decode_png_resample_16bit_value(a))
         end
-        return pixels
+        pixels
       end
 
       # Decodes a scanline of a 1-bit, grayscale image into a row of pixels.
@@ -353,12 +356,11 @@ module ChunkyPNG
       # @raise [ChunkyPNG::NotSupported] when the color_mode and/or bit depth is not supported.
       def decode_png_pixels_from_scanline_method(color_mode, depth)
         decoder_method = case color_mode
-          when ChunkyPNG::COLOR_TRUECOLOR;       :"decode_png_pixels_from_scanline_truecolor_#{depth}bit"
-          when ChunkyPNG::COLOR_TRUECOLOR_ALPHA; :"decode_png_pixels_from_scanline_truecolor_alpha_#{depth}bit"
-          when ChunkyPNG::COLOR_INDEXED;         :"decode_png_pixels_from_scanline_indexed_#{depth}bit"
-          when ChunkyPNG::COLOR_GRAYSCALE;       :"decode_png_pixels_from_scanline_grayscale_#{depth}bit"
-          when ChunkyPNG::COLOR_GRAYSCALE_ALPHA; :"decode_png_pixels_from_scanline_grayscale_alpha_#{depth}bit"
-          else nil
+          when ChunkyPNG::COLOR_TRUECOLOR       then :"decode_png_pixels_from_scanline_truecolor_#{depth}bit"
+          when ChunkyPNG::COLOR_TRUECOLOR_ALPHA then :"decode_png_pixels_from_scanline_truecolor_alpha_#{depth}bit"
+          when ChunkyPNG::COLOR_INDEXED         then :"decode_png_pixels_from_scanline_indexed_#{depth}bit"
+          when ChunkyPNG::COLOR_GRAYSCALE       then :"decode_png_pixels_from_scanline_grayscale_#{depth}bit"
+          when ChunkyPNG::COLOR_GRAYSCALE_ALPHA then :"decode_png_pixels_from_scanline_grayscale_alpha_#{depth}bit"
         end
 
         raise ChunkyPNG::NotSupported, "No decoder found for color mode #{color_mode} and #{depth}-bit depth!" unless respond_to?(decoder_method, true)
@@ -379,7 +381,6 @@ module ChunkyPNG
       # @param [ChunkyPNG::Palette] decoding_palette The palette to use to decode colors.
       # @return (see ChunkyPNG::Canvas::PNGDecoding#decode_png_pixelstream)
       def decode_png_image_pass(stream, width, height, color_mode, depth, start_pos, decoding_palette)
-
         pixels = []
         if width > 0 && height > 0
 
@@ -419,11 +420,11 @@ module ChunkyPNG
       # @return [void]
       def decode_png_str_scanline(stream, pos, prev_pos, line_length, pixel_size)
         case stream.getbyte(pos)
-          when ChunkyPNG::FILTER_NONE;    # noop
-          when ChunkyPNG::FILTER_SUB;     decode_png_str_scanline_sub(     stream, pos, prev_pos, line_length, pixel_size)
-          when ChunkyPNG::FILTER_UP;      decode_png_str_scanline_up(      stream, pos, prev_pos, line_length, pixel_size)
-          when ChunkyPNG::FILTER_AVERAGE; decode_png_str_scanline_average( stream, pos, prev_pos, line_length, pixel_size)
-          when ChunkyPNG::FILTER_PAETH;   decode_png_str_scanline_paeth(   stream, pos, prev_pos, line_length, pixel_size)
+          when ChunkyPNG::FILTER_NONE    then # rubocop:disable Lint/EmptyWhen # no-op
+          when ChunkyPNG::FILTER_SUB     then decode_png_str_scanline_sub(stream, pos, prev_pos, line_length, pixel_size)
+          when ChunkyPNG::FILTER_UP      then decode_png_str_scanline_up(stream, pos, prev_pos, line_length, pixel_size)
+          when ChunkyPNG::FILTER_AVERAGE then decode_png_str_scanline_average(stream, pos, prev_pos, line_length, pixel_size)
+          when ChunkyPNG::FILTER_PAETH   then decode_png_str_scanline_paeth(stream, pos, prev_pos, line_length, pixel_size)
           else raise ChunkyPNG::NotSupported, "Unknown filter type: #{stream.getbyte(pos)}!"
         end
       end
@@ -462,7 +463,7 @@ module ChunkyPNG
       # @return [void]
       def decode_png_str_scanline_average(stream, pos, prev_pos, line_length, pixel_size)
         for i in 1..line_length do
-          a = (i > pixel_size) ? stream.getbyte(pos + i - pixel_size) : 0
+          a = i > pixel_size ? stream.getbyte(pos + i - pixel_size) : 0
           b = prev_pos ? stream.getbyte(prev_pos + i) : 0
           stream.setbyte(pos + i, (stream.getbyte(pos + i) + ((a + b) >> 1)) & 0xff)
         end
@@ -475,14 +476,19 @@ module ChunkyPNG
       def decode_png_str_scanline_paeth(stream, pos, prev_pos, line_length, pixel_size)
         for i in 1..line_length do
           cur_pos = pos + i
-          a = (i > pixel_size) ? stream.getbyte(cur_pos - pixel_size) : 0
+          a = i > pixel_size ? stream.getbyte(cur_pos - pixel_size) : 0
           b = prev_pos ? stream.getbyte(prev_pos + i) : 0
-          c = (prev_pos && i > pixel_size) ? stream.getbyte(prev_pos + i - pixel_size) : 0
+          c = prev_pos && i > pixel_size ? stream.getbyte(prev_pos + i - pixel_size) : 0
           p = a + b - c
           pa = (p - a).abs
           pb = (p - b).abs
           pc = (p - c).abs
-          pr = (pa <= pb) ? (pa <= pc ? a : c) : (pb <= pc ? b : c)
+          pr = if pa <= pb
+            pa <= pc ? a : c
+          else
+            pb <= pc ? b : c
+          end
+
           stream.setbyte(cur_pos, (stream.getbyte(cur_pos) + pr) & 0xff)
         end
       end