image_size 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9caeef6f83a5e285b9925268a389b46b2d15b6def554e0480c3b4105868022e8
-  data.tar.gz: b1933e6c5d7fdc6686d8fe15082a64d39b76433aa659fc203c6d09c0ed937b86
+  metadata.gz: b0873a78a9fb9f84f07d0389071379dda288330bd38ee7516b442ffde85a3af8
+  data.tar.gz: 0b9fffd2311efa1c24379686821289951a4cd2ec895c27325148a886a24ff57b
 SHA512:
-  metadata.gz: be6a77d33b518ca07842b3b1d4bc8793949b0fb09ede5bc46c6753f7bd51255ee078f34714c851010b0b43df9ce32e2d52a236f990155ad5dd056fd5cc297214
-  data.tar.gz: d63e52caaa020d1b26e573a06d74b309f154542a82f7539fcb5c44d8ea7df7d44b5fbb54e51b502fe05e8e42e4191c8b0e8281f3d169a01717355016fa1fd9e5
+  metadata.gz: f6dede99002af9b9fc32f9776e42019079abcd846370c06b2aeee812a73c9ec46dcb6c703d1ae454f807d532c1d6b740aabb999892a6ef610cd17311f6a9a7f0
+  data.tar.gz: 819d8a3b7797b1f12b59eb608ffdeda9338314a923ca54711143832685853ed36b9ae8d165fcfa242ce4e1d72aecd5a03bd11714aa7aee3b464722ea8bb4688f

data/.github/workflows/check.yml

@@ -19,8 +19,10 @@ jobs:
         - '2.6'
         - '2.7'
         - '3.0'
+        - '3.1'
         - jruby-9.1
         - jruby-9.2
+        - jruby-9.3
       fail-fast: false
     steps:
     - uses: actions/checkout@v2
@@ -50,6 +52,7 @@ jobs:
         - '2.6'
         - '2.7'
         - '3.0'
+        - '3.1'
       fail-fast: false
     steps:
     - uses: actions/checkout@v2
@@ -58,12 +61,3 @@ jobs:
         ruby-version: "${{ matrix.ruby }}"
         bundler-cache: true
     - run: bundle exec rspec --format documentation
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.0'
-        bundler-cache: true
-    - run: bundle exec rubocop

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: rubocop
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: 45 4 * * 3
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -53,6 +53,9 @@ Style/EmptyCaseCondition:
 Style/Encoding:
   Enabled: false
 
+Style/FileRead:
+  Enabled: false
+
 Style/HashEachMethods:
   Enabled: true
 
@@ -77,6 +80,9 @@ Style/ParallelAssignment:
 Style/SafeNavigation:
   Enabled: false
 
+Style/SlicingWithRange:
+  Enabled: false
+
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
 

data/.rubocop_todo.yml

@@ -9,17 +9,17 @@
 # Offense count: 8
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 43
+  Enabled: false
 
 # Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 21
+  Enabled: false
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 21
+  Enabled: false
 
 # Offense count: 8
 # Cop supports --auto-correct.

data/CHANGELOG.markdown

@@ -2,6 +2,15 @@
 
 ## unreleased
 
