cyberweb 0.4.174

data/lib/cyberweb/encoding/encoding.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Note that the default character encoding for HTML5 is UTF-8.
+# =========================================================================== #
+# require 'cyberweb/encoding/encoding.rb'
+# =========================================================================== #
+module Cyberweb
+
+module Encoding # === Cyberweb::Encoding
+
+  # ========================================================================= #
+  # === ENCODING_UTF8
+  # ========================================================================= #
+  ENCODING_UTF8 = 'utf-8'
+
+  # ========================================================================= #
+  # === ENCODING_ISO
+  # ========================================================================= #
+  ENCODING_ISO = 'ISO-8859-1'
+    ISO_ENCODING = ENCODING_ISO
+
+  # ========================================================================= #
+  # === MAIN_ENCODING
+  #
+  # This is the main pointer to the default encoding.
+  #
+  # The current main encoding will be UTF-8.
+  # ========================================================================= #
+  MAIN_ENCODING = ENCODING_UTF8
+    MAIN_ENCODING_TO_USE = MAIN_ENCODING # === MAIN_ENCODING_TO_USE
+
+  # ========================================================================= #
+  # === ENCODING_US_ASCII
+  # ========================================================================= #
+  ENCODING_US_ASCII = 'US-ASCII'
+    US_ASCII = ENCODING_US_ASCII # === US_ASCII
+
+  # ========================================================================= #
+  # === Cyberweb::Encoding.ensure_main_encoding
+  # ========================================================================= #
+  def self.ensure_main_encoding(
+      of_this_string
+    )
+    if of_this_string.frozen?
+      of_this_string = of_this_string.to_s.dup
+    end
+    of_this_string.force_encoding(MAIN_ENCODING_TO_USE)
+  end
+
+end
+
+# =========================================================================== #
+# Pull in the Cyberweb::Encoding module at once.
+# =========================================================================== #
+include ::Cyberweb::Encoding
+
+# =========================================================================== #
+# === Cyberweb.main_encoding?
+#
+# We point to the main Encoding in use here.
+# =========================================================================== #
+def self.main_encoding?
+  ::Cyberweb::Encoding::MAIN_ENCODING
+end
+
+# =========================================================================== #
+# === Cyberweb.ensure_main_encoding
+# =========================================================================== #
+def self.ensure_main_encoding(of_this_string)
+  ::Cyberweb::Encoding.ensure_main_encoding(of_this_string)
+end
+
+# =========================================================================== #
+# === DEFAULT_PROJECT_ENCODING
+#
+# Assign an initial project-wide encoding that is to be used.
+# =========================================================================== #
+DEFAULT_PROJECT_ENCODING = {
+  encoding: ::Cyberweb.main_encoding?
+}
+
+end

data/lib/cyberweb/erb/test.rhtml

@@ -0,0 +1,81 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'erb'
+
+# =========================================================================== #
+# Build template data class.
+# =========================================================================== #
+class Product
+  def initialize(code, name, desc, cost)
+    @code = code
+    @name = name
+    @desc = desc
+    @cost = cost
+
+    @features = [ ]
+  end
+
+  def add_feature( feature )
+    @features << feature
+  end
+
+  # Support templating of member data.
+  def get_binding
+    binding
+  end
+
+  # ...
+end
+
+# =========================================================================== #
+# Create spaghetti-template.
+# =========================================================================== #
+template = %{
+  <html>
+    <head><title>Ruby Toys -- <%= @name %></title></head>
+    <body>
+
+      <h1><%= @name %> (<%= @code %>)</h1>
+      <p><%= @desc %></p>
+
+      <ul>
+        <% @features.each do |f| %>
+          <li><b><%= f %></b></li>
+        <% end %>
+      </ul>
+
+      <p>
+        <% if @cost < 10 %>
+          <b>Only <%= @cost %>!!!</b>
+        <% else %>
+           Call for a price, today!
+        <% end %>
+      </p>
+
+    </body>
+  </html>
+}.gsub(/^  /, '')
+
+rhtml = ERB.new(template)
+
+# =========================================================================== #
+# Set up template data.
+# =========================================================================== #
+toy = Product.new(
+  "TZ-1002",
+  "Rubysapien",
+  "Geek's Best Friend!  Responds to Ruby commands...",
+  999.95
+)
+toy.add_feature("Listens for verbal commands in the Ruby language!")
+toy.add_feature("Ignores Perl, Java, and all C variants.")
+toy.add_feature("Karate-Chop Action!!!")
+toy.add_feature("Matz signature on left leg.")
+toy.add_feature("Gem studded eyes... Rubies, of course!")
+
+# =========================================================================== #
+# Produce result.
+# =========================================================================== #
+rhtml.run(toy.get_binding)

