rmagick 4.0.0 → 5.3.0

data/README.md

@@ -0,0 +1,316 @@
+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
+
+**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 gcc ImageMagick-devel make which
+```
+
+#### 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

@@ -43,7 +43,7 @@ task build: [:config] do
     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
@@ -63,26 +63,13 @@ end
 desc 'Release'
 task release: %i[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']
+namespace :website do
+  PATH_TO_LOCAL_WEBSITE_REPOSITORY = File.expand_path('../rmagick.github.io')
 
-namespace :legacy do
-  require 'find'
-
-  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!(/0\.0\.0/, Magick::VERSION)
       line.gsub!(%r{YY/MM/DD}, now)
@@ -90,89 +77,73 @@ namespace :legacy do
     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 StandardError
-      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 }
-  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
+  ENTITY = {
+    '&' => '&amp;',
+    '>' => '&gt;',
+    '<' => '&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 'Update versions in html files'
-  task :doc do
-    Dir.chdir('doc') do
-      FileList['*.html'].each { |d| reversion_file(d) }
+  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
-
-  # 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 0o644, FileList['doc/*.html', 'doc/ex/*.rb', 'doc/ex/images/*', 'examples/*.rb']
-  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
+    Dir.glob('doc/*.html') do |file|
+      update_html('doc', PATH_TO_LOCAL_WEBSITE_REPOSITORY, File.basename(file))
+    end
 
-        f.puts name[2..-1] # remove leading "./"
-      end
+    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
 
 require 'rake/extensiontask'
-require 'rake/testtask'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
@@ -180,11 +151,6 @@ 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
 
 if ENV['STYLE_CHECKS']
@@ -192,5 +158,5 @@ if ENV['STYLE_CHECKS']
   RuboCop::RakeTask.new
   task default: %i[rubocop]
 else
-  task default: %i[spec test]
+  task default: %i[spec]
 end

data/before_install_linux.sh

@@ -1,6 +1,8 @@
+#!/usr/bin/env bash
+
 set -euox pipefail
 
-gem install bundler
+gem install bundler -v 2.3.26 # Bundler 2.4.x has dropped support for Ruby 2.3
 
 if [ -v STYLE_CHECKS ]; then
   set +ux
@@ -13,62 +15,54 @@ if [ ! -v IMAGEMAGICK_VERSION ]; then
   exit 1
 fi
 
+sudo apt-get clean
+sudo apt-get update
+
 # remove all existing imagemagick related packages
 sudo apt-get autoremove -y imagemagick* libmagick* --purge
 
-if [ ! -v TRAVIS ]; then
-  sudo apt-get update
-
-  # install build tools, ImageMagick delegates
-  sudo apt-get install -y build-essential libx11-dev libxext-dev zlib1g-dev \
-    liblcms2-dev libpng-dev libjpeg-dev libfreetype6-dev libxml2-dev \
-    libtiff5-dev libwebp-dev vim ghostscript ccache
-fi
+# install build tools, ImageMagick delegates
+sudo apt-get install -y build-essential libx11-dev libxext-dev zlib1g-dev \
+  liblcms2-dev libpng-dev libjpeg-dev libfreetype6-dev libxml2-dev \
+  libtiff5-dev libwebp-dev liblqr-1-0-dev vim gsfonts ghostscript
 
 if [ ! -d /usr/include/freetype ]; then
   # If `/usr/include/freetype` is not existed, ImageMagick 6.7 configuration fails about Freetype.
   sudo ln -sf /usr/include/freetype2 /usr/include/freetype
 fi
 
-project_dir=`pwd`
-build_dir=${project_dir}/build-ImageMagick/ImageMagick-${IMAGEMAGICK_VERSION}
+project_dir=$(pwd)
+build_dir="${project_dir}/build-ImageMagick/ImageMagick-${IMAGEMAGICK_VERSION}"
 if [ -v CONFIGURE_OPTIONS ]; then
-  build_dir=${build_dir}-${CONFIGURE_OPTIONS}
+  build_dir="${build_dir}-${CONFIGURE_OPTIONS}"
 fi
 
 build_imagemagick() {
   mkdir -p build-ImageMagick
 
   version=(${IMAGEMAGICK_VERSION//./ })
-  if (( "${version[0]}${version[1]}" >= 69 )); then
-    wget https://github.com/ImageMagick/ImageMagick6/archive/${IMAGEMAGICK_VERSION}.tar.gz
-    tar -xf ${IMAGEMAGICK_VERSION}.tar.gz
-    rm ${IMAGEMAGICK_VERSION}.tar.gz
-    mv ImageMagick6-${IMAGEMAGICK_VERSION} $build_dir
-  else
-    wget https://www.imagemagick.org/download/releases/ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz
-    tar -xf ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz
-    rm ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz
-    mv ImageMagick-${IMAGEMAGICK_VERSION} $build_dir
-  fi
+  wget "https://imagemagick.org/archive/releases/ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  tar -xf "ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  rm "ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  mv "ImageMagick-${IMAGEMAGICK_VERSION}" "${build_dir}"
 
   options="--with-magick-plus-plus=no --disable-docs"
   if [ -v CONFIGURE_OPTIONS ]; then
-    options="${CONFIGURE_OPTIONS} $options"
+    options="${CONFIGURE_OPTIONS} ${options}"
   fi
 
-  cd $build_dir
-  CC="ccache cc" CXX="ccache c++" ./configure --prefix=/usr $options
+  cd "${build_dir}"
+  ./configure --prefix=/usr "${options}"
   make -j
 }
 
-if [ ! -d $build_dir ]; then
+if [ ! -d "${build_dir}" ]; then
   build_imagemagick
 fi
 
-cd $build_dir
+cd "${build_dir}"
 sudo make install -j
-cd $project_dir
+cd "${project_dir}"
 
 sudo ldconfig
 

data/before_install_osx.sh

@@ -1,2 +1,58 @@
-brew update
-brew install imagemagick
+#!/usr/bin/env bash
+
+set -euox pipefail
+
+gem install bundler -v 2.3.26 # Bundler 2.4.x has dropped support for Ruby 2.3
+
+if [ -v STYLE_CHECKS ]; then
+  set +ux
+  exit 0
+fi
+
+if [ ! -v IMAGEMAGICK_VERSION ]; then
+  echo "you must specify an ImageMagick version."
+  echo "example: 'IMAGEMAGICK_VERSION=6.8.9-10 bash ./before_install_osx.sh'"
+  exit 1
+fi
+
+export HOMEBREW_NO_AUTO_UPDATE=true
+brew uninstall --force imagemagick imagemagick@6
+brew install wget ghostscript freetype jpeg little-cms2 openexr libomp libpng libtiff liblqr libtool zlib webp
+
+export LDFLAGS="-L$(brew --prefix libxml2)/lib -L$(brew --prefix zlib)/lib -L$(brew --prefix glib)/lib -L$(brew --prefix openexr)/lib"
+export CPPFLAGS="-I$(brew --prefix libxml2)/include -I$(brew --prefix zlib)/include -I$(brew --prefix glib)/include/glib-2.0 -I$(brew --prefix glib)/lib/glib-2.0/include -I$(brew --prefix openexr)/include/OpenEXR"
+
+project_dir=$(pwd)
+build_dir="${project_dir}/build-ImageMagick/ImageMagick-${IMAGEMAGICK_VERSION}"
+if [ -v CONFIGURE_OPTIONS ]; then
+  build_dir="${build_dir}-${CONFIGURE_OPTIONS}"
+fi
+
+build_imagemagick() {
+  mkdir -p build-ImageMagick
+
+  version=(${IMAGEMAGICK_VERSION//./ })
+  wget "https://imagemagick.org/archive/releases/ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  tar -xf "ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  rm "ImageMagick-${IMAGEMAGICK_VERSION}.tar.xz"
+  mv "ImageMagick-${IMAGEMAGICK_VERSION}" "${build_dir}"
+
+  options="--with-magick-plus-plus=no --disable-docs"
+  if [ -v CONFIGURE_OPTIONS ]; then
+    options="${CONFIGURE_OPTIONS} ${options}"
+  fi
+
+  cd "${build_dir}"
+  ./configure --prefix=/usr/local "${options}" --without-raw
+  make -j
+}
+
+if [ ! -d "${build_dir}" ]; then
+  build_imagemagick
+fi
+
+cd "${build_dir}"
+make install -j
+cd "${project_dir}"
+
+set +ux