image_paradise 0.1.12

data/lib/image_paradise/toplevel_methods/file_related_code.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/file_related_code.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.remove_file
+  #
+  # We need a common way to delete files, so here it is.
+  # ========================================================================= #
+  def self.remove_file(i)
+    FileUtils.rm(i) if File.exist? i
+  end
+
+  # ========================================================================= #
+  # === remove_file
+  # ========================================================================= #
+  def remove_file(i)
+    ::ImageParadise.remove_file(i)
+  end
+
+end

data/lib/image_paradise/toplevel_methods/flip_image_left_right.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/flip_image_left_right.rb'
+# =========================================================================== #
+module ImageParadise
+
+  begin
+    require 'esystem'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === ImageParadise.flip_image_left_right
+  # ========================================================================= #
+  def self.flip_image_left_right(this_image)
+    if this_image.is_a? Array
+      this_image.each {|entry|
+        flip_image_left_right(entry)
+      }
+    else
+      name_of_the_output_file = 'flipped_image_left_to_right_'+this_image
+      _ = 'convert '+this_image+' \( -flop \) +append '+name_of_the_output_file
+      Esystem.esystem _
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.flip_image_left_right(ARGV)
+end # flip_image_left_right

data/lib/image_paradise/toplevel_methods/greyscale_this_image.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/grayscale_this_image.rb'
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/e.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.greyscale_this_image
+  #
+  # This method will greyscale an image file. Right now we depend
+  # on the gem mini_magick for this task.
+  #
+  # This method may be useful when you wish to pre-process a coloured
+  # image, turn it into black-white only, before using OCR ("optical
+  # character recognition") on it.
+  # ========================================================================= #
+  def self.greyscale_this_image(
+      i, prepend_this_string = 'greyscaled_'
+    )
+    begin
+      require 'mini_magick'
+      i = [i].flatten.compact
+      i.each {|this_file|
+        img = MiniMagick::Image.open(this_file)
+        img.colorspace('Gray') # Turn it into grayscale here.
+        store_here = "#{prepend_this_string}#{this_file}"
+        e "Storing into the file `#{store_here}`."
+        img.write(store_here)
+      }
+    rescue LoadError
+      e 'This method requires the gem mini_magick.'
+      e
+      e 'You can install it via:'
+      e
+      e '  gem install mini_magick'
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.grayscale_this_image
+  #
+  # This is just for "support" of american english. The resulting image
+  # files will have a prepended string called 'grayscaled_' rather
+  # than 'greyscaled_'.
+  # ========================================================================= #
+  def self.grayscale_this_image(i)
+    ImageParadise.greyscale_this_image(i, 'grayscaled_')
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.greyscale_this_image(ARGV)
+end # greyscale_this_image

data/lib/image_paradise/toplevel_methods/help.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/help.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.show_help                                    (help tag)
+  #
+  # Invocation example:
+  #
+  #   image_paradise --help
+  #
+  # ========================================================================= #
+  def self.show_help
+    heredoc_variable = <<-EOF
+Right now we only support hese options:
+
+  --autogenerate-black-wallpaper
+  --wallpaper
+  --cfdg                         # batch-generate the cfdg files
+  --merge                        # merge together the given input image-files
+
+EOF
+    e heredoc_variable
+  end
+
+end

data/lib/image_paradise/toplevel_methods/make_this_image_transparent.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/make_this_image_transparent.rb'
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/esystem.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.make_this_image_transparent
+  #
+  # This method depends on the program called ImageMagick.
+  # ========================================================================= #
+  def self.make_this_image_transparent(i)
+    i = [i].flatten.compact
+    i.each {|this_image|
+      output_filename = "output_#{this_image}"
+      _ = 'convert '+this_image+' -transparent white '
+      _ << output_filename
+      esystem _
+    }
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.make_this_image_transparent(ARGV)
+end # make_this_image_transparent

