cyberweb 0.8.17 → 0.9.31

data/lib/cyberweb/web_object/javascript_and_jquery.rb

@@ -10,6 +10,171 @@ module Cyberweb
 
 class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
 
+  # ========================================================================= #
+  # === Javascript_write
+  # ========================================================================= #
+  def javascript_write(
+      i = 'Hello world!'
+    )
+    addnl(
+      return_javascript(
+        'document.write('+i.to_s+')'
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === return_javascript
+  #
+  # This method would yield a String such as:
+  #
+  #   "\n<script>\n\nabc\n</script>\n"
+  #
+  # ========================================================================= #
+  def return_javascript(i)
+    ::Cyberweb.return_javascript(i)
+  end
+
+  # ========================================================================= #
+  # === dump_all_javascript
+  #
+  # This method was added in February 2023. It can be used to read the
+  # content of all .js files that are distributed by the cyberweb
+  # project, and present it as one large string. This is an alternative
+  # to the requirement of the browser normally needing to read from
+  # a local .js file. I actually ran into permission issues in February
+  # 2023, so I decided to add a "hackish" work-around over that
+  # problem - thus the method was added.
+  # ========================================================================= #
+  def dump_all_javascript
+    _ = ''.dup
+    # ======================================================================= #
+    # Build up the String next:
+    # ======================================================================= #
+    path_to_use = sitelibdir?+
+                  'cyberweb/javascript_code/'
+    js_files_to_load?.each {|this_js_file|
+      full_path = path_to_use+
+                  this_js_file
+      if File.exist? full_path
+        _ << File.read(full_path)+"\n"
+      else
+        # _ << "THE PATH IS\n"
+        # _ << full_path+"\n"
+      end
+    }
+    append_onto_the_main_javascript_variable(return_javascript(_))
+  end
+
+  # ========================================================================= #
+  # === append_onto_the_main_javascript_variable
+  # ========================================================================= #
+  def append_onto_the_main_javascript_variable(i)
+    @internal_hash[:javascript] << i
+  end
+
+  # ========================================================================= #
+  # === javascript_file=
+  #
+  # A wrapper towards cyberweb.rb and javascript_file() method.
+  #
+  # Usage example:
+  #
+  #   w.javascript_file = :fader
+  #
+  # ========================================================================= #
+  def javascript_file=(i)
+    _ = "#{javascript_file(i.dup)}#{N}"
+    @internal_hash[:javascript] << _
+  end; alias link_in_javascript                       javascript_file= # === link_in_javascript
+       alias load_javascript                          javascript_file= # === load_javascript
+
+  # ========================================================================= #
+  # === return_default_javascript
+  # ========================================================================= #
+  def return_default_javascript#(
+    #  i = ::Cyberweb.converted_path_to_data # Disabled this line as of October 2022.
+    #)
+    #::Cyberweb.return_default_javascript(i)
+    _ = ''.dup
+    # path_to_use = ::Cyberweb.converted_path_to_project_base_dir
+    # path_to_use = ::Cyberweb.log_dir?+'javascript_code/'
+    path_to_use = ::Cyberweb.converted_path_to_the_directory_containing_the_copied_javascript_files
+    array = ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES
+    _ = ''.dup # This String will be returned.
+    array.each {|entry|
+     full_path = "#{path_to_use}#{entry}".dup
+      _ << '<script src="'+full_path+'"'
+      _ = _.ljust(48)
+      _ << ' type="text/javascript"></script>'
+      _ << NL
+    }
+    return _
+  end
+
+  # ========================================================================= #
+  # === body_javascript=
+  #
+  # This method sets the @body_javascript ivar. This variable will be used
+  # for making the <body> of a HTML page, at the least to JavaScript
+  # that is associated with the <body> tag. Normally this is not in use
+  # for most webpages though.
+  #
+  # As of September 2011 it is required that the last character is a ';'.
+  # If this is not the case it will be appended.
+  #
+  # Usage example:
+  #
+  #   w.body_onload = 'draginit()' # This is an alias.
+  #
+  # ========================================================================= #
+  def body_javascript=(
+      this_javascript = ''
+    )
+    @internal_hash[:body_javascript] << this_javascript
+    if @internal_hash[:body_javascript] and @internal_hash[:body_javascript].end_with?(';')
+    else
+      if @internal_hash[:body_javascript].frozen?
+        @internal_hash[:body_javascript] = @internal_hash[:body_javascript].dup
+      end
+      @internal_hash[:body_javascript] << ';'
+    end
+  end
+    # ======================================================================= #
+    # === onload=
+    #
+    # Right now this is an alias towards the above method. But one day
+    # this may change (May 2011)
+    # ======================================================================= #
+    alias onload=      body_javascript= # === onload=
+    alias onload       body_javascript= # === onload
+    alias body_onload= body_javascript= # === body_onload=
+
+  # ========================================================================= #
+  # === body_javascript?
+  # ========================================================================= #
+  def body_javascript?
+    @internal_hash[:body_javascript]
+  end
+
+  # ========================================================================= #
+  # === javascript?
+  # ========================================================================= #
+  def javascript?
+    @internal_hash[:javascript]
+  end
+
+  # ========================================================================= #
+  # === js_files_to_load?
+  #
+  # This method will return which .js files are to be loaded by the
+  # cyberweb project. This is normally defined in the file at
+  # 'cyberweb/yaml/js_files_to_load.yml'.
+  # ========================================================================= #
+  def js_files_to_load?
+    ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES
+  end
+
   # ========================================================================= #
   # === ejavascript
   #
@@ -84,13 +249,6 @@ EOF
     ejavascript(content)
   end
 
-  # ========================================================================= #
-  # === return_javascript
-  # ========================================================================= #
-  def return_javascript(i)
-    ::Cyberweb.return_javascript(i)
-  end
-
   # ========================================================================= #
   # === this_jquery_version
   #
@@ -199,35 +357,6 @@ EOF
     add_to_main_string_lateron(_)
   end; alias no_right_click disable_right_click # === no_right_click
 
-  # ========================================================================= #
-  # === body_javascript=
-  #
-  # This method sets the @body_javascript ivar. This variable will be used
-  # for making the <body> of a HTML page. As of Sep 2011 we require
-  # that the last character is a ;
-  #
-  # Usage example:
-  #
-  #   w.body_onload = 'draginit()' # This is an alias.
-  #
-  # ========================================================================= #
-  def body_javascript=(this_javascript = '')
-    @internal_hash[:body_javascript] << this_javascript
-    if @internal_hash[:body_javascript] and @internal_hash[:body_javascript].end_with?(';')
-    else
-      @internal_hash[:body_javascript] << ';'
-    end
-  end
-    # ======================================================================= #
-    # === onload=
-    #
-    # Right now this is an alias towards the above method. But one day
-    # this may change (May 2011)
-    # ======================================================================= #
-    alias onload=      body_javascript= # === onload=
-    alias onload       body_javascript= # === onload
-    alias body_onload= body_javascript= # === body_onload=
-
   # ========================================================================= #
   # ===  javascript_pop_up
   # ========================================================================= #
@@ -272,21 +401,6 @@ EOF
     @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

data/lib/cyberweb/web_object/link.rb

@@ -10,6 +10,95 @@ module Cyberweb
 
 class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
 
+  # ========================================================================= #
+  # === science_links_to
+  # ========================================================================= #
+  def science_links_to(
+      i = [
+        :chemistry,
+        :organic_chemistry
+      ]
+    )
+    science_hyperlinks(
+      i,
+      true
+    ) { :use_unicode_right_arrows }
+  end
+
+  # ========================================================================= #
+  # === string_link
+  #
+  # This method essentially creates a String representation of the HTML
+  # <a> tag.
+  #
+  # Since as of April 2022 the method "slink" is now an alias to string_link;
+  # it used to be an alias towards "def a()", but this was changed - the
+  # word string_link more logically may refer to slink as its intrinsic
+  # abbreviation.
+  # ========================================================================= #
+  def string_link(
+      i           = '',
+      option_hash = {},
+      &block
+    )
+    # ======================================================================= #
+    # === Handle blocks given to this method next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :pretty
+      # ===================================================================== #
+      when :pretty
+        option_hash[:remote_URL] = beautiful_url(i)
+      end
+    end
+    if i.is_a?(Symbol)
+      if i.start_with?('local_')
+        i = BeautifulUrl.local_menu(i)
+      else
+        i = beautiful_url(i)
+        # =================================================================== #
+        # Also check if the second argument is a String. In this case we
+        # must modify it. Example for input that fulfils this criterium:
+        #
+        #   remote_link(:hydrogenase, 'Hydrogenase')+
+        #
+        # =================================================================== #
+        if option_hash.is_a? String
+          option_hash = { content: option_hash }
+        end
+      end
+    end
+    # ======================================================================= #
+    # === Handle local entries for the "/home/x" directory layout.
+    # ======================================================================= #
+    if i.start_with? '/home/x'
+      i = i.dup
+      i.sub!(/\/home\/x\//, relative_path?)
+    end
+    # ======================================================================= #
+    # Next, double forward slashes, aka //, will be removed. However had
+    # this also cripples links such as "chrome://extensions/", which is
+    # bad. Thus, in February 2023, the following line was commented
+    # out; in the event we want to re-enable it, we may have to think
+    # more about the use cases.
+    # ======================================================================= #
+    # i = rds(i.to_s.dup)
+    # ======================================================================= #
+    # Delegate onto HtmlTags.a().
+    # ======================================================================= #
+    return HtmlTags.a(
+      i,
+      option_hash
+    )
+  end; alias string_a           string_link # === string_a
+       alias string_href        string_link # === string_href
+       alias string_remote_link string_link # === string_remote_link
+       alias slink              string_link # === slink
+       alias remote_hyperlink   string_link # === remote_hyperlink
+
   # ========================================================================= #
   # === a                                                   (a tag, link tag)
   #
@@ -45,6 +134,9 @@ class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
 
   # ========================================================================= #
   # === linkbr                                                      (abr tag)
+  #
+  # This method will mostly delegate onto HtmlTags.a(), by calling
+  # a() internally first.
   # ========================================================================= #
   def linkbr(
       i           = '',
@@ -69,7 +161,7 @@ class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
       end
     end
     case i
-    when 'SELF'
+    when /^SELF$/
       i = request_uri?
     else
       # ===================================================================== #
@@ -95,38 +187,6 @@ class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
     br
   end; alias abr linkbr # === abr
 
-  # ========================================================================= #
-  # === roebe_internal_link
-  #
-  # This is the method that, since as of June 2021, should be used for
-  # any "roebe-internal" link. This refers primarily to my home
-  # system, which is now spread out into different projects.
-  #
-  # Note that since as of June 2021, all roebe-internal links MUST start
-  # with a :local_ prefix. This may change at a later time, but for now
-  # we will keep this very strict.
-  # ========================================================================= #
-  def roebe_internal_link(
-      i, hash
-    )
-    if i.is_a? Symbol
-      if i.start_with? 'local'
-        i = BeautifulUrl.local_link(i)
-        # =================================================================== #
-        # For sinatra, we will simplify this a bit. This is fairly hackish
-        # but it should suffice for now.
-        # =================================================================== #
-        if uses_sinatra?
-          i = i.to_s
-          i = File.basename(
-                i.delete_suffix(File.extname(i))
-              )
-        end
-      end
-    end
-    abr(i, hash)
-  end; alias roebe_local_link roebe_internal_link # === roebe_local_link
-
   # ========================================================================= #
   # === self_abr
   #
@@ -165,7 +225,9 @@ class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
   #   pretty_link('Jules Bordet')
   #
   # ========================================================================= #
-  def pretty_link(i, optional_css_class = '')
+  def pretty_link(
+      i, optional_css_class = ''
+    )
     remote_URL = beautiful_URL(i)
     return string_a(remote_URL, content: i, css_class: optional_css_class)
   end
@@ -365,4 +427,115 @@ class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
     end
   end
 
+  # ========================================================================= #
+  # === science_hyperlinks
+  #
+  # This method will add some of my default hyperlinks for local files,
+  # in regards to science-related links/content.
+  #
+  # The first argument to this method can be additional entries that
+  # the user may want to display.
+  #
+  # Different usage examples follow next:
+  #
+  #   science_hyperlinks
+  #   science_hyperlinks { :use_unicode_right_arrows }
+  #   science_links {{ use_this_image: LINK_IMAGE }}
+  #
+  # ========================================================================= #
+  def science_hyperlinks(
+      additional_entries              = nil,
+      use_only_the_additional_entries = false,
+      &block
+    )
+    array_science_entries = %w(
+      local_cellbiology
+      local_biochemistry
+      local_chemistry
+      local_genetics
+      local_gene_expression
+      local_microbiology
+      local_biotechnology
+      local_evolution
+    )
+    if use_only_the_additional_entries
+      array_science_entries.clear
+    end
+    if additional_entries
+      array_science_entries << [additional_entries]
+      array_science_entries.flatten!
+      array_science_entries.compact! 
+    end
+    yielded = nil
+    yielded = yield if block_given?
+    array_science_entries.each {|this_local_link|
+      this_local_link = BeautifulUrl.local_menu(this_local_link)
+      short_name = File.basename(this_local_link.to_s).delete_suffix('.cgi').dup.
+                   tr('_',' ').
+                   sub(/local/,'')
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :use_this_image
+        # =================================================================== #
+        if yielded.has_key?(:use_this_image)
+          use_this_image = yielded[:use_this_image]
+          short_name = "#{use_this_image}#{short_name.strip}"
+        end
+      else
+        case yielded
+        # =================================================================== #
+        # === pretty_image
+        # =================================================================== #
+        when :pretty_image
+          short_name.prepend(dot109?)
+        # =================================================================== #
+        # === :use_unicode_right_arrows
+        # =================================================================== #
+        when :use_unicode_right_arrows
+          short_name.prepend('→')
+        end
+      end
+      abr_self(
+        this_local_link,
+        content: short_name
+      )
+    }
+  end; alias add_science_links science_hyperlinks # === add_science_links
+       alias science_links     science_hyperlinks # === science_links
+
+  # ========================================================================= #
+  # === check_for_links_markdown_file
+  #
+  # This method will check for a file called "links.md".
+  # ========================================================================= #
+  def check_for_links_markdown_file
+    _ = 'links.md'
+    # Also check for LINKS.md
+    unless File.exist? _
+      _ = 'LINKS.md'
+    end
+    if File.exist? _
+      use_this_css_class = ''.dup # A default value.
+      lines = File.readlines(_)
+      lines.each {|this_entry|
+        if this_entry.include? '# ' # Assume a "hidden" CSS class in this case.
+          splitted = this_entry.split('# ')
+          use_this_css_class = splitted.last.strip
+          this_entry = splitted.first
+        end
+        if this_entry.is_a?(String) and this_entry.start_with?(':')
+          this_entry = Cyberweb.sanitize_url(
+            this_entry.delete(':').to_sym
+          )
+        end
+        abr_self(
+          this_entry,
+          css_class: use_this_css_class
+        )
+      }
+      br # And one last trailing newline.
+    end
+  end; alias try_links_file       check_for_links_markdown_file # === try_links_file
+       alias check_for_links_file check_for_links_markdown_file # === check_for_links_file
+
 end; end