rmagick 4.1.0.rc2 → 4.1.0

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+lib/**/*.rb
+ext/**/*.c
+*.md
+LICENSE

data/CHANGELOG.md

@@ -3,6 +3,69 @@
 All notable changes to this project are documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## RMagick 4.1.0
+
+Improvements:
+
+- reduce package size by more than 1.5mb (#849)
+- improve memory usage (#836)
+- add support for Ruby 2.7 (#853)
+- *many* documentation fixes and cleanups
+- *many* testing fixes and cleanups
+- Support CMYK color in Image#get_pixels (#871)
+- Support to get CMYK color in Image#pixel_color (#875)
+- Support to set CMYK color in Image#pixel_color (#908)
+- Add ImageList#map (#1154)
+
+Bug Fixes:
+
+- fixed memory leaks (#809, #815, #816, #960, #1024)
+- eliminate compiler warnings (#855, #864, #878, #917, #969, #981, #996, #1000, #1044)
+- Recognize invert option in Image#opaque_channel with ImageMagick 7 (#882)
+- Fix heap-buffer-overflow in Image#wet_floor with ImageMagick 7 (#883)
+- Handle channel value with new image in Image#opaque_channel with ImageMagick 7 (#886)
+- Pass caption value into ImageMagick 7 API in Image#polaroid (#898)
+- Example: Fix “uninitialized constant Magick::TransparentOpacity” error (#899)
+- Example: Fix error of constant usage (#900)
+- Example: Fix error in doc/ex/composite.rb (#901)
+- Example: Fix error in doc/ex/crop_with_gravity.rb (#902)
+- Revert removed RemapImages() calling in ImageList#remap for ImageMagick 6 (#904)
+- Example: Fix alpha channel in examples/vignette.rb (#918)
+- Example: Fix alpha channel in doc/ex/coalesce.rb (#920)
+- Handle alpha value in Pixel#to_color (#922)
+- Detect the proper ARCHFLAGS on macOS (#923)
+- Handle boolean value as dither option in ImageList#quantize (#926)
+- Use strlcpy instead of strncpy to ensure null terminating. (#933)
+- Remove memalign() (#939)
+- Add safe strlen() to ensure avoiding buffer overrun (#940)
+- Use strlcpy() instead of strcpy() to ensure avoiding buffer overflow (#941)
+- Use snprintf() instead of sprintf() to ensure avoiding buffer overflow (#945)
+- Example: Remove unnecessary alpha setting (#950)
+- Replace to correct format specifiers for size_t/ssize_t value (#978)
+- Use proper format specifiers within MinGW (#997)
+- Fix snprintf() format specifiers for unsigned value (#1006)
+- Fix warning of “Variable is reassigned a value before the old one has been use” (#1008)
+- Fix warning of “warning: explicitly assigning value of variable of type 'int' to itself” (#1013)
+- Fix Image#resample to use blur option properly with ImageMagick 7 (#1023)
+- Fix Image#resize to use blur option properly with ImageMagick 7 (#1032)
+- Fix that Color#compliance returns nil with undefined bit (#1049)
+- Check memory API properly on Windows (#1050)
+- Example: Fix “undefined method `opacity’” (#1051)
+- Add workaround to pdf problem (#1072)
+- Fix exception message because #export_pixels accept 0 argument (#1121)
+- Fix default value of `fill` argument in Image#initialize (#1122)
+- Call rm_ensure_result() in creating Image object (#1144)
+- Use StringValueCStr() instead of StringValuePtr() (#1156)
+- Use RSTRING_PTR() to retrieve a pointer of String object for buffer (#1157)
+- Use StringValueCStr() to get null-terminated C-lang string (#1158)
+- Fix SEGV in Magick::Draw#marshal_load (#1162)
+- Fix SEGV in rm_check_ary_len() with unexpected argument value (#1168)
+- Fix SEGV in Image#marshal_load (#1169)
+
+Breaking Changes:
+
+- remove `tainted?` logic (#854)
+
 ## RMagick 4.1.0.rc2
 
 - fix a couple of compilation bugs (#796, #797)

data/CONTRIBUTING.md

@@ -20,9 +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).
-3. [CodeClimate Issues](https://codeclimate.com/github/rmagick/rmagick/issues). You can install [CodeClimate Browser Extension](https://docs.codeclimate.com/docs/browser-extension) to see them right on GitHub.
+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
@@ -59,12 +63,8 @@ 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 [Travis
-CI](https://travis-ci.org/rmagick/rmagick) to cover Linux builds,
-[Appveyor](https://ci.appveyor.com/project/mockdeep/rmagick) for Windows
-builds, and [CircleCI](https://circleci.com/gh/rmagick/rmagick) for another
-Linux environment and console access for debugging builds.  It runs all
-Minitest and RSpec tests on several Ruby and ImageMagick versions.
+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`.
 
@@ -72,6 +72,10 @@ 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
 ------
+
+[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/README.md

@@ -0,0 +1,292 @@
+RMagick
+=======
+
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/901780ea1a244a8584b18033b2e03866)](https://app.codacy.com/gh/rmagick/rmagick?utm_source=github.com&utm_medium=referral&utm_content=rmagick/rmagick&utm_campaign=Badge_Grade_Settings)
+[![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 DEVELOPMENT version of RMagick.
+To see prerequisites for the latest RELEASED version of the gem, switch to the
+master branch.
+
+**O/S** Linux, \*BSD, OS X, Windows 2000, XP, Vista, other \*nix-like systems.
+
+**Ruby** 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 has beta support in
+version 4.1.0.rc2 (#256). You can get ImageMagick from
+<https://imagemagick.org>.
+
+### Ubuntu
+On Ubuntu, you can run:
+
+```sh
+sudo apt-get install libmagickwand-dev
+```
+
+On Centos, you can run:
+
+```sh
+sudo yum install gcc ImageMagick-devel make which
+```
+
+### macOS
+On macOS, you can run:
+
+```sh
+brew install pkg-config imagemagick
+```
+
+or you can run if you would like to use ImageMagick 6:
+
+```sh
+brew install pkg-config imagemagick@6
+```
+
+### Windows
+1. Install latest Ruby+Devkit package which you can get from [RubyInstaller for Windows](https://rubyinstaller.org).
+2. 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).
+3. Install ImageMagick. You need to turn on checkboxes `Add application directory to your system path` and `Install development headers and librarries 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].
+
+On OS X with Homebrew, try (re)installing pkg-config:
+
+```sh
+brew uninstall pkg-config
+brew install pkg-config
+brew unlink pkg-config
+brew link pkg-config
+```
+
+### 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.
+
+### 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
@@ -121,21 +121,21 @@ namespace :legacy do
   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 <<~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
+      html.write <<~END_HTML_TAIL
+          </body>
+        </html>
+      END_HTML_TAIL
     end
   end
 
@@ -172,7 +172,6 @@ END_HTML_TAIL
 end
 
 require 'rake/extensiontask'
-require 'rake/testtask'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
@@ -180,11 +179,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 +186,5 @@ if ENV['STYLE_CHECKS']
   RuboCop::RakeTask.new
   task default: %i[rubocop]
 else
-  task default: %i[spec test]
+  task default: %i[spec]
 end