image_size 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a128281e6674bd684b8485151f3938a5d34d8fdf146e293e908e8cfb5c762d5
-  data.tar.gz: 0615d7750931da9cf45ec6003fd1f20dba7638e393a6d18bbec53901c078e864
+  metadata.gz: e7880ff3fdbcfdbbc6e3248c79ef59adea338f21c63c285323c5b01bdf699477
+  data.tar.gz: b8ce40e97bc91a2f7e91a9ce3f47d17f06aa38a6a28f7e534837c1f668cc51e2
 SHA512:
-  metadata.gz: d2d3cf28085954077a3016735c15ede7827dd1a72afd0617182d4278f0890f8ef41cbc8e84fe7d2661a270a8ce570b6e3cfeaa148c8be4d141c3a233cb712a59
-  data.tar.gz: a6dd7107a1c344a4963cf527d80e76c08e6b64cf22ae2edb6d2c7dad022f3452505a369fc9a4b4c665136e34ee2379a41b235e5d89881a32721c49ae14c6b6aa
+  metadata.gz: 027e0f32e86acf19b92cb00404dfb2b26f0989ed13d07247512ff024d058a245d62b3b252e2605ff1d79a41636cb87874f2f556f3e2cdcaf2727efe3fc91efe2
+  data.tar.gz: b8a5074adaa1d08d6b3b8d9d1a5da5c5239e1ea46b345fc13ffbf5ba75736d826beaeceb38b09aec7267f6c934856c1237c9c514ecad3fb6e9701b0846352f0d

data/.github/workflows/check.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
   schedule:
   - cron: 45 4 * * 3
+permissions:
+  contents: read
 jobs:
   check:
     runs-on: ubuntu-22.04

data/.github/workflows/rubocop.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
   schedule:
   - cron: 45 4 * * 3
+permissions:
+  contents: read
 jobs:
   rubocop:
     runs-on: ubuntu-latest

data/CHANGELOG.markdown

@@ -2,6 +2,10 @@
 
 ## unreleased
 
