cyberweb 0.4.174

data/lib/cyberweb/web_object/evaluate.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/evaluate.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  begin
+    require 'beautiful_url/toplevel_methods/local_menu.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === evaluate_from_this_file_via_beautiful_url
+  # ========================================================================= #
+  def evaluate_from_this_file_via_beautiful_url(i)
+    unless Object.const_defined? :BeautifulUrl
+      begin
+        require 'beautiful_url'
+      rescue LoadError; end
+    end
+    if i.start_with? 'local'
+      i = BeautifulUrl.local_menu(i)
+    else
+      i = BeautifulUrl[i]
+    end
+    i = i.first if i.is_a? Array
+    if i.end_with? '.cgi'
+      # ===================================================================== #
+      # Need the .rb variant instead.
+      # ===================================================================== #
+      i = i.dup if i.frozen?
+      i.delete_suffix!('.cgi')
+      i << '.rb'
+    end
+    evaluate_from_this_file(i)
+  end
+
+  # ========================================================================= #
+  # === evaluate_from_this_file
+  #
+  # This method can be used to simply read in from a local file, and
+  # evaluate the text as if it were ruby code, as-is.
+  # ========================================================================= #
+  def evaluate_from_this_file(
+      this_file
+    )
+    if this_file and File.file?(this_file)
+      file_content = File.read(this_file, encoding: 'utf-8')
+      dataset = remove_comments_from_this_string(file_content)
+      eval(dataset)
+      close_html
+    else
+      e 'No file exists at '+this_file.to_s+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === evaluate_from_the_same_named_file
+  #
+  # This method allows us to skip providing the name for the evaluation
+  # method defined below this method.
+  #
+  # This is typically called from a .sinatra file.
+  #
+  # In June 2021 this was a bit relaxed, in order to allow straight
+  # require() statements to work. Ruby does not accept .sinatra as
+  # a file end when require is used, so a .rb file has to be used
+  # instead. In that case, this method will strip away "_for_sinatra"
+  # if it is part of the file. Thus we will assume that such a
+  # file exists, with the trailing "_for_sinatra.rb" part.
+  #
+  # Note that this method may fail if $PROGRAM_NAME is set improperly,
+  # which may be the case if it is started via a /usr/bin/ path
+  # rather than a .rb file.
+  # ========================================================================= #
+  def evaluate_from_the_same_named_file(
+      i = $PROGRAM_NAME
+    )
+    i = $PROGRAM_NAME if i.nil?
+    if i.end_with? '.sinatra'
+      is_a_sinatra_application # Enable this as well.
+    end
+    i = i.dup
+    i.delete_suffix!(File.extname(i)) # Chop off the .sinatra part or other ends.
+    if i.end_with? '_for_sinatra'
+      i.delete_suffix!('_for_sinatra')
+      is_a_sinatra_application # Enable this as well.
+    end
+    i << '.rb' unless i.end_with? '.rb'
+    evaluate_from_this_file(i)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::WebObject.evaluate_from_the_same_named_file_then_serve
+  #
+  # This is the simplified variant that can be used for .cgi files, if
+  # a nearby .rb file exists. In order for this to work, the file must
+  # have the same name, minus the extension (which can be different).
+  # ========================================================================= #
+  def self.evaluate_from_the_same_named_file_then_serve(
+      output_the_result              = :default,
+      optional_use_this_name_instead = nil
+    )
+    _ = Cyberweb::WebObject.new
+    _.evaluate_from_the_same_named_file(optional_use_this_name_instead)
+    return _.do_serve(output_the_result)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::WebObject.evaluate_from_this_file_via_beautiful_url
+  # ========================================================================= #
+  def self.evaluate_from_this_file_via_beautiful_url(
+      this_file
+    )
+    _ = Cyberweb::WebObject.new
+    _.is_a_sinatra_application # This is hardcoded for now - we will assume that only Sinatra uses this.
+    _.evaluate_from_this_file_via_beautiful_url(this_file)
+    return _.do_serve
+  end
+
+end; end

