image_paradise 0.1.12

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
+# =========================================================================== #
+require 'image_paradise/constants.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === 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,98 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# For rotate-actions you can look at the following website:
+#
+#   https://imagemagick.org/script/command-line-options.php#rotate
+#
+# The specific API would be:
+#
+#   -rotate degrees{<}{>}
+#
+# =========================================================================== #
+# require 'image_paradise/rotate/rotate.rb'
+# =========================================================================== #
+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.
+  #
+  # The second input-argument specifies the degree for the rotation; a
+  # value with a '+' or without any modified token means "clockwise
+  # "rotation; a value that is negative, aka has a leading '-', means
+  # counter-clockwise rotation. 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',
+      use_this_background_colour = nil # <- Fill with this background colour.
+    )
+    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|
+      output_file = 'new_file_'+File.basename(this_image)
+      _ = 'convert -rotate "'+by_n_degrees.to_s+'"'
+      _ << ' '+this_image
+      if use_this_background_colour
+        case use_this_background_colour.to_s
+        when 'black'
+          use_this_background_colour = 'FFFFFF'
+        end
+        _ << ' -background "#'+use_this_background_colour.to_s+'"'
+      end
+      _ << " #{output_file}"
+      esystem _
+    }
+  end; self.instance_eval { alias rotate_these_images rotate_this_image } # === ImageParadise.rotate_these_images
+
+  # ========================================================================= #
+  # === ImageParadise.rotate_left
+  # ========================================================================= #
+  def self.rotate_left(
+      these_images               = ARGV,
+      by_n_degrees               = :rotate_left,
+      use_this_background_colour = nil
+    )
+    ImageParadise.rotate_this_image(
+      these_images, by_n_degrees, use_this_background_colour
+    )
+  end
+
+  # ========================================================================= #
+  # === ImageParadise.rotate_right
+  # ========================================================================= #
+  def self.rotate_right(
+      these_images               = ARGV,
+      by_n_degrees               = :rotate_right,
+      use_this_background_colour = nil
+    )
+    ImageParadise.rotate_this_image(
+      these_images, by_n_degrees, use_this_background_colour
+    )
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.rotate_this_image(ARGV)
+end # rotate_this_image /Users/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.

data/lib/image_paradise/svg/circle.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/circle.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+module Circle # === ImageParadise::Svg::Circle
+
+  # ========================================================================= #
+  # === DEFAULT_HEIGHT
+  # ========================================================================= #
+  DEFAULT_HEIGHT = '100'.freeze
+
+  # ========================================================================= #
+  # === DEFAULT_RADIUS
+  # ========================================================================= #
+  DEFAULT_RADIUS = '40'.freeze
+
+  # ========================================================================= #
+  # === Svg::Circle.create
+  #
+  # This will generate a SVG circle.
+  #
+  # A circle has to be synced though as otherwise it is not a circle.
+  # ========================================================================= #
+  def self.create(
+      height_and_width = DEFAULT_HEIGHT,
+      fill_colour      = 'red',
+      stroke_width     = '3',
+      radius           = DEFAULT_RADIUS
+    )
+    # ======================================================================= #
+    # === Handle Hash given as input to us next
+    # ======================================================================= #
+    if height_and_width.is_a? Hash
+      if height_and_width.has_key? :height
+        height_and_width = height_and_width.delete(:height) # This is ok because width and height are the same.
+      end
+      if height_and_width.has_key? :radius
+        radius = height_and_width.delete(:radius)
+        case radius
+        when :half_default_width
+          radius = DEFAULT_RADIUS.to_f / 2
+        when :quarter_default_width
+          radius = DEFAULT_RADIUS.to_f / 4
+        end
+      end if height_and_width.is_a? Hash
+      if height_and_width.has_key? :stroke_width
+        stroke_width = height_and_width.delete(:stroke_width)
+      end if height_and_width.is_a? Hash
+      if height_and_width.has_key? :colour
+        fill_colour = height_and_width.delete(:colour)
+      end if height_and_width.is_a? Hash
+      if height_and_width.respond_to? :empty?
+        height_and_width = DEFAULT_HEIGHT if height_and_width.empty?
+      end
+    end
+    # ======================================================================= #
+    # Convert the various arguments passed to this method into a String.
+    # ======================================================================= #
+    height_and_width = height_and_width.to_s.dup unless height_and_width.is_a? Hash
+    fill_colour      = fill_colour.to_s.dup
+    stroke_width     = stroke_width.to_s.dup
+    radius           = radius.to_i.to_s.dup
+    # ======================================================================= #
+    # === Handle random fill colour
+    # ======================================================================= #
+    if fill_colour == 'random'
+      fill_colour = Colours::HtmlColours.random.dup
+    end
+    _ = Svg.strip(
+      '<svg height="'+height_and_width+'" width="'+height_and_width+'">
+        <circle cx="50" cy="50" r="'+radius+'" stroke="black" stroke-width="'+stroke_width+'" fill="'+fill_colour+'" />'+
+        Svg.close_svg
+    )+N
+    _ = _.to_s.dup
+    Svg.add(_)
+    return _
+  end
+
+end
+
+# =========================================================================== #
+# === Svg.circle
+#
+# Always sync to the above method.
+#
+# Usage example:
+#
+#   Svg.circle(150,:blue,5,20)
+#
+# =========================================================================== #
+def self.circle(
+    a = '100',
+    b = 'red',
+    c = '3',
+    r = '40'
+  )
+  Svg::Circle.create(a,b,c,r)
+end
+
+end; end

