image_paradise 0.1.12

data/lib/image_paradise/confree_generator/gui/insert_button.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::InsertButton
+#
+# require 'image_paradise/confree_generator/gui/insert_button.rb'
+# =========================================================================== # 
+# This button is used to insert a line at the current iter.
+# InsertButton.new
+# =========================================================================== #
+module ImageParadise
+
+class InsertButton < Gtk::Button
+
+  include Gtk::Colours
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(mode, master_widget)
+    super('Insert ' << mode.to_s.upcase)
+    set_mode(mode)
+    @master_widget = master_widget
+    self.modify_bg( Gtk::StateType::NORMAL,   CADETBLUE )
+    self.modify_bg( Gtk::StateType::ACTIVE,   BROWN )
+    self.modify_bg( Gtk::StateType::PRELIGHT, BISQUE )
+    self.set_size_request(66, 28)
+    self.set_border_width(0)
+    self.signal_connect(:clicked) { |widget, event| check_args(@mode) }
+  end
+
+  # ========================================================================= #
+  # === set_mode
+  # ========================================================================= #
+  def set_mode(i)
+    @mode = i
+  end
+
+  # ========================================================================= #
+  # === check_args
+  #
+  # Here we check for the different insert buttons.
+  # ========================================================================= #
+  def check_args(which_mode)
+    _ = @master_widget.source_buffer
+    case which_mode
+    when :comment
+      _.insert_at_cursor(
+        '# ===================================== #'+N)
+      _.insert_at_cursor(
+        '# '+N)
+      _.insert_at_cursor(
+        '# ===================================== #'+N)
+    when :background
+      _.insert_at_cursor('background { b -0.95 sat 1 hue 180 }')
+    when :square
+      _.insert_at_cursor('SQUARE {}')
+    when :triangle
+      _.insert_at_cursor('TRIANGLE {}')
+    when :line
+      _.insert_at_cursor('LINE {}')
+    when :rect
+      _.insert_at_cursor('RECT {}')
+    when :circle
+      _.insert_at_cursor('CIRCLE {}')
+    when :hue
+      _.insert_at_cursor(' hue 10 ')
+    when :sat
+      _.insert_at_cursor(' sat 0.995 ')
+    when :b
+      _.insert_at_cursor(' b 0.995 ')
+    when :n
+      _.insert_at_cursor("\n")
+    end
+  end
+
+end; end

data/lib/image_paradise/confree_generator/reset.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/confree_generator/reset.rb'
+# =========================================================================== #
+module ImageParadise
+
+class ConfreeGenerator < ::ImageParadise::Base # === ImageParadise::ConfreeGenerator
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @try_to_open_the_generated_image_in_the_browser
+    # ======================================================================= #
+    @try_to_open_the_generated_image_in_the_browser =
+      TRY_TO_OPEN_THE_GENERATED_IMAGE_IN_THE_BROWSER
+    # ======================================================================= #
+    # === @create_image
+    # ======================================================================= #
+    @create_image = true
+    # ======================================================================= #
+    # The variable @html_file tells us where to store html stuff into.
+    #
+    # By default it will point at:
+    #
+    #   /Depot/Images/Confree_Images.html
+    #
+    # ======================================================================= #
+    @html_file = "#{TEMP_IMAGES}Confree_Images.html"
+    # ======================================================================= #
+    # === @file_listing
+    # ======================================================================= #
+    @file_listing = nil # will contain files in my IMG/CFDG dir
+    @batch_mode = false
+    # ======================================================================= #
+    # === @n_confree_files
+    # ======================================================================= #
+    @n_confree_files = 0
+    set_location_of_output_file
+    set_width_then_height(
+      DEFAULT_WIDTH,
+      DEFAULT_HEIGHT
+    )
+    # ======================================================================= #
+    # === @create_html_gallery
+    # ======================================================================= #
+    @create_html_gallery = CREATE_HTML_GALLERY # If true, we create a html gallery.
+    # ======================================================================= #
+    # The next flag can be true or false.
+    #
+    # By default it should be true. If it is true, we will generate the
+    # image in question. Sometimes though, we may only want to generate
+    # the HTML code - that is why this variable exists.
+    # ======================================================================= #
+    @generate_the_image = GENERATE_THE_IMAGE
+  end
+
+end; end