data/lib/cyberweb/erb/test_template.erb

@@ -0,0 +1,9 @@
+require 'erb'
+
+x = 42
+
+template = ERB.new <<-EOF
+  The value of x is: <%= x %>
+EOF
+
+puts template.result(binding)

data/lib/cyberweb/evaluate_from_the_same_named_file_then_serve.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/DATA/PROGRAMMING_LANGUAGES/RUBY/src/roebe/lib/roebe/www/zoologie/zoologie.cgi
+# =========================================================================== #
+require 'cyberweb'
+
+Cyberweb::WebObject.evaluate_from_the_same_named_file_then_serve

data/lib/cyberweb/favicon/favicon.rb

@@ -0,0 +1,196 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::Favicon
+#
+# This class can download remote favicons. OpenSSL is required for this
+# functionality if you connect to remote https hosts.
+#
+# The three optional dependencies for this class are on:
+#
+#   → nokogiri
+#   → open-uri, and
+#   → addressable
+#
+# =========================================================================== #
+# require 'cyberweb/favicon/favicon.rb'
+# =========================================================================== #
+module Cyberweb
+
+class Favicon # === Cyberweb::Favicon
+
+  require 'cyberweb/constants/nl.rb'
+
+  begin
+    require 'nokogiri'
+  rescue LoadError; end
+
+  begin
+    require 'open-uri'
+  rescue LoadError; end
+
+  begin
+    require 'addressable/uri'
+  rescue LoadError; end
+
+  attr_accessor :data
+
+  # ========================================================================= #
+  # Errors that are part of the Favicon class.
+  # ========================================================================= #
+  class Error          < StandardError; end
+  class InvalidFavicon < Error; end
+  class MissingFavicon < Error; end
+
+  # ========================================================================= #
+  # === url?
+  # ========================================================================= #
+  def url?
+    @url
+  end; alias url url? # === url
+
+  # ========================================================================= #
+  # === url?
+  # ========================================================================= #
+  def url=(i)
+    @url = i
+  end; alias set_url url= # === set_url
+
+  # ========================================================================= #
+  # === Cyberweb::Favicon.download
+  #
+  # Use this method to download a remote favicon. The first argument
+  # should be the remote URL to a website, as a String.
+  #
+  # Nokogiri will search for any favicon in the remote URL.
+  # ========================================================================= #
+  def self.download(url)
+    uri = Addressable::URI.heuristic_parse(url)
+    uri = Addressable::URI.encode(uri) # needed for chars with accents in url
+    doc = Nokogiri::HTML(open(uri))
+    # ======================================================================= #
+    # Search for the favicon-path next:
+    # ======================================================================= #
+    path = doc.xpath("//link[@rel='shortcut icon' or @rel='icon']/@href").first
+    path = path ? path.to_s : '/favicon.ico'
+    favicon_uri = Addressable::URI.join(uri, path.to_s)
+    # ======================================================================= #
+    # Note that favicon_uri will point to something such as:
+    #
+    #   http://www.ruppweb.org/favicon.ico
+    #
+    # ======================================================================= #
+    begin
+      stream = open(favicon_uri)
+      unless stream.content_type[/^image/]
+        raise InvalidFavicon, "wrong content_type (#{stream.content_type})"
+      end
+      # ===================================================================== #
+      # Obtain the stream-dataset next.
+      # ===================================================================== #
+      data = stream.read
+      if data.size == 0
+        raise InvalidFavicon, 'zero data'
+      end
+      # ===================================================================== #
+      # Instantiate a new Favicon class next.
+      # ===================================================================== #
+      fav = Favicon.new
+      fav.url  = favicon_uri.to_s
+      fav.data = data
+      # ===================================================================== #
+      # Ok, we now have the dataset required stored in the object fav.
+      # We can next proceed to download this into a file.
+      # ===================================================================== #
+      begin
+        e "A favicon was discovred at: #{fav.url}"
+        location = 'favicon.png' # Where to store it.
+        File.open(location, 'w') { |file|
+          file.write(fav.data)
+        }
+        e 'Stored into the file: '+
+          (Dir.pwd+'/'+location).squeeze('/')
+      rescue MissingFavicon
+        e 'Favicon is missing.'
+      rescue InvalidFavicon
+        e 'Favicon is invalid.'
+      end
+    rescue OpenURI::HTTPError => e
+      raise MissingFavicon if e.to_s[/404/] # 404 means missing.
+      raise # nevermind, reraise the previous exception
+    end
+  end
+
+end
+
+# =========================================================================== #
+# === Cyberweb.download_favicon
+#
+# This method can be used to download a remote favicon.
+#
+# Invocation examples:
+#
+#   Cyberweb.download_favicon('https://www.ruby-lang.org/en/')
+#   Cyberweb.download_favicon 'http://www.ruppweb.org/default.htm'
+#
+# =========================================================================== #
+def self.download_favicon(remote_url = '')
+  ::Cyberweb::Favicon.download(remote_url)
+end; self.instance_eval { alias get_favicon download_favicon } # === Cyberweb.get_favicon
+
+# =========================================================================== #
+# === Cyberweb.return_favicon
+#
+# Assign a favicon with this method. The argument `change_to` should be
+# a Fixnum, and icon_path should be a string.
+#
+# Since Sep 2011, if we pass a symbol as argument to `icon_path`, we
+# will try to use webicons instead (which as you can see, will use 
+# the method get_webimage()).
+# =========================================================================== #
+def self.return_favicon(
+    change_to = path_to_images?,
+    icon_path = ''
+  )
+  _ =  '<link rel="shortcut icon" href="'.dup
+  _ << change_to.to_s unless change_to.start_with? '/home/x'
+  _ << '/' unless _.end_with? '/'
+  if icon_path.is_a? Symbol # Handle Symbols here.
+    icon_path = get_webimage(icon_path)
+  elsif icon_path.is_a? Hash
+    if icon_path.has_key? :path_to_icon
+      icon_path = icon_path.delete(:path_to_icon)
+    end
+  end
+  case icon_path.to_s.downcase
+  when 'rand','random'
+    icon_path = get_webimage(:rand)
+  when 'def'
+    icon_path = DEFAULT_FAVICON
+  when 'cfdg'
+    icon_path = create_random_cfdg_favicon
+  end
+  _ << icon_path unless change_to.start_with? '/home/x'
+  _ << '" />' << NL
+  return _ # Return the result finally, as string.
+end
+
+# =========================================================================== #
+# === Cyberweb.create_random_cfdg_favicon
+#
+# This is a special method, should be used internally only! (cfdg tag)
+# =========================================================================== #
+def self.create_random_cfdg_favicon
+  print_html_header
+  img_dir = IMAGE_DIRECTORY
+  directory_with_cfdg_images = img_dir+'CFDG/'
+  favicon_name = 'DEFAULT_FAVICON.png'
+  _ = 'CFDG/'+get_files_from(directory_with_cfdg_images).sample(1)[0]
+  string = 'cfdg '+img_dir+'/'+_+' -b 2 -w 48 -h 48 '+img_dir+'/'+favicon_name
+  # ee string+'<br>'
+  system(string+' 2>&1')
+  return favicon_name
+end
+
+end