+## v3.1.0 (2022-09-17)
+
+* Document experimental fetching from http server [#18](https://github.com/toy/image_size/issues/18) [@toy](https://github.com/toy)
+* Improve experimental fetching of image meta from http server by reading only required amount of data when server does not support range header [@toy](https://github.com/toy)
+
+## v3.0.2 (2022-05-19)
+
+* Fix handling empty files [#20](https://github.com/toy/image_size/issues/20) [@toy](https://github.com/toy)
+
 ## v3.0.1 (2021-10-21)
 
 * Fix reading file chunks starting after EOF and reading chunks non-consecutively [toy/image_optim_rails#12](https://github.com/toy/image_optim_rails/issues/12) [@toy](https://github.com/toy)
@@ -11,6 +20,7 @@
 * Read only required chunks of data for files and seekable IOs [@toy](https://github.com/toy)
 * Raise `FormatError` whenever reading data returns less data than expected [#12](https://github.com/toy/image_size/issues/12) [@toy](https://github.com/toy)
 * Add `w`/`width` and `h`/`height` accessors to `Size` [@toy](https://github.com/toy)
+* Experimental efficient fetching of image meta from http server supporting range [@toy](https://github.com/toy)
 
 ## v2.1.2 (2021-08-21)
 

data/README.markdown

@@ -1,5 +1,6 @@
 [![Gem Version](https://img.shields.io/gem/v/image_size?logo=rubygems)](https://rubygems.org/gems/image_size)
 [![Build Status](https://img.shields.io/github/workflow/status/toy/image_size/check/master?logo=github)](https://github.com/toy/image_size/actions/workflows/check.yml)
+[![Rubocop](https://img.shields.io/github/workflow/status/toy/image_size/rubocop/master?label=rubocop&logo=rubocop)](https://github.com/toy/image_size/actions/workflows/rubocop.yml)
 
 # image_size
 
@@ -17,7 +18,7 @@ gem install image_size
 Add to your `Gemfile`:
 
 ```ruby
-gem 'image_size', '~> 2.0'
+gem 'image_size', '~> 3.0'
 ```
 
 ## Usage
@@ -53,7 +54,7 @@ require 'image_size'
 image_size = ImageSize.new(ARGF)
 ```
 
-Works with `open-uri` if needed:
+Works with `open-uri`, see [experimental HTTP server interface below](#experimental-fetch-image-meta-from-http-server):
 
 ```ruby
 require 'image_size'
@@ -89,9 +90,58 @@ File.open('spec/images/jpeg/436x429.jpeg', 'rb') do |fh|
 end
 ```
 
+### Experimental: fetch image meta from HTTP server
+
+If server recognises Range header, only needed chunks will be fetched even for TIFF images, otherwise required amount
+of data will be fetched, in most cases first few kilobytes (TIFF images is an exception).
+
+```ruby
+require 'image_size'
+require 'image_size/uri_reader'
+
+url = 'http://upload.wikimedia.org/wikipedia/commons/b/b4/Mardin_1350660_1350692_33_images.jpg'
+p ImageSize.url(url).size
+```
+
+This interface is as fast as dedicated gem fastimage for images with meta information in the header:
+
+```ruby
+url = 'http://upload.wikimedia.org/wikipedia/commons/b/b4/Mardin_1350660_1350692_33_images.jpg'
+puts Benchmark.measure{ p FastImage.size(url) }
+```
+```
+[9545, 6623]
+  0.004176   0.001974   0.006150 (  0.282889)
+```
+```ruby
+puts Benchmark.measure{ p ImageSize.url(url).size }
+```
+```
+[9545, 6623]
+  0.005604   0.001406   0.007010 (  0.238629)
+```
+
+And considerably faster for images with meta information at the end of file:
+
+```ruby
+url = "https://upload.wikimedia.org/wikipedia/commons/c/c7/Curiosity%27s_Vehicle_System_Test_Bed_%28VSTB%29_Rover_%28PIA15876%29.tif"
+puts Benchmark.measure{ p FastImage.size(url) }
+```
+```
+[7360, 4912]
+  0.331284   0.247295   0.578579 (  6.027051)
+```
+```ruby
+puts Benchmark.measure{ p ImageSize.url(url).size }
+```
+```
+[7360, 4912]
+  0.006247   0.001045   0.007292 (  0.197631)
+```
+
 ## Licence
 
 This code is free to use under the terms of the [Ruby's licence](LICENSE.txt).
 
 Original author: Keisuke Minami <keisuke@rccn.com>.\
-Further development 2010-2021 Ivan Kuchin https://github.com/toy/image_size
+Further development 2010-2022 Ivan Kuchin https://github.com/toy/image_size

data/image_size.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_size'
-  s.version     = '3.0.1'
+  s.version     = '3.1.0'
   s.summary     = %q{Measure image size using pure Ruby}
   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}"
@@ -22,8 +22,8 @@ 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'
+  if RUBY_VERSION >= '2.5'
+    s.add_development_dependency 'rubocop', '~> 1.22'
     s.add_development_dependency 'rubocop-rspec', '~> 2.0'
   end
 end

data/lib/image_size/uri_reader.rb

@@ -6,65 +6,103 @@ require 'image_size/chunky_reader'
 require 'net/https'
 require 'uri'
 
-# This is a hacky experiment and not part of public API
+# Experimental, not yet part of stable API
 #
-# It adds ability to fetch size of image from http server while downloading only
-# needed chunks if the server recognises Range header
+# It adds ability to fetch image meta from HTTP server while downloading only
+# needed chunks if the server recognises Range header, otherwise fetches only
+# required amount of data
 class ImageSize
-  class URIReader # :nodoc:
-    include ChunkyReader
-
-    def initialize(uri, redirects = 5)
-      if !@http || @http.address != uri.host || @http.port != uri.port
-        @http.finish if @http
-        @http = Net::HTTP.new(uri.host, uri.port)
-        @http.use_ssl = true if uri.scheme == 'https'
-        @http.start
-      end
+  module URIReader # :nodoc:
+    module HTTPChunkyReader # :nodoc:
+      include ChunkyReader
 
-      @request_uri = uri.request_uri
-      response = request_chunk(0)
+      def chunk_range_header(i)
+        { 'Range' => "bytes=#{chunk_size * i}-#{(chunk_size * (i + 1)) - 1}" }
+      end
+    end
 
-      case response
-      when Net::HTTPRedirection
-        raise "Too many redirects: #{response['location']}" unless redirects > 0
+    class BodyReader # :nodoc:
+      include ChunkyReader
 
-        initialize(uri + response['location'], redirects - 1)
-      when Net::HTTPOK
-        @body = response.body
-      when Net::HTTPPartialContent
-        @chunks = { 0 => response.body }
-      else
-        raise "Unexpected response: #{response}"
+      def initialize(response)
+        @body = String.new
+        @body_reader = response.to_enum(:read_body)
       end
-    end
 
-    def [](offset, length)
-      if @body
+      def [](offset, length)
+        if @body_reader
+          begin
+            @body << @body_reader.next while @body.length < offset + length
+          rescue StopIteration, IOError
+            @body_reader = nil
+          end
+        end
+
         @body[offset, length]
-      else
-        super
       end
     end
 
-    def chunk(i)
-      unless @chunks.key?(i)
-        response = request_chunk(i)
-        case response
-        when Net::HTTPPartialContent
-          @chunks[i] = response.body
-        else
-          raise "Unexpected response: #{response}"
-        end
+    class RangeReader # :nodoc:
+      include HTTPChunkyReader
+
+      def initialize(http, request_uri, chunk0)
+        @http = http
+        @request_uri = request_uri
+        @chunks = { 0 => chunk0 }
       end
 
-      @chunks[i]
+      def chunk(i)
+        unless @chunks.key?(i)
+          response = @http.get(@request_uri, chunk_range_header(i))
+          case response
+          when Net::HTTPPartialContent
+            @chunks[i] = response.body
+          else
+            raise "Unexpected response: #{response}"
+          end
+        end
+
+        @chunks[i]
+      end
     end
 
-  private
+    class << self
+      include HTTPChunkyReader
+
+      def open(uri, max_redirects = 5)
+        http = nil
+        (max_redirects + 1).times do
+          unless http && http.address == uri.host && http.port == uri.port
+            http.finish if http
+
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = true if uri.scheme == 'https'
+            http.start
+          end
 
-    def request_chunk(i)
-      @http.get(@request_uri, 'Range' => "bytes=#{chunk_size * i}-#{(chunk_size * (i + 1)) - 1}")
+          response = http.request_get(uri.request_uri, chunk_range_header(0)) do |response_with_unread_body|
+            case response_with_unread_body
+            when Net::HTTPOK
+              return yield BodyReader.new(response_with_unread_body)
+            end
+          end
+
+          case response
+          when Net::HTTPRedirection
+            uri += response['location']
+          when Net::HTTPPartialContent
+            return yield RangeReader.new(http, uri.request_uri, response.body)
+          when Net::HTTPRequestedRangeNotSatisfiable
+            return yield StringReader.new('')
+          else
+            raise "Unexpected response: #{response}"
+          end
+        end
+
+        raise "Too many redirects: #{uri}"
+      ensure
+        http.finish if http.started?
+      end
     end
   end
 
@@ -72,7 +110,7 @@ class ImageSize
     class << self
       def open_with_uri(input, &block)
         if input.is_a?(URI)
-          yield URIReader.new(input)
+          URIReader.open(input, &block)
         else
           open_without_uri(input, &block)
         end

data/lib/image_size.rb

@@ -76,6 +76,7 @@ private
   def detect_format(ir)
     head = ir[0, 1024]
     case
+    when head.nil? || head.empty?                                 then nil
     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

data/spec/image_size/chunky_reader_spec.rb

@@ -56,9 +56,11 @@ describe ImageSize::ChunkyReader do
               offsets.each do |offset_b|
                 length = offset_b - offset
                 expect(reader[offset, length]).to eq(data[offset, length]),
-                                                  "for offset #{offset} and length #{length}\n"\
-                                                  "expected: #{data[offset, length].inspect}\n"\
-                                                  "     got: #{reader[offset, length].inspect}"
+                                                  [
+                                                    "for offset #{offset} and length #{length}",
+                                                    "expected: #{data[offset, length].inspect}",
+                                                    "     got: #{reader[offset, length].inspect}",
+                                                  ].join("\n")
               end
             end
           end

data/spec/image_size_spec.rb

@@ -7,31 +7,20 @@ require 'image_size/uri_reader'
 
 require 'tempfile'
 require 'shellwords'
-require 'webrick'
+
+require 'test_server'
 
 describe ImageSize do
   before :all do
-    @server = WEBrick::HTTPServer.new({
-      :Logger => WEBrick::Log.new(StringIO.new),
-      :AccessLog => [],
-      :BindAddress => '127.0.0.1',
-      :Port => 0, # get the next available port
-      :DocumentRoot => '.',
-    })
-    @server_thread = Thread.new{ @server.start }
-    @server_base_url = URI("http://127.0.0.1:#{@server.config[:Port]}/")
+    @server = TestServer.new
   end
 
   after :all do
-    @server.shutdown
-    @server_thread.join
+    @server.finish
   end
 
-  max_filesize = 16_384
-
-  (Dir['spec/images/*/*.*'] + [__FILE__[%r{spec/.+?\z}]]).each do |path|
-    filesize = File.size(path)
-    warn "#{path} is too big #{filesize} (max #{max_filesize})" if filesize > max_filesize
+  Dir['spec/**/*'].each do |path|
+    next unless File.file?(path)
 
     describe "for #{path}" do
       let(:name){ File.basename(path) }
@@ -49,6 +38,15 @@ describe ImageSize do
         }
       end
       let(:file_data){ File.open(path, 'rb', &:read) }
+      let(:file_size){ file_data.length }
+
+      before do
+        max_file_size = 16_384
+
+        if file_size > max_file_size
+          raise "reduce resulting gem size, #{path} is too big (#{file_size} > #{max_file_size})"
+        end
+      end
 
       context 'given as data' do
         it 'gets format and dimensions' do
@@ -65,7 +63,11 @@ describe ImageSize do
             image_size = ImageSize.new(io)
             expect(image_size).to have_attributes(attributes)
             expect(io).not_to be_closed
-            expect(io.pos).to_not be_zero
+            if file_size.zero?
+              expect(io.pos).to be_zero
+            else
+              expect(io.pos).to_not be_zero
+            end
             io.rewind
             expect(io.read).to eq(file_data)
           end
@@ -102,7 +104,11 @@ describe ImageSize do
             image_size = ImageSize.new(io)
             expect(image_size).to have_attributes(attributes)
             expect(io).not_to be_closed
-            expect(io.pos).to_not be_zero
+            if file_size.zero?
+              expect(io.pos).to be_zero
+            else
+              expect(io.pos).to_not be_zero
+            end
             io.rewind
             expect(io.read).to eq(file_data)
           end
@@ -117,9 +123,54 @@ describe ImageSize do
       end
 
       context 'fetching from webserver' do
-        it 'gets format and dimensions' do
-          image_size = ImageSize.url(@server_base_url + path)
-          expect(image_size).to have_attributes(attributes)
+        let(:file_url){ @server.base_url + path }
+
+        context 'supporting range' do
+          context 'without redirects' do
+            it 'gets format and dimensions' do
+              image_size = ImageSize.url(file_url)
+              expect(image_size).to have_attributes(attributes)
+            end
+          end
+
+          context 'with redirects' do
+            it 'gets format and dimensions' do
+              image_size = ImageSize.url("#{file_url}?redirect=5")
+              expect(image_size).to have_attributes(attributes)
+            end
+          end
+
+          context 'with too many redirects' do
+            it 'gets format and dimensions' do
+              expect do
+                ImageSize.url("#{file_url}?redirect=6")
+              end.to raise_error(/Too many redirects/)
+            end
+          end
+        end
+
+        context 'not supporting range' do
+          context 'without redirects' do
+            it 'gets format and dimensions' do
+              image_size = ImageSize.url("#{file_url}?ignore_range")
+              expect(image_size).to have_attributes(attributes)
+            end
+          end
+
+          context 'with redirects' do
+            it 'gets format and dimensions' do
+              image_size = ImageSize.url("#{file_url}?ignore_range&redirect=5")
+              expect(image_size).to have_attributes(attributes)
+            end
+          end
+
+          context 'with too many redirects' do
+            it 'gets format and dimensions' do
+              expect do
+                ImageSize.url("#{file_url}?ignore_range&redirect=6")
+              end.to raise_error(/Too many redirects/)
+            end
+          end
         end
       end
     end

data/spec/test_server.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'webrick'
+
+class TestServer
+  attr_reader :base_url
+
+  def initialize(host = '127.0.0.1')
+    server_options = {
+      :Logger => WEBrick::Log.new(StringIO.new),
+      :AccessLog => [],
+      :BindAddress => host,
+      :Port => 0, # get the next available port
+      :DocumentRoot => '.',
+      :RequestCallback => proc do |req, res|
+        redirect = req.query['redirect'].to_i
+        if redirect > 0
+          res.set_redirect(
+            WEBrick::HTTPStatus::TemporaryRedirect,
+            [
+              req.request_uri.port == @base_url.port ? @second_url : @base_url,
+              req.request_uri.request_uri,
+              "?#{encode_www_form(req.query.merge('redirect' => redirect - 1))}",
+            ].inject(:+)
+          )
+        end
+
+        req.header.delete('range') if req.query['ignore_range']
+      end,
+    }
+
+    @server = WEBrick::HTTPServer.new(server_options)
+    @server.listen(host, 0) # listen on second port
+
+    @base_url = URI("http://#{host}:#{@server.listeners[0].addr[1]}/")
+    @second_url = URI("http://#{host}:#{@server.listeners[1].addr[1]}/")
+
+    @thread = Thread.new{ @server.start }
+  end
+
+  def finish
+    @server.shutdown
+    @thread.join
+  end
+
+private
+
+  if URI.respond_to?(:encode_www_form)
+    def encode_www_form(h)
+      URI.encode_www_form(h)
+    end
+  else
+    require 'cgi'
+
+    def encode_www_form(h)
+      h.map do |k, v|
+        "#{CGI.escape(k)}=#{CGI.escape(v.to_s)}"
+      end.join('&')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_size
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Keisuke Minami
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/check.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -85,6 +86,7 @@ files:
 - spec/images/bmp/v3-bottom2top.42x50.bmp
 - spec/images/bmp/v3-top2bottom.42x50.bmp
 - spec/images/cur/32x256.cur
+- spec/images/empty
 - spec/images/gif/668x481.gif
 - spec/images/ico/32x256.ico
 - spec/images/jp2/163x402.jp2
@@ -118,13 +120,14 @@ files:
 - spec/images/xbm/crlf.16x32.xbm
 - spec/images/xpm/24x32.xpm
 - spec/images/xpm/crlf.24x32.xpm
+- spec/test_server.rb
 homepage: https://github.com/toy/image_size
 licenses:
 - Ruby
 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.0.1
+  documentation_uri: https://www.rubydoc.info/gems/image_size/3.1.0
   source_code_uri: https://github.com/toy/image_size
 post_install_message:
 rdoc_options: []
@@ -141,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Measure image size using pure Ruby
@@ -154,6 +157,7 @@ test_files:
 - spec/images/bmp/v3-bottom2top.42x50.bmp
 - spec/images/bmp/v3-top2bottom.42x50.bmp
 - spec/images/cur/32x256.cur
+- spec/images/empty
 - spec/images/gif/668x481.gif
 - spec/images/ico/32x256.ico
 - spec/images/jp2/163x402.jp2
@@ -187,3 +191,4 @@ test_files:
 - spec/images/xbm/crlf.16x32.xbm
 - spec/images/xpm/24x32.xpm
 - spec/images/xpm/crlf.24x32.xpm
+- spec/test_server.rb