data/lib/image_paradise/svg/feature.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/feature.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+class Feature # === ImageParadise::Svg::Feature
+
+  attr_accessor :stroke
+  attr_accessor :stroke_width
+  attr_accessor :fill
+  attr_accessor :fill_opacity
+  attr_accessor :stroke_opacity
+  attr_accessor :style
+
+  # ========================================================================= #
+  # === to_svg
+  # ========================================================================= #
+  def to_svg
+    '<overrideme/>'
+  end
+
+  # ========================================================================= #
+  # === attr_to_s
+  # ========================================================================= #
+  def attr_to_s(
+      attr_name, attr_val
+    )
+    return '' if attr_val.nil? 
+    " #{attr_name}=\"#{attr_val}\"" unless attr_val.to_s.empty?
+  end
+
+  # ========================================================================= #
+  # === point_to_s
+  # ========================================================================= #
+  def point_to_s(
+      x_attr_name, y_attr_name, point
+    )
+    return '' if point.nil? 
+    return_val = " #{x_attr_name}=\"#{point.x}\"" unless point.x.to_s.empty?
+    return_val + " #{y_attr_name}=\"#{point.y}\"" unless point.y.to_s.empty?
+  end
+
+end; end; end

data/lib/image_paradise/svg/rectangle.rb

@@ -0,0 +1,154 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/rectangle.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+module Rectangle # === ImageParadise::Svg::Rectangle
+
+  # ========================================================================= #
+  # === DEFAULT_WIDTH
+  # ========================================================================= #
+  DEFAULT_WIDTH = '400'
+
+  # ========================================================================= #
+  # === DEFAULT_HEIGHT
+  # ========================================================================= #
+  DEFAULT_HEIGHT = '180'
+
+  # ========================================================================= #
+  # === DEFAULT_FILL_COLOUR
+  # ========================================================================= #
+  DEFAULT_FILL_COLOUR = 'red'
+
+  # ========================================================================= #
+  # === Svg::Rectangle.create
+  #
+  # This will generate a SVG rectangle.
+  #
+  # A proper rectangle has a width and a height setting.
+  #
+  # You can optionally handle opacity if you pass in a block.
+  # ========================================================================= #
+  def self.create(
+      width        = DEFAULT_WIDTH,
+      height       = DEFAULT_HEIGHT,
+      fill_colour  = DEFAULT_FILL_COLOUR,
+      stroke_width = '3'
+    )
+
+    extra_elements = '' # Extra values for the SVG attribute.
+    opacity = ''.dup # This variable keeps track over whether we require opacity.
+
+    # ======================================================================= #
+    # === Handle block arguments next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # Next convert a Proc to its "real" value.
+      # ===================================================================== #
+      if yielded.is_a? Proc
+        yielded = yielded.call
+      end
+      if yielded.is_a?(String)
+        if yielded.include? 'opacity'
+          # ================================================================= #
+          # === Handle opacity
+          #
+          # Popular options are:
+          #
+          #   'fill-opacity:0.9;stroke-opacity:0.9'
+          #
+          # ================================================================= #
+          opacity << yielded
+          opacity << ';' unless opacity.end_with? ';'
+        end
+        if yielded.include? 'rounded'
+          # ================================================================= #
+          # === Handle rounded edges for a rectangle
+          #
+          # The rx and the ry attributes rounds the corners of the rectangle.
+          # ================================================================= #
+          extra_elements = ' x="50" y="20" rx="20" ry="20" '
+        end
+      end
+    end
+
+    # ======================================================================= #
+    # === Handle Hash given as input to us next
+    # ======================================================================= #
+    if width.is_a? Hash
+      if width.has_key? :fill_colour
+        fill_colour = width.delete(:fill_colour)
+      end
+      if width.has_key? :width
+        width = width.delete(:width)
+      end if width.is_a? Hash
+      if width.has_key? :height
+        height = width.delete(:height) # This is ok because width and height are the same.
+      end if width.is_a? Hash
+      if width.has_key? :stroke_width
+        stroke_width = width.delete(:stroke_width)
+      end if width.is_a? Hash
+      if width.has_key? :colour
+        fill_colour = width.delete(:colour)
+      end if width.is_a? Hash
+      unless width.is_a? Numeric
+        width = DEFAULT_WIDTH if width.empty?
+      end
+    end
+    # ======================================================================= #
+    # Convert the various arguments passed to this method into a String.
+    # ======================================================================= #
+    width         = width.to_s.dup unless width.is_a? Hash
+    height        = height.to_s
+    fill_colour   = fill_colour.to_s
+    stroke_width  = stroke_width.to_s
+    # ======================================================================= #
+    # === Handle random fill colour
+    # ======================================================================= #
+    if fill_colour == 'random'
+      fill_colour = Colours::HtmlColours.random
+    end
+    # ======================================================================= #
+    # We will put the inner-rectangle at 80%.
+    # ======================================================================= #
+    _ = Svg.strip(
+    '<svg width="'+width+'" height="'+height+'">
+
+        <rect '+extra_elements+'width="'+(width.to_f * 80 / 100).to_i.to_s+'" height="'+(height.to_f * 80 / 100).to_i.to_s+'" style="'+opacity+'fill:'+fill_colour+';stroke-width:'+stroke_width+';stroke:rgb(0,0,0)">
+        '+Svg.close_svg
+    )+N
+    _ = _.to_s.dup
+    Svg.add(_)
+    return _
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise::Svg.rectangle
+#
+# Always sync to the above method.
+#
+# Usage examples:
+#
+#   Svg.rectangle(150,:blue,5,20)
+#
+# =========================================================================== #
+def self.rectangle(
+    a = Svg::Rectangle::DEFAULT_WIDTH,
+    b = Svg::Rectangle::DEFAULT_HEIGHT,
+    c = Svg::Rectangle::DEFAULT_FILL_COLOUR,
+    d = '3',
+    &block
+  )
+  Svg::Rectangle.create(a,b,c,d) { block }
+end
+
+end; end