data/lib/cyberweb/generator/README.md

@@ -0,0 +1,2 @@
+In this directory code is stored that can be used to generate template files
+or .cgi files. In other words: "code that can generate code".

data/lib/cyberweb/generator/cgi.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::Generator::CGI
+#
+# This class can be used to generate .cgi scripts that conform to the
+# web_object API.
+# =========================================================================== #
+# require 'cyberweb/generator/cgi.rb'
+# =========================================================================== #
+require 'cyberweb/generator/class.rb'
+
+module Cyberweb
+
+module Generator
+
+class CGI < ::Cyberweb::Generator::Generator # === Cyberweb::Generator::CGI
+
+  begin
+    require 'esystem/method'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === Cyberweb::Generator::CGI.generate_default_skeleton_for_webpage
+  #
+  # This method will return a String that is ultimately used for the
+  # autogeneration of new .cgi files.
+  # ========================================================================= #
+  def self.generate_default_skeleton_for_webpage(
+      use_this_title = 'Provide a title for the page here'
+    )
+    return RUBY_HEADER+"
+# =========================================================================== #
+#
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+
+english {
+# autoextend # ← This can be used to automatically do: include Cyberweb
+title '#{use_this_title}'
+ruby_favicon
+css_style :template1
+body_css_class 'mar0px s2px padt2px VERDANAs'
+body_css_style 'background-color: #d3d2d1;'
+font_size 'def'
+
+doc('mar0px pad0px s0_5em') {
+  h1 dot(106, 'marr8px')+
+     '#{use_this_title.capitalize}',
+     'mart1px marb0_5em'
+}}"
+  end
+
+  # ========================================================================= #
+  # === DEFAULT_PAGE_CONTENT
+  #
+  # This is the basic skeleton that will be used to generate the file
+  # in question.
+  # ========================================================================= #
+  DEFAULT_PAGE_CONTENT =
+    ::Cyberweb::Generator::CGI.generate_default_skeleton_for_webpage
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline(commandline_arguments)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    @title_of_page = ''.dup # Will be empty initially.
+    @default_page_content = DEFAULT_PAGE_CONTENT
+  end
+
+  # ========================================================================= #
+  # === set_commandline
+  # ========================================================================= #
+  def set_commandline(i = '')
+    @commandline = i
+  end
+
+  # ========================================================================= #
+  # === process_commandline
+  #
+  # Only act on the keyword "generate".
+  # ========================================================================= #
+  def process_commandline
+    if commandline?.is_a? Array
+      _ = commandline?.first
+    else
+      _ = commandline?
+    end
+    if commandline?
+      case _ # case tag
+      # === generate
+      when 'generate'
+        generate_cgi_file(commandline?[1])
+      else
+        if _.end_with? '.cgi'
+          generate_cgi_file(_)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === commandline?
+  # ========================================================================= #
+  def commandline?
+    @commandline
+  end
+
+  # ========================================================================= #
+  # === title_of_page?
+  # ========================================================================= #
+  def title_of_page?
+    @title_of_page
+  end; alias title? title_of_page? # === title?
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === update_default_page_content
+  #
+  # This method will generate and assign the default skeleton for a
+  # webpage to the instance variable @default_page_content.
+  # ========================================================================= #
+  def update_default_page_content
+    @default_page_content =
+      Cyberweb::Generator::CGI.generate_default_skeleton_for_webpage(title?) # Assign it here.
+  end
+
+  # ========================================================================= #
+  # === generate_cgi_file
+  #
+  # This method will ultimately generate a proper .cgi file.
+  # ========================================================================= #
+  def generate_cgi_file(i)
+    # ======================================================================= #
+    # We have to re-determine the title of a page.
+    # ======================================================================= #
+    @title_of_page = File.basename(i).tr('_',' ').
+                     gsub(/#{File.extname(i)}/,'')
+    update_default_page_content # Need to update @default_page_content.
+    what = @default_page_content
+    into = i
+    write_what_into(what, into) # <- Create the file here.
+    opnn; e "Created file `#{sfile(into)}`."
+    if is_on_roebe?
+      # ===================================================================== #
+      # Open it on my home system as well, via my main editor.
+      # ===================================================================== #
+      Esystem.esystem("#{MAIN_EDITOR_TO_USE} #{into} &")
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    process_commandline
+  end
+
+end; end
+
+  # ========================================================================= #
+  # === Cyberweb.generate_cgi
+  #
+  # Use this method to generate a .cgi file.
+  # ========================================================================= #
+  def self.generate_cgi(
+      this_cgi_file = 'test.cgi'
+    )
+    ::Cyberweb::Generator::CGI.new(this_cgi_file)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::Generator::CGI.new(ARGV)
+end

data/lib/cyberweb/generator/class.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::Generator::Generator
+#
+# Bundle together some require-lines.
+# =========================================================================== #
+# require 'cyberweb/generator/class.rb'; < ::Cyberweb::Generator::Generator
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+module Generator 
+
+class Generator < ::Cyberweb::Base # === Cyberweb::Generator::Generator
+
+  require 'html_tags'
+
+  begin
+    require 'convert_global_env'
+  rescue LoadError; end
+
+end; end; end