image_paradise 0.4.20

data/lib/image_paradise/label/simple_label.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::SimpleLabel
+#
+# This class will create a simple label.
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+
+module ImageParadise
+
+class SimpleLabel < Base # === ImageParadise::SimpleLabel
+
+  begin
+    require 'open'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === DO_OPEN_IN_BROWSER
+  # ========================================================================= #
+  DO_OPEN_IN_BROWSER = true
+
+  # ========================================================================= #
+  # === DEFAULT_FONT_TO_USE
+  # ========================================================================= #
+  DEFAULT_FONT_TO_USE = 'Helvetica'
+
+  # ========================================================================= #
+  # === DEFAULT_IMAGE_FORMAT
+  # ========================================================================= #
+  DEFAULT_IMAGE_FORMAT = 'PNG'
+
+  # ========================================================================= #
+  # === REGEX_FOR_SIZE
+  # ========================================================================= #
+  REGEX_FOR_SIZE = /(\d+x\d+)/
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_label(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === set_label
+  # ========================================================================= #
+  def set_label(i)
+    if i.is_a? Array
+      i = i.join(' ').strip
+    end
+    # ======================================================================= #
+    # Check whether the label includes a Dimension. This may be a conflict
+    # if the user REALLY wants to use some integer value, as part of the
+    # given label - but aside from this, I think in most other cases,
+    # this is a good default.
+    # ======================================================================= #
+    if i =~ REGEX_FOR_SIZE
+      size_dimension = $1.to_s.dup
+      set_size(size_dimension)
+      i.sub!(/#{size_dimension}/,'')
+    end
+    @label = i
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    @_           = ''.dup
+    @label       = ''.dup
+    @background  = 'lightblue'
+    @fill        = 'blue'
+    @font        = DEFAULT_FONT_TO_USE
+    @pointsize   = '96'
+    @output_file = 'label.'+DEFAULT_IMAGE_FORMAT.downcase
+    set_size       '250x75'
+  end
+
+  # ========================================================================= #
+  # === set_size
+  # ========================================================================= #
+  def set_size(i = '250x75')
+    @size = i.to_s
+  end
+
+  # ========================================================================= #
+  # === build_up_main_command
+  # ========================================================================= #
+  def build_up_main_command
+    @_ = 'convert'.dup
+    add_default_background
+    add_default_fill
+    add_default_font
+    add_default_gravity
+    add_size
+    add_label
+    # add_default_pointsize # Do not add this option if you also added the default size.
+    add_output_file
+  end
+
+  # ========================================================================= #
+  # === add_size
+  # ========================================================================= #
+  def add_size
+    @_ << ' -size '+@size
+  end
+
+  # ========================================================================= #
+  # === add_default_background
+  # ========================================================================= #
+  def add_default_background
+    @_ << ' -background '+@background
+  end
+
+  # ========================================================================= #
+  # === add_default_font
+  # ========================================================================= #
+  def add_default_font
+    @_ << ' -font '+@font
+  end
+
+  # ========================================================================= #
+  # === add_label
+  # ========================================================================= #
+  def add_label
+    _ = @label
+    if _.include? ' '
+      _ = '"'+_+'"'
+    end
+    @_ << ' label:'+_
+  end
+
+  # ========================================================================= #
+  # === add_default_gravity
+  # ========================================================================= #
+  def add_default_gravity
+    @_ << ' -gravity center'
+  end
+
+  # ========================================================================= #
+  # === output_then_run_the_main_command
+  # ========================================================================= #
+  def output_then_run_the_main_command
+    esystem @_
+  end
+
+  # ========================================================================= #
+  # === add_output_file
+  # ========================================================================= #
+  def add_output_file
+    @_ << ' '+@output_file
+  end
+
+  # ========================================================================= #
+  # === output_file?
+  # ========================================================================= #
+  def output_file?
+    @output_file
+  end
+
+  # ========================================================================= #
+  # === add_default_pointsize
+  # ========================================================================= #
+  def add_default_pointsize
+    @_ << ' -pointsize '+@pointsize
+  end
+
+  # ========================================================================= #
+  # === add_default_fill
+  # ========================================================================= #
+  def add_default_fill
+    @_ << ' -fill '+@fill
+  end
+
+  # ========================================================================= #
+  # === consider_opening_in_the_browser
+  # ========================================================================= #
+  def consider_opening_in_the_browser
+    if DO_OPEN_IN_BROWSER
+      Open.in_browser(output_file?)
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    build_up_main_command
+    output_then_run_the_main_command
+    consider_opening_in_the_browser
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::SimpleLabel.new(ARGV)
+end # simple_label "Tomorrow is another day."
+    # simple_label "Tomorrow is another day. 500x250"

data/lib/image_paradise/project/project.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/project/project.rb'
+# ImageParadise.project_base_directory?
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY = 
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === ImageParadise.project_base_directory?
+  # ========================================================================= #
+  def self.project_base_directory?
+    PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_dir? project_base_directory? } # === ImageParadise.project_base_dir?
+       self.instance_eval { alias project_dir?      project_base_directory? } # === ImageParadise.project_dir?
+       self.instance_eval { alias base_dir?         project_base_directory? } # === ImageParadise.base_dir?
+       self.instance_eval { alias base_directory?   project_base_directory? } # === ImageParadise.base_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts ImageParadise.project_base_dir?
+end

data/lib/image_paradise/requires/common_base_requires.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/requires/common_base_requires.rb'
+# =========================================================================== #
+require 'fileutils'
+require 'image_paradise/requires/require_colours.rb'
+begin
+  require 'esystem/method'
+rescue LoadError; end
+begin
+  require 'opn'
+rescue LoadError; end
+begin
+  require 'save_file'
+rescue LoadError; end

data/lib/image_paradise/requires/require_colours.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/requires/require_colours.rb'
+# =========================================================================== #
+begin
+  require 'colours/html_colours'
+rescue LoadError; end

data/lib/image_paradise/requires/require_gtk_components.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/requires/require_gtk_components.rb'
+# =========================================================================== #
+require 'image_paradise/requires/require_the_image_paradise_project.rb'
+require 'image_paradise/gui/gtk/control_panel.rb'

data/lib/image_paradise/requires/require_image_to_ascii.rb

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

data/lib/image_paradise/requires/require_the_image_paradise_project.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Delegate to the following file in order to load the other .rb
+# files of this project.
+# =========================================================================== #
+# require 'image_paradise/requires/require_the_image_paradise_project.rb'
+# =========================================================================== #
+require 'image_paradise/image_paradise.rb'
+require 'image_paradise/colours/colours.rb'
+require 'image_paradise/utility_scripts/black_white.rb'
+require 'image_paradise/shell/interactive.rb'
+require 'image_paradise/rotate/rotate.rb'
+require 'image_paradise/constants/constants.rb'
+require 'image_paradise/constants/image_file_types.rb'
+require 'image_paradise/svg/svg.rb'
+
+# =========================================================================== #
+# Include all image_paradise/class_methods next:
+# =========================================================================== #
+require 'image_paradise/requires/require_toplevel_methods.rb'
+
+ImageParadise.require_toplevel_methods
+
+require 'image_paradise/requires/require_image_to_ascii.rb'
+
+require 'image_paradise/utility_scripts/black_white.rb'
+require 'image_paradise/utility_scripts/image_border.rb'
+require 'image_paradise/utility_scripts/image_manipulations.rb'
+require 'image_paradise/utility_scripts/random_text_to_image.rb'
+require 'image_paradise/utility_scripts/to_jpg.rb'
+require 'image_paradise/utility_scripts/to_gif.rb'
+require 'image_paradise/utility_scripts/text_on_image.rb'
+require 'image_paradise/utility_scripts/image_gallery/image_gallery.rb'
+
+# =========================================================================== #
+# Add chunky-png support:
+# =========================================================================== #
+require 'image_paradise/chunky_png/chunky_png.rb'
+
+require 'image_paradise/toplevel_methods/misc.rb'

data/lib/image_paradise/requires/require_toplevel_methods.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/requires/require_toplevel_methods.rb'
+# ImageParadise.require_toplevel_methods
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/constants/constants.rb'
+
+  # ========================================================================= #
+  # === ImageParadise.require_toplevel_methods
+  # ========================================================================= #
+  def self.require_toplevel_methods
+    Dir["#{PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"].each {|this_image|
+      require "image_paradise/toplevel_methods/#{File.basename(this_image)}"
+    }
+  end
+
+end

data/lib/image_paradise/rotate/README.md

@@ -0,0 +1,2 @@
+Rotate-specific code, that is when images are flipped around, can
+be found in this directory here.

data/lib/image_paradise/rotate/rotate.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The rotate command-line option of ImageMagick takes one argument, which
+# is the number of degrees by which to rotate the image. A positive number
+# is the number of degrees to the right, and a negative number is the
+# number of degrees to the left.
+#
+# For specific rotate-actions you can look at the following website:
+#
+#   https://imagemagick.org/script/command-line-options.php#rotate
+#
+# The specific API would then be:
+#
+#   -rotate degrees{<}{>}
+#
+# =========================================================================== #
+# require 'image_paradise/rotate/rotate.rb'
+# ImageParadise.rotate_left(these_images, n_degrees, background_colour, output_file_here) 
+# ImageParadise.rotate_right(these_images, n_degrees, background_colour, output_file_here)
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/toplevel_methods/esystem.rb'
+
+  # ========================================================================= #
+  # === ImageParadise.rotate_this_image
+  #
+  # This method will always operate on the first input argument(s) in
+  # batch form - hence we convert the first argument given to an
+  # Array, inside of the method. Doing so allows the user to provide
+  # a bunch of images that will all receive the same rotate-operation.
+  #
+  # The second input-argument to this method specifies the degree for the
+  # rotation; a value with a '+' or without any modified token means
+  # "clockwise rotation", that is rotation towards the right. A value
+  # that is negative here, aka has a leading '-', means "counter-clockwise
+  # rotation", that is to the left. Thus, rotate-left is counter-clockwise;
+  # and rotate-right is clockwise.
+  #
+  # When we use convert, the commandline flags should look like this:
+  #
+  #   convert -resize "600>" image.png Newimage/image.png
+  #
+  # ========================================================================= #
+  def self.rotate_this_image(
+      these_images               = ARGV,
+      by_n_degrees               = '-45', # Default is -45.
+      use_this_background_colour = nil,   # ← Fill with this background colour.
+      output_file                = :infer
+    )
+    case by_n_degrees
+    when :rotate_left,
+         :left
+      by_n_degrees = '-90'
+    when :rotate_right,
+         :right
+      by_n_degrees = '+90'
+    end
+    these_images = [these_images].flatten.compact
+    these_images.each {|this_image|
+      case output_file
+      when :infer, :default, nil
+        output_file = 'new_file_'+File.basename(this_image)
+      end
+      # ===================================================================== #
+      # Note that the -density 300 part was added in March 2021,
+      # after I noticed a significant loss in quality after
+      # rotate-operations.
+      # ===================================================================== #
+      _ = 'convert -density 300 -rotate "'+by_n_degrees.to_s+'"'.dup
+      _ << " #{this_image}"
+      if use_this_background_colour
+        case use_this_background_colour.to_s
+        when :default
+          use_this_background_colour = nil
+        when 'black'
+          use_this_background_colour = 'FFFFFF'
+        end
+        if use_this_background_colour
+          _ << ' -background "#'+use_this_background_colour.to_s+'"'
+        end
+      end
+      _ << " #{output_file}"
+      esystem _
+    }
+  end; self.instance_eval { alias rotate_these_images rotate_this_image } # === ImageParadise.rotate_these_images
+
+  # ========================================================================= #
+  # === ImageParadise.rotate_left
+  #
+  # The second argument specifies the degree-rotation.
+  # ========================================================================= #
+  def self.rotate_left(
+      these_images               = ARGV,
+      by_n_degrees               = :rotate_left,
+      use_this_background_colour = nil,
+      output_file                = :infer
+    )
+    ImageParadise.rotate_this_image(
+      these_images, by_n_degrees, use_this_background_colour, output_file
+    )
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.rotate_right
+  # ========================================================================= #
+  def self.rotate_right(
+      these_images               = ARGV,
+      by_n_degrees               = :rotate_right,
+      use_this_background_colour = nil,
+      output_file                = :infer
+    )
+    ImageParadise.rotate_this_image(
+      these_images, by_n_degrees, use_this_background_colour, output_file
+    )
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.rotate_this_image(ARGV)
+end # rotatethisimage /home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/image_paradise/test/16x16_red_square_image_for_testing.png

data/lib/image_paradise/shell/interactive.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::Interactive
+#
+# Usage example:
+#   ImageParadise::Interactive.new
+# =========================================================================== #
+# require 'image_paradise/shell/interactive.rb'
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+require 'image_paradise/toplevel_methods/write_this_text.rb'
+
+module ImageParadise
+
+class Interactive < ::ImageParadise::Base # === ImageParadise::Interactive
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    register_sigint
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i] unless i.is_a? Array
+    @input = i # Must be an Array.
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    try_to_enter_this_directory('/Depot/j')
+    loop {
+      obtain_user_input
+      menu(@user_input)
+    }
+  end
+
+  # ========================================================================= #
+  # === try_to_enter_this_directory
+  # ========================================================================= #
+  def try_to_enter_this_directory(i = '/Depot/j')
+    if File.directory?(i)
+      chdir(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_user_input
+  # ========================================================================= #
+  def obtain_user_input
+    @user_input = $stdin.gets.chomp
+  end
+
+  # ========================================================================= #
+  # === display_prompt
+  # ========================================================================= #
+  def display_prompt
+    print '> '
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      display_prompt
+      case i # case tag
+      # ===================================================================== #
+      # === pwd
+      # ===================================================================== #
+      when /pwd/
+        e sdir(Dir.pwd)
+      # ===================================================================== #
+      # === bachelor_master
+      # ===================================================================== #
+      when '1',/bachelor_?master/
+        generate_bachelor_and_master_images
+      when 'q','exit'
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === generate_bachelor_and_master_images                        (main tag)
+  # ========================================================================= #
+  def generate_bachelor_and_master_images
+    height_value    =  28
+    width_value     =  94
+    pointsize_value =  18
+    # ======================================================================= #
+    # Designate another store-location for our two images there.
+    # ======================================================================= #
+    ImageParadise.store_image_files_in_this_directory = 
+      '/home/x/DATA/IMG/STUDIUM/'
+    ImageParadise.write_this_text(
+      'Bachelor',
+        {colour: 'red', height: height_value, width: width_value, upcase_filename: true, pointsize: pointsize_value}
+    )
+    ImageParadise.write_this_text(
+      'Master',
+        {colour: 'darkblue', height: height_value, width: width_value, upcase_filename: true, pointsize: pointsize_value}
+    )
+  end
+
+  # ========================================================================= #
+  # === []
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise.interactive_shell
+# =========================================================================== #
+def self.interactive_shell
+  ImageParadise::Interactive.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::Interactive.new(ARGV)
+end # interactive.rb

data/lib/image_paradise/svg/README.md

@@ -0,0 +1,5 @@
+This subdirectory contains code related to SVG.
+
+Until August 2020, this used to be a separate project,
+called svg_paradise, before it was integrated into
+this project here.