rmagick 2.16.0 → 5.5.0

data/CONTRIBUTING.md

@@ -20,8 +20,13 @@ RMagick is a Ruby gem with a C extension. The extension wraps the ImageMagick C
 Priorities
 ----------
 
-1. Green build of the gem on all operating systems. You can see the current build state on [the project page at Travis CI](https://travis-ci.org/rmagick/rmagick). You are welcome to improve it.
-2. [Open issues](https://github.com/rmagick/rmagick/issues). You are welcome to reproduce them, report current state, suggest solutions, open pull requests with fixes. If you don't know where to start, sort issues by least recently updated. You can also [subscribe to receive random issues by email](http://www.codetriage.com/rmagick/rmagick).
+1.  [Open issues][open-issues]. You are welcome to reproduce them, report
+  current state, suggest solutions, open pull requests with fixes. If you
+  don't know where to start, sort issues by least recently updated. You can
+  also [subscribe to receive random issues by email][codetriage].
+
+2.  [CodeClimate Issues][codeclimate-issues]. You can install [CodeClimate
+  Browser Extension][codeclimate-extension] to see them right on GitHub.
 
 
 Testing
@@ -33,18 +38,44 @@ If you write new tests, please do it in RSpec.
 
 You are also welcome to convert existing Test/Unit tests to RSpec.
 
+Run all tests:
+
+    bundle exec rake
+
+It will run RSpec and Minitest tests.
+
+Useful information about RSpec:
+* [Better Specs](http://www.betterspecs.org/) — how to write RSpec tests better
+* [RSpec matchers cheat sheet](http://cheatrags.com/rspec-matchers) - how to use RSpec matchers to test different things
+
 
 Committing
 ----------
 
-All work for a next release is done in the `develop` branch. Please create your branch off of it.
-
 It is better if you follow [Git Style Guide](https://github.com/agis-/git-style-guide).
 
 
 Pull Requests
 -------------
 
-Please choose the `rmagick/rmagick` repo and the `develop` branch as the destination for your pull request.
+Please choose the `rmagick/rmagick` repo as the destination for your pull
+request. GitHub may suggest `rmagick-temp/rmagick` repo by default. **This is
+incorrect.** Please switch to `rmagick/rmagick`. It should be the next repo in
+the drop-down list.
+
+Every pull request is tested on GitHub Actions to cover Linux builds and Windows builds.
+It runs all tests on several Ruby and ImageMagick versions.
+
+A quick way to fix formatting errors is to run `bundle exec rubocop --autocorrect path/to/file.rb`.
+
+If you add new classes or methods, please add tests for them as well.
+RSpec is preferred (see above).
+Tests should test all possible branches of code execution (all conditions in `if`/`case` statements, etc.) to avoid errors later.
+
+Thanks
+------
 
-NOTE: GitHub suggests `rmagick-temp/rmagick` repo by default. **This is incorrect.** Please switch to `rmagick/rmagick`. It should be the next repo in the drop-down list.
+[open-issues]: https://github.com/rmagick/rmagick/issues
+[codetriage]: http://www.codetriage.com/rmagick/rmagick
+[codeclimate-issues]: https://codeclimate.com/github/rmagick/rmagick/issues
+[codeclimate-extension]: https://docs.codeclimate.com/docs/browser-extension

data/Gemfile

@@ -3,8 +3,22 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rmagick.gemspec
 gemspec
 
-group :development, :test do
-  gem 'simplecov', :require => false
+gem 'pry', '~> 0.14'
+gem 'rake-compiler', '~> 1.0'
+gem 'rspec', '~> 3.8'
+gem 'rspec_junit_formatter', '~> 0.6.0'
+gem 'simplecov', '~> 0.16.1'
+gem 'yard', '~> 0.9.24'
+
+if RUBY_PLATFORM !~ /mswin|mingw/
+  gem 'rubocop', '~> 0.81.0'
+  gem 'rubocop-rspec', '~> 1.38.1'
+  gem 'rubocop-performance', '~> 1.5.2'
+end
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
+  # For CI
+  gem 'rbs', '~> 3.4'
+
+  gem 'steep', '~> 1.6'
 end
-# Used by README.textile
-# gem "RedCloth"

data/README.md

@@ -0,0 +1,319 @@
+RMagick
+=======
+
+[![GemVersion](https://img.shields.io/gem/v/rmagick.svg?style=flat)](https://rubygems.org/gems/rmagick)
+![CI](https://github.com/rmagick/rmagick/workflows/CI/badge.svg)
+
+Table of Contents
+-----------------
+
+-   [Introduction](#introduction)
+-   [Prerequisites](#prerequisites)
+-   [Installing RMagick](#installing-rmagick)
+-   [Using RMagick](#using-rmagick)
+-   [Things that can go wrong](#things-that-can-go-wrong)
+-   [Upgrading](#upgrading)
+-   [More samples](#more-samples)
+-   [Reporting Bugs](#reporting-bugs)
+-   [Development Setup](#development-setup)
+-   [Credits](#credits)
+-   [License](#mit-license)
+-   [Releasing](#releasing)
+
+Introduction
+------------
+
+RMagick is an interface between the Ruby programming language and the
+ImageMagick image processing library.
+
+Prerequisites
+-------------
+
+These prerequisites are required for the latest version of RMagick.
+
+**OS**
+- Linux
+- \*BSD
+- macOS
+- Windows
+- Other \*nix-like systems
+
+**C++ compiler**
+- RMagick 5.4.0 or later requires a C++ compiler.
+
+**Ruby**
+- Version 2.3 or later.
+
+You can get Ruby from <https://www.ruby-lang.org>.
+
+Ruby must be able to build C-Extensions (e.g. MRI, Rubinius, not JRuby)
+
+**ImageMagick**
+- Version 6.7.7 or later (6.x.x).
+- Version 7.0.8 or later (7.x.x). Require RMagick 4.1.0 or later.
+
+You can get ImageMagick from <https://imagemagick.org>.
+
+### Linux
+#### Ubuntu
+On Ubuntu, you can run:
+
+```sh
+sudo apt-get install libmagickwand-dev
+```
+
+#### Centos
+On Centos, you can run:
+
+```sh
+sudo yum install ImageMagick-devel
+```
+
+#### Arch Linux
+On Arch Linux, you can run:
+
+```sh
+pacman -Syy imagemagick
+```
+
+#### Alpine Linux
+On Alpine Linux, you can run:
+
+```
+apk add imagemagick imagemagick-dev imagemagick-libs
+```
+
+or you can run if you would like to use ImageMagick 6:
+
+```
+apk add imagemagick6 imagemagick6-dev imagemagick6-libs
+```
+
+### macOS
+On macOS, you can run:
+
+```sh
+brew install imagemagick
+```
+
+or you can run if you would like to use ImageMagick 6:
+
+```sh
+brew install imagemagick@6
+```
+
+### Windows
+1. Install latest Ruby+Devkit package which you can get from [RubyInstaller for Windows](https://rubyinstaller.org).
+2. You might need to configure `PATH` environment variable to where the compiler is located.
+   (Ex: `set PATH=C:\Ruby27-x64\msys64\usr\bin;C:\Ruby27-x64\msys64\mingw64\bin;%PATH%`)
+3. Download `ImageMagick-7.XXXX-Q16-x64-dll.exe` (not, `ImageMagick-7.XXXX-Q16-x64-static.exe`) binary from [Windows Binary Release](https://imagemagick.org/script/download.php#windows), or you can download ImageMagick 6 from [Windows Binary Release](https://legacy.imagemagick.org/script/download.php#windows).
+4. Install ImageMagick. You need to turn on checkboxes `Add application directory to your system path` and `Install development headers and libraries for C and C++` in an installer for RMagick.
+<img width="50%" src="https://user-images.githubusercontent.com/199156/77183472-b72cbd00-6b11-11ea-8b9a-247bc1f9d8b1.png" />
+
+Installing RMagick
+------------------
+
+### Installing via Bundler
+
+Add to your `Gemfile`:
+
+```rb
+gem 'rmagick'
+```
+
+Then run:
+
+```sh
+bundle install
+```
+
+### Installing via RubyGems
+
+Run:
+
+```sh
+gem install rmagick
+```
+
+### Versioning
+
+RMagick is versioned according to Semantic Versioning. For stable version
+compatible with Ruby 1.8+, use `~> 2.0`. Versions >= 3 work on Ruby >= 2.x
+only.
+
+Using RMagick
+-------------
+
+Require RMagick in your project as follows:
+
+```rb
+require 'rmagick'
+```
+
+See <https://rmagick.github.io/usage.html> for links to more information.
+
+Things that can go wrong
+------------------------
+
+The [RMagick installation FAQ][faq] has answers to the most commonly reported
+problems, though may be out of date.
+
+### Can't install RMagick. Can't find libMagick or one of the dependent libraries. Check the mkmf.log file for more detailed information
+
+Typically this message means that one or more of the libraries that ImageMagick
+depends on hasn't been installed. Examine the mkmf.log file in the ext/RMagick
+subdirectory of the installation directory for any error messages. These
+messages typically contain enough additional information for you to be able to
+diagnose the problem. Also see [this FAQ][libmagick-faq].
+
+### Cannot open shared object file
+
+If you get a message like this:
+
+```sh
+$DIR/RMagick.rb:11:in `require': libMagick.so.0:
+  cannot open shared object file: No such file or directory -
+  $DIR/RMagick2.so (LoadError)
+```
+
+you probably do not have the directory in which the ImageMagick library
+is installed in your load path. An easy way to fix this is to define
+the directory in the `LD_LIBRARY_PATH` environment variable. For
+example, suppose you installed the ImageMagick library `libMagick.so` in
+`/usr/local/lib`. (By default this is where it is installed.) Create the
+`LD_LIBRARY_PATH` variable like this:
+
+```sh
+export LD_LIBRARY_PATH=/usr/local/lib
+```
+
+On Linux, see `ld(1)` and `ld.so(8)` for more information. On other operating
+systems, see the documentation for the dynamic loading facility.
+
+This operation might not be required when you can use 4.2.5 or later.
+
+### Segmentation fault
+
+Default stack size of your operating system might be too small. Try removing
+the limit with this command:
+
+```sh
+ulimit -s unlimited
+```
+
+Upgrading
+---------
+
+If you upgrade to a newer release of ImageMagick, make sure you're using a
+release of RMagick that supports that release. It's safe to install a new
+release of RMagick over an earlier release.
+
+More samples
+------------
+
+You can find more sample RMagick programs in the `/examples` directory. These
+programs are not installed in the RMagick documentation tree.
+
+Reporting bugs
+--------------
+
+Please report bugs in RMagick, its documentation, or its installation programs
+via the bug tracker on the [RMagick issues page][issues].
+
+However, We can't help with Ruby installation and configuration or ImageMagick
+installation and configuration. Information about reporting problems and
+getting help for ImageMagick is available at the [ImageMagick
+website][imagemagick] or the [ImageMagick Forum][imagemagick-forum].
+
+Development Setup
+-----------------
+
+In order to minimize issues on your local machine, we recommend that you make
+use of a [Vagrant installation][dev-box].
+
+Steps to get up and running with a passing build are as follows:
+
+### 1) set up the Vagrant environment
+
+If you don't already have Vagrant installed, you can download and install it
+from [here][vagrant]. Once installed, we can set up a pre-built environment:
+
+```sh
+git clone https://github.com/tjschuck/rake-compiler-dev-box.git
+cd rake-compiler-dev-box
+vagrant up
+```
+
+This last part will probably take a while as it has to download an Ubuntu image
+and configure it. If there is an error during this process, you may need to
+reboot your computer and enable virtualization in your BIOS settings.
+
+### 2) clone RMagick and log in to the vagrant box
+
+Within the `rake-compiler-dev-box` directory:
+
+```sh
+git clone https://github.com/rmagick/rmagick.git # or your fork
+vagrant ssh
+```
+
+### 3) install ImageMagick and additional environment stuff
+
+```sh
+cd /vagrant/rmagick
+export IMAGEMAGICK_VERSION=6.8.9-10
+bash ./before_install_linux.sh
+```
+
+This will take just a few minutes to build ImageMagick
+
+### 4) build RMagick
+
+```sh
+rake
+```
+
+This compiles the RMagick extensions and runs the tests. If all goes well
+you'll see a lot of output, eventually ending in something like:
+
+```sh
+Finished tests in 35.865734s, 11.3758 tests/s, 6560.3007 assertions/s.
+
+408 tests, 235290 assertions, 0 failures, 0 errors, 0 skips
+```
+
+And you're all set! The copy of RMagick within `/vagrant/rmagick` inside your
+Vagrant session is the same as the one in the `rake-compiler-dev-box` directory
+on your machine. You can make changes locally and run tests within your `ssh`
+session.
+
+Credits
+-------
+
+**Authors:** Tim Hunter, Omer Bar-or, Benjamin Thomas
+
+Thanks to [ImageMagick Studio LLC][imagemagick] for ImageMagick and for hosting
+the RMagick documentation.
+
+License
+-----------
+
+[MIT License](LICENSE)
+
+Releasing
+---------
+
+See <https://github.com/rmagick/rmagick/wiki/Release-Process>
+
+1.  Update ChangeLog
+2.  Edit `lib/rmagick/version.rb`
+3.  Are the tests passing? Run `rake` again just to be sure.
+4.  `rake release`
+
+[issues]: https://github.com/rmagick/rmagick/issues
+[libmagick-faq]: https://web.archive.org/web/20140512193354/https://rmagick.rubyforge.org/install-faq.html#libmagick
+[faq]: https://web.archive.org/web/20140512193354/https://rmagick.rubyforge.org/install-faq.html
+[imagemagick]: https://imagemagick.org
+[imagemagick-forum]: https://imagemagick.org/discourse-server
+[dev-box]: https://github.com/tjschuck/rake-compiler-dev-box
+[vagrant]: https://www.vagrantup.com/

data/Rakefile

@@ -3,21 +3,28 @@ require './lib/rmagick/version'
 require 'fileutils'
 require 'English'
 
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -r ./ext/RMagick/extconf.rb -r ./lib/rmagick.rb"
+end
+
 task :config do
   def version
     Magick::VERSION
   end
+
   # e.g. 2.13.3 becomes RMagick_2-13-3
   def version_tag
-    "RMagick_#{version.gsub('.','-')}"
+    "RMagick_#{version.tr('.', '-')}"
   end
+
   # e.g. 2.13.3 becomes rmagick-2.13.3.gem
   def gem_name
     "rmagick-#{version}.gem"
   end
 
   def base
-    File.expand_path('..', __FILE__)
+    File.expand_path(__dir__)
   end
 end
 
@@ -30,18 +37,18 @@ task :assert_clean_repo do
 end
 
 desc 'build gem'
-task :build => [:config] do
+task build: [:config] do
   sh 'gem build -V rmagick.gemspec'
   if $CHILD_STATUS.success?
     FileUtils.mkdir_p(File.join(base, 'pkg'))
     FileUtils.mv(File.join(base, gem_name), 'pkg')
   else
-    STDERR.puts 'Could not build gem'
+    warn 'Could not build gem'
     exit $CHILD_STATUS.exitstatus
   end
 end
 
-task :push_and_tag => [:build] do
+task push_and_tag: [:build] do
   sh "gem push #{File.join(base, 'pkg', gem_name)}"
   if $CHILD_STATUS.success?
     sh "git tag -a -m \"Version #{version}\" #{version_tag}"
@@ -54,117 +61,100 @@ task :push_and_tag => [:build] do
 end
 
 desc 'Release'
-task :release => [:assert_clean_repo, :push_and_tag]
-
-desc 'Release and build the legacy way'
-task :legacy_release=> ['legacy:README.html', 'legacy:extconf', 'legacy:doc', 'legacy:manifest', 'release']
+task release: %i[assert_clean_repo push_and_tag]
 
-namespace :legacy do
-  require 'find'
+namespace :website do
+  PATH_TO_LOCAL_WEBSITE_REPOSITORY = File.expand_path('../rmagick.github.io')
 
-  task :redcloth do
-    require 'redcloth'
-  end
-
-  README = 'README.html'
-  MANIFEST = 'ext/RMagick/MANIFEST'
-
-  # Change the version number placeholders in a file.
-  # Returns an array of lines from the file.
-  def reversion(name)
+  def replace_reversion(lines)
     now = Time.new
     now = now.strftime('%m/%d/%y')
 
-    lines = File.readlines name
     lines.each do |line|
-      line.gsub!(%r{0\.0\.0}, Magick::VERSION)
+      line.gsub!(/0\.0\.0/, Magick::VERSION)
       line.gsub!(%r{YY/MM/DD}, now)
     end
     lines
   end
 
-  # Rewrite a file containing embedded version number placeholders.
-  def reversion_file(name)
-    lines = reversion(name)
-    tmp_name = name + '_tmp'
-    mv name, tmp_name
-    begin
-      File.open(name, 'w') { |f| lines.each { |line| f.write line } }
-    rescue
-      mv tmp_name, name
-    ensure
-      rm tmp_name
-    end
-  end
-
-  desc 'Update version in extconf'
-  task :extconf do
-    reversion_file 'ext/RMagick/extconf.rb'
+  def update_html(input_dir, output_dir, file_name)
+    lines = File.readlines(File.join(input_dir, file_name))
+    lines = replace_reversion(lines)
+    File.open(File.join(output_dir, file_name), 'w') { |f| lines.each { |line| f.write line } }
   end
 
-  desc 'Build README.txt from README.textile using RedCloth'
-  task 'README.txt' => [:redcloth] do
-    reversion_file 'README.textile'
-    body = File.readlines 'README.textile'
-    body = RedCloth.new(body.join).to_html + "\n"
-    File.open('README.txt', 'w') { |f| f.write body }
+  ENTITY = {
+    '&' => '&',
+    '>' => '>',
+    '<' => '&lt;'
+  }.freeze
+
+  def file_to_html(input_dir, input_file_name, output_dir, output_file_name)
+    File.open(File.join(input_dir, input_file_name)) do |src|
+      File.open(File.join(output_dir, output_file_name), 'w') do |dest|
+        dest.puts <<~END_EXHTMLHEAD
+          <!DOCTYPE public PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+          <html xmlns="http://www.w3.org/1999/xhtml">
+          <head>
+            <meta name="generator" content="ex2html.rb" />
+            <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+            <link rel="stylesheet" type="text/css" href="css/popup.css" />
+            <title>RMagick example: #{input_file_name}</title>
+          </head>
+          <body>
+          <h1>#{input_file_name}</h1>
+          <div class="bodybox">
+          <div class="bodyfloat">
+          <pre>
+        END_EXHTMLHEAD
+
+        src.each do |line|
+          line.gsub!(/[&><]/) { |s| ENTITY[s] }
+          dest.puts(line)
+        end
+
+        dest.puts <<~END_EXHTMLTAIL
+          </pre>
+          </div>
+          </div>
+          <div id="close"><a href="javascript:window.close();">Close window</a></div>
+          </body>
+          </html>
+        END_EXHTMLTAIL
+      end
+    end
   end
 
-  desc 'Build README.html from README.txt'
-  task README => 'README.txt' do
-    puts "writing #{README}"
-    File.open(README, 'w') do |html|
-      html.write <<END_HTML_HEAD
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-  <head>
-    <title>RMagick #{Magick::VERSION} README</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-    <meta name="GENERATOR" content="RedCloth">
-  </head>
-  <body>
-END_HTML_HEAD
-      html.write File.readlines('README.txt')
-      html.write <<END_HTML_TAIL
-  </body>
-</html>
-END_HTML_TAIL
+  desc 'Update RMagick website'
+  task :update do
+    unless File.exist?(PATH_TO_LOCAL_WEBSITE_REPOSITORY)
+      puts "Please clone the rmagick.github.io repository to #{PATH_TO_LOCAL_WEBSITE_REPOSITORY}"
+      exit 1
     end
-  end
 
-  desc 'Update versions in html files'
-  task :doc do
-    Dir.chdir('doc') do
-      FileList['*.html'].each { |d| reversion_file(d) }
+    Dir.glob('doc/*.html') do |file|
+      update_html('doc', PATH_TO_LOCAL_WEBSITE_REPOSITORY, File.basename(file))
     end
-  end
 
-  # Remove files we don't want in the tarball.
-  # Ensure files are not executable. (ref: bug #10080)
-  desc "Remove files we don't want in the .gem; ensure files are not executable"
-  task :fix_files do
-    rm 'README.txt', :verbose => true
-    chmod 0644, FileList['doc/*.html', 'doc/ex/*.rb', 'doc/ex/images/*', 'examples/*.rb']
+    Dir.glob('doc/ex/*.rb') do |file|
+      file_name = File.basename(file)
+      file_to_html('doc/ex', file_name, PATH_TO_LOCAL_WEBSITE_REPOSITORY, "#{file_name}.html")
+    end
   end
+end
 
-  desc 'Build manifest'
-  task :manifest do
-    now = Time.new
-    now = now.strftime('%H:%M:%S %m/%d/%y')
-    puts "generating #{MANIFEST}"
-
-    File.open(MANIFEST, 'w') do |f|
-      f.puts "MANIFEST for #{Magick::VERSION} - #{now}\n\n"
-      Find.find('.') do |name|
-        next if File.directory? name
-        f.puts name[2..-1]    # remove leading "./"
-      end
+namespace :rbs do
+  desc 'Validate RBS definitions'
+  task :validate do
+    all_sigs = Dir.glob('sig').map { |dir| "-I #{dir}" }.join(' ')
+    sh("bundle exec rbs #{all_sigs} validate") do |ok, _|
+      abort('one or more rbs validate failed') unless ok
     end
   end
 end
 
+require 'bundler/gem_tasks'
 require 'rake/extensiontask'
-require 'rake/testtask'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
@@ -172,17 +162,12 @@ Rake::ExtensionTask.new('RMagick2') do |ext|
   ext.ext_dir = 'ext/RMagick'
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-end
-
-task :test => :compile
-task :spec => :compile
+task spec: :compile
 
 if ENV['STYLE_CHECKS']
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-  task :default => [:spec, :test, :rubocop]
+  task default: %i[rubocop]
 else
-  task :default => [:spec, :test]
+  task default: %i[spec]
 end