cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/generator/webpage_for_images.rb

@@ -1,553 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === Cyberweb::Generator::WebpageForImages
-#
-# This semi-standalone class will create a little webpage, mostly to
-# just display some auto-generated images (via ImageMagick), but also
-# an arbitrary collection of images.
-#
-# Specific Usage example for this class:
-#
-#   webpage = Cyberweb::Generator::WebpageForImages.new
-#   webpage.set_images(@_)
-#   webpage.run
-#
-# ============================================================================ #
-# require 'cyberweb/generator/webpage_for_images.rb'
-# ============================================================================ #
-require 'cyberweb/generator/class.rb'
-
-module Cyberweb
-
-module Generator
-
-class WebpageForImages < ::Cyberweb::Generator::Generator # === Cyberweb::Generator::WebpageForImages
-
-  include HtmlTags
-
-  require 'cyberweb/html_template/html_template.rb'
-  require 'cyberweb/toplevel_methods/jquery.rb'
-  
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  # ========================================================================= #
-  # === IMG_CSS_STYLE
-  #
-  # Determine the default css-rules for <img> tags.
-  # ========================================================================= #
-  IMG_CSS_STYLE =
-    'border:1px solid black;
-     margin-left: 4.5em;
-     padding-left: 5px;'.delete("\n").squeeze(' ')
-
-  # ========================================================================= #
-  # === DEBUG
-  # ========================================================================= #
-  DEBUG = false # Whether we debug this class or not.
-
-  # ========================================================================= #
-  # === BE_VERBOSE
-  # ========================================================================= #
-  BE_VERBOSE = true
-
-  # ========================================================================= #
-  # === HTML
-  # ========================================================================= #
-  HTML = '.html' # HTML File suffice comes here.
-
-  # ========================================================================= #
-  # === INFO_DIRECTORY
-  # ========================================================================= #
-  INFO_DIRECTORY = '/Depot/Information/' # Base directory where to store, unless we use Dir.pwd
-
-  # ========================================================================= #
-  # === ARRAY_IMAGES
-  # ========================================================================= #
-  ARRAY_IMAGES = %w( jpg png gif ) # All valid image-formats.
-
-  # ========================================================================= #
-  # === initialize
-  #
-  # First argument should have the commandline arguments.
-  # ========================================================================= #
-  def initialize(
-      commandline_arguments = :return_pwd,
-      run_already           = true
-    )
-    case commandline_arguments
-    when :do_not_run_yet
-      commandline_arguments = nil
-      run_already = false
-    end
-    set_commandline_arguments(
-      commandline_arguments
-    )
-    reset
-    if block_given?
-      case yield
-      # ===================================================================== #
-      # === :use_jquery
-      # ===================================================================== #
-      when :use_jquery,
-           :jquery
-        @use_jquery = true
-      # ===================================================================== #
-      # === :do_not_run_yet
-      # ===================================================================== #
-      when :do_not_run_yet
-        run_already = false
-      end
-    end
-    case run_already
-    # ======================================================================= #
-    # === :do_not_run_yet
-    # ======================================================================= #
-    when :do_not_run_yet
-      run_already = false
-    end
-    run if run_already
-  end
-
-  # ========================================================================= #
-  # === reset                                                     (reset tag)
-  # ========================================================================= #
-  def reset
-    super()
-    # ======================================================================= #
-    # === @_
-    # ======================================================================= #
-    @_ = ''.dup
-    # ======================================================================= #
-    # === @use_jquery
-    #
-    # Whether we will use jquery by default or whether we will not.
-    #
-    # I decided to set this to true during June 2021. While it creates
-    # an overhead and an increase in file size, I think jquery is
-    # very convenient. This may, however had, be subject to change in
-    # the future, hence why this comment has been added.
-    # ======================================================================= #
-    @use_jquery = true
-    # ======================================================================= #
-    # === @css
-    # ======================================================================= #
-    @css = '' # Whether we add css stuff or not.
-    clear_images # Clears @images.
-    # ======================================================================= #
-    # === @debug
-    # ======================================================================= #
-    @debug = DEBUG
-    # ======================================================================= #
-    # === @show_names_of_image_files
-    # ======================================================================= #
-    @show_names_of_image_files = false
-    # ======================================================================= #
-    # === @registered_ids
-    # ======================================================================= #
-    @registered_ids = []
-    # ======================================================================= #
-    # === @this_dir
-    # ======================================================================= #
-    @this_dir = return_pwd
-    be_verbose
-    set_store_where 'foo.html' # default. Works on the current directory.
-  end
-
-  # ========================================================================= #
-  # === clear_images
-  # ========================================================================= #
-  def clear_images
-    @images = [] # Should always be an Array.
-  end
-
-  # ========================================================================= #
-  # === set_background
-  # ========================================================================= #
-  def set_background(i)
-    i = i.to_s
-    @css = '<style>
-        body {background-color:'+i+';}
-        </style>' 
-  end; alias background set_background # === background
-
-  # ========================================================================= #
-  # === return_pwd
-  # ========================================================================= #
-  def return_pwd
-    ("#{Dir.pwd}/").squeeze('/')
-  end
-
-  # ========================================================================= #
-  # === return_css
-  # ========================================================================= #
-  def return_css
-    return @css
-  end
-
-  # ========================================================================= #
-  # === is_image_file?
-  # ========================================================================= #
-  def is_image_file?(i) # Whether something really is an image or not.
-    ARRAY_IMAGES.any? {|f| i.downcase.include? f }
-  end
-
-  # ========================================================================= #
-  # === be_verbose
-  # ========================================================================= #
-  def be_verbose
-    @be_verbose = true
-  end # Whether we will be verbose or not.
-
-  # ========================================================================= #
-  # === set_images
-  #
-  # Use this method to set the list of images.
-  # ========================================================================= #
-  def set_images(i)
-    if i.is_a? Array # before adding, check if we are all images.
-      i.select! {|image| is_image_file? image }
-    end
-    @images << i # This should always be an array.
-    @images.flatten!
-  end; alias store_images  set_images # === store_images
-       alias append_images set_images # === append_images (is the same as above)
-
-  # ========================================================================= #
-  # === scan_for_images_in_current_directory
-  # ========================================================================= #
-  def scan_for_images_in_current_directory
-    scan_for_images_in_this_directory(Dir.pwd)
-  end
-
-  # ========================================================================= #
-  # === save_what_to
-  # ========================================================================= #
-  def save_what_to(
-      what      = @_,
-      to        = @store_where,
-      file_mode = 'w+'
-    ) # store argument "what" in a file.
-    if @be_verbose
-      opnn; puts 'Saving to `'+sfile(to)+'` now.'
-    end
-    if File.exist? to
-      opnn; puts RED+'Warning: '+sfile(to)+RED+' already exists.'
-      opnn; puts RED+'We will delete it first.'+rev
-      File.delete(to)
-    end
-    File.open(to, file_mode) {|file_handle|
-      file_handle.print(what)
-    }
-  end; alias save_file save_what_to # === save_file
-
-  # ========================================================================= #
-  # === apply_filter
-  # ========================================================================= #
-  def apply_filter(i) # Apply a filter here.
-    case i
-    when /^only gif/
-      @images.reject! {|img| !img.include? '.gif'}
-    end
-  end
-
-  # ========================================================================= #
-  # === debug
-  # ========================================================================= #
-  def debug
-    pp @input_directory
-    pp @store_where
-  end
-
-  # ========================================================================= #
-  # === show_help
-  # ========================================================================= #
-  def show_help
-    e 'We currently allow these special arguments:'
-    e
-    e '  NJOY'
-    e '  PWD'
-    e '  ?'
-    e
-  end
-
-  # ========================================================================= #
-  # === process_commandline_arguments
-  # ========================================================================= #
-  def process_commandline_arguments
-    if @commandline_arguments
-      case @commandline_arguments.first # case tag.
-      # ===================================================================== #
-      # === --njoy
-      # ===================================================================== #
-      when /-?-?njoy/,'NJOY', :njoy
-        e 'We will use the excellent images from a special directory.'
-        scan_there :njoy
-      # ===================================================================== #
-      # === --help
-      # ===================================================================== #
-      when /^-?-?help$/i,'HELP'
-        show_help
-        exit
-      # ===================================================================== #
-      # === --pwd
-      # ===================================================================== #
-      when /^-?-?pwd$/i # This means we store in the current directory.
-        set_store_where(Dir.pwd+'/ContentOfCurrentDirectory')
-        clear_images
-        scan_for_images_in_this_directory
-      # ===================================================================== #
-      # === ?
-      # ===================================================================== #
-      when '?'
-        opnn; e 'The file in question will be:'
-        e
-        e "  #{sfile(store_where?)}"
-        e
-        exit
-      end if @commandline_arguments.is_a? Array
-    end
-  end
-
-  # ========================================================================= #
-  # === return_image
-  #
-  # Use this when you wish to append an image.
-  # ========================================================================= #
-  def return_image(i)
-    result = ''.dup
-    i = rds(i)
-    if @show_names_of_image_files
-      result << '<h2 style="color:orange; font-style: italic">'+i+'</h2>'+NBR
-    end
-    new_filename = File.basename(i).gsub(/#{File.extname(i)}/, '')
-    id = 'drag_'+new_filename.downcase.tr(' ','').tr('.','_')
-    @registered_ids << id
-    result << '<img id="'+id+'" style="'+IMG_CSS_STYLE+'" src="'+i+'">'+NBR
-    if use_jquery?
-      result << '<script>
-      $(function() {
-    $( "#'+id+'" ).draggable();
-  });
-  </script>'
-    end
-    return result
-  end
-
-  # ========================================================================= #
-  # === show_names_of_image_files
-  # ========================================================================= #
-  def show_names_of_image_files
-    @show_names_of_image_files = true
-  end; alias show_names show_names_of_image_files # === show_names
-
-  # ========================================================================= #
-  # === add                                                         (add tag)
-  #
-  # Use the alias _ is also permissive, but I recommend using only add() -
-  # it makes the code more explicit without it becoming too long, in my
-  # opinion.
-  # ========================================================================= #
-  def add(i) # Use this (and only this) method to append onto the main string.
-    @_ << i
-  end; alias _ add # === _
-
-  # ========================================================================= #
-  # === set_this_dir
-  # ========================================================================= #
-  def set_this_dir(
-      i = Dir.pwd
-    )
-    i = i.to_s.dup # Ensure that we do not have a frozen String.
-    i << '/' unless i.end_with? '/'
-    @this_dir = i
-  end
-
-  # ========================================================================= #
-  # === dir?
-  # ========================================================================= #
-  def dir?
-    @this_dir
-  end
-
-  # ========================================================================= #
-  # === set_commandline_arguments
-  # ========================================================================= #
-  def set_commandline_arguments(i)
-    @commandline_arguments = i
-  end
-
-  # ========================================================================= #
-  # === report_scanning_directory
-  # ========================================================================= #
-  def report_scanning_directory
-    opnn; puts 'Scanning from '+sdir(dir?)
-  end
-
-  # ========================================================================= #
-  # === opnn
-  # ========================================================================= #
-  def opnn
-    super(NAMESPACE)
-  end
-
-  # ========================================================================= #
-  # === use_jquery?
-  # ========================================================================= #
-  def use_jquery?
-    @use_jquery
-  end
-
-  # ========================================================================= #
-  # === set_store_where
-  # ========================================================================= #
-  def set_store_where(
-      i = INFO_DIRECTORY+'/AllFilesFrom_'+@input_directory
-    ) # contains the full path where to store things.
-    if i
-      # ===================================================================== #
-      # i = File.basename(i) # File.basename() is not good, it removes '/'
-      # Append '.html' string, unless it already exists there.
-      # ===================================================================== #
-      i << HTML unless i.end_with? HTML
-    end
-    i = File.absolute_path(i)
-    @store_where = i
-  end; alias store_where          set_store_where # === store_where
-       alias set_page_name        set_store_where # === set_page_name
-       alias store_where=         set_store_where # === store_where=
-       alias set_output_page_here set_store_where # === set_output_page_here
-
-  # ========================================================================= #
-  # === store_where?
-  # ========================================================================= #
-  def store_where?
-    @store_where
-  end; alias title?       store_where? # === title?
-       alias output_file? store_where? # === output_file?
-
-  # ========================================================================= #
-  # === return_jquery
-  #
-  # This method will add the jquery version.
-  #
-  # In order to do this, we have to tap into the Cyberweb project.
-  # ========================================================================= #
-  def return_jquery
-    return ::Cyberweb.return_jquery_string
-  end
-
-  # ========================================================================= #
-  # === append_everything
-  # ========================================================================= #
-  def append_everything
-    body = ''.dup
-    body << return_css
-    if @use_jquery
-      body << return_jquery
-    end
-    @images.each {|this_image|
-      body << return_image(this_image)
-    } unless @images.empty?
-    add(
-      Cyberweb::HtmlTemplate.new {{
-        title:           title?,
-        body_css_style: 'background-color: black',
-        body:            body
-      }}.to_s
-    )
-  end
-
-  # ========================================================================= #
-  # === scan_for_images_in_this_directory
-  #
-  # Use the following method to get all images from a given subdirectory.
-  # ========================================================================= #
-  def scan_for_images_in_this_directory(
-      i                      = return_pwd,
-      include_subdirectories = true
-    )
-    case i
-    # ======================================================================= #
-    # === :return_pwd
-    # ======================================================================= #
-    when :return_pwd
-      i = return_pwd
-    end
-    set_this_dir(i)
-    case i.to_s.downcase
-    # ======================================================================= #
-    # === njoy
-    # ======================================================================= #
-    when 'njoy'
-      i = ENV['MY_DATA'].to_s.dup+'/images/NJOY/'
-    end
-    i = ConvertGlobalEnv.convert(i) if i.include? '$'
-    if include_subdirectories
-      i = Dir["#{i}/**/**".squeeze('/')]
-    else
-      i = Dir["#{i}/*".squeeze('/')]
-    end
-    set_images(i) # This is ok because set_images will check on its own.
-  end; alias scan_here     scan_for_images_in_this_directory # === scan_here
-       alias scan_there    scan_for_images_in_this_directory # === scan_there
-       alias scan_from     scan_for_images_in_this_directory # === scan_from
-       alias use_this_dir= scan_for_images_in_this_directory # === use_this_dir=
-
-  # ========================================================================= #
-  # === run                                                         (run tag)
-  # ========================================================================= #
-  def run
-    process_commandline_arguments
-    debug if @debug
-    append_everything
-    save_file
-  end
-
-end; end
-
-# =========================================================================== #
-# === Cyberweb.create_webpage_for_images
-# =========================================================================== #
-def self.create_webpage_for_images(i = ARGV)
-  Cyberweb::Generator::WebpageForImages.new(i) { :use_jquery }
-end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  require 'colours/colours_e_autoinclude.rb'
-  _ = Cyberweb::Generator::WebpageForImages.new(ARGV, :do_not_run_yet) { :use_jquery }
-  _.set_output_page_here(
-    '/Depot/Information/Images.html'
-  ) # We store the data into this html file here.
-  if ARGV.first
-    _.scan_for_images_in_this_directory Dir.pwd # We assume PWD.
-  elsif Dir.pwd.include?('/home/x')
-    _.set_store_where(
-      File.absolute_path(
-        File.basename(Dir.pwd).downcase+'.html'
-      )
-    ) 
-    _.scan_for_images_in_this_directory :return_pwd
-  else # Empty default will now simply use the current working directory.
-    _.set_store_where(
-      File.absolute_path(
-        File.basename(Dir.pwd).downcase+'.html'
-      )
-    )
-    _.scan_for_images_in_this_directory :return_pwd
-  end
-  _.report_scanning_directory
-  # The next line of code could be used to designate a black background.
-  # _.background 'black'
-  _.show_names
-  # _.scan_for_images_in_this_directory '$IMG/SCIENCE' 
-  # _.scan_for_images_in_this_directory '$IMG',true
-  # _.apply_filter 'only gifs'
-  _.run
-end # cyberweb_generator NJOY

data/lib/cyberweb/html_codes/README.md

@@ -1,15 +0,0 @@
-This directory will store HTML character entities.
-
-Currently, we only keep track of the "Greek letters" such as
-Delta or Lambda. We keep two variants for each - the small 
-variant and the larger variant.
-
-So, for instance: DELTA_SMALL will be the small delta token
-and DELTA_LARGE will be that triangle-shaped variant.
-
-In order to simplify usage of it, we will alias DELTA to 
-DELTA_SMALL, so you can just use DELTA anyway.
-
-Last but not least, we will include the HTML character entity
-automatically. This latter behaviour may one day change though
-- perhaps it should become togglable.

data/lib/cyberweb/images/real/README.md

@@ -1,6 +0,0 @@
-This directory used to contain the "real" images, aka .jpg
-or .png files, for the Cyberweb component.
-
-In September 2020 this had to be reverted, though, due to
-some bugs. At a later time I may re-evaluate this, but for
-now this file, as a notice, has to suffice.

data/lib/cyberweb/io/README.md

@@ -1 +0,0 @@
-This directory is for when we wish to restore IO.

data/lib/cyberweb/javascript/scroll.rb

@@ -1,17 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-module Cyberweb
-
-  # ========================================================================= #
-  # === javascript_scroll
-  #
-  # This method will make use of jquery scroll.
-  #
-  # Not implemented yet.
-  # ========================================================================= #
-  def javascript_scroll
-  end
-
-end

data/lib/cyberweb/objectified_html_tags/README.md

@@ -1,8 +0,0 @@
-"Objectified HTML Tags" refers to things such as:
-
-    Span.new('Hey there')
-
-We want to operate on the OOP level here.
-
-Note that this will also include non-html tags, so this
-is a slight misnomer.