image_paradise 0.1.12

data/lib/image_paradise/image_manipulations.rb

@@ -0,0 +1,320 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/image_manipulations.rb'
+# =========================================================================== #
+require 'image_paradise/gm_support.rb'
+
+module ImageParadise
+
+class ImageManipulations
+  
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument to this method should be the path to the file
+  # that we want to manipulate.
+  # ========================================================================= #
+  def initialize(i)
+    reset
+    set_file(i)
+  end
+
+  # ========================================================================= #
+  # === set_file
+  # ========================================================================= #
+  def set_file(i)
+    @file = i
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @filename_changed = false
+    @display_sys_command = false
+  end
+
+  # ========================================================================= #
+  # === file?
+  # ========================================================================= #
+  def file?
+    @file
+  end; alias file file? # === file
+
+  # ========================================================================= #
+  # === identify
+  #
+  # Runs ImageMagick's 'identify'.
+  #
+  # See http://www.imagemagick.org/script/identify.php
+  # ========================================================================= #
+  def identify(i = {})
+    tokens = ['identify']
+    tokens << expand_arguments_to_key_value_pairs(i) if i
+    tokens << " '#{@file}#{"[#{i[:layer].to_s}]" if i[:layer]}'"
+    tokens  = convert_to_command(tokens)
+    output  = run_command(tokens).first
+    output
+  end
+
+  # ========================================================================= #
+  # === dimensions
+  #
+  # Return the x and y dimensions of an image, as a Hash.
+  # ========================================================================= #
+  def dimensions
+    dimensions = identify( # Tap into Imagemagick's identify binary.
+      :layer => 0, :format => "%wx%h"
+    ).chomp.split('x')
+    hash = {
+      x: dimensions[0].to_i,
+      y: dimensions[1].to_i
+    }
+    return hash
+  end; alias width_and_height dimensions # === width_and_height
+
+  # ========================================================================= #
+  # === width
+  #
+  # Returns the x dimension of an image as an integer
+  # ========================================================================= #
+  def width
+    dimensions[:x]
+  end
+
+  # ========================================================================= #
+  # === height
+  #
+  # Returns the y dimension of an image as an integer
+  # ========================================================================= #
+  def height
+    dimensions[:y]
+  end
+
+  # ========================================================================= #
+  # === montage
+  #
+  # Runs ImageMagick's 'montage'.
+  #
+  # See http://www.imagemagick.org/script/montage.php
+  # ========================================================================= #
+  def montage(sources, i = {})
+    tokens = ['montage']
+    tokens << expand_arguments_to_key_value_pairs(i) if i
+    sources.each {|source| tokens << " '#{source}'" }
+    tokens << " '#{@file}'"
+    tokens  = convert_to_command(tokens)
+    success = run_command(tokens)[1]
+    success
+  end
+
+  # ========================================================================= #
+  # === filename_changed?
+  # ========================================================================= #
+  def filename_changed?
+    @filename_changed
+  end
+
+  # ========================================================================= #
+  # === do_manipulate
+  #
+  # Runs ImageMagick's 'mogrify' command. The first argument to this
+  # method is an (optional) Hash.
+  #
+  # See http://www.imagemagick.org/script/mogrify.php
+  #
+  # Invocation example:
+  #   image.do_manipulate(scale: '80%') # => true
+  # ========================================================================= #
+  def do_manipulate(i = {})
+    tokens  = ['mogrify']
+    tokens << expand_arguments_to_key_value_pairs(i) if i
+    tokens << " '#{@file}#{"[#{i[:layer].to_s}]" if i[:layer]}'"
+    tokens << " -annotate #{i[:annotate].to_s}" if i[:annotate]
+    tokens  = convert_to_command(tokens)
+    success = run_command(tokens)[1]
+    replace_file(i[:format].to_s.downcase, i[:layer]) if success && i[:format]
+    success
+  end; alias manipulate! do_manipulate # === manipulate!
+
+  # ========================================================================= #
+  # === shrink
+  #
+  # Shrinks the given image at hand. Be careful with this method - it
+  # will instantly shrink the given file, without keeping a backup. So
+  # if you want to keep a backup, you have to copy the image file on
+  # your own BEFORE invoking this method here.
+  # ========================================================================= #
+  def shrink(n_percent = '80%')
+    unless n_percent.is_a? String
+      n_percent = n_percent.to_s
+    end
+    n_percent << '%' unless n_percent.end_with? '%'
+    do_manipulate(scale: n_percent)
+  end
+
+  # ========================================================================= #
+  # === replace_file
+  #
+  # Replaces the old file (with the old file format) with the newly
+  # generated one.
+  #
+  # The old file will be deleted and $file will be reset.
+  #
+  # If ImageMagick generated more than one file, $file will have a "*", 
+  # so that all files generated will be manipulated in the following
+  # steps.
+  # ========================================================================= #
+  def replace_file(format, layer)
+    return if File.extname(@file) == format
+
+    layer ||= 0
+    layer = layer.split(',').first if layer.is_a? String
+
+    File.delete(@file)
+
+    @filename_changed = true
+
+    path = File.join File.dirname(@file), File.basename(@file, File.extname(@file))
+    new_file = find_file(path, format, layer)
+
+    @file = new_file.call(path, format, '*') unless new_file.nil?
+  end
+
+  # ========================================================================= #
+  # === find_file
+  # ========================================================================= #
+  def find_file(path, format, layer)
+    possible_paths = [
+      Proc.new { |inner_path, inner_format, _inner_layer|
+        "#{inner_path}.#{inner_format}"
+      },
+      Proc.new { |inner_path, inner_format, inner_layer|
+        "#{inner_path}-#{inner_layer}.#{format}"
+      },
+      Proc.new { |inner_path, inner_format, inner_layer|
+        "#{inner_path}.#{inner_format}.#{inner_layer}"
+      }
+    ]
+    possible_paths.find { |possible_path|
+      File.exist?(possible_path.call(path, format, layer))
+    }
+  end
+
+  # ========================================================================= #
+  # === convert                                                 (convert tag)
+  #
+  # Runs ImageMagick's 'convert'.
+  #
+  # The second argument to this method has to be a Hash, if it is given.
+  #
+  # See http://www.imagemagick.org/script/convert.php
+  # ========================================================================= #
+  def convert(output, i = {})
+    tokens  = ['convert']
+    tokens << expand_arguments_to_key_value_pairs(i) if i
+    tokens << " '#{@file}#{"[#{i[:layer].to_s}]" if i.has_key?(:layer)}'"
+    tokens << " -annotate #{i[:annotate].to_s}" if i.has_key?(:annotate)
+    tokens << " #{output}"
+    tokens  = convert_to_command(tokens)
+    success = run_command(tokens)[1]
+    success
+  end
+
+  # ========================================================================= #
+  # === convert_to_command
+  #
+  # This method adds a proper prefix, which is defined in the file
+  # gm_support.rb. Then it joins the commands of the Array at hand.
+  # ========================================================================= #
+  def convert_to_command(tokens)
+    # ======================================================================= #
+    # Pass into the method prefix() next.
+    # ======================================================================= #
+    tokens[0] = prefix(tokens.first) if respond_to? :prefix
+    tokens.flatten.join
+  end
+
+  # ========================================================================= #
+  # === expand_arguments_to_key_value_pairs
+  #
+  # Convert the entries into a format that ImageMagick understands.
+  # ========================================================================= #
+  def expand_arguments_to_key_value_pairs(i)
+    special_arguments = [ :layer, :annotate ]
+    # ======================================================================= #
+    # First, reject keys that are not :layer or :annotate.
+    # ======================================================================= #
+    i.reject {|key, _value| special_arguments.include?(key) }.map {|key, value|
+      " -#{key} '#{value}'"
+    }
+  end; alias convert_arguments expand_arguments_to_key_value_pairs # === convert_arguments
+
+  # ========================================================================= #
+  # === run_command
+  #
+  # Use IO.popen to run the passed command at hand.
+  #
+  # The method returns an Array, holding the output, and the success
+  # status.
+  # ========================================================================= #
+  def run_command(i)
+    i = i.to_s
+    if @display_sys_command
+      # ===================================================================== #
+      # Show the command if the ivar above is true.
+      # ===================================================================== #
+      e i
+    end
+    output = IO.popen(i) {|dataset| dataset.read }
+    success = $?.exitstatus == 0 ? true : false
+    [output, success]
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise.identify
+# =========================================================================== #
+def self.identify(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).identify(hash_arguments)
+end
+
+# =========================================================================== #
+# === ImageParadise.convert
+# =========================================================================== #
+def self.convert(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).convert(hash_arguments)
+end
+
+# =========================================================================== #
+# === ImageParadise.dimensions
+# =========================================================================== #
+def self.dimensions(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).dimensions(hash_arguments)
+end
+
+# =========================================================================== #
+# === ImageParadise.montage
+# =========================================================================== #
+def self.montage(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).montage(hash_arguments)
+end
+
+# =========================================================================== #
+# === ImageParadise.do_manipulate
+# =========================================================================== #
+def self.do_manipulate(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).do_manipulate(hash_arguments)
+end
+
+# =========================================================================== #
+# === ImageParadise.shrink
+# =========================================================================== #
+def self.shrink(this_image, hash_arguments = {})
+  ImageParadise::ImageManipulations.new(this_image).shrink(hash_arguments)
+end
+
+end

data/lib/image_paradise/image_paradise.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::ImageParadise
+#
+# This project can be used to do fancy image manipulations from the
+# commandline, including the de-novo creation of new images.
+#
+# Usage example:
+#   ImageParadise::ImageParadise.new
+# =========================================================================== #
+# require 'image_paradise'
+# =========================================================================== #
+require 'image_paradise/requires/common_base_requires.rb'
+require 'image_paradise/toplevel_methods/esystem.rb'
+require 'image_paradise/toplevel_methods/crop.rb'
+require 'image_paradise/toplevel_methods/png_to_svg.rb'
+require 'image_paradise/constants.rb'
+require 'image_paradise/identify.rb'
+require 'image_paradise/create_animated_gif.rb'
+require 'image_paradise/graphs.rb'
+require 'image_paradise/confree_generator/class.rb'
+require 'image_paradise/optimizer.rb'
+
+module ImageParadise
+
+class ImageParadise # === ImageParadise::ImageParadise
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # First argument is the filename that we wish to use.
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_filename(i)
+    if run_already.to_s.include? 'dont'
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === set_filename
+  #
+  # This will be the input filename.
+  # ========================================================================= #
+  def set_filename(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup if i
+    @filename = i
+  end
+
+  # ========================================================================= #
+  # === filename?
+  # ========================================================================= #
+  def filename?
+    @filename
+  end; alias input? filename? # === input?
+
+  # ========================================================================= #
+  # === ImageParadise.font_tiled
+  # ========================================================================= #
+  def self.font_tiled(i = DEFAULT_TEXT)
+    i = DEFAULT_TEXT if i.nil?
+    width_and_height = '500x250'
+    _ = CONVERT+" -size "+width_and_height+" xc:lightblue -font "+
+        DEFAULT_FONT+" -pointsize 68 
+        -tile pattern:checkerboard -annotate +28+68 '"+i+"' 
+        font_tile.jpg"
+    esys _
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.esys
+  # ========================================================================= #
+  def self.esys(i)
+    i.delete!(N)
+    esystem(i)
+  end
+
+  # ========================================================================= #
+  # === esys
+  # ========================================================================= #
+  def esys(i)
+    ImageParadise.esys(i)
+  end
+
+  # ========================================================================= #
+  # === colourize
+  #
+  # Input should be R,G,B values.
+  # ========================================================================= #
+  def colourize(rgb_values = '2,15,75')
+    case rgb_values
+    when :randomize, :random
+      rgb_values = (rand(255)+1).to_s+','+(rand(255)+1).to_s+','+(rand(255)+1).to_s
+    end
+    _ = CONVERT+' -colorize '+rgb_values+' '+input?+' '+output?
+    ImageParadise.esys _
+  end
+
+  # ========================================================================= #
+  # === output
+  # ========================================================================= #
+  def output?
+    'output.png'
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.resize
+  #
+  # This is equivalent to:
+  #   convert terminal.gif  -resize 64x64  resize_terminal.gif
+  # ========================================================================= #
+  def self.resize(resize_how = '-resize 64x64')
+    _ = CONVERT+' '+resize_how+' '+input_output?
+  end
+
+  # ========================================================================= #
+  # === input_output?
+  # ========================================================================= #
+  def input_output?
+    input?+' '+output?
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run # (run tag)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  # _ = ImageParadise.new(ARGV, :dont_run_yet)
+  # _.run
+  ImageParadise::ImageParadise.crop('rose.jpg')
+end # rimage
+    # require 'image_paradise'; ImageParadise.new('foo.jpg').colourize :random