data/lib/cyberweb/web_object/favicon.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/favicon.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === ruby_favicon
+  # ========================================================================= #
+  def ruby_favicon
+    favicon :ruby_favicon
+  end
+
+  # ========================================================================= #
+  # === set_favicon
+  #
+  # This method will "enable" a favicon.
+  #
+  # The first argument to this method should hold the (relative) path
+  # to our favicon icon.
+  #
+  # You can also use a :symbol as first argument, which will be
+  # assumed to mean that we wish to use a certain webimage.
+  #
+  # Remember that the favicon comes between the <head> tag.
+  #
+  # It may look like so:
+  #
+  #   <link rel="icon" type="image/png" href="/somewhere/myicon.png" />
+  #
+  # ========================================================================= #
+  def set_favicon(
+      i = 'RPG/RPG_FAVICON.png'
+    )
+    if i.is_a? Symbol
+      case i
+      # ======================================================================= #
+      # === :rpg_favicon
+      # ======================================================================= #
+      when :rpg_favicon
+        i = 'RPG/RPG_FAVICON.png'
+      # ======================================================================= #
+      # === :science_favicon
+      # ======================================================================= #
+      when :science_favicon
+        i = 'science/SCIENCE_FAVICON.png'
+      # ======================================================================= #
+      # === :ruby_favicon
+      # ======================================================================= #
+      when :ruby_favicon
+        i = 'programming/ruby/RUBY_FAVICON.png'
+      # ======================================================================= #
+      # === :bioroebe_favicon
+      # ======================================================================= #
+      when :bioroebe_favicon
+        i = 'bioroebe/images/BIOROEBE.png'
+      # ======================================================================= #
+      # === :dsa
+      # ======================================================================= #
+      when :dsa,
+           :dsa_favicon
+        i = 'RPG/DSA/DSA_FAVICON.png'
+      # ======================================================================= #
+      # === :dnd_favicons
+      # ======================================================================= #
+      when :dnd_favicons,
+           :dnd_favicon,
+           :dnd
+        i = 'RPG/DnD/DnD_FAVICON.png'
+      # ======================================================================= #
+      # === :shadowrun_favicon
+      # ======================================================================= #
+      when :shadowrun_favicon,
+           :shadowrun
+        i = 'RPG/SR/SHADOWRUN_FAVICON.png'
+      # ======================================================================= #
+      # === :default
+      # ======================================================================= #
+      when :default
+        i = 'STD/ZITRONE.png'
+      # ======================================================================= #
+      # === :tai_favicon
+      # ======================================================================= #
+      when :tai_favicon
+        i = 'RPG/SARLEM/OSTREICH/TAI/TAI_FAVICON.png'
+      # ======================================================================= #
+      # === :sarlem
+      # ======================================================================= #
+      when :sarlem,
+           :sarlem_favicon
+        i = 'RPG/SARLEM/SARLEM_FAVICON.png'
+      # ======================================================================= #
+      # === :random
+      # ======================================================================= #
+      when :random,
+           :rand
+        i = random_favicon
+      # ======================================================================= #
+      # === :inline
+      #
+      # Add support for "inline" favicons" which are ... no favicons really.
+      #
+      # URLs prefixed with the "data:" scheme allow content creators to
+      # embed small files inline in documents.
+      # ======================================================================= #
+      when :inline,
+           :minimal,
+           :none
+        i = "<link href=data:, rel=icon>#{NL}"
+      else
+        # ===================================================================== #
+        # We assume this symbol to be part of WebImage. This will
+        # handle input such as :big_star, for example.
+        # ===================================================================== #
+        i = ::Cyberweb.get_webimage(i)
+      end
+    end
+    i = return_path_to_the_images_directory+i.to_s
+    add_with_newline(
+      return_favicon_string(i)
+    )
+  end; alias fav                set_favicon # === fav (fav tag)
+       alias favicon=           set_favicon # === favicon=
+       alias favicon            set_favicon # === favicon
+       alias fav=               set_favicon # === fav=
+       alias f=                 set_favicon # === f=
+       alias f                  set_favicon # === f
+       alias set_favicon_string set_favicon # === set_favicon_string
+       alias print_favicon      set_favicon # === print_favicon
+
+  # ========================================================================= #
+  # === return_favicon_string
+  # ========================================================================= #
+  def return_favicon_string(i = '')
+    '<link rel="icon" href="'+i.to_s+'">'
+  end; alias favicon_string? return_favicon_string # === favicon_string?
+       alias favicon_path    return_favicon_string # === favicon_path
+       alias favicon?        return_favicon_string # === favicon?
+       alias favicon_path?   return_favicon_string # === favicon_path?
+
+  require 'cyberweb/requires/require_web_images.rb'
+  # ========================================================================= #
+  # === random_favicon
+  #
+  # This method will be like set_favicon_string(), but we will randomly
+  # set to a specific favicon.
+  # ========================================================================= # 
+  def random_favicon
+    WebImages.random.gsub(
+      /\/home\/x\/DATA\/images\//, ''
+    )
+  end
+
+end; end