data/lib/image_paradise/toplevel_methods/menu.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This menu parses the commandline.
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/menu.rb'
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/toplevel_methods/help.rb'
+  require 'image_paradise/toplevel_methods/wallpaper.rb'
+
+  # ========================================================================= #
+  # === @use_this_image
+  # ========================================================================= #
+  @use_this_image = nil
+
+  # ========================================================================= #
+  # === ImageParadise.use_this_image?
+  # ========================================================================= #
+  def self.use_this_image?
+    @use_this_image
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.set_use_this_image
+  # ========================================================================= #
+  def self.set_use_this_image(i)
+    @use_this_image = i
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.menu
+  # ========================================================================= #
+  def self.menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === imgparadise --cfdg
+      # ===================================================================== #
+      when /^-?-?cfdg$/
+        require 'image_paradise/confree_generator/class.rb'
+        ::ImageParadise.confreegenerator('--html')
+      # ===================================================================== #
+      # === imgparadise FOOBAR.png --rotate=33%
+      # ===================================================================== #
+      when /-?-?rotate=(-?\d{1,2})%?$/i
+        rotate_by_n_percent = $1.to_s.dup
+        use_this_file = ''.dup
+        if ::ImageParadise.use_this_image?
+          use_this_file << ::ImageParadise.use_this_image?.dup
+        end
+        ::ImageParadise.rotate_this_image(
+          use_this_file,
+          rotate_by_n_percent,
+          :black
+        )
+      # ===================================================================== #
+      # === image_paradise --help
+      # ===================================================================== #
+      when /help/i
+        show_help
+      # ===================================================================== #
+      # === image_paradise --autogenerate-black-wallpaper
+      #
+      # The variant here will allow us to us any colour for the wallpaper,
+      # whereas the variant below will create a default wallpaper.
+      # ===================================================================== #
+      when /^-?-?autogenerate-?(.+)-?wallpaper/
+        use_this_colour = $1.to_s.dup.delete('-')
+        ::ImageParadise.wallpaper(colour: use_this_colour)
+      # ===================================================================== #
+      # === image_paradise --wallpaper
+      # ===================================================================== #
+      when /-?-?wallpaper?/
+        ::ImageParadise.wallpaper
+      else
+        if File.exist? i
+          set_use_this_image(i)
+        end
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.menu(ARGV)
+end

data/lib/image_paradise/toplevel_methods/merge_these_images.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/merge_these_images.rb'
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/esystem.rb'
+require 'image_paradise/toplevel_methods/e.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.merge_these_images
+  #
+  # This method can be used to merge several input-image files together.
+  #
+  # This functionality depends on the project called ImageMagick.
+  # ========================================================================= #
+  def self.merge_these_images(
+      i, use_this_as_output_name = 'MERGED_IMAGES'
+    )
+    i = [i].flatten.compact
+    _ = 'convert '.dup
+    i.each {|this_image|
+      _ << "#{this_image} "
+    }
+    unless use_this_as_output_name.include? '.'
+      # ===================================================================== #
+      # In this case we assume that it has no proper end, such as
+      # .png or .jpg and so forth.
+      # ===================================================================== #
+      if use_this_as_output_name.frozen?
+        use_this_as_output_name = use_this_as_output_name.dup
+      end
+      use_this_as_output_name << File.extname(i.first)
+    end
+    _ << '+append '+use_this_as_output_name
+    esystem _
+    if File.exist? use_this_as_output_name
+      e "Stored as `#{use_this_as_output_name}`."
+    end
+    return use_this_as_output_name
+  end; self.instance_eval { alias merge merge_these_images } # === ImageParadise.merge
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.merge_these_images(ARGV)
+end # merge_these_images