+## v3.6.0 (2026-05-26)
+
+* Support `.icns` Apple Icon Image format [@toy](https://github.com/toy)
+
 ## v3.5.0 (2026-05-03)
 
 * Add `byte_size` method to expose the size of the image data in bytes [#27](https://github.com/toy/image_size/pull/27) [@dgodd](https://github.com/dgodd)

data/README.markdown

@@ -5,7 +5,7 @@
 # image_size
 
 Measure image size/dimensions using pure Ruby.
-Formats: `apng`, `avif`, `bmp`, `cur`, `emf`, `gif`, `heic`, `heif`, `ico`, `j2c`, `jp2`, `jpeg`, `jpx`, `mng`, `pam`, `pbm`, `pcx`, `pgm`, `png`, `ppm`, `psd`, `svg`, `swf`, `tiff`, `webp`, `xbm`, `xpm`.
+Formats: `apng`, `avif`, `bmp`, `cur`, `emf`, `gif`, `heic`, `heif`, `icns`, `ico`, `j2c`, `jp2`, `jpeg`, `jpx`, `mng`, `pam`, `pbm`, `pcx`, `pgm`, `png`, `ppm`, `psd`, `svg`, `swf`, `tiff`, `webp`, `xbm`, `xpm`.
 
 ## Installation
 

data/image_size.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_size'
-  s.version     = '3.5.0'
+  s.version     = '3.6.0'
   s.summary     = %q{Measure image size/dimensions using pure Ruby}
-  s.description = %q{Measure following file dimensions: apng, avif, bmp, cur, emf, gif, heic, heif, ico, j2c, jp2, jpeg, jpx, mng, pam, pbm, pcx, pgm, png, ppm, psd, svg, swf, tiff, webp, xbm, xpm}
+  s.description = %q{Measure following file dimensions: apng, avif, bmp, cur, emf, gif, heic, heif, icns, ico, j2c, jp2, jpeg, jpx, mng, pam, pbm, pcx, pgm, png, ppm, psd, svg, swf, tiff, webp, xbm, xpm}
   s.homepage    = "https://github.com/toy/#{s.name}"
   s.authors     = ['Keisuke Minami', 'Ivan Kuchin']
   s.license     = 'Ruby'

data/lib/image_size/media_types.rb

@@ -9,6 +9,7 @@ class ImageSize
     emf: %w[image/emf],
     gif: %w[image/gif],
     heic: %w[image/heic image/heif],
+    icns: %w[image/x-icns],
     ico: %w[image/x-icon image/vnd.microsoft.icon],
     j2c: %w[image/j2c],
     jp2: %w[image/jp2],

data/lib/image_size.rb

@@ -31,35 +31,40 @@ class ImageSize
     alias_method :h, :height
   end
 
-  # Given path to image finds its format, width and height
-  def self.path(path)
-    new(Pathname.new(path))
-  end
+  class << self
+    # Given path to image finds its format, width and height
+    def path(path)
+      new(Pathname.new(path))
+    end
 
-  # Used for svg and emf
-  def self.dpi
-    @dpi || 72.0
-  end
+    # DPI used for svg and emf
+    def dpi
+      @dpi || 72.0
+    end
 
-  # Used for svg and emf
-  def self.dpi=(dpi)
-    fail ArgumentError, "dpi should be nil or positive, got #{dpi}" unless dpi.nil? || dpi > 0
+    # Set DPI used for svg and emf
+    def dpi=(dpi)
+      fail ArgumentError, "dpi should be nil or positive, got #{dpi}" unless dpi.nil? || dpi > 0
 
-    @dpi = dpi ? dpi.to_f : nil
-  end
+      @dpi = dpi ? dpi.to_f : nil
+    end
 
-  # Size of chunk to use by IO and URI readers
-  def self.chunk_size
-    @chunk_size || 4096
-  end
+    # Use display pixels instead of physical/image pixels for icns
+    attr_accessor :use_display_pixels
 
-  # Set size of chunk to use by IO and URI readers
-  def self.chunk_size=(chunk_size)
-    unless chunk_size.nil? || (chunk_size.is_a?(Integer) && chunk_size > 0)
-      fail ArgumentError, "chunk_size should be a positive Integer or nil, got #{chunk_size}"
+    # Size of chunk to use by IO and URI readers
+    def chunk_size
+      @chunk_size || 4096
     end
 
-    @chunk_size = chunk_size
+    # Set size of chunk to use by IO and URI readers
+    def chunk_size=(chunk_size)
+      unless chunk_size.nil? || (chunk_size.is_a?(Integer) && chunk_size > 0)
+        fail ArgumentError, "chunk_size should be a positive Integer or nil, got #{chunk_size}"
+      end
+
+      @chunk_size = chunk_size
+    end
   end
 
   # Given image as any class responding to read and eof? or data as String, finds its format and dimensions
@@ -106,6 +111,8 @@ private
 
   SVG_R = /<svg\b([^>]*)>/.freeze
   XML_R = /<\?xml|<!--/.freeze
+  private_constant :SVG_R, :XML_R
+
   def detect_format(ir)
     head = ir[0, 1024]
     case
@@ -126,6 +133,7 @@ private
     when head[0, 12] =~ /\ARIFF(?m:....)WEBP\z/                   then :webp
     when head[0, 4] == "\0\0\1\0"                                 then :ico
     when head[0, 4] == "\0\0\2\0"                                 then :cur
+    when head[0, 4] == 'icns'                                     then :icns
     when head[0, 12] == "\0\0\0\fjP  \r\n\207\n"                  then detect_jpeg2000_type(ir)
     when head[0, 4] == "\377O\377Q"                               then :j2c
     when head[0, 4] == "\1\0\0\0" && head[40, 4] == ' EMF'        then :emf
@@ -190,6 +198,8 @@ private
     0xC9, 0xCA, 0xCB,
     0xCD, 0xCE, 0xCF
   ].freeze
+  private_constant :JPEG_CODE_CHECK
+
   def size_of_jpeg(ir)
     section_marker = "\xFF"
     offset = 2
@@ -351,6 +361,60 @@ private
   end
   alias_method :size_of_cur, :size_of_ico
 
+  ICNS_16X12 = %w[icm# icm4 icm8].freeze
+  ICNS_SQUARE = {
+    [16, 1] => %w[ic04 icp4 ics# ics4 ics8 is32 s8mk],
+    [16, 2] => %w[ic11],
+    [18, 1] => %w[icsb],
+    [18, 2] => %w[icsB],
+    [24, 1] => %w[sb24],
+    [24, 2] => %w[SB24],
+    [32, 1] => %w[ICN# ICON ic05 icl4 icl8 icp5 il32 l8mk],
+    [32, 2] => %w[ic12],
+    [48, 1] => %w[h8mk ich# ich4 ich8 icp6 ih32],
+    [128, 1] => %w[ic07 it32 t8mk],
+    [128, 2] => %w[ic13],
+    [256, 1] => %w[ic08],
+    [256, 2] => %w[ic14],
+    [512, 1] => %w[ic09],
+    [512, 2] => %w[ic10],
+  }.each_with_object({}){ |(spec, types), h| types.each{ |type| h[type] = spec } }.freeze
+  private_constant :ICNS_16X12, :ICNS_SQUARE
+
+  def size_of_icns(ir)
+    file_length = ir.unpack1(4, 4, 'N')
+    offset = 8
+
+    types = []
+    while offset < file_length
+      type = ir[offset, 4]
+      length = ir.unpack1(offset + 4, 4, 'N')
+
+      case type
+      when 'TOC ' # rely on table of contents
+        fail FormatError, "TOC length #{length} is not divisible by 8" unless length % 8 == 0
+
+        types = (1...(length / 8)).map{ |i| ir[offset + (8 * i), 4] }
+        break
+      when 'icnV', 'info', 'name' # not icons
+      when 'slct', 'sbtp', "\375\331/\250" # nested icns
+      else
+        types << type
+      end
+
+      offset += length
+    end
+
+    types.map do |type|
+      next [16, 12] if ICNS_16X12.include?(type)
+
+      side, scale = ICNS_SQUARE[type]
+      fail FormatError, "unknown icon type: #{type.inspect}" unless side
+
+      (self.class.use_display_pixels ? [side] : [side * scale]) * 2
+    end.max
+  end
+
   def size_of_webp(ir)
     case ir.fetch(12, 4)
     when 'VP8 '
@@ -368,6 +432,8 @@ private
     recurse: %w[jp2h],
     last: %w[jp2h]
   )
+  private_constant :JP2_WALKER
+
   def size_of_jp2(ir)
     JP2_WALKER.recurse(ir) do |box|
       return ir.unpack(box.data_offset, 8, 'NN').reverse if box.type == 'ihdr'
@@ -381,6 +447,7 @@ private
 
   EMF_UMAX = 256**4
   EMF_SMAX = EMF_UMAX / 2
+  private_constant :EMF_UMAX, :EMF_SMAX
 
   def size_of_emf(ir)
     left, top, right, bottom =
@@ -400,6 +467,8 @@ private
     full: %w[meta hdlr pitm ipma ispe],
     last: %w[meta]
   )
+  private_constant :HEIF_WALKER
+
   def size_of_heif(ir)
     pitm = nil
     ipma = nil
@@ -456,6 +525,4 @@ private
   end
   alias_method :size_of_avif, :size_of_heif
   alias_method :size_of_heic, :size_of_heif
-
-  private_constant :SVG_R, :XML_R, :JPEG_CODE_CHECK, :JP2_WALKER, :EMF_UMAX, :EMF_SMAX, :HEIF_WALKER
 end

data/spec/image_size/chunky_reader_spec.rb

@@ -2,7 +2,7 @@
 
 require 'rspec'
 
-require 'image_size/chunky_reader'
+require 'image_size'
 
 describe ImageSize::ChunkyReader do
   context :[] do

data/spec/image_size/seekable_io_reader_spec.rb

@@ -2,7 +2,7 @@
 
 require 'rspec'
 
-require 'image_size/seekable_io_reader'
+require 'image_size'
 
 describe ImageSize::SeekableIOReader do
   context :[] do

data/spec/image_size_spec.rb

@@ -70,16 +70,20 @@ describe ImageSize do
     end
   end
 
-  Dir['spec/**/*'].each do |path|
-    next unless File.file?(path)
+  def self.test_image_size(path, &block)
+    file_size = File.size(path)
+    max_file_size = 16_384
+    fail "reduce resulting gem size, #{path} is too big (#{file_size} > #{max_file_size})" if file_size > max_file_size
 
     describe "for #{path}" do
       let(:name){ File.basename(path) }
+      let(:match){ name.match(/(?<width>\d+)x(?<height>\d+)(?:@(?<scale>\d)x)?\.(?<format>[^.]+)$/) }
+      let(:scale){ (match[:scale] || 1).to_i if match }
       let(:attributes) do
-        if (match = /(\d+)x(\d+)\.([^.]+)$/.match(name))
-          width = match[1].to_i
-          height = match[2].to_i
-          format = match[3].to_sym
+        if match
+          width = match[:width].to_i * scale
+          height = match[:height].to_i * scale
+          format = match[:format].to_sym
         end
         size = [width, height] if format
         media_types = ImageSize::MEDIA_TYPES[format] || []
@@ -97,15 +101,8 @@ describe ImageSize do
         }
       end
       let(:file_data){ File.binread(path) }
-      let(:file_size){ file_data.length }
 
-      before do
-        max_file_size = 16_384
-
-        if file_size > max_file_size
-          fail "reduce resulting gem size, #{path} is too big (#{file_size} > #{max_file_size})"
-        end
-      end
+      instance_exec(&block) if block
 
       context 'given as data' do
         it 'gets format and dimensions' do
@@ -269,6 +266,32 @@ describe ImageSize do
     end
   end
 
+  context 'for non images' do
+    test_image_size 'spec/test_server.rb'
+    test_image_size 'spec/images/empty'
+  end
+
+  context 'for images' do
+    Dir['spec/images/*/*.*'].each do |path|
+      if path.end_with?('.icns')
+        context 'without use_display_pixels' do
+          test_image_size path
+        end
+
+        context 'with use_display_pixels' do
+          before{ ImageSize.use_display_pixels = true }
+          after{ ImageSize.use_display_pixels = nil }
+
+          test_image_size path do
+            let(:scale){ 1 }
+          end
+        end
+      else
+        test_image_size path
+      end
+    end
+  end
+
   it 'raises ArgumentError if argument is not valid' do
     expect do
       ImageSize.new(Object)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_size
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Keisuke Minami
@@ -53,8 +53,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: 'Measure following file dimensions: apng, avif, bmp, cur, emf, gif, heic,
-  heif, ico, j2c, jp2, jpeg, jpx, mng, pam, pbm, pcx, pgm, png, ppm, psd, svg, swf,
-  tiff, webp, xbm, xpm'
+  heif, icns, ico, j2c, jp2, jpeg, jpx, mng, pam, pbm, pcx, pgm, png, ppm, psd, svg,
+  swf, tiff, webp, xbm, xpm'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,6 +100,11 @@ files:
 - spec/images/heif/multiple.169x83.heic
 - spec/images/heif/rotate.73x173.avif
 - spec/images/heif/sequence.7x5.avif
+- spec/images/icns/16x12.icns
+- spec/images/icns/afp_scanpix_leta_pilipey_kyiv.256x256@1x.icns
+- spec/images/icns/reuters_scanpix_leta_garanich_kyiv.256x256@2x.icns
+- spec/images/icns/toc.512x512@1x.icns
+- spec/images/icns/toc.512x512@2x.icns
 - spec/images/ico/32x256.ico
 - spec/images/jp2/163x402.jp2
 - spec/images/jp2/176x373.jpx
@@ -140,7 +145,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/toy/image_size/issues
   changelog_uri: https://github.com/toy/image_size/blob/master/CHANGELOG.markdown
-  documentation_uri: https://www.rubydoc.info/gems/image_size/3.5.0
+  documentation_uri: https://www.rubydoc.info/gems/image_size/3.6.0
   source_code_uri: https://github.com/toy/image_size
 rdoc_options: []
 require_paths:
@@ -178,6 +183,11 @@ test_files:
 - spec/images/heif/multiple.169x83.heic
 - spec/images/heif/rotate.73x173.avif
 - spec/images/heif/sequence.7x5.avif
+- spec/images/icns/16x12.icns
+- spec/images/icns/afp_scanpix_leta_pilipey_kyiv.256x256@1x.icns
+- spec/images/icns/reuters_scanpix_leta_garanich_kyiv.256x256@2x.icns
+- spec/images/icns/toc.512x512@1x.icns
+- spec/images/icns/toc.512x512@2x.icns
 - spec/images/ico/32x256.ico
 - spec/images/jp2/163x402.jp2
 - spec/images/jp2/176x373.jpx