cyberweb 0.4.174

data/lib/cyberweb/web_object/javascript.rb

@@ -0,0 +1,427 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/javascript.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  require 'cyberweb/toplevel_methods/jquery.rb'
+  require 'cyberweb/javascript/javascript.rb'
+  require 'cyberweb/toplevel_methods/html_comment.rb'
+
+  # ========================================================================= #
+  # === make_this_id_draggable
+  #
+  # Note that this will be guaranteed to always add the corresponding
+  # javascript code, which is different to javascript_drag_and_drop().
+  # ========================================================================= #
+  def make_this_id_draggable(this_id)
+    addnl(
+      ::Cyberweb.return_javascript_drag_and_drop(this_id)
+    )
+  end
+
+  # ========================================================================= #
+  # === javascript_drag_and_drop
+  # ========================================================================= #
+  def javascript_drag_and_drop(i)
+    if use_jquery?
+      make_this_id_draggable(i)
+    end
+  end; alias drag_and_drop       javascript_drag_and_drop # === drag_and_drop
+       alias drag_n_drop         javascript_drag_and_drop # === drag_n_drop
+       alias drag_drop           javascript_drag_and_drop # === drag_drop
+       alias drag                javascript_drag_and_drop # === drag
+       alias add_javascript_drag javascript_drag_and_drop # === add_javascript_drag
+       alias drag_this           javascript_drag_and_drop # === drag_this
+       alias enable_drag_for     javascript_drag_and_drop # === enable_drag_for
+       alias drag_this_id        javascript_drag_and_drop # === drag_this_id
+
+  # ========================================================================= #
+  # === this_jquery_version
+  #
+  # This method will always return the latest jquery version to use.
+  #
+  # It will query a toplevel method for this, rather than storing
+  # this internally.
+  # ========================================================================= #
+  def this_jquery_version
+    ::Cyberweb.jquery_version? # Ought to be a String, always.
+  end; alias jquery_version? this_jquery_version # === jquery_version?
+
+  # ========================================================================= #
+  # === path_to_jquery_dir?
+  # ========================================================================= #
+  def path_to_jquery_dir?
+    ::Cyberweb.path_to_jquery_dir?
+  end
+
+  # ========================================================================= #
+  # === return_jquery_string
+  #
+  # Since as of 21.09.2014 this method will return two .js files here.
+  #
+  # The version of jquery-ui is currently hardcoded.
+  #
+  # The latest version of jquery-ui can be viewed here:
+  #
+  #   https://code.jquery.com/ui/
+  #
+  # ========================================================================= #
+  def return_jquery_string(
+      jquery_ui_version = Cyberweb.jquery_ui_version?
+    )
+    return ::Cyberweb.return_jquery_string(jquery_ui_version)
+  end; alias build_jquery_string return_jquery_string # === build_jquery_string
+
+  require 'cyberweb/javascript/drag_and_drop.rb'
+  # ========================================================================= #
+  # === drag_and_drop
+  # ========================================================================= #
+  def drag_and_drop(
+      this_id = 'drag_test'
+    )
+    if use_jquery?
+      addnl(
+        ::Cyberweb.return_javascript_drag_and_drop(this_id)
+      )
+    end
+  end; alias drag                drag_and_drop # === drag
+       alias enable_drag_for     drag_and_drop # === enable_drag_for
+       alias drag_n_drop         drag_and_drop # === drag_n_drop
+       alias drag_drop           drag_and_drop # === drag_drop
+       alias add_javascript_drag drag_and_drop # === add_javascript_drag
+
+  # ========================================================================= #
+  # === update_the_body
+  #
+  # This method will update the content of the <body> tag, via javascript.
+  # ========================================================================= #
+  def update_the_body(with_this_content)
+    ejavascript'
+document.body.innerHTML = "'+with_this_content+'"
+   '
+  end
+
+  # ========================================================================= #
+  # === ejavascript
+  #
+  # The name of this method indicates "echo javascript", mostly for
+  # historic/legacy reasons.
+  # ========================================================================= #
+  def ejavascript(i = '')
+    if i.is_a? Symbol
+      case i
+      # ===================================================================== #
+      # === :popup_open
+      # ===================================================================== #
+      when :popup_open
+        i = '
+function popup_open(name_of_the_id = "popup_element") {
+  var popup = document.getElementById(name_of_the_id);
+  popup.classList.toggle("show");
+}
+'
+      end
+    end
+    addn(
+      return_javascript(i)
+    )
+  end; alias javascript               ejavascript # === javascript
+       alias embed_javascript         ejavascript # === embed_javascript
+       alias embed_this_javascript    ejavascript # === embed_this_javascript
+       alias ejavascript_code         ejavascript # === ejavascript_code
+       alias add_this_javascript_code ejavascript # === add_this_javascript_code
+       alias script                   ejavascript # === script
+
+  # ========================================================================= #
+  # === javascript_defer
+  #
+  # The point of defer is to indicate that a javascript-file will
+  # not be changing structure of the page as it is being executed.
+  #
+  # Note that the defer attribute is supported only for external
+  # script files; it is ignored for internal javascript code.
+  # ========================================================================= #
+  def javascript_defer(
+      use_this_source
+    )
+    addnl(
+      '<script defer src="'+use_this_source+'"></script>'
+    )
+  end
+
+  # ========================================================================= #
+  # === disable_right_click
+  # ========================================================================= #
+  def disable_right_click
+    addnl(
+      ::Cyberweb.disable_right_click(:return_it)
+    )
+  end; alias no_right_click disable_right_click # === no_right_click
+
+  # ========================================================================= #
+  # === append_jquery_string
+  # ========================================================================= #
+  def append_jquery_string
+    if use_jquery?
+      append return_jquery_string
+    end
+  end
+
+  # ========================================================================= #
+  # === return_javascript
+  # ========================================================================= #
+  def return_javascript(i)
+    ::Cyberweb.return_javascript(i)
+  end
+
+  # ========================================================================= #
+  # === use_jquery?
+  #
+  # This allows us to use jquery specifically.
+  # ========================================================================= #
+  def use_jquery?
+    @config['use_jquery']
+  end
+
+  # ========================================================================= #
+  # === javascript_file=
+  #
+  # A wrapper towards cyberweb.rb and javascript_file() method.
+  #
+  # Usage example:
+  #
+  #   w.javascript_file = :fader
+  #
+  # ========================================================================= #
+  def javascript_file=(i)
+    @internal_hash[:javascript] << javascript_file(i)+N
+  end; alias link_in_javascript javascript_file= # === link_in_javascript
+       alias load_javascript    javascript_file= # === load_javascript
+
+  require 'cyberweb/javascript/javascript_last_modified.rb'
+  # ========================================================================= #
+  # === javascript_last_modified
+  # ========================================================================= #
+  def javascript_last_modified(i = '')
+    addnl(
+      ::Cyberweb.javascript_last_modified(i)
+    )
+  end
+
+  # ========================================================================= #
+  # === display_time
+  #
+  # Simply display the time.
+  # ========================================================================= #
+  def display_time(
+      in_what_format = :javascript,
+      css_style      = ''
+    )
+    if in_what_format.is_a?(Hash) and in_what_format.has_key?(:css_style)
+      css_style = in_what_format.delete(:css_style)
+      in_what_format = :javascript
+    end
+    div('','clock',css_style) {
+      case in_what_format
+      # ===================================================================== #
+      # === :javascript
+      # ===================================================================== #
+      when :javascript, :default
+        return_javascript "updateClock(); setInterval('updateClock()', 1000 )"
+      when :ruby
+        e Time.now.strftime('%H:%M:%S') 
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === show_cheerleader
+  #
+  # Shows an ASCII cheerleader.
+  # ========================================================================= #
+  def show_cheerleader(
+      path_to_cheerleader_file = Cyberweb.path_to_data?+'CODE/javascript/cheerleader.js'
+    )
+    filename = 'cheerleader.js'
+    _ = path_to_cheerleader_file
+    _ << filename unless _[-filename.size, filename.size] == filename
+    load_javascript(_)
+  end
+
+  # ========================================================================= #
+  # === display_simple_clock
+  #
+  # This is a simpler clock variant.
+  # ========================================================================= #
+  def display_simple_clock(
+      optional_css_class = ''
+    )
+    ee '<p id="id_for_the_simple_clock_timer" class="'+optional_css_class.to_s+'"></p>'
+    addnl(
+      return_javascript '
+      simple_clock_timer();
+var timer = setInterval(function() {
+  simple_clock_timer();
+}, 1000);
+
+function return_formatted_time() {
+  var d = new Date();
+  var formatted_time = ("0"+d.getHours()).slice(-2)+":"+
+                       ("0"+d.getMinutes()).slice(-2)+":"+
+                       ("0"+d.getSeconds()).slice(-2);
+  return formatted_time;
+}
+
+function simple_clock_timer() {
+  document.getElementById("id_for_the_simple_clock_timer").innerHTML = return_formatted_time();
+}
+'
+    )
+  end
+
+  # ========================================================================= #
+  # === chmod_displayer
+  # ========================================================================= #
+  def chmod_displayer(i = :default)
+    addnl(
+      ::Cyberweb.chmod_displayer(i)
+    )
+  end
+
+  require 'cyberweb/javascript/javascript.rb'
+  # ========================================================================= #
+  # === sanitize_javascript
+  # ========================================================================= #
+  def sanitize_javascript(i)
+    ::Cyberweb.sanitize_javascript(i)
+  end
+
+  # ========================================================================= #
+  # === javascript_script=
+  #
+  # This method assigns to the @javascript variable. We expect it to
+  # hold strings related to javascript-code.
+  # ========================================================================= #
+  def javascript_script=(i)
+    if @internal_hash[:javascript].frozen?
+      @internal_hash[:javascript] = @internal_hash[:javascript].dup
+    end
+    @internal_hash[:javascript] << return_javascript(i) # Tap into javascript/ subdirectory.
+  end; alias javascript_in_head_tag javascript_script= # === javascript_in_head_tag
+
+  # ========================================================================= #
+  # === return_default_javascript
+  # ========================================================================= #
+  def return_default_javascript(
+      i = ::Cyberweb.converted_path_to_data
+    )
+    ::Cyberweb.return_default_javascript(i)
+  end
+
+  # ========================================================================= #
+  # === javascript?
+  # ========================================================================= #
+  def javascript?
+    @internal_hash[:javascript]
+  end
+
+  require 'cyberweb/javascript/on_click_change_opacity.rb'
+  # ========================================================================= #
+  # === on_click_make_darker
+  # ========================================================================= #
+  def on_click_make_darker(this_id, opacity = '0.90')
+    addn(
+      ::Cyberweb.on_click_make_darker(this_id, opacity)
+    )
+  end
+
+  # ========================================================================= #
+  # === enable_jquery_for_every_page?
+  #
+  # Determine whether we are using jquery for every page.
+  # ========================================================================= #
+  def enable_jquery_for_every_page?
+    @config['enable_jquery_for_every_page']
+  end
+
+  # ========================================================================= #
+  # === jquery
+  #
+  # An alias to enabling the use of jquery on a website, through the
+  # method call do_use_jquery().
+  # ========================================================================= #
+  def jquery(i = '+')
+    i = i.to_s # We definitely do want a String here.
+    do_use_jquery if i == '+'
+  end
+
+  # ========================================================================= #
+  # === report_the_jquery_version_in_use
+  # ========================================================================= #
+  def report_the_jquery_version_in_use
+    e 'The jquery version in use is '\
+      '<b>'+this_jquery_version.to_s+'</b>.'
+  end
+
+  # ========================================================================= #
+  # === do_we_use_jquery?
+  #
+  # This method can be used to report whether a particular web-object
+  # makes use of jquery or whether it does not.
+  # ========================================================================= #
+  def do_we_use_jquery?
+    e "Does this web_object make use of jquery? #{use_jquery?}"
+  end; alias report_whether_this_webobject_makes_use_of_jquery do_we_use_jquery? # === report_whether_this_webobject_makes_use_of_jquery
+       alias report_use_jquery?                                do_we_use_jquery? # === report_use_jquery?
+       alias jquery_is_used?                                   do_we_use_jquery? # === jquery_is_used?
+
+  # ========================================================================= #
+  # === do_use_jquery
+  #
+  # Use this method to enable jquery support.
+  #
+  # I recommend to use this method, rather than use_jquery, but if
+  # you want to be lazy, feel free to use either variant. I just
+  # think that the explicit "do_" implies an action, which I
+  # think is more logical.
+  # ========================================================================= #
+  def do_use_jquery
+    @config['use_jquery'] = true # Do a batch-assignment here.
+  end; alias use_jquery    do_use_jquery # === use_jquery
+       alias enable_drag   do_use_jquery # === enable_drag
+       alias enable_jquery do_use_jquery # === enable_jquery
+
+  # ========================================================================= #
+  # === jquery_resizable_via_the_mouse
+  #
+  # This method can be used to resize an element via the mouse.
+  # ========================================================================= #
+  def jquery_resizable_via_the_mouse(
+      hash_or_string = { id: :resizable_via_the_mouse }
+    )
+    if hash_or_string and hash_or_string.is_a?(Hash) and
+       hash_or_string.has_key?(:id)
+      hash_or_string = hash_or_string[:id].to_s
+    end
+    ejavascript '$( function() {
+      $("#'+hash_or_string.to_s+'").resizable();
+    } );'
+  end
+
+  # ========================================================================= #
+  # === no_jquery
+  #
+  # Do not use jquery. This is the default.
+  # ========================================================================= #
+  def no_jquery
+    @config['use_jquery'] = false
+  end
+
+end; end