data/lib/image_paradise/confree_generator/shared/shared.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::ConfreeGenerator::Shared
+#
+# Data to be exchanged between the different .rb files in the
+# confree_generator project is bundled into this file here.
+# =========================================================================== #
+# require 'image_paradise/confree_generator/shared/shared.rb'
+# =========================================================================== #
+require 'image_paradise/confree_generator/constants.rb'
+require 'image_paradise/base/base.rb'
+require 'image_paradise/toplevel_methods/file_related_code.rb'
+
+module ImageParadise
+
+class ConfreeGenerator < ::ImageParadise::Base # === ImageParadise::ConfreeGenerator::Shared
+
+module Shared # require 'confree_generator/shared.rb'; include Shared
+
+  include Colours
+
+  N = "\n" # Newline.
+
+  # ========================================================================= #
+  # === ARRAY_SKIP_THESE_FILES
+  #
+  # The following Array lists all .cfdg files which should be be part of 
+  # what we return with "get_all_cfdg_files".
+  #
+  # Some .cfdg files that take notoriously long to process can be 
+  # added to this array.
+  # ========================================================================= #
+  ARRAY_SKIP_THESE_CFDG_FILES = %w(
+    std_cfdg.cfdg
+  )
+
+  # ========================================================================= #
+  # Height and Width settings. Should not be too large because otherwise
+  # the generated image files may be really huge.
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === DEFAULT_HEIGHT
+  # ========================================================================= #
+  DEFAULT_HEIGHT = '420' # default height for an image
+
+  # ========================================================================= #
+  # === DEFAULT_WIDTH
+  # ========================================================================= #
+  DEFAULT_WIDTH  = '280' # default width  for an image
+
+  # ========================================================================= #
+  # === MY_CONFREE_DIR
+  #
+  # This constants defines the directory where our .cfdg files reside.
+  # You can either set an environment variable, called CFDG, or simply 
+  # hardcode the value. This constant is very important for batch-processing.
+  # ========================================================================= #
+  if ENV['CFDG']
+    MY_CONFREE_DIR = ENV['CFDG'].to_s.dup+'/'
+  else
+    MY_CONFREE_DIR = '/Users/x/DATA/IMG/CFDG/' # '/tmp/'
+  end; DIRECTORY_WITH_CFDG_IMAGES = MY_CONFREE_DIR; CFDG_DIRECTORY = MY_CONFREE_DIR
+
+  # ========================================================================= #
+  # Where our TEMP dir is defined.
+  # ========================================================================= #
+  if ENV['MY_TEMP']
+    TEMP_DIR = ENV['MY_TEMP'].to_s.dup+'/'
+  else
+    TEMP_DIR = '/Depot/Temp/' # Hardcoded for now.
+  end
+  TEMP_IMAGES = '/Depot/Images/'
+  HTML_FILE_CONFREE_IMAGES = '/Depot/Information/Confree_Images.html'
+  YOUR_FAVOURITE_EDITOR = 'bluefish' # Your favourite editor comes here.
+
+  # ========================================================================= #
+  # === get_random_cfdg_file
+  #
+  # This method will obtain one random .cfdg file.
+  # ========================================================================= #
+  def get_random_cfdg_file(i = DIRECTORY_WITH_CFDG_IMAGES)
+    get_all_cfdg_files(i).sample
+  end; alias get_random_cfdg get_random_cfdg_file # === get_random_cfdg
+
+  # ========================================================================= #
+  # === get_all_cfdg_files
+  #
+  # This method will try to get all .cfdg files, except for
+  # all entries we stored in our Array at the top.
+  # ========================================================================= #
+  def get_all_cfdg_files(
+      i = DIRECTORY_WITH_CFDG_IMAGES
+    )
+    Dir["#{i}*.cfdg"] - ARRAY_SKIP_THESE_CFDG_FILES
+  end
+
+end; end; end

data/lib/image_paradise/constants.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/constants.rb'
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/project/project.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === ALPHABET
+  # ========================================================================= #
+  ALPHABET = ('a'..'z').to_a
+
+  # ========================================================================= #
+  # === DEFAULT_CROP_COMMAND_TO_USE
+  # ========================================================================= #
+  DEFAULT_CROP_COMMAND_TO_USE = '125x125+35+35'
+
+  # ========================================================================= #
+  # === DEFAULT_TEXT
+  #
+  # This is the default text.
+  # ========================================================================= #
+  DEFAULT_TEXT = 'Hello World!'
+
+  # ========================================================================= #
+  # === DEFAULT_FONT
+  # ========================================================================= #
+  DEFAULT_FONT = 'Terminus'
+
+  # ========================================================================= #
+  # === CONVERT
+  # ========================================================================= #
+  CONVERT      = 'convert'
+
+end

data/lib/image_paradise/constants/image_file_types.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/constants/image_file_types.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise::ARRAY_IMAGE_FILE_TYPES
+  # ========================================================================= #
+  ARRAY_IMAGE_FILE_TYPES = %w(
+    .png
+    .gif
+    .tiff
+    .jpg
+    .bmp
+    .ascii
+  )
+
+end

