rmagick 4.1.0.rc2 → 4.1.0

data/README.textile

@@ -1,259 +0,0 @@
-h1. RMagick
-
-!https://img.shields.io/gem/v/rmagick.svg?style=flat!:http://rubygems.org/gems/rmagick !https://travis-ci.org/rmagick/rmagick.svg?branch=master!:https://travis-ci.org/rmagick/rmagick !https://ci.appveyor.com/api/projects/status/xw3usp6s1ghfimb4/branch/master?svg=true!:https://ci.appveyor.com/project/mockdeep/rmagick !https://circleci.com/gh/rmagick/rmagick.svg?style=svg!:https://circleci.com/gh/rmagick/rmagick
-
-h3. Table of Contents
-
-* "Introduction":#intro
-* "Prerequisites":#prereq
-* "Installing RMagick":#install
-* "Things that can go wrong":#wrong
-* "Upgrading":#upgrade
-* "More samples":#samples
-* "Reporting Bugs":#bugs
-* "Development Setup":#dev-setup
-* "Contact Information":#contact
-* "Credits":#credits
-* "License":#license
-* "Releasing":#releasing
-
-h2(#intro). Introduction
-
-RMagick is an interface between the Ruby programming language and the
-ImageMagick image processing library.
-
-h2(#prereq). 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 "www.ruby-lang.org":http://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 is NOT yet supported; ETA Summer 2019 (https://github.com/rmagick/rmagick/issues/256). You can get ImageMagick from "www.imagemagick.org":http://www.imagemagick.org.
-
-On Ubuntu, you can run:
-
-bc. sudo apt-get install libmagickwand-dev
-
-On Centos, you can run:
-
-bc. sudo yum install gcc ImageMagick-devel make which
-
-*Note to Windows users:* Please make sure that you choose an ImageMagick version that matches the bitness of your Ruby version.
-
-h2(#install). Installing RMagick
-
-h4. Installing via Bundler
-
-Add to your `Gemfile`:
-
-bc. gem 'rmagick'
-
-Then run:
-
-bc. bundle install
-
-h4. Installing via RubyGems
-
-Run:
-
-bc. gem install rmagick
-
-h4. Versioning
-
-RMagick is versioned according to Semantic Versioning.
-For stable version compatible with Ruby 1.8+, use `~> 2.0`.
-Upcoming version 3 will work on Ruby 2.x only.
-
-h2(#usage). Using RMagick
-
-Require RMagick in your project as follows:
-
-bc. require 'rmagick'
-
-See https://rmagick.github.io/usage.html for links to more information.
-
-h2(#wrong). Things that can go wrong
-
-The "RMagick installation FAQ":https://web.archive.org/web/20140512193354/http://rmagick.rubyforge.org/install-faq.html
-has answers to the most commonly reported problems, though may be out of date.
-
-h4. 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":https://web.archive.org/web/20140512193354/http://rmagick.rubyforge.org/install-faq.html#libmagick.
-
-On OS X with Homebrew, try [re]installing pkg-config:
-
-<pre>
-brew uninstall pkg-config
-brew install pkg-config
-brew unlink pkg-config
-brew link pkg-config
-</pre>
-
-h4. Cannot open shared object file
-
-If you get a message like this:
-
-<pre>
-    $DIR/RMagick.rb:11:in `require': libMagick.so.0:
-      cannot open shared object file: No such file or directory -
-      $DIR/RMagick2.so (LoadError)
-</pre>
-
-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:
-
-<pre>
-        export LD_LIBRARY_PATH=/usr/local/lib
-</pre>
-
-On Linux, see @ld(1)@ and @ld.so(8)@ for more information. On other operating
-systems, see the documentation for the dynamic loading facility.
-
-h4. Segmentation fault
-
-Default stack size of your operating system might be too small. Try removing the limit with this command:
-
-<pre>
-        ulimit -s unlimited
-</pre>
-
-h2(#upgrade). 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.
-
-h2(#samples). More samples
-
-You can find more sample RMagick programs in the /example directory.
-These programs are not installed in the RMagick documentation tree.
-
-h2(#bugs). Reporting bugs
-
-Please report bugs in RMagick, its documentation, or its installation
-programs to me via the bug tracker on the "RMagick issues page":https://github.com/rmagick/rmagick/issues
-
-However, I 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 web site":http://www.imagemagick.org
-or the "ImageMagick Forum":http://www.imagemagick.org/discourse-server.
-
-h2(#dev-setup). Development Setup
-
-In order to minimize issues on your local machine, we recommend that you make
-use of a "Vagrant installation":https://github.com/tjschuck/rake-compiler-dev-box.
-
-Steps to get up and running with a passing build are as follows:
-
-h4. 1) set up the Vagrant environment
-
-If you don't already have Vagrant installed, you can download and install it
-from "here":https://www.vagrantup.com/. Once installed, we can set up a pre-built environment:
-
-<pre>
-git clone https://github.com/tjschuck/rake-compiler-dev-box.git
-cd rake-compiler-dev-box
-vagrant up
-</pre>
-
-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.
-
-h4. 2) clone RMagick and log in to the vagrant box
-
-Within the `rake-compiler-dev-box` directory:
-
-<pre>
-git clone https://github.com/rmagick/rmagick.git # or your fork
-vagrant ssh
-</pre>
-
-h4. 3) install ImageMagick and additional environment stuff
-
-<pre>
-cd /vagrant/rmagick
-export IMAGEMAGICK_VERSION=6.8.9-10
-bash ./before_install_linux.sh
-</pre>
-
-This will take just a few minutes to build ImageMagick
-
-h4. 4) build RMagick
-
-<pre>
-rake
-</pre>
-
-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:
-
-<pre>
-Finished tests in 35.865734s, 11.3758 tests/s, 6560.3007 assertions/s.
-
-408 tests, 235290 assertions, 0 failures, 0 errors, 0 skips
-</pre>
-
-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.
-
-h2(#contact). Contact Information
-
-*Author:* Tim Hunter, Omer Bar-or, Benjamin Thomas
-
-h2(#credits). Credits
-
-Thanks to "ImageMagick Studio LLC":http://www.imagemagick.org for ImageMagick
-and for hosting the RMagick documentation.
-
-h2(#license). MIT License
-
-<pre>
-Copyright &copy; 2002-2009 by Timothy P. Hunter
-
-Changes since Nov. 2009 copyright &copy; by Benjamin Thomas and Omer Bar-or
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the "Software"),
-to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
-THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-</pre>
-
-<hr>
-
-h2(#releasing). Releasing
-
-See https://github.com/rmagick/rmagick/wiki/Release-Process
-
-# Update ChangeLog
-# Edit lib/rmagick/version.rb
-# Are the tests passing? Run `rake` again just to be sure.
-# `rake release`

data/benchmarks/memory/README.md

@@ -1,50 +0,0 @@
-# How to measure the memory usage
-
-## 1. Install gnuplot
-If you need a graph of memory usage, it can draw the graph with `gnuplot`.
-
-With `Homebrew`, you can install `gnuplot` like
-
-```
-$ brew install gnuplot
-```
-
-## 2. Retrieve two performance data `before` / `after`
-Retrieve data before applying patches.
-
-```
-$ rake build
-$ gem install pkg/rmagick-3.1.0.gem
-$ cd benchmarks/memory
-$ ruby image_new.rb > before.csv
-```
-
-Apply the patches then retrieve improved data.
-
-```
-$ rake build
-$ gem install pkg/rmagick-3.1.0.gem
-$ cd benchmarks/memory
-$ ruby image_new.rb > after.csv
-```
-
-## 3. Draw the performance graph
-Launch `gnuplot` and execute `load 'rmagick.gnuplot'` command in prompt then the performance graph will be drew.
-
-```
-$ cd benchmarks/memory
-$ gnuplot
-
-	G N U P L O T
-	Version 5.2 patchlevel 7    last modified 2019-05-29
-
-	Copyright (C) 1986-1993, 1998, 2004, 2007-2018
-	Thomas Williams, Colin Kelley and many others
-
-	gnuplot home:     http://www.gnuplot.info
-	faq, bugs, etc:   type "help FAQ"
-	immediate help:   type "help"  (plot window: hit 'h')
-
-Terminal type is now 'qt'
-gnuplot> load 'rmagick.gnuplot'
-```

data/benchmarks/memory/image_new.rb

@@ -1,8 +0,0 @@
-require 'rmagick'
-
-1000.times do |i|
-  Magick::Image.new(1000, 1000)
-
-  rss = Integer(`ps -o rss= -p #{Process.pid}`) / 1024.0
-  puts "#{i},#{rss}"
-end

data/benchmarks/memory/rmagick.gnuplot

@@ -1,16 +0,0 @@
-set datafile separator ","
-
-set key outside center top horizontal reverse Left samplen 2
-unset border
-set xtics scale 0
-set ytics scale 0
-set grid ytics linewidth 1 linetype -1
-
-set style line 1 lt 1 lc rgbcolor "#3465a4" lw 2.5 pt 7 ps 1
-set style line 2 lt 1 lc rgbcolor "#ff6347" lw 2.5 pt 7 ps 1
-set style line 3 lt 1 lc rgbcolor "#888a85" lw 2.5 pt 5 ps 1
-
-set xlabel "Nth loop"
-set ylabel "Memory usage (MiB)"
-
-plot "before.csv" with line linestyle 1, "after.csv" with line linestyle 2

data/doc/.cvsignore

@@ -1 +0,0 @@
-c

data/doc/comtasks.html

@@ -1,287 +0,0 @@
-<!DOCTYPE html 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=
-  "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-
-  <title>RMagick 0.0.0: Common Tasks</title>
-  <meta http-equiv="Content-Type" content=
-  "text/html; charset=us-ascii" />
-  <meta name="GENERATOR" content="Quanta Plus" />
-  <meta name="Copyright" content=
-  "Copyright (C) 2006 by Timothy P. Hunter" />
-  <link rel="stylesheet" type="text/css" href="css/doc.css" />
-<script type="text/javascript" src="scripts/doc.js">
-</script>
-<style type="text/css">
-  /*<![CDATA[*/
-
-  /* Styles local to this page. */
-  #drop_shadow {
-    margin-left: auto;
-    margin-right: auto;
-    width: 250px;
-  }
-
-
-  /*]]>*/
-</style>
-</head>
-
-<body>
-  <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
-
-  <div class="nav">
-    &laquo;&nbsp;<a href="optequiv.html">Prev</a> | <a href=
-    "index.html">Contents</a> | <a href=
-    "magick.html">Next</a>&nbsp;&raquo;
-  </div>
-
-  <h1>Common Tasks</h1>
-
-  <div id="toc">
-    <h2>Table of Contents</h2>
-
-    <ul style="margin-left: 15px; padding-top: 1em;">
-      <li><a href="#info">Getting information about an
-      image</a></li>
-
-      <li><a href="#convert">Converting an image to another
-      format</a></li>
-
-      <li><a href="#thumb">Making thumbnails</a></li>
-
-      <li><a href="#resizing">Resizing to a maximum (or minimum)
-      size</a></li>
-
-      <li><a href="#blob">Writing to or reading from a string
-      instead of a file</a></li>
-
-      <li><a href="#gray">Converting a color image to
-      grayscale</a></li>
-
-      <li><a href="#compressing">Compressing image files</a></li>
-
-      <li><a href="#shadow">Making a drop shadow</a></li>
-    </ul>
-  </div>
-
-  <h2 id="info">Getting information about an image</h2>
-
-  <p>One of the most fundamental operations on an image is simply
-  getting basic information about the image. RMagick assigns dozens
-  of <a href="imageattrs.html">attributes</a> to an image. All you
-  have to do is read the image and then call the attribute methods.
-  Here's a Ruby program that takes image filenames from the command
-  line and then prints a variety of information about each image to
-  the terminal.</p>
-  <pre class="example">
-require "rmagick"
-ARGV.each { |file|
-    puts file
-    img = Magick::Image::read(file).first
-    puts "   Format: #{img.format}"
-    puts "   Geometry: #{img.columns}x#{img.rows}"
-    puts "   Class: " + case img.class_type
-                            when Magick::DirectClass
-                                "DirectClass"
-                            when Magick::PseudoClass
-                                "PseudoClass"
-                        end
-    puts "   Depth: #{img.depth} bits-per-pixel"
-    puts "   Colors: #{img.number_colors}"
-    puts "   Filesize: #{img.filesize}"
-    puts "   Resolution: #{img.x_resolution.to_i}x#{img.y_resolution.to_i} "+
-        "pixels/#{img.units == Magick::PixelsPerInchResolution ?
-        "inch" : "centimeter"}"
-    if img.properties.length &gt; 0
-        puts "   Properties:"
-        img.properties { |name,value|
-            puts %Q|      #{name} = "#{value}"|
-        }
-    end
-    }
-</pre>
-
-  <h2 id="convert">Converting an image to another format</h2>
-
-  <p>Converting an image to another format is as simple as writing
-  the image to a file. ImageMagick uses the output filename
-  suffix (".jpg" for JPEG, ".gif" for GIF, for example) or prefix
-  ("ps:" for PostScript, for example) to determine the format of
-  the output image.</p>
-
-  <h2 id="thumb">Making thumbnails</h2>
-
-  <p>RMagick gives you four different methods for resizing an
-  image: <a href="image3.html#resize"><code>resize</code></a>,
-  <a href="image3.html#sample"><code>sample</code></a>, <a href=
-  "image3.html#scale"><code>scale</code></a>, and <a href=
-  "image3.html#thumbnail"><code>thumbnail</code></a>. All four are
-  equally easy to use. Specify the number of columns and rows you
-  want the thumbnail to have, like this:</p>
-  <pre class="example">
-img = Image.new "bigimage.gif"
-thumb = img.scale(125, 125)
-thumb.write "thumb.gif"
-</pre>
-
-  <p>Alternatively, just pass a single <code>Float</code> argument
-  that represents the change in size. For example, to
-  proportionally reduce the size of an image to 25% of its original
-  size, do this:</p>
-  <pre class="example">
-img = Image.new "bigimage.gif"
-thumb = img.scale(0.25)
-thumb.write "thumb.gif"
-</pre>
-
-  <p>The <code>resize</code> method gives you more control by
-  allowing you to specify a <a href=
-  "constants.html#FilterType">filter</a> to use when scaling the
-  image. Some filters produce a better-looking thumbnail at the
-  expense of extra processing time. You can also use a
-  <code>blur</code> argument, which specifies how much blurriness
-  or sharpness the resize method should introduce.</p>
-
-  <p>The <code>sample</code> method, unlike the other two, does not
-  do any color interpolation when resizing.</p>
-
-  <p>The <code>thumbnail</code> method is faster than
-  <code>resize</code> if the thumbnail is less than 10% of the size
-  of the original image.</p>
-
-  <h3>flickr-style thumbnails</h3>
-
-  <p><a href="http://www.flickr.com">flickr</a> thumbnails are 75
-  pixels wide and 75 pixels tall. If the original image isn't
-  square, the thumbnail is cropped in its larger dimension so that
-  the image isn't distorted. You can get make this kind of
-  thumbnail with the <a href=
-  "image3.html#resize_to_fill">resize_to_fill</a> method.</p>
-  <pre class="example">
-thumb = img.resize_to_fill(75, 75)
-</pre>
-
-  <h2 id="resizing">Resizing to a maximum (or minimum) size</h2>
-
-  <p>Say you need to make all your thumbnails no bigger than 64x64
-  but with the same aspect ratio as the original. Or, you don't
-  want to resize the image if it's already smaller than 64x64. The
-  <a href=
-  "image1.html#change_geometry"><code>change_geometry</code></a>
-  method can help.</p>
-
-  <p>The <code>change_geometry</code> method accepts an
-  ImageMagick <a href="imusage.html#geometry">geometry string</a>
-  argument and a block. The geometry string specifies how to change
-  the image's size: one or two numbers to specify the new size and
-  optional flags to describe any constraints. The
-  <code>change_geometry</code> method parses the geometry string
-  and computes new width and height values. Then it calls the
-  block, passing the values it computed.</p>
-
-  <p>Within the block you can do whatever you want with the new
-  values. Typically you'll call one of the resize methods mentioned
-  in the previous section and make the resized image the return
-  value from the block. The <code>change_geometry</code> method
-  then returns that value to its caller.</p>
-
-  <h3>Simple thumbnails</h3>
-
-  <p>If you just want to make sure your thumbnail is no bigger than
-  a certain width and height, use the <a href=
-  "image3.html#resize_to_fit">resize_to_fit</a> method.</p>
-  <pre class="example">
-thumb = img.resize_to_fit(75, 75)
-</pre>
-
-  <h2><a id="blob" name="blob">Writing to or reading from a string
-  instead of a file</a></h2>
-
-  <p>Use the <a href="image1.html#from_blob">Image.from_blob</a>
-  method to construct an Image object from a string. Use the
-  <a href="image3.html#to_blob">Image#to_blob</a> method to convert
-  an image to a string. A blob is simply an in-memory version of an
-  image file. That is, you could use <code>File.read</code> to read
-  an JPEG file into a string, then create an image by using that
-  string as an argument to <code>from_blob</code>. Similarly, if
-  you create a string version of an image with
-  <code>to_blob</code>, then write the string to a file, any image
-  viewer will be able to display it just as if you had written the
-  image directly to a file. Blobs are very useful in web
-  applications when you want to modify an image and then stream it
-  back to the client.</p>
-
-  <p>Use <a href=
-  "image2.html#import_pixels">Image#import_pixels</a> to load pixel
-  data from a string buffer into an image. The pixel data must be
-  in scanline order, right-to-left and top-to-bottom. The data can
-  be packed as 8-bit bytes, 16-bit halfwords, 32-bit fullwords, or
-  as C floats or doubles. The reciprocal method is <a href=
-  "image3.html#export_pixels_to_str">Image#export_pixels_to_str</a>.</p>
-
-  <h2 id="gray">Converting a color image to grayscale</h2>
-
-  <p>Use the <a href=
-  "image3.html#quantize"><code>quantize</code></a> method with the
-  <a href=
-  "constants.html#ColorspaceType">Magick::GRAYColorspace</a>
-  argument. If you want real "grayscale," quantize the image to 256
-  colors. If you want to convert a color image to black-and-white,
-  use 2 colors. (See the <code>demo.rb</code> example.)</p>
-
-  <h2 id="compressing">Compressing image files</h2>
-
-  <p>Many image formats, including JPEG, PDF, and BMP, support
-  compressed image files. The type of compression used depends on
-  the format. Specify the compression type by assigning a <a href=
-  "constants.html#CompressionType">CompressionType</a> value to the
-  <a href="info.html#compression">compression</a> optional argument
-  to the <a href="image3.html#write">write</a> method.</p>
-
-  <p>The JPEGCompression and ZipCompression types support multiple
-  levels of compression. Use the <a href=
-  "info.html#quality">quality</a> optional argument to the
-  <code>write</code> method. The quality attribute is a number
-  between 0 and 100, with 100 representing the least compression.
-  When you compress an image using JPEGCompression, more
-  compression usually results in a lower-quality image. When you
-  compress an image using ZipCompression, more compression usually
-  takes longer.</p>
-
-  <p>For more information, see the ImageMagick documentation for
-  the <code>-quality</code> option to the utility commands.</p>
-  <pre class="example">
-img.write("myimage.jpg") { self.quality = 50 }
-</pre>
-
-  <h2 id="shadow">Making a drop shadow</h2>
-
-  <p>Here's one way to make a drop shadow behind text. Make the
-  shadow first by drawing the text in a light gray color. Position
-  the text slightly to the right and down from where the real text
-  will be. Then use the <a href=
-  "image1.html#blur_image"><code>blur_image</code></a> method to
-  make the shadow by blurring the text. Finally, draw the text
-  again in whatever color you want. <em>(Click the image to see the
-  Ruby program that created it.)</em></p>
-
-  <div id="drop_shadow">
-    <a href="javascript:popup('drop_shadow.rb.html')"><img src=
-    "ex/drop_shadow.gif" title="Click to see the example script"
-    alt="drop shadow example" /></a>
-  </div>
-  <hr />
-
-  <p class="spacer"></p>
-
-  <div class="nav">
-    &laquo; <a href="optequiv.html">Prev</a> | <a href=
-    "index.html">Contents</a> | <a href="magick.html">Next</a>
-    &raquo;
-  </div>
-</body>
-</html>