data/lib/cyberweb/web_object/languages.rb

@@ -0,0 +1,172 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The typical layout of a .html page should be similar to this:
+#
+#   <!DOCTYPE html>
+#   <html lang="en">
+#   <head>
+#   <meta charset="utf-8"/>
+#
+# =========================================================================== #
+# require 'cyberweb/web_object/languages.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === german
+  # ========================================================================= #
+  def german(i = nil, &block)
+    add_doctype_then_html_start_tag_then_head_tag_then_charset
+    german_trinity
+    if i
+      set_title(i)
+    end
+    handle_these_calls(&block)
+    close_html_after_making_sure_that_the_body_tag_exists
+  end
+
+  # ========================================================================= #
+  # === english                                                 (english tag)
+  # ========================================================================= #
+  def english(i = nil, &block)
+    add_doctype_then_html_start_tag_then_head_tag_then_charset
+    english_trinity
+    if i
+      set_title(i)
+    end
+    handle_these_calls(&block)
+    close_html_after_making_sure_that_the_body_tag_exists
+  end
+
+  # ========================================================================= #
+  # === language
+  #
+  # You can use this method to specify a certain language in order to
+  # use for the given web page. I tend to use this to remind myself
+  # in which language I shall write a web-page in, e. g. usually
+  # either in german, or more commonly these days, in english.
+  #
+  # Invocation example:
+  #
+  #   language :english
+  #
+  # ========================================================================= #
+  def language(
+      which_language = nil
+    )
+    case which_language
+    # ======================================================================= #
+    # === eng
+    # ======================================================================= #
+    when 'eng','e','en','default'
+      which_language = 'english'
+    # ======================================================================= #
+    # === ger
+    # ======================================================================= #
+    when 'ger','g','ge','german','deutsch'
+      which_language = 'german'
+    end
+    @internal_hash[:language] = which_language.to_s # Will be kept as a String.
+  end
+
+  # ========================================================================= #
+  # === german_unicode_and_jquery
+  #
+  # This convenience method will enable german language layout for a
+  # webpage, jquery-drag-and-drop support, as well as declare that
+  # the page at hand uses unicode characters (and thus needs support
+  # for unicode).
+  # ========================================================================= #
+  def german_unicode_and_jquery
+    do_use_jquery
+    german_trinity
+  end; alias german_unicode_jquery         german_unicode_and_jquery # === german_unicode_jquery
+       alias use_jquery_german_and_unicode german_unicode_and_jquery # === german_unicode_and_jquery
+
+  # ========================================================================= #
+  # === english_unicode_and_jquery
+  # ========================================================================= #
+  def english_unicode_and_jquery
+    do_use_jquery
+    english_trinity
+  end
+
+  # ========================================================================= #
+  # === german_unicode
+  # ========================================================================= #
+  def german_unicode
+    use_german
+    use_unicode
+  end
+
+  # ========================================================================= #
+  # === use_english
+  # ========================================================================= #
+  def use_english # An easier shortcut.
+    language :english
+  end; alias do_use_english use_english # === english
+
+  # ========================================================================= #
+  # === german_trinity
+  #
+  # This variant specifically does NOT force the use of jquery since as
+  # of May 2021. If you want to force jquery, use the method
+  # called german_unicode_and_jquery() instead.
+  #
+  # Strictly speaking the word "trinity" is thus no longer correct, but
+  # for the time being it will be retained.
+  # ========================================================================= #
+  def german_trinity
+    german_unicode # This bundles "use_german" and "use_unicode".
+    add_html_comment("\nThis website is making use of german.\n")
+    add_relevant_meta_entries(:ignore_checks)
+  end; alias use_unicode_german_and_jquery german_trinity # === use_unicode_german_and_jquery
+       alias trinity_german                german_trinity # === trinity_german
+       alias trinity                       german_trinity # === trinity
+
+  # ========================================================================= #
+  # === use_german
+  #
+  # This is an easier shortcut to designate that the current webpage
+  # makes use of the german language as part of its content primarily.
+  # ========================================================================= #
+  def use_german # An easier shortcut.
+    language :german
+  end
+
+  # ========================================================================= #
+  # === english_trinity
+  # ========================================================================= #
+  def english_trinity
+    do_use_english
+    use_unicode
+    add_html_comment("\nThis website is making use of english.\n")
+    add_relevant_meta_entries(:ignore_checks)
+  end; alias use_english_trinity english_trinity # === use_english_trinity
+       alias english_trinity     english_trinity # === english_trinity
+
+  # ========================================================================= #
+  # === add_doctype_then_html_start_tag_then_head_tag_then_charset
+  #
+  # This must add a string-chain like:
+  #
+  #   <!DOCTYPE html>
+  #   <html lang="en">
+  #   <head>
+  #   <meta charset="utf-8"/>
+  #
+  # ========================================================================= #
+  def add_doctype_then_html_start_tag_then_head_tag_then_charset
+    add(DOCTYPE_HTML5)
+    add(Cyberweb.return_html_start) # html lang.
+    add(Cyberweb.return_head_start)
+    add(Cyberweb.return_utf_charset)
+  end
+
+end; end