image_paradise 0.1.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc6e0fea2cf16f3e33ffc160b00a7948393ec93c3fdef26cd4072dc33cb41fee
+  data.tar.gz: 41c6bfef80f3d324db9c9fe26d7e076ac3406029c29a31287d6cbfd2f2e10622
+SHA512:
+  metadata.gz: 40db871132c2848d0e30a2494bc50d3d6d2a5017c1523203586edcc6d4c1f53eeab9b3b051b0ac15ad5dc237cc2f271187746938fcb26a880556b76609ac6de4
+  data.tar.gz: 2d807e4ea173b4b1367d73efeba6248ad65a7f8518ee59e47fcf4d449f0f32573bc81f6e41277321dbf605a68d7d922a365cb53d536ffeda35d6931452850981

data/LICENSE.md

@@ -0,0 +1,38 @@
+The code in the graphs/ subdirectory is based on the gem called gruff
+and thus the MIT license (I kept the MIT license for that code since I
+believe that this is only fair even though you could change the license
+to require a similar GPL-distribution clause of your modifications,
+since topfunky made it available for his gruff project via the MIT
+license; for my own projects written from scratch I prefer the GPL-2.0
+version though):
+
+Copyright (c) 2005-2012 Topfunky Corporation boss@topfunky.com
+Copyright (c) 2015  Robert A. Heiler
+
+MIT License
+
+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.
+
+------------------------------------------------------------------------
+
+The rest of the code base in image_manipulation is GPL-2.0 and has been
+written by me:
+
+  Copyright (c) 2014-2015 Robert A. Heiler

data/README.md

