cyberweb 0.4.174

data/lib/cyberweb/html_tags/img.rb

@@ -0,0 +1,294 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/html_tags/img.rb'
+# Cyberweb.get_images
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/ee.rb'
+  require 'cyberweb/images/images.rb'
+
+  # ========================================================================= #
+  # === Img
+  # ========================================================================= #
+  class Img < WebBase
+
+    # ======================================================================= #
+    # === @img_css_class
+    # ======================================================================= #
+    @img_css_class = nil
+
+    # ======================================================================= #
+    # === Img.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @img_css_class = i
+    end
+
+    # ======================================================================= #
+    # === Img.to_s
+    # ======================================================================= #
+    def self.to_s; @img_css_class; end
+
+  end
+
+  # ========================================================================= #
+  # === img                                                         (img tag)
+  #
+  # This method will return a proper <img> tag. (Macht ein <img> tag).
+  #
+  # It will tap into the method string_img() for this, so please refer to
+  # that method instead for the full documentation. (bl $CYBER/html_tags.rb)
+  #
+  # Usage example:
+  #
+  #   img 'LINKS/OGRE.png','wid14px hei14px',"style",'id','alt'
+  #
+  # You do not have to specify IMG/blabla - IMG will automatically be
+  # appended.
+  #
+  #   Cyberweb.img('../../','aaa','bb','cc','id','alt')
+  #
+  # ========================================================================= #
+  def img(
+      url        = '',
+      css_class  = Img.to_s,
+      the_id     = '',
+      css_style  = '',
+      new_line   = false,
+      alt        = '', 
+      to_img_dir = ::Cyberweb.path_to_images?,
+      usemap     = '',
+      javascript = '',
+      &block
+    )
+
+    url = rds(url) if url.to_s.include? '//' # Need .to_s here because it could be a Symbol.
+    ::Cyberweb.ee string_img(
+      url, css_class, the_id, css_style, new_line,
+      alt, to_img_dir, usemap, javascript,
+      &block
+    ) # string_img() resides in: bl $CYBERWEB/foundation/string_img.rb
+    # yield if block_given? # yield extra params like cgi pnl
+    # Since September 2014 we will delegate towards string_img to handle blocks.
+  end; alias ig img # === ig
+
+  # ========================================================================= #
+  # === img_nbr
+  #
+  # Calls img() with a nbr. The method img() is defined in
+  #   bl $CYBER/html_tags/img.rb
+  # ========================================================================= #
+  def img_nbr(
+      url, 
+      css_class  = '',
+      the_id     = '',
+      css_style  = '', 
+      new_line   = 0,
+      alt        = '',
+      to_img_dir = ::Cyberweb.path_to_images?,
+      usemap     = '',
+      javascript = ''
+    )
+    img(url,
+      css_class, the_id, css_style,
+      new_line, alt, to_img_dir,
+      usemap, javascript
+    )
+    nbr
+  end; alias img_br img_nbr # === img_br
+       alias imgbr  img_nbr # === imgbr
+
+  # ========================================================================= #
+  # === Cyberweb.get_images                                  (all images tag)
+  #
+  # This wrapper returns all images of a given dir. For this, it calls the
+  # method get_files_from().
+  #
+  # If the second argument, `traverse_into_subdirectories_as_well`, is
+  # true, then we will traverse into all subdirectories and seek images.
+  # ========================================================================= #
+  def self.get_images(
+      from_this_dir                        = IMAGE_DIRECTORY,
+      traverse_into_subdirectories_as_well = false
+    )
+    case from_this_dir
+    when :here
+      from_this_dir = Dir.pwd
+    end
+    if File.exist?(from_this_dir)
+      _ = get_files_from(
+            from_this_dir,
+            false,
+            traverse_into_subdirectories_as_well
+          )
+      _.select! {|file| ::Cyberweb.is_image?(file) }
+    else
+      _ = []
+    end
+    return _
+  end; self.instance_eval { alias get_all_images      get_images } # === Cyberweb.get_all_images
+       self.instance_eval { alias get_images_from     get_images } # === Cyberweb.get_images_from
+       self.instance_eval { alias get_all_img_files   get_images } # === Cyberweb.get_all_img_files
+       self.instance_eval { alias get_all_images_from get_images } # === Cyberweb.get_all_images_from
+
+  # ========================================================================= #
+  # === package_web_images
+  #
+  # This method will package all web images.
+  #
+  # The constant ARRAY_LISTING_ALL_PROJECT_IMAGES is defined
+  # in the file constant.rb
+  # ========================================================================= #
+  def package_web_images
+    img_base = IMAGE_DIRECTORY
+    target   = '/Depot/Images/WebImages/'
+    ARRAY_LISTING_ALL_PROJECT_IMAGES.each { |img|
+      img = img_base+get_webimage(img)
+      create_directory(target) unless File.exist? target
+      FileUtils::Verbose.cp img, target
+    }
+    system "tar cfvj #{target}.tar.xz #{target}"
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.img
+  # ========================================================================= #
+  def self.img(
+      url        = '',
+      css_class  = Img.to_s,
+      the_id     = '',
+      css_style  = '',
+      new_line   = false,
+      alt        = '', 
+      to_img_dir = ::Cyberweb.path_to_images?,
+      usemap     = '',
+      javascript = '',
+      &block
+    )
+    url = rds(url) if url.to_s.include? '//' # Need .to_s here because it could be a Symbol.
+    ee ::Cyberweb.string_img(
+      url, css_class, the_id, css_style, new_line, alt,
+      to_img_dir, usemap, javascript, &block
+    ) # string_img() is in: bl $CYBERWEB/string_img/string_img.rb
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_absolute_img
+  #
+  # If we link in remote images, we can use this simplified method here
+  # called Cyberweb.string_absolute_img. It will return a String,
+  # as the name indicates.
+  #
+  # The first argument to this method should be the remote URL,
+  # e. g. the absolute URL to the image at hand. This could
+  # be, for example, a String such as the following:
+  #
+  #   'https://wiki.ultimacodex.com/images/d/d5/DupreU7.PNG'
+  #
+  # ========================================================================= #
+  def self.string_absolute_img(
+      remote_url,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    # ======================================================================= #
+    # === Handle Hashes given as second argument
+    # ======================================================================= #
+    if css_class.is_a? Hash
+      if css_class.has_key? :id
+        the_id = css_class.delete(:id)
+        css_class = '' if css_class.empty? and css_class.is_a?(Hash)
+      end
+      if css_class.has_key? :css_class
+        css_class = css_class.delete(:css_class)
+        css_class = '' if css_class.empty? and css_class.is_a?(Hash)
+      end
+    end
+    _ = '<img src="'+remote_url+'"'.dup
+    unless the_id.empty?
+      if the_id.include? 'id='
+        _ << the_id # In this case we assume the id was already added.
+      else
+        _ << ' id="'+the_id.to_s+'"' # .to_s because it might be a Symbol
+      end
+    end
+    _ << return_css_class(css_class).to_s unless css_class.to_s.empty?
+    _ << '>'
+    return _ # And return the result here.
+  end; self.instance_eval { alias sabsolute_img string_absolute_img } # === Cyberweb.sabsolute_img
+       self.instance_eval { alias saimg         string_absolute_img } # === Cyberweb.samig
+
+  # ========================================================================= #
+  # === string_absolute_img
+  #
+  # This method will invoke Cyberweb.string_absolute_img() in order to
+  # go on and display a remote image.
+  # ========================================================================= #
+  def string_absolute_img(
+      remote_url,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    return ::Cyberweb.string_absolute_img(
+      remote_url, css_class, the_id, css_style
+    )
+  end; alias sabsolute_img string_absolute_img # === sabsolute_img
+       alias saimg         string_absolute_img # === saimg
+
+  # ========================================================================= #
+  # === absolute_img
+  #
+  # This method will invoke string_absolute_img() in order to go on and
+  # "display" a remote image onto the webpage at hand.
+  #
+  # The first argument to this method should be the remote URL to the
+  # image at hand, as a String.
+  #
+  # Usage examples:
+  #
+  #   absolute_img('http://mikesrpgcenter.com/krondor/maps/timirianya.gif')
+  #   remote_img('http://mikesrpgcenter.com/krondor/maps/timirianya.gif')
+  #
+  # ========================================================================= #
+  def absolute_img(
+      remote_url,     # (1) URL
+      css_class = '', # (2) CSS class
+      the_id    = '', # (3) The ID
+      css_style = ''  # (4) CSS style
+    )
+    ee string_absolute_img(
+      remote_url,
+      css_class,
+      the_id,
+      css_style
+    )
+  end; alias embed_remote_image        absolute_img # === embed_remote_image
+       alias remote_image              absolute_img # === remote_image
+       alias remote_img                absolute_img # === remote_image
+       alias display_this_remote_image absolute_img # === display_this_remote_image
+
+  # ========================================================================= #
+  # === in_dir_image
+  #
+  # This will use an image from the current working directory.
+  #
+  # The first argument to it should be the target file path of your local
+  # file system.
+  # ========================================================================= #
+  def in_dir_image(
+      path,
+      optional_css_class = '',
+      optional_id        = :drag,
+      optional_css_style = ''
+    )
+    ee HtmlTags.img(path, optional_css_class, optional_id, optional_css_style)
+    javascript_drag_and_drop(optional_id) if optional_id == :drag
+  end; alias indir_img  in_dir_image # === indir_img
+       alias img_in_dir in_dir_image # === img_in_dir
+
+end

data/lib/cyberweb/html_tags/input.rb

@@ -0,0 +1,345 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/standalone_classes/input_focus.rb'
+
+  # ========================================================================= #
+  # === Input
+  # ========================================================================= #
+  class Input < WebBase
+
+    # ======================================================================= #
+    # === @input_css_class
+    # ======================================================================= #
+    @input_css_class = nil
+
+    # ======================================================================= #
+    # === Input.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @input_css_class = i
+    end
+
+    # ======================================================================= #
+    # === Input.to_s
+    # ======================================================================= #
+    def self.to_s
+      @input_css_class
+    end
+
+  end
+
+  # ========================================================================= #
+  # === input                                                     (input tag)
+  #
+  # This method will ultimately generate HTML such as the following:
+  #
+  #   <input type="submit" value="Submit" />
+  #
+  # The allowed input types are:
+  #
+  #   button,checkbox,color,date,datetime,datetime-local,
+  #   email,file,hidden,image,month,number,password,radio,
+  #   range,reset,search,submit,tel,text,time,url,week 
+  #
+  # A :hidden input field means that it won't be displayed to the
+  # visitor.
+  #
+  # As of Jan 2014, name_to_use will no longer be displayed if it
+  # is empty.
+  #
+  # Now to some specific usage examples with this method - there
+  # are many different ways to use the input() method:
+  #
+  #   input(:submit,'Compile which program:','s2em','id_submit','border:3px solid gold','y','onChange="this.select();"') 
+  #   input :text,'','s2em','dna_input','border:3px solid gold','x'
+  #   input :s,'','s0_5em mars2em','border:1px solid gold','submit'
+  #   input :text,'DefaultValue','mars2em','ID','border:1px dotted gold','y_accesskey','javascript'
+  #   input :submit
+  #   input :text, 'Hello World!', :select_on_click
+  #
+  # ========================================================================= #
+  def input(
+      type          = :submit,    # (1) type
+      default_value = '',         # (2) default value
+      css_class     = Input.to_s, # (3) css class
+      name_to_use   = '',         # (4) name to use
+      css_style     = '',         # (5) css style
+      accesskey     = '',         # (6) accesskey
+      my_javascript = '',         # (7) javascript
+      id            = nil,        # (8) id
+      hash          = {}          # (9) an additional hash
+    )
+    # ======================================================================= #
+    # First, let's start to assemble our main string that we will return.
+    # ======================================================================= #
+    _ = '<input'.dup
+    # ======================================================================= #
+    # Second, let's check if the second argument is a hash.
+    # ======================================================================= #
+    if default_value.is_a? Hash
+      # ===================================================================== #
+      # === :css_class
+      # ===================================================================== #
+      if default_value.has_key? :css_class
+        css_class = default_value.delete(:css_class)
+      end
+      # ===================================================================== #
+      # === :accesskey
+      # ===================================================================== #
+      if default_value.has_key? :accesskey
+        accesskey = default_value[:accesskey]
+      end
+      # ===================================================================== #
+      # === :id
+      # ===================================================================== #
+      if default_value.has_key? :id
+        id = default_value[:id]
+      end
+      # ===================================================================== #
+      # === :name
+      # ===================================================================== #
+      if default_value.has_key? :name
+        name_to_use = default_value.delete(:name)
+      end
+    end
+    case type.to_sym # case tag
+    when :datetime
+      _ << ' type="datetime-local"' 
+    when :month
+      _ << ' type="month"'
+    when :week
+      _ << ' type="week"'
+    when :image, :img, :i
+      _ << ' type="image"'
+    when :button,      :b
+      _ << ' type="button"'
+    when :hidden,      :h
+      _ << ' type="hidden"'
+    when :submit,      :s
+      _ << ' type="submit"'
+    when :reset,       :r
+      _ << ' type="reset"'
+    when :text, :field, :default, :t
+      _ << ' type="text"'
+    when :file, :file_uploads, :upload, :file_dialogue,
+         :f, :file_handle  # File uploads are handled here.
+      _ << ' type="file"'
+      id = 'input_file_upload' if id.nil?
+    else
+      _ = type.to_s+' was not found ...'+NL
+    end
+    # ======================================================================= #
+    # Next, handle Symbol input given to css_class.
+    #
+    # This can be a Symbol such as:
+    #   :select_on_click
+    # or such as:
+    #   :focus_with_deepskyblue_background
+    # ======================================================================= #
+    if css_class.is_a? Symbol
+      case css_class # case tag
+      when :select_on_click
+        css_class = Input.to_s
+        if my_javascript.empty? # If it is empty then we can populate it.
+          my_javascript = :select_on_click
+        end
+      else
+        # =================================================================== #
+        # The next line will handle cases such as:
+        #   :focus_with_yellow_background
+        # =================================================================== #
+        if css_class.to_s.start_with? 'focus_with'
+          # ================================================================= #
+          # Delegate towards class InputFocus next.
+          # ================================================================= #
+          input_focus = ::Cyberweb::InputFocus.new(css_class)
+          add_css_style input_focus.string?
+          css_class = input_focus.css_class?.dup
+          # ================================================================= #
+          # Keep in mind that the user may have set a default value for
+          # a css class, via Input.set_css_class(). If this is the case
+          # then we have to honour this setting and will simply append it.
+          # ================================================================= #
+          unless Input.to_s.empty?
+            css_class << N+Input.to_s.dup
+          end
+        end
+      end
+    end
+    # ======================================================================= #
+    # === Handle blocks next, if given
+    #
+    # Check for block-supplied to the method. Note that this must come
+    # before the call to return_css_class(), as the blocks passed into
+    # this method may also modify the css-class in use.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield # yield the block here.
+      case yielded
+      when :select_on_click
+        my_javascript = :select_on_click
+      else
+        if yielded.is_a? Hash
+          # ================================================================= #
+          # === Handle: input_submit {{ css_class: 'bblack1' }}
+          # ================================================================= #
+          if yielded.has_key? :css_class
+            css_class = yielded.delete(:css_class)
+          end
+          # ================================================================= #
+          # === Handle: input_submit {{ text: 'submit' }}
+          # ================================================================= #
+          if yielded.has_key? :text
+            default_value = yielded.delete(:text)
+          end
+        end
+      end
+    end
+    _ << return_css_class(css_class)
+    _ << return_css_style(css_style)
+    if name_to_use.is_a? Symbol # This is copy/paste of the above.
+      case name_to_use
+      when :select_on_click
+        name_to_use = ''
+        if my_javascript.empty? # If it is empty then we can populate it.
+          my_javascript = :select_on_click
+        end
+      end
+    end
+    _ << return_the_name(name_to_use) unless name_to_use.to_s.empty?
+    _ << return_accesskey(accesskey)
+    if id
+      if id.is_a? String
+        _ << ' id="'+id.to_s+'"'
+      end
+    end
+    my_javascript = sanitize_javascript(my_javascript)
+    _ << ' '+my_javascript unless my_javascript.empty?
+    if default_value.is_a? Hash
+      if default_value.has_key? :value
+        _ << ' value="'+default_value[:value].to_s+'"'
+      end
+    else
+      unless _.include?('value') 
+        unless default_value.to_s.empty? # then add our default value
+          _ << ' value="'+default_value.to_s+'"'
+        end
+      end
+    end
+    # ======================================================================= #
+    # Next handle a possible hash-argument here.
+    # ======================================================================= #
+    if hash.is_a? Hash
+      _ << ' size="'+hash[:size].to_s+'"' if hash[:size]
+      _ << ' maxlength="'+hash[:max_length].to_s+'"' if hash[:max_length]
+    end
+    _ << ' />'+NL
+    ee _
+  end
+
+  # ========================================================================= #
+  # === checkbox
+  # ========================================================================= #
+  def checkbox(
+      default_value = '',
+      css_class     = Input.to_s,
+      name_to_use   = '',
+      css_style     = '',
+      accesskey     = '',
+      my_javascript = '',
+      id            = nil,
+      hash          = {}
+    )
+    input(:checkbox,
+      default_value, css_class, name_to_use, css_style,
+      accesskey, my_javascript, id, hash
+    )
+  end
+
+  # ========================================================================= #
+  # === input_text
+  #
+  # This is a simplified name for an <input> tag that accepts text.
+  # ========================================================================= #
+  def input_text(
+      default_value = '',
+      css_class     = Input.to_s,
+      name_to_use   = '',
+      css_style     = '',
+      accesskey     = '',
+      my_javascript = '',
+      id            = nil,
+      hash          = {}
+    )
+    input(:text,
+      default_value, css_class, name_to_use, css_style,
+      accesskey, my_javascript, id, hash
+    )
+  end
+
+  # ========================================================================= #
+  # === file_dialog_button
+  # ========================================================================= #
+  def file_dialog_button(
+      default_value = 'Search for a file',
+      css_class     = Input.to_s,
+      name_to_use   = '',
+      css_style     = '',
+      accesskey     = '',
+      my_javascript = '',
+      id            = nil,
+      hash          = {}
+    )
+    input :file, default_value, css_class, name_to_use,
+          css_style, accesskey, my_javascript, id, hash
+  end; alias file_dialogue_button file_dialog_button # === file_dialogue_button
+
+  # ========================================================================= #
+  # === input_submit
+  #
+  # This is essentially a submit-button, in HTML.
+  #
+  # The first argument is the text that should be used for that button.
+  # ========================================================================= #
+  def input_submit(
+      default_value = '',
+      css_class     = Input.to_s,
+      name_to_use   = '',
+      css_style     = '',
+      accesskey     = '',
+      my_javascript = '',
+      id            = nil,
+      hash          = {},
+      &block
+    )
+    input(
+      :submit,
+      default_value,
+      css_class,
+      name_to_use,
+      css_style,
+      accesskey,
+      my_javascript,
+      id,
+      hash,
+      &block
+    )
+  end
+
+  # ========================================================================= #
+  # === submit
+  #
+  # Easier usage. You can just use submit() to have it work.
+  # ========================================================================= #
+  def submit(
+      name      = 'Submit it',
+      css_class = 'BG_Black s2em BO white'
+    )
+    input :submit, name, css_class,'submit', 'border: 1px solid gold'
+  end; alias add_submit_button submit # === add_submit_button
+
+end

data/lib/cyberweb/html_tags/label.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code for the <label> tag.
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Label
+  # ========================================================================= #
+  class Label < WebBase
+
+    # ======================================================================= #
+    # === @label_css_class
+    # ======================================================================= #
+    @label_css_class = nil
+
+    # ======================================================================= #
+    # === Label.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @label_css_class = i
+    end
+
+    # ======================================================================= #
+    # === Label.to_s
+    # ======================================================================= #
+    def self.to_s; @label_css_class; end
+
+  end
+
+  # ========================================================================= #
+  # === label
+  #
+  # In rails this would be used like this:
+  #
+  #   label_tag(:q, "Search for:")
+  #
+  # This would then create:
+  #   <label for="q">Search for:</label>
+  # ========================================================================= #
+  def label(
+      key_to_use  = ':q',
+      text_to_use = 'Search for:',
+      css_class   = Label.to_s,
+      the_id      = '',
+      css_style   = ''
+    )
+    key_to_use = key_to_use.to_s
+    key_to_use.prepend ':' unless key_to_use.start_with? ':'
+    result = '<label for="'+key_to_use.to_s+'">'+text_to_use.to_s+'</label>'
+    ee result
+  end
+
+  # ========================================================================= #
+  # === clabel
+  # ========================================================================= #
+  def clabel
+    eclose :label
+  end
+
+end