data/lib/cyberweb/web_object/html_related_tags.rb

@@ -0,0 +1,320 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/html_related_tags.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === li                                                           (li tag)
+  #
+  # This method should ultimately generate a String such as:
+  #
+  #   <li>foobar</li>
+  #
+  # ========================================================================= #
+  def li(
+      content             = '',
+      optional_css_class  = '',
+      optional_the_id     = '',
+      optional_css_style  = '',
+      optional_javascript = '',
+      &block
+    )
+    # ======================================================================= #
+    # First, always add the <li> tag, whenever li() is called.
+    # ======================================================================= #
+    addnl(
+      '<li'+
+      css_class_or_no_class(optional_css_class.dup)+
+      id_or_no_id(optional_the_id.to_s.dup)+
+      css_style_or_no_style(optional_css_style.dup)+
+      '>'
+    )
+    addnl(content.dup) if content and !content.empty?
+    # ======================================================================= #
+    # === Handle blocks given to this method next
+    # ======================================================================= #
+    if block_given?
+      addnl(yield)
+      cli
+    end
+  end
+
+  # ========================================================================= #
+  # === ul                                                           (ul tag)
+  # ========================================================================= #
+  def ul(
+      optional_css_class = 'marl1em', # This is the default.
+      optional_the_id    = '',
+      &block
+    )
+    # ======================================================================= #
+    # === First we will handle Hashes
+    # ======================================================================= #
+    if optional_css_class.is_a? Hash
+      # ===================================================================== #
+      # === :id
+      # ===================================================================== #
+      if optional_css_class.has_key? :id
+        optional_the_id = optional_css_class.delete(:id)
+        optional_css_class = 'marl1em' if optional_css_class.empty?
+      end
+    end
+    addnl(
+      '<ul class="'+optional_css_class.to_s+'"'+
+      id_or_no_id(optional_the_id)+
+      '>'
+    )
+    if block_given?
+      yield
+      cul
+    end
+  end
+
+  # ========================================================================= #
+  # === h2
+  # ========================================================================= #
+  def h2(
+      i                   = '',
+      optional_css_class  = '',
+      optional_the_id     = '',
+      optional_css_style  = '',
+      optional_javascript = ''
+    )
+    addn(
+      HtmlTags.h2(i, optional_css_class, optional_the_id, optional_css_style)
+    )
+  end
+
+  # ========================================================================= #
+  # === h4
+  # ========================================================================= #
+  def h4(
+      i                   = '',
+      optional_css_class  = '',
+      optional_the_id     = '',
+      optional_css_style  = '',
+      optional_javascript = ''
+    )
+    addn(
+      HtmlTags.h4(i, optional_css_class, optional_the_id, optional_css_style)
+    )
+  end
+
+  # ========================================================================= #
+  # === h5
+  # ========================================================================= #
+  def h5(
+      i                   = '',
+      optional_css_class  = '',
+      optional_the_id     = '',
+      optional_css_style  = '',
+      optional_javascript = ''
+    )
+    addn(
+      HtmlTags.h5(i, optional_css_class, optional_the_id, optional_css_style)
+    )
+  end
+
+  # ========================================================================= #
+  # === h6
+  # ========================================================================= #
+  def h6(
+      i                   = '',
+      optional_css_class  = '',
+      optional_the_id     = '',
+      optional_css_style  = '',
+      optional_javascript = ''
+    )
+    addn(
+      HtmlTags.h6(i, optional_css_class, optional_the_id, optional_css_style)
+    )
+  end
+
+  # ========================================================================= #
+  # === p                                                             (p tag)
+  #
+  # This method handles the creation of <p> tags ultimately.
+  # ========================================================================= #
+  def p(
+      optional_css_class = 'pad5px',
+      the_id             = '',
+      optional_css_style = '',
+      &block
+    )
+    # ======================================================================= #
+    # === Handle Hashes next
+    # ======================================================================= #
+    if optional_css_class.is_a? Hash
+      # ===================================================================== #
+      # === :id
+      # ===================================================================== #
+      if optional_css_class.has_key? :id
+        the_id = optional_css_class.delete(:id)
+      end
+      # ===================================================================== #
+      # === :css_class
+      #
+      # Must come after :id.
+      # ===================================================================== #
+      if optional_css_class.has_key? :css_class
+        optional_css_class = optional_css_class.delete(:css_class)
+      end
+      if optional_css_class.is_a?(Hash) and
+        optional_css_class.empty?
+        optional_css_class = ''
+      end
+    end
+    addn(
+      '<p'+
+      css_class_or_no_class(optional_css_class)+
+      id_or_no_id(the_id.to_s)+
+      css_style_or_no_style(optional_css_style)+
+      '>'
+    )
+    if block_given?
+      yield
+      addn('</p>')
+    end
+  end
+
+  # ========================================================================= #
+  # === button                                                   (button tag)
+  #
+  # The following example shows how this could be used:
+  #
+  #   button {{
+  #     text: 'Hey there!'
+  #   }}
+  #
+  # A slightly more advanced example is the following variant:
+  #
+  #  button {{
+  #    text: 'Hey there - with more css and a Hello World alert-box in javascript!',
+  #    css_class: 'bblack1 darkgreen pad8px BOLD',
+  #    javascript_function: 'msg("Hello world!!!")'
+  #  }}
+  #
+  # Here is another variant, by specifically responding to a click-event:
+  #
+  #  button {{
+  #    text:           'Click here'
+  #    css_class:      'bblack1 pad8px'
+  #    on_click_event: :on_click_event_hello_world
+  #  }}
+  #
+  # ========================================================================= #
+  def button(&block)
+    input(:button, &block)
+  end
+
+  # ========================================================================= #
+  # === pre                                                         (pre tag)
+  # ========================================================================= #
+  def pre(
+      i                  = '',
+      optional_css_class = 'FS1_5em',
+      optional_the_id    = '',
+      optional_css_style = '',
+      optional_commands  = nil
+    )
+    if optional_commands
+      case optional_commands
+      # ===================================================================== #
+      # === :remove_html
+      # ===================================================================== #
+      when :remove_html
+        i = Cyberweb.remove_html(i)
+      end
+    end
+    addn(
+      '<pre'+
+      css_class_or_no_class(optional_css_class)+
+      id_or_no_id(optional_the_id)+
+      css_style_or_no_style(optional_css_style)+
+      '>'+
+      i.to_s+
+      '</pre>'
+    )
+  end
+
+  # ========================================================================= #
+  # === textarea
+  #
+  # This create a <textarea> tag.
+  #
+  # Example:
+  #
+  #   textarea('foobar','bblack1 pad1em','textarea_id')
+  #
+  # ========================================================================= #
+  def textarea(
+      default_content = '', # 1) content
+      css_class       = '', # 2) css-class
+      the_id          = '', # 3) the id
+      css_style       = '', # 4) css_style
+      n_cols          = 25, # 5) n columns
+      n_rows          = 8,  # 6) n rows
+      javascript      = '', # 7) javascript
+      name            = '', # 8) name
+      &block
+    )
+    addnl(
+      ::Cyberweb.string_textarea(
+        default_content,
+        css_class,
+        the_id,
+        css_style,
+        n_cols,
+        n_rows,
+        javascript,
+        name,
+        &block
+      )
+    )
+  end; alias string_textarea textarea # === string_textarea
+       alias textview        textarea # === textview
+       alias add_write_area  textarea # === add_write_area
+
+  # ========================================================================= #
+  # === ctextarea
+  # ========================================================================= #
+  def ctextarea
+    close(:textarea)
+  end
+
+  # ========================================================================= #
+  # === cbody
+  # ========================================================================= #
+  def cbody
+    close(:body)
+  end
+
+  # ========================================================================= #
+  # === cframeset
+  # ========================================================================= #
+  def cframeset
+    close(:frameset)
+  end
+
+  # ========================================================================= #
+  # === cul
+  # ========================================================================= #
+  def cul
+    close(:ul)
+  end
+
+  # ========================================================================= #
+  # === cli
+  # ========================================================================= #
+  def cli
+    close(:li)
+  end
+
+end; end