@@ -0,0 +1,179 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/image_paradise.svg)](https://badge.fury.io/rb/image_paradise)
+
+## Flip-flopping an image from left-to-right
+
+If you want to flip an image left-to-right, you can use
+class <b>FlipImageLeftRight</b>. The file resides at
+<b>image_paradise/toplevel_methods/flip_image_left_right.rb/</b>.
+
+## Rotating an image
+
+(Technically this is similar to flip-flop, but I added this functionality
+at a later point, so the flip-flop subsection here shall remain for the
+time being.)
+
+The commandline API for rotating an image called **FOOBAR.png**, in 
+regards to image_paradise, may go so:
+
+    imgparadise FOOBAR.png --rotate=33%
+    imgparadise foo.png --rotate=90%
+    imgparadise *.png --rotate=90%
+
+Simply pass the rotation-value that you wish to use into --rotate.
+
+Be careful, though - this command will overwrite the image, so **make
+sure to backup your old image** before applying this command.
+
+## Transparent images
+
+You can use this API to make an image transparent:
+
+  ImageParadise.make_this_image_transparent
+
+This will try to make use of ImageMagick's **convert** ability.
+
+## Merging image files together
+
+You can use the toplevel method **ImageParadise.merge_these_images**
+in order to merge several image files together. This depends on the
+binary called **convert**, from ImageMagick.
+
+As first argument simply pass an Array of the files that you wish
+to merge, such as:
+
+    ImageParadise.merge_these_images(%w( foo.png bar.png bla.png ))
+    ImageParadise.merge(%w( foo.png bar.png bla.png )) # <- This also works.
+
+## Greyscaling images
+
+You can grayscale images via:
+
+    ImageParadise.greyscale_this_image()
+    ImageParadise.grayscale_this_image()
+
+This currently (Jan 2019) depends on the gem called **mini_magick**. In
+the future we may add some more flexibility to this method, but for the
+time being mini_magick is a dependency if you wish to make use of
+these **toplevel methods**. 
+
+Greyscaling an image may be useful if you wish to use this for
+**optical character recognition**, aka recognising written text
+on it.
+
+## Borders
+
+You can add some borders to images.
+
+The toplevel method **ImageParadise.add_black_border_to_this_image()**
+can be used to add a black border to an image. The first argument to
+this method is the path to the image at hand. The second argument
+specifies the size of the border, in **pixels**. So the number **3**
+as second argument would mean draw a border 3 pixel wide around the
+image at hand.
+
+Invocation example for the file called **foobar.png**:
+
+   ImageParadise.add_black_border_to_this_image('foobar.png',3)
+
+Obviously for this to work, the file must exist.
+
+## class ImageParadiseImageToAscii
+
+This class can convert images to ASCII files, if ImageMagick
+(and the rmagick bindings) are available.
+
+To specifically require this class, do this:
+
+    require 'image_paradise/requires/require_image_to_ascii.rb'
+
+Then pass the filename into the class:
+
+    result = ImageParadise::ImageToAscii['foobar.jpg']
+    result = ImageParadise.image_to_ascii('foobar.jpg')
+
+or
+
+    _ = ImageParadise::ImageToAscii.new '/foo/bar.png'
+    _.to_ascii # Generate the ascii "image" here specifically, via this method call.
+
+or
+
+	  print ImageParadise::ImageToAscii('yo.png').to_ascii(width: 50)
+
+	  +--------------------------------------------------+
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooo===++++====ooooooooooooooooooooo|
+	  |ooooooooooooo=+:~.~........~~~:+=ooooooooooooooooo|
+	  |oooooooooo==:~...~~:++++++:~~..~~:+=oooooooooooooo|
+	  |oooooooo=+:...~++====oooo====+:~..~:+=oooooooooooo|
+	  |ooooooo=+~..~:++==ooooooooooo=++:~..~+=ooooooooooo|
+	  |oooooo=+~.~:+=+~.~~~~~~~~:~~~.~:++:~.~+=oooooooooo|
+	  |ooooo=+~~.+===~................~+==:.~~+=ooooooooo|
+	  |ooooo=:~~:+=+:~................~~+=+:~.:=ooooooooo|
+	  |ooooo=~.~+==+~.......XXXXX.......+==+~.:=ooooooooo|
+	  |ooooo=~~~+==:~.......XXXXX.......:==+~.:=ooooooooo|
+	  |ooooo=~~~:==+~.......XXXXX......~+==+~.~=ooooooooo|
+	  |ooooo=:~~~+=++~.................:+=+~~~:=ooooooooo|
+	  |ooooo=+:..~+==+~~...........~~~+==+~..:+=ooooooooo|
+	  |ooooooo+:..~:+=o=+:........:+====:~.~:==oooooooooo|
+	  |oooooooo=+~.~~:+==+~......~+==+:~..~:+oooooooooooo|
+	  |ooooooooo=+:~..~~:~~.......~:~~..~:+oooooooooooooo|
+	  |oooooooooooo=+~~..............~:+=oooooooooooooooo|
+	  |ooooooooooooooo==++:~~~~~~:++==ooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  +--------------------------------------------------+
+  
+Add colours via the "colour" option
+
+	  require 'image_paradise'
+    a = ImageParadise::ImageToAscii.new "http://www.evangogh.org/images/paintings/self-portrait.jpg"
+    puts a.to_ascii(color: true)
+
+Command Line examples:
+
+    image_to_ascii ~/Desktop/foo.png # Local file.
+    image_to_ascii http://www.google.com/images/foo.png # Remote image.
+    image_to_ascii -c -f html ~/foobar.jpg > ~/Desktop/ascii-as-html.html # Output via HTML.
+    image_to_ascii -w 50 -c -f html ~/foo/bar.jpg > ~/Desktop/saturdaynight.html # Or smaller.
+
+To display help:
+
+	  image_to_ascii -h
+
+	  Usage: image_to_ascii [options] <path_or_url>
+        -w, --width WIDTH                Width of the finished Ascii Image (Default: 150)
+        -f, --format [text/html]         output format (Default: text)
+        -c, --color                      Switch to use colored terminal output (Default: false)
+        -i, --invert-chars               Invert the character map. *Depending on background and image color - this can make the result clearer.*
+        -v, --version                    Show the version of this project
+        -h, --help                       Show this message
+
+## SVG
+
+ImageParadise now has a submodule called **Svg**, for svg-related
+objects. Documentation is currently missing for this part. Hopefully
+I will have more time in the future to add the missing
+documentation here. :\
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevegen@gmail.com
+
+(Do keep in mind that responding to emails may take some time, depending
+on the amount of work I may have at that moment, due to reallife. I will,
+however had, read feedback. Patches and code changes are welcome too
+of course, as long as they are in the spirit of the project at
+hand, e. g. fitting to the general theme.)
+
+Thank you.

data/USAGE.md

@@ -0,0 +1,10 @@
+= Usage of this Library
+
+== Requiring it
+
+  require 'image_paradise'
+
+== Using it in a project
+
+  _ = ImageParadise.new("path_to_an_image")
+  _.run

data/bin/black_white

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This small executable will turn a coloured image into a black-white
+# image, an operation that is more aptly called "grayscaling".
+# =========================================================================== #
+require 'image_paradise'
+
+ImageParadise.black_white(ARGV)

data/bin/display_text_from_this_image

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/extract_text_from_this_image.rb'
+
+puts ImageParadise.extract_text_from_this_image(ARGV, :default, :do_show_the_command)

data/bin/image_paradise

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise'
+
+ImageParadise.menu(ARGV)

data/bin/image_paradise_shell

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise'
+
+ImageParadise.interactive_shell

data/bin/image_to_ascii

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This is the executable for class ImageParadise::ImageToAscii.
+# =========================================================================== #
+require 'image_paradise/requires/require_image_to_ascii.rb'
+require 'optparse'
+
+OPTIONS       = {}
+invert_chars  = false
+
+option_parser = OptionParser.new { |opts|
+  opts.banner = 'Usage: asciiart [options] <path_or_url>'
+
+  opts.on('-w', '--width WIDTH', 'Width of the finished Ascii Art (Default: 100)') { |width|
+    OPTIONS[:width] = width.to_i
+  }
+  opts.on('-f', '--format [text/html]', 'output format (Default: text)') { |format|
+    OPTIONS[:format] = format
+  }
+  opts.on('-c', '--color', 'Switch to use colored terminal output (Default: false)') {
+    OPTIONS[:color] = true
+  }
+  opts.on('-i', '--invert-chars', 'Invert the character map. Depending on your '\
+    'terminal and image this can make the image clearer (or a lot worse)') {
+    invert_chars = true
+  }
+  opts.on_tail('-v', '--version', 'Show AsciiArt version') {
+    puts 'AsciiArt version '+AsciiArt::VERSION
+    exit
+  }
+  opts.on_tail('-h', '--help', 'Show this message') {
+    puts opts
+    exit
+  }
+}
+
+begin
+  option_parser.parse!
+rescue OptionParser::MissingArgument => e
+  puts "ERROR: #{e.message.capitalize}\n#{option_parser}"
+  exit
+end
+
+if ARGV.length == 0
+  puts "ERROR: You must specify a path or URL to convert\n#{option_parser}"
+  exit
+end
+
+_ = ImageParadise::ImageToAscii.new(ARGV.first)
+_.image_chars = _.image_chars.reverse if invert_chars
+
+puts _.to_ascii(OPTIONS)

data/bin/image_to_pdf

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/image_to_pdf/image_to_pdf.rb'
+
+ImageParadise::ImageToPdf.new(ARGV)

data/bin/make_this_image_transparent

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/class_methods/make_this_image_transparent.rb'
+
+ImageParadise.make_this_image_transparent(ARGV)

data/bin/rotate_left

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/rotate/rotate.rb'
+
+ImageParadise.rotate_left(ARGV)

data/bin/rotate_right

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/rotate/rotate.rb'
+
+ImageParadise.rotate_right(ARGV)

data/doc/README.gen

@@ -0,0 +1,162 @@
+ADD_RUBY_HEADER
+
+## Flip-flopping an image from left-to-right
+
+If you want to flip an image left-to-right, you can use
+class <b>FlipImageLeftRight</b>. The file resides at
+<b>image_paradise/toplevel_methods/flip_image_left_right.rb/</b>.
+
+## Rotating an image
+
+(Technically this is similar to flip-flop, but I added this functionality
+at a later point, so the flip-flop subsection here shall remain for the
+time being.)
+
+The commandline API for rotating an image called **FOOBAR.png**, in 
+regards to image_paradise, may go so:
+
+    imgparadise FOOBAR.png --rotate=33%
+    imgparadise foo.png --rotate=90%
+    imgparadise *.png --rotate=90%
+
+Simply pass the rotation-value that you wish to use into --rotate.
+
+Be careful, though - this command will overwrite the image, so **make
+sure to backup your old image** before applying this command.
+
+## Transparent images
+
+You can use this API to make an image transparent:
+
+  ImageParadise.make_this_image_transparent
+
+This will try to make use of ImageMagick's **convert** ability.
+
+## Merging image files together
+
+You can use the toplevel method **ImageParadise.merge_these_images**
+in order to merge several image files together. This depends on the
+binary called **convert**, from ImageMagick.
+
+As first argument simply pass an Array of the files that you wish
+to merge, such as:
+
+    ImageParadise.merge_these_images(%w( foo.png bar.png bla.png ))
+    ImageParadise.merge(%w( foo.png bar.png bla.png )) # <- This also works.
+
+## Greyscaling images
+
+You can grayscale images via:
+
+    ImageParadise.greyscale_this_image()
+    ImageParadise.grayscale_this_image()
+
+This currently (Jan 2019) depends on the gem called **mini_magick**. In
+the future we may add some more flexibility to this method, but for the
+time being mini_magick is a dependency if you wish to make use of
+these **toplevel methods**. 
+
+Greyscaling an image may be useful if you wish to use this for
+**optical character recognition**, aka recognising written text
+on it.
+
+## Borders
+
+You can add some borders to images.
+
+The toplevel method **ImageParadise.add_black_border_to_this_image()**
+can be used to add a black border to an image. The first argument to
+this method is the path to the image at hand. The second argument
+specifies the size of the border, in **pixels**. So the number **3**
+as second argument would mean draw a border 3 pixel wide around the
+image at hand.
+
+Invocation example for the file called **foobar.png**:
+
+   ImageParadise.add_black_border_to_this_image('foobar.png',3)
+
+Obviously for this to work, the file must exist.
+
+## class ImageParadiseImageToAscii
+
+This class can convert images to ASCII files, if ImageMagick
+(and the rmagick bindings) are available.
+
+To specifically require this class, do this:
+
+    require 'image_paradise/requires/require_image_to_ascii.rb'
+
+Then pass the filename into the class:
+
+    result = ImageParadise::ImageToAscii['foobar.jpg']
+    result = ImageParadise.image_to_ascii('foobar.jpg')
+
+or
+
+    _ = ImageParadise::ImageToAscii.new '/foo/bar.png'
+    _.to_ascii # Generate the ascii "image" here specifically, via this method call.
+
+or
+
+	  print ImageParadise::ImageToAscii('yo.png').to_ascii(width: 50)
+
+	  +--------------------------------------------------+
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooo===++++====ooooooooooooooooooooo|
+	  |ooooooooooooo=+:~.~........~~~:+=ooooooooooooooooo|
+	  |oooooooooo==:~...~~:++++++:~~..~~:+=oooooooooooooo|
+	  |oooooooo=+:...~++====oooo====+:~..~:+=oooooooooooo|
+	  |ooooooo=+~..~:++==ooooooooooo=++:~..~+=ooooooooooo|
+	  |oooooo=+~.~:+=+~.~~~~~~~~:~~~.~:++:~.~+=oooooooooo|
+	  |ooooo=+~~.+===~................~+==:.~~+=ooooooooo|
+	  |ooooo=:~~:+=+:~................~~+=+:~.:=ooooooooo|
+	  |ooooo=~.~+==+~.......XXXXX.......+==+~.:=ooooooooo|
+	  |ooooo=~~~+==:~.......XXXXX.......:==+~.:=ooooooooo|
+	  |ooooo=~~~:==+~.......XXXXX......~+==+~.~=ooooooooo|
+	  |ooooo=:~~~+=++~.................:+=+~~~:=ooooooooo|
+	  |ooooo=+:..~+==+~~...........~~~+==+~..:+=ooooooooo|
+	  |ooooooo+:..~:+=o=+:........:+====:~.~:==oooooooooo|
+	  |oooooooo=+~.~~:+==+~......~+==+:~..~:+oooooooooooo|
+	  |ooooooooo=+:~..~~:~~.......~:~~..~:+oooooooooooooo|
+	  |oooooooooooo=+~~..............~:+=oooooooooooooooo|
+	  |ooooooooooooooo==++:~~~~~~:++==ooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  |oooooooooooooooooooooooooooooooooooooooooooooooooo|
+	  +--------------------------------------------------+
+  
+Add colours via the "colour" option
+
+	  require 'image_paradise'
+    a = ImageParadise::ImageToAscii.new "http://www.evangogh.org/images/paintings/self-portrait.jpg"
+    puts a.to_ascii(color: true)
+
+Command Line examples:
+
+    image_to_ascii ~/Desktop/foo.png # Local file.
+    image_to_ascii http://www.google.com/images/foo.png # Remote image.
+    image_to_ascii -c -f html ~/foobar.jpg > ~/Desktop/ascii-as-html.html # Output via HTML.
+    image_to_ascii -w 50 -c -f html ~/foo/bar.jpg > ~/Desktop/saturdaynight.html # Or smaller.
+
+To display help:
+
+	  image_to_ascii -h
+
+	  Usage: image_to_ascii [options] <path_or_url>
+        -w, --width WIDTH                Width of the finished Ascii Image (Default: 150)
+        -f, --format [text/html]         output format (Default: text)
+        -c, --color                      Switch to use colored terminal output (Default: false)
+        -i, --invert-chars               Invert the character map. *Depending on background and image color - this can make the result clearer.*
+        -v, --version                    Show the version of this project
+        -h, --help                       Show this message
+
+## SVG
+
+ImageParadise now has a submodule called **Svg**, for svg-related
+objects. Documentation is currently missing for this part. Hopefully
+I will have more time in the future to add the missing
+documentation here. :\
+
+ADD_CONTACT_INFORMATION