data/lib/image_paradise/create_animated_gif.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS
+  # ========================================================================= #
+  INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS = '*.gif'
+
+  # ========================================================================= #
+  # === DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+  # ========================================================================= #
+  DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS = '100'
+
+  # ========================================================================= #
+  # === ImageParadise.create_animated_gif
+  #
+  # This method will create an animated gif.
+  #
+  # The input should be either an Array of input_images, or a string which
+  # will be used to create the command.
+  #
+  # A delay of 100 means 1 second delay.
+  # ========================================================================= #
+  def self.create_animated_gif(
+      input_images = INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS,
+      delay        = DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+    )
+    output_name = 'animated_gif.gif'
+    _ = 'convert -delay 100 -loop 0 '+input_images+' '+output_name
+    esystem _
+    e 'Finished creating `'+sfile(output_name)+'`.' if File.exist? output_name
+  end
+
+  # ========================================================================= #
+  # === create_animated_gif
+  # ========================================================================= #
+  def create_animated_gif(
+      input_images = INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS,
+      delay = DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+    )
+    ImageParadise.create_animated_gif(input_images, delay)
+  end
+
+end

data/lib/image_paradise/crop/crop.rb

@@ -0,0 +1,302 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::Crop
+#
+# This class can be used to crop an image file via ImageMagick.
+#
+# Usage example:
+#   require 'crop'
+#   ImageParadise::Crop.new
+# =========================================================================== #
+# require 'image_paradise/crop.rb'
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+
+module ImageParadise
+
+class Crop < ::ImageParadise::Base # === ImageParadise::Crop
+
+  # ========================================================================= #
+  # === CROP_COMMAND_TO_USE
+  # ========================================================================= #
+  CROP_COMMAND_TO_USE = '125x125+35+35'
+
+  # ========================================================================= #
+  # === CONVERT_COMMAND
+  # ========================================================================= #
+  CONVERT_COMMAND = 'convert'
+
+  # ========================================================================= #
+  # === TEMP_DIR
+  # ========================================================================= #
+  TEMP_DIR = '/Depot/Temp/'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      input_filename        = nil,
+      use_this_crop_command = nil,
+      run_already           = true
+    )
+    reset
+    case input_filename
+    when :do_not_run_yetimage_shell
+      input_filename = nil
+      run_already = false
+    end
+    set_input_filename(input_filename)
+    set_use_this_crop_command(use_this_crop_command)
+    case run_already
+    when :dont_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    @be_verbose = true
+    @temp_dir = TEMP_DIR
+    @temp_dir = (Dir.pwd+'/').squeeze '/'
+    set_input_filename
+    set_output_file
+  end
+
+  # ========================================================================= #
+  # === input_filename?
+  # ========================================================================= #
+  def input_filename?
+    @input_filename.to_s
+  end; alias input? input_filename? # === input?
+
+  # ========================================================================= #
+  # === crop_command?
+  # ========================================================================= #
+  def crop_command?
+    @use_this_crop_command
+  end
+
+  # ========================================================================= #
+  # === synchronize_output_filename
+  # ========================================================================= #
+  def synchronize_output_filename
+    set_output_file :synchronize
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === perform_crop_action
+  #
+  # The first input shall be the filename we wish to crop.
+  #
+  # The second input shall be which specific crop command we will use.
+  # ========================================================================= #
+  def perform_crop_action(
+      crop_this_image       = input?,
+      use_this_crop_command = crop_command?
+    )
+    if crop_this_image.is_a? Array
+      crop_this_image = crop_this_image.join(' ')
+    end
+    # ======================================================================= #
+    # Next convert both into Strings.
+    # ======================================================================= #
+    crop_this_image = crop_this_image.to_s
+    use_this_crop_command = use_this_crop_command.to_s
+    if use_this_crop_command.empty?
+      use_this_crop_command = DEFAULT_CROP_COMMAND_TO_USE
+    end
+    # ======================================================================= #
+    # The following means that the user passed only one +5 rather
+    # than two +5+5, hence we sanitize it here.
+    # ======================================================================= #
+    if use_this_crop_command.count('+') == 1
+      use_this_crop_command << use_this_crop_command[
+        use_this_crop_command.index('+')..-1
+      ]
+    end
+    if use_this_crop_command.include? '%'
+      use_this_crop_command << 'x+0+0' unless use_this_crop_command[0,1] == 'x'
+    end
+    set_crop_command(use_this_crop_command) # Synchronize it back here.
+    opn; e 'Next cropping the image `'+sfancy(crop_this_image)+'`.'
+    _ = CONVERT_COMMAND+' '+crop_this_image+
+        ' -crop '+use_this_crop_command+' '+output_file?
+    opn; Esystem.esystem(_)
+    report_where_the_file_is_now_stored if be_verbose?
+    return output_file?
+  end; alias do_crop perform_crop_action # === do_crop
+       alias crop    perform_crop_action # === crop
+
+  # ========================================================================= #
+  # === report_where_the_file_is_now_stored
+  # ========================================================================= #
+  def report_where_the_file_is_now_stored
+    opn; e 'This should now be stored at '
+    opn; e "  #{sfile(output_file?)}"
+  end
+
+  # ========================================================================= #
+  # === set_use_this_crop_command
+  # ========================================================================= #
+  def set_use_this_crop_command(i = nil)
+    i = CROP_COMMAND_TO_USE if i.nil?
+    i = i.join ' ' if i.is_a? Array
+    @use_this_crop_command = i
+  end; alias set_crop_command set_use_this_crop_command # === set_crop_command
+
+  # ========================================================================= #
+  # === output_file?
+  # ========================================================================= #
+  def output_file?
+    @output_file
+  end; alias result  output_file? # === result
+       alias result? output_file? # === result?
+       alias output? output_file? # === output?
+
+  # ========================================================================= #
+  # === set_input_filename
+  #
+  # Whenever we modify the input filename, we also must update the
+  # output_filename.
+  # ========================================================================= #
+  def set_input_filename(i = nil)
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input_filename = i
+    synchronize_output_filename
+  end; alias input_file= set_input_filename # === input_file=
+
+  # ========================================================================= #
+  # === ImageParadise::Crop[]
+  #
+  # An alias to the above method.
+  # ========================================================================= #
+  def self.[](i, use_this_crop_command)
+    Crop.crop(i, use_this_crop_command)
+  end
+
+  # ========================================================================= #
+  # === ImageParadise::Crop.crop
+  #
+  # We purposely require two arguments here.
+  # ========================================================================= #
+  def self.crop(
+      crop_this_image,
+      use_this_crop_command,
+      optional_hash = {}
+    )
+    _ = Crop.new :do_not_run_yet
+    if optional_hash.has_key? :store_in_this_directory
+      _.set_store_here(
+        optional_hash.delete(:store_in_this_directory)
+      )
+    end
+    _.input_file = crop_this_image
+    result = _.crop(crop_this_image, use_this_crop_command)
+    return result
+  end
+
+  # ========================================================================= #
+  # === set_output_file
+  # ========================================================================= #
+  def set_output_file(
+      i = default_name_for_cropped_image
+    )
+    if i.nil? or i == :synchronize
+      i = default_name_for_cropped_image
+    end
+    i = (Dir.pwd+'/'+i).squeeze('/') unless i.include? '/'
+    @output_file = i
+  end
+
+  # ========================================================================= #
+  # === default_name_for_cropped_image
+  # ========================================================================= #
+  def default_name_for_cropped_image
+    temp_dir?+'CROPPED_IMAGE_'+today+'_'+File.basename(input?)
+  end
+
+  # ========================================================================= #
+  # === temp_dir?
+  # ========================================================================= #
+  def temp_dir?
+    @temp_dir
+  end
+
+  # ========================================================================= #
+  # === set_store_here
+  # ========================================================================= #
+  def set_store_here(i)
+    i << '/' unless i.end_with? '/'
+    @temp_dir = i
+  end
+
+  # ========================================================================= #
+  # === run_everything
+  # ========================================================================= #
+  def run_everything
+    perform_crop_action # This here will do the actual cropping.
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_everything
+  end
+
+end
+
+  # ========================================================================= #
+  # === ImageParadise.crop
+  #
+  # Use this toplevel-method in order to crop an image.
+  #
+  # If we omit the second argument then we will use the default setting,
+  # which should be sufficiently useful enough to yield a cropped image.
+  #
+  # The "-crop" operator also understands how to crop an image to just
+  # a percentage of its original size.
+  #
+  # For example, this would half the size of the image: 
+  #   convert foo.png -crop 50%x+0+0 CROPPED_foo.png
+  #
+  # The first argument to this method shall be the filename that we wish
+  # to modify.
+  #
+  # The second argument is the specific image manipulation we wish to
+  # apply onto that image.
+  #
+  # Usage example:
+  #   ImageParadise.crop('foo.png','40x30+10+10')
+  # ========================================================================= #
+  # Official documentation for crop-related actions in regards to
+  # ImageMagick can be found here:
+  #
+  #   http://www.imagemagick.org/script/command-line-options.php?#crop
+  # ========================================================================= #
+  def self.crop(
+      i, # The input-ile is a mandatory argument.
+      crop_command_to_use = DEFAULT_CROP_COMMAND_TO_USE,
+      optional_hash = {}
+    )
+    ::ImageParadise::Crop.crop(i, crop_command_to_use, optional_hash)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::Crop.new(ARGV[0], ARGV[1])
+end # crop