data/lib/image_paradise/toplevel_methods/mirror_image.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/esystem.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.mirror_image
+  # ========================================================================= #
+  def self.mirror_image(this_image)
+    if this_image.is_a? Array
+      this_image.each {|entry|
+        mirror_image(entry)
+      }
+    else
+      name_of_the_output_file = 'mirrored_image_'+this_image
+      _ = 'convert '+this_image+' \( -clone 0 -flop \) +append '+name_of_the_output_file
+      esystem _
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.mirror_image(ARGV)
+end # mirror_image

data/lib/image_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === @store_image_files_in_this_directory
+  # ========================================================================= #
+  @store_image_files_in_this_directory = nil
+
+  # ========================================================================= #
+  # === ImageParadise.store_image_files_in_this_directory=
+  # ========================================================================= #
+  def self.store_image_files_in_this_directory=(
+    i = '/home/x/DATA/IMG/STUDIUM/'
+    )
+    i << '/' unless i.end_with? '/' # Directories must have a trailing '/' token.
+    @store_image_files_in_this_directory = i
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.store_image_files_in_this_directory?
+  # ========================================================================= #
+  def self.store_image_files_in_this_directory?
+    @store_image_files_in_this_directory
+  end
+
+end

data/lib/image_paradise/toplevel_methods/png_to_svg.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ImageParadise # require 'image_paradise/png_to_svg.rb'
+
+  # ========================================================================== #
+  # === ImageParadise.png_to_svg
+  #
+  # Use this method to convert a .png file to a .svg file.
+  #
+  # This has several limitations since we use potrace for this.
+  #
+  # potrace can not work with .png files, only with .pnm files, so
+  # we first have to convert these files.
+  #
+  # The biggest limitation here is that it will remove all colours. :)
+  #
+  # Usage example:
+  #
+  #   ImageParadise.png_to_svg 'COOKBOOKS_LOGO.png'
+  #
+  # ========================================================================== #
+  def self.png_to_svg(this_input_file)
+    pnm_file = this_input_file.gsub(/\.png$/,'')+'.pnm'
+    svg_file = this_input_file.gsub(/\.png$/,'')+'.svg'
+    _ = 'convert '+this_input_file+' '+pnm_file
+    Esystem.esystem _
+    _ = 'potrace '+pnm_file+' -s -o '+svg_file
+    Esystem.esystem _
+    return svg_file
+  end; self.instance_eval { alias convert_png_to_svg png_to_svg } # === Imageparadise.convert_png_to_svg
+
+end

data/lib/image_paradise/toplevel_methods/roebe.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/roebe.rb'
+# ImageParadise.is_on_roebe?
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end

data/lib/image_paradise/toplevel_methods/to_png.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::ToPng
+#
+# This class will simply convert an image file to .png.
+#
+# Usage example:
+#
+#   ImageParadise::ToPng.new
+#
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/to_png.rb'
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+require 'image_paradise/optimizer.rb'
+
+module ImageParadise
+
+class ToPng < ::ImageParadise::Base # === ImageParadise::ToPng
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i].flatten.compact
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === store_where?
+  # ========================================================================= #
+  def store_where?(
+      i = @input
+    )
+    i.gsub(File.extname(i),'')+'.png'
+  end
+
+  # ========================================================================= #
+  # === run_everything
+  #
+  # This method contains the main logic of the file.
+  # ========================================================================= #
+  def run_everything
+    @input.each {|this_file|
+      store_where = store_where?(this_file)
+      opn; e 'Next converting '+simp(this_file)+' to '+sfile(store_where)
+      _ = 'convert '+this_file+' '+store_where
+      esystem _
+      if File.exist? store_where
+        opn; e 'We will next try to optimize '+sfile(store_where)
+        opn; e 'The old file size is: '+sfancy(File.size(store_where).to_s)
+        ::ImageParadise::Optimizer[store_where]
+        opn; e 'The new file size is: '+sfancy(File.size(store_where).to_s)
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run # (run tag)
+    run_everything
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise.to_png
+# =========================================================================== #
+def self.to_png(i = ARGV)
+  ImageParadise::ToPng.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::ToPng.new(ARGV)
+end # to_png