image_size 1.5.0 → 2.1.1

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE.txt

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Keisuke Minami <keisuke@rccn.com>.
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.markdown

@@ -1,55 +1,91 @@
+[![Gem Version](https://img.shields.io/gem/v/image_size.svg?style=flat)](https://rubygems.org/gems/image_size)
+[![Build Status](https://github.com/toy/image_size/actions/workflows/check.yml/badge.svg)](https://github.com/toy/image_size/actions/workflows/check.yml)
+
 # image_size
 
 measure image size using pure Ruby
-formats: `apng`, `bmp`, `cur`, `gif`, `jpeg`, `ico`, `mng`, `pbm`, `pcx`, `pgm`, `png`, `ppm`, `psd`, `swf`, `tiff`, `xbm`, `xpm`, `webp`
+formats: `apng`, `bmp`, `cur`, `gif`, `ico`, `j2c`, `jp2`, `jpeg`, `jpx`, `mng`, `pam`, `pbm`, `pcx`, `pgm`, `png`, `ppm`, `psd`, `svg`, `swf`, `tiff`, `webp`, `xbm`, `xpm`
 
-[![Build Status](https://travis-ci.org/toy/image_size.png?branch=master)](https://travis-ci.org/toy/image_size)
+## Installation
 
-## Download
+```sh
+gem install image_size
+```
 
-The latest version of image\_size can be found at http://github.com/toy/image_size
+### Bundler
 
-## Installation
+Add to your `Gemfile`:
 
-    gem install image_size
+```ruby
+gem 'image_size', '~> 2.0'
+```
 
 ## Usage
 
-    image_size = ImageSize.path('spec/images/jpeg/320x240.jpeg')
-    image_size.format       #=> :jpec
-    image_size.width        #=> 320
-    image_size.height       #=> 240
-    image_size.size         #=> [320, 240]
+```ruby
+image_size = ImageSize.path('spec/test.jpg')
 
-`width` and `height` have aliases `w` and `h`.
+image_size.format       #=> :jpec
+image_size.width        #=> 320
+image_size.height       #=> 240
+image_size.w            #=> 320
+image_size.h            #=> 240
+image_size.size         #=> [320, 240]
+```
 
-## Examples
+Or using `IO` object:
 
-    require 'image_size'
+```ruby
+image_size = File.open('spec/test.jpg', 'rb'){ |fh| ImageSize.new(fh) }
+```
 
-    ImageSize.path('spec/test.jpg')
+Any object responding to `read` and `eof?`:
 
-    open('spec/test.jpg', 'rb') do |fh|
-      ImageSize.new(fh)
-    end
+```ruby
+require 'image_size'
 
+image_size = ImageSize.new(ARGF)
+```
 
-    require 'image_size'
-    require 'open-uri'
+Works with `open-uri` if needed:
 
-    open('http://www.rubycgi.org/image/ruby_gtk_book_title.jpg', 'rb') do |fh|
-      ImageSize.new(fh)
-    end
+```ruby
+require 'image_size'
+require 'open-uri'
 
-    open('http://www.rubycgi.org/image/ruby_gtk_book_title.jpg', 'rb') do |fh|
-      data = fh.read
-      ImageSize.new(data)
-    end
+image_size = URI.parse('http://www.rubycgi.org/image/ruby_gtk_book_title.jpg').open('rb') do |fh|
+  ImageSize.new(fh)
+end
 
-## Licence
+image_size = open('http://www.rubycgi.org/image/ruby_gtk_book_title.jpg', 'rb') do |fh|
+  ImageSize.new(fh)
+end
+```
+
+Note that starting with version `2.0.0` the object given to `ImageSize` will not be rewound before or after use.
+So rewind if needed before passing to `ImageSize` and/or rewind after passing to `ImageSize` before reading data.
+
+```ruby
+require 'image_size'
 
-This code is free to use under the terms of the Ruby's licence.
+File.open('spec/test.jpg', 'rb') do |fh|
+  image_size = ImageSize.new(fh)
+
+  fh.rewind
+  data = fh.read
+end
+
+File.open('spec/test.jpg', 'rb') do |fh|
+  data = fh.read
+  fh.rewind
+
+  image_size = ImageSize.new(fh)
+end
+```
+
+## Licence
 
-## Contact
+This code is free to use under the terms of the [Ruby's licence](LICENSE.txt).
 
-Original author: "Keisuke Minami": mailto:keisuke@rccn.com
+Original author: Keisuke Minami <keisuke@rccn.com>.\
+Further development 2010-2020 Ivan Kuchin https://github.com/toy/image_size

data/image_size.gemspec

@@ -2,14 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_size'
-  s.version     = '1.5.0'
+  s.version     = '2.1.1'
   s.summary     = %q{Measure image size using pure Ruby}
-  s.description = %q{Measure following file dimensions: apng, bmp, cur, gif, jpeg, ico, mng, pbm, pcx, pgm, png, ppm, psd, swf, tiff, xbm, xpm, webp}
-  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.description = %q{Measure following file dimensions: apng, bmp, cur, gif, 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'
 
-  s.rubyforge_project = s.name
+  s.metadata = {
+    'bug_tracker_uri'   => "https://github.com/toy/#{s.name}/issues",
+    'changelog_uri'     => "https://github.com/toy/#{s.name}/blob/master/CHANGELOG.markdown",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{s.name}/#{s.version}",
+    'source_code_uri'   => "https://github.com/toy/#{s.name}",
+  }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -17,4 +22,7 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   s.add_development_dependency 'rspec', '~> 3.0'
+  if RUBY_VERSION >= '2.4'
+    s.add_development_dependency 'rubocop', '~> 1.0'
+  end
 end

data/lib/image_size.rb

@@ -1,11 +1,13 @@
-# -- coding: ASCII-8BIT --
-#
+# encoding: BINARY
+# frozen_string_literal: true
+
 require 'stringio'
-require 'tempfile'
 
+# Determine image format and size
 class ImageSize
   class FormatError < StandardError; end
 
+  # Array joining with 'x'
   class Size < Array
     # join using 'x'
     def to_s
@@ -15,34 +17,26 @@ class ImageSize
 
   class ImageReader # :nodoc:
     attr_reader :data
+
     def initialize(data_or_io)
-      @io = case data_or_io
-      when IO, StringIO, Tempfile
-        data_or_io.dup.tap(&:rewind)
-      when String
+      @io = if data_or_io.is_a?(String)
         StringIO.new(data_or_io)
+      elsif data_or_io.respond_to?(:read) && data_or_io.respond_to?(:eof?)
+        data_or_io
       else
-        raise ArgumentError.new("expected instance of IO, StringIO, Tempfile or String, got #{data_or_io.class}")
+        raise ArgumentError, "expected data as String or an object responding to read and eof?, got #{data_or_io.class}"
       end
-      @read = 0
-      @data = ''
-    end
-
-    def close
-      @io.rewind
-      @io.close if IO === @io
+      @data = String.new # not frozen
     end
 
     CHUNK = 1024
     def [](offset, length)
-      while offset + length > @read
-        @read += CHUNK
-        if data = @io.read(CHUNK)
-          if data.respond_to?(:encoding)
-            data.force_encoding(@data.encoding)
-          end
-          @data << data
-        end
+      while !@io.eof? && @data.length < offset + length
+        data = @io.read(CHUNK)
+        break unless data
+
+        data.force_encoding(@data.encoding) if data.respond_to?(:encoding)
+        @data << data
       end
       @data[offset, length]
     end
@@ -50,7 +44,7 @@ class ImageSize
 
   # Given path to image finds its format, width and height
   def self.path(path)
-    open(path, 'rb'){ |f| new(f) }
+    File.open(path, 'rb'){ |f| new(f) }
   end
 
   # Used for svg
@@ -63,13 +57,13 @@ class ImageSize
     @dpi = dpi.to_f
   end
 
-  # Given image as IO, StringIO, Tempfile or String finds its format and dimensions
+  # Given image as any class responding to read and eof? or data as String, finds its format and dimensions
   def initialize(data)
     ir = ImageReader.new(data)
-    if @format = detect_format(ir)
-      @width, @height = self.send("size_of_#{@format}", ir)
-    end
-    ir.close
+    @format = detect_format(ir)
+    return unless @format
+
+    @width, @height = send("size_of_#{@format}", ir)
   end
 
   # Image format
@@ -77,11 +71,11 @@ class ImageSize
 
   # Image width
   attr_reader :width
-  alias :w :width
+  alias_method :w, :width
 
   # Image height
   attr_reader :height
-  alias :h :height
+  alias_method :h, :height
 
   # get image width and height as an array which to_s method returns "#{width}x#{height}"
   def size
@@ -90,29 +84,29 @@ class ImageSize
 
 private
 
-  SVG_R = /<svg\b([^>]*)>/
+  SVG_R = /<svg\b([^>]*)>/.freeze
+  XML_R = /<\?xml|<!--/.freeze
   def detect_format(ir)
     head = ir[0, 1024]
     case
-    when head[0, 6] =~ /GIF8[79]a/          then :gif
-    when head[0, 8] == "\211PNG\r\n\032\n"  then detect_png_type(ir)
-    when head[0, 8] == "\212MNG\r\n\032\n"  then :mng
-    when head[0, 2] == "\377\330"           then :jpeg
-    when head[0, 2] == 'BM'                 then :bmp
-    when head[0, 2] =~ /P[1-7]/             then :ppm
-    when head =~ /\#define\s+\S+\s+\d+/     then :xbm
-    when head[0, 4] == "II*\000"            then :tiff
-    when head[0, 4] == "MM\000*"            then :tiff
-    when head =~ /\/\* XPM \*\//            then :xpm
-    when head[0, 4] == '8BPS'               then :psd
-    when head[0, 3] =~ /[FC]WS/             then :swf
-    when head[SVG_R] ||
-      head =~ /<\?xml|<!--/ && ir[0, 4096][SVG_R]
-                                            then :svg
-    when head[0, 2] =~ /\n[\000-\005]/      then :pcx
-    when head[0, 12] =~ /RIFF(?m:....)WEBP/ then :webp
-    when head[0, 4] == "\000\000\001\000"   then :ico
-    when head[0, 4] == "\000\000\002\000"   then :cur
+    when head[0, 6] =~ /GIF8[79]a/                                then :gif
+    when head[0, 8] == "\211PNG\r\n\032\n"                        then detect_png_type(ir)
+    when head[0, 8] == "\212MNG\r\n\032\n"                        then :mng
+    when head[0, 2] == "\377\330"                                 then :jpeg
+    when head[0, 2] == 'BM'                                       then :bmp
+    when head[0, 3] =~ /P[1-6]\s|P7\n/                            then detect_pnm_type(ir)
+    when head =~ /\#define\s+\S+\s+\d+/                           then :xbm
+    when %W[II*\0 MM\0*].include?(head[0, 4])                     then :tiff
+    when head =~ %r{/\* XPM \*/}                                  then :xpm
+    when head[0, 4] == '8BPS'                                     then :psd
+    when head[0, 3] =~ /[FC]WS/                                   then :swf
+    when head =~ SVG_R || (head =~ XML_R && ir[0, 4096][SVG_R])   then :svg
+    when head[0, 2] =~ /\n[\0-\5]/                                then :pcx
+    when head[0, 12] =~ /RIFF(?m:....)WEBP/                       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, 12] == "\0\0\0\fjP  \r\n\207\n"                  then detect_jpeg2000_type(ir)
+    when head[0, 4] == "\377O\377Q"                               then :j2c
     end
   end
 
@@ -129,6 +123,26 @@ private
     :png
   end
 
+  def detect_pnm_type(ir)
+    case ir[0, 2]
+    when 'P1', 'P4' then :pbm
+    when 'P2', 'P5' then :pgm
+    when 'P3', 'P6' then :ppm
+    when 'P7'       then :pam
+    end
+  end
+
+  def detect_jpeg2000_type(ir)
+    return unless ir[16, 4] == 'ftyp'
+
+    # using xl-box would be weird, but doesn't seem to contradict specification
+    skip = ir[12, 4] == "\0\0\0\1" ? 16 : 8
+    case ir[12 + skip, 4]
+    when 'jp2 ' then :jp2
+    when 'jpx ' then :jpx
+    end
+  end
+
   def size_of_gif(ir)
     ir[6, 4].unpack('vv')
   end
@@ -137,6 +151,7 @@ private
     unless ir[12, 4] == 'MHDR'
       raise FormatError, 'MHDR not in place for MNG'
     end
+
     ir[16, 8].unpack('NN')
   end
 
@@ -144,16 +159,17 @@ private
     unless ir[12, 4] == 'IHDR'
       raise FormatError, 'IHDR not in place for PNG'
     end
+
     ir[16, 8].unpack('NN')
   end
   alias_method :size_of_apng, :size_of_png
 
-  JpegCodeCheck = [
-    "\xc0", "\xc1", "\xc2", "\xc3",
-    "\xc5", "\xc6", "\xc7",
-    "\xc9", "\xca", "\xcb",
-    "\xcd", "\xce", "\xcf",
-  ] # :nodoc:
+  JPEG_CODE_CHECK = %W[
+    \xC0 \xC1 \xC2 \xC3
+    \xC5 \xC6 \xC7
+    \xC9 \xCA \xCB
+    \xCD \xCE \xCF
+  ].freeze
   def size_of_jpeg(ir)
     section_marker = "\xFF"
     offset = 2
@@ -162,12 +178,13 @@ private
       offset += 1 until section_marker != ir[offset + 1, 1]
       raise FormatError, 'EOF in JPEG' if ir[offset, 1].nil?
 
-      marker, code, length = ir[offset, 4].unpack('aan')
+      _marker, code, length = ir[offset, 4].unpack('aan')
       offset += 4
 
-      if JpegCodeCheck.include?(code)
+      if JPEG_CODE_CHECK.include?(code)
         return ir[offset + 1, 4].unpack('nn').reverse
       end
+
       offset += length - 2
     end
   end
@@ -191,12 +208,38 @@ private
     header = ir[0, 1024]
     header.gsub!(/^\#[^\n\r]*/m, '')
     header =~ /^(P[1-6])\s+?(\d+)\s+?(\d+)/m
-    case $1
-      when 'P1', 'P4' then @format = :pbm
-      when 'P2', 'P5' then @format = :pgm
-    end
     [$2.to_i, $3.to_i]
   end
+  alias_method :size_of_pbm, :size_of_ppm
+  alias_method :size_of_pgm, :size_of_ppm
+
+  def size_of_pam(ir)
+    width = height = nil
+    offset = 3
+    loop do
+      if ir[offset, 1] == '#'
+        offset += 1 until ["\n", '', nil].include?(ir[offset, 1])
+        offset += 1
+      else
+        chunk = ir[offset, 32]
+        case chunk
+        when /\AWIDTH (\d+)\n/
+          width = $1.to_i
+        when /\AHEIGHT (\d+)\n/
+          height = $1.to_i
+        when /\AENDHDR\n/
+          break
+        when /\A(?:DEPTH|MAXVAL) \d+\n/, /\ATUPLTYPE \S+\n/
+          # ignore
+        else
+          raise FormatError, "Unexpected data in PAM header: #{chunk.inspect}"
+        end
+        offset += $&.length
+        break if width && height
+      end
+    end
+    [width, height]
+  end
 
   def size_of_xbm(ir)
     ir[0, 1024] =~ /^\#define\s*\S*\s*(\d+)\s*\n\#define\s*\S*\s*(\d+)/mi
@@ -209,6 +252,7 @@ private
       if data.length != length
         raise FormatError, 'XPM size not found'
       end
+
       length += 1024
     end
     [$1.to_i, $2.to_i]
@@ -219,7 +263,7 @@ private
   end
 
   def size_of_tiff(ir)
-    endian2b = (ir[0, 4] == "II*\000") ? 'v' : 'n'
+    endian2b = ir[0, 4] == "II*\000" ? 'v' : 'n'
     endian4b = endian2b.upcase
     packspec = [nil, 'C', nil, endian2b, endian4b, nil, 'c', nil, endian2b, endian4b]
 
@@ -232,17 +276,18 @@ private
     until width && height
       ifd = ir[offset, 12]
       raise FormatError, 'Reached end of directory entries in TIFF' if ifd.nil? || offset > num_dirent
+
       tag, type = ifd.unpack(endian2b * 2)
       offset += 12
 
-      unless packspec[type].nil?
-        value = ifd[8, 4].unpack(packspec[type])[0]
-        case tag
-        when 0x0100
-          width = value
-        when 0x0101
-          height = value
-        end
+      next if packspec[type].nil?
+
+      value = ifd[8, 4].unpack(packspec[type])[0]
+      case tag
+      when 0x0100
+        width = value
+      when 0x0101
+        height = value
       end
     end
     [width, height]
@@ -257,7 +302,7 @@ private
     value_bit_length = ir[8, 1].unpack('B5').first.to_i(2)
     bit_length = 5 + value_bit_length * 4
     rect_bits = ir[8, bit_length / 8 + 1].unpack("B#{bit_length}").first
-    values = rect_bits.unpack('@5' + "a#{value_bit_length}" * 4).map{ |bits| bits.to_i(2) }
+    values = rect_bits[5..-1].unpack("a#{value_bit_length}" * 4).map{ |bits| bits.to_i(2) }
     x_min, x_max, y_min, y_max = values
     [(x_max - x_min) / 20, (y_max - y_min) / 20]
   end
@@ -269,18 +314,18 @@ private
     end
     dpi = self.class.dpi
     [attributes['width'], attributes['height']].map do |length|
-      if length
-        pixels = case length.downcase.strip[/(?:em|ex|px|in|cm|mm|pt|pc|%)\z/]
-        when 'em', 'ex', '%' then nil
-        when 'in' then length.to_f * dpi
-        when 'cm' then length.to_f * dpi / 2.54
-        when 'mm' then length.to_f * dpi / 25.4
-        when 'pt' then length.to_f * dpi / 72
-        when 'pc' then length.to_f * dpi / 6
-        else length.to_f
-        end
-        pixels.round if pixels
+      next unless length
+
+      pixels = case length.downcase.strip[/(?:em|ex|px|in|cm|mm|pt|pc|%)\z/]
+      when 'em', 'ex', '%' then nil
+      when 'in' then length.to_f * dpi
+      when 'cm' then length.to_f * dpi / 2.54
+      when 'mm' then length.to_f * dpi / 25.4
+      when 'pt' then length.to_f * dpi / 72
+      when 'pc' then length.to_f * dpi / 6
+      else length.to_f
       end
+      pixels.round if pixels
     end
   end
 
@@ -301,4 +346,44 @@ private
       [(w16 | w8 << 16) + 1, (h16 | h8 << 16) + 1]
     end
   end
+
+  def size_of_jp2(ir)
+    offset = 12
+    stop = nil
+    in_header = false
+    loop do
+      break if stop && offset >= stop
+      break if ir[offset, 4] == '' || ir[offset, 4].nil?
+
+      size = ir[offset, 4].unpack('N')[0]
+      type = ir[offset + 4, 4]
+
+      data_offset = 8
+      case size
+      when 1
+        size = ir[offset, 8].unpack('Q>')[0]
+        data_offset = 16
+        raise FormatError, "Unexpected xl-box size #{size}" if (1..15).include?(size)
+      when 2..7
+        raise FormatError, "Reserved box size #{size}"
+      end
+
+      if type == 'jp2h'
+        stop = offset + size unless size.zero?
+        offset += data_offset
+        in_header = true
+      elsif in_header && type == 'ihdr'
+        return ir[offset + data_offset, 8].unpack('NN').reverse
+      else
+        break if size.zero? # box to the end of file
+
+        offset += size
+      end
+    end
+  end
+  alias_method :size_of_jpx, :size_of_jp2
+
+  def size_of_j2c(ir)
+    ir[8, 8].unpack('NN')
+  end
 end