cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/{constants/array_predefined_constants.rb → sinatra/base/set_use_this_port.rb}

@@ -2,22 +2,29 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'cyberweb/toplevel_methods/array_predefined_constants.rb'
+# require 'cyberweb/sinatra/base/set_use_this_port.rb'
 # =========================================================================== #
 module Cyberweb
 
+begin
   # ========================================================================= #
-  # === @array_predefined_constants
-  #
-  # The following array defines which constants are available predefined.
+  # Require the sinatra-base next. This step is quite important.
   # ========================================================================= #
-  @array_predefined_constants = []
+  require 'sinatra/base.rb'
+rescue LoadError; end
+
+if Object.const_defined? :Sinatra
+
+class Sinatra < ::Sinatra::Base
 
   # ========================================================================= #
-  # === Cyberweb.array_predefined_constants?
+  # === Cyberweb::Sinatra.set_use_this_port
   # ========================================================================= #
-  def self.array_predefined_constants?
-    @array_predefined_constants
+  def self.set_use_this_port(
+      i = ::Cyberweb::Sinatra.use_this_port?
+    )
+    @use_this_port = i
+    Sinatra.set(:port, i)
   end
 
-end
+end; end; end

data/lib/cyberweb/sinatra/base/use_this_port.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/sinatra/base/use_this_port.rb'
+# =========================================================================== #
+module Cyberweb
+
+begin
+  # ========================================================================= #
+  # Require the sinatra-base next. This step is quite important.
+  # ========================================================================= #
+  require 'sinatra/base.rb'
+rescue LoadError; end
+
+if Object.const_defined? :Sinatra
+
+class Sinatra < ::Sinatra::Base
+
+  # ========================================================================= #
+  # === DEFAULT_PORT_TO_USE
+  # ========================================================================= #
+  DEFAULT_PORT_TO_USE = '4567'
+
+  # ========================================================================= #
+  # === @use_this_port
+  #
+  # This must be nil initially, in order to distinguish from a user setting
+  # it to another value, such as via the commandline.
+  # ========================================================================= #
+  @use_this_port = nil
+
+  # ========================================================================= #
+  # === Cyberweb::Sinatra.use_this_port?
+  # ========================================================================= #
+  def self.use_this_port?
+    @use_this_port
+  end
+
+end; end; end

data/lib/cyberweb/sinatra/base.rb

@@ -5,12 +5,10 @@
 # === Cyberweb::Sinatra
 # =========================================================================== #
 # require 'cyberweb/sinatra/base.rb'
+# class Controller < Cyberweb::Sinatra
 # =========================================================================== #
 module Cyberweb
 
-require 'cyberweb/toplevel_methods/roebe.rb'
-require 'colours'
-
 begin
   # ========================================================================= #
   # Require the sinatra-base next. This step is quite important.
@@ -22,37 +20,29 @@ if Object.const_defined? :Sinatra
 
 class Sinatra < ::Sinatra::Base
 
-  include Colours
-  include Colours::E
+  require 'cyberweb/sinatra/custom_extensions.rb'
+  include Cyberweb::Sinatra::CustomExtensions
+
   begin
     require 'html_tags'
     include HtmlTags::BaseModule
   rescue LoadError; end
 
-  # ========================================================================= #
-  # === USE_THIS_PORT
-  # ========================================================================= #
-  USE_THIS_PORT = '4567'
-
-  set(:port, USE_THIS_PORT)
+  require 'cyberweb/sinatra/base/use_this_port.rb'
 
   # ========================================================================= #
   # === initialize
+  #
+  # The second argument is the port.
   # ========================================================================= #
-  def initialize(i = ARGV)
+  def initialize(
+      i                            = ARGV,
+      use_this_port                = ::Cyberweb::Sinatra.use_this_port?,
+      shall_we_open_in_the_browser = true
+    )
     super()
     reset
-    if ::Cyberweb.is_on_roebe?
-      require 'open'
-      # ===================================================================== #
-      # Tell us which port will be used:
-      # ===================================================================== #
-      target = "http://localhost:#{USE_THIS_PORT}/"
-      e sfancy(target)
-      Thread.new {
-        Open.in_browser(target) {{ delay: '1.0 second' }}
-      }.join
-    end
+    consider_opening_on_this_port(use_this_port) if shall_we_open_in_the_browser
   end
 
   # ========================================================================= #
@@ -63,6 +53,9 @@ class Sinatra < ::Sinatra::Base
     # === @index_of_hyperlinks
     # ======================================================================= #
     @index_of_hyperlinks = ''.dup
+    # ======================================================================= #
+    # === @root_string
+    # ======================================================================= #
     @root_string = '<html><head>'\
                    '<title>Hello world!</title>'\
                    '<body>'\
@@ -71,6 +64,30 @@ class Sinatra < ::Sinatra::Base
                    '</html>'.dup
   end
 
+  # ========================================================================= #
+  # === consider_opening_on_this_port
+  # ========================================================================= #
+  def consider_opening_on_this_port(
+      use_this_port
+    )
+    case use_this_port
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      use_this_port = ::Cyberweb::Sinatra.use_this_port?
+    end
+    if ::Cyberweb.is_on_roebe? and
+       !use_this_port.nil? and
+       use_this_port # Check for false here.
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{use_this_port}/"
+      Cyberweb.try_to_open_this_URL_via_the_browser(target, use_this_port)
+    end
+  end
+
   # ========================================================================= #
   # === return_index_of_hyperlinks
   #
@@ -83,13 +100,21 @@ class Sinatra < ::Sinatra::Base
 
   # ========================================================================= #
   # === set_port
+  #
+  # This unfortunately does not work right now. The idea was to call the
+  # set-method on the toplevel.
   # ========================================================================= #  
-  def set_port(i = USE_THIS_PORT)
-    set(:port, USE_THIS_PORT)
+  def set_port(
+      i = USE_THIS_PORT
+    )
+    set(:port, USE_THIS_PORT) # Delegate towards Sinatra::Base here.
   end
 
   # ========================================================================= #
   # === return_root_string
+  #
+  # The root-string will contain the main index that is displayed when the
+  # user visits the page initially.
   # ========================================================================= #
   def return_root_string
     @root_string
@@ -104,17 +129,6 @@ class Sinatra < ::Sinatra::Base
     return_root_string
   }
 
-  # ========================================================================= #
-  # === not_yet_implemented
-  #
-  # This can be added as a placeholder for future changes.
-  # ========================================================================= #
-  def not_yet_implemented
-    p(
-      "Not yet implemented."
-    )
-  end
-
   # ========================================================================= #
   # === input_type_user_input
   # ========================================================================= #
@@ -129,6 +143,7 @@ class Sinatra < ::Sinatra::Base
     '<input type="submit" name="user_input_submit" value="Search" class="default_submit">'
   end
 
+
   # ========================================================================= #
   # === Cyberweb::Sinatra.start_sinatra_interface
   # ========================================================================= #

data/lib/cyberweb/sinatra/custom_extensions.rb

@@ -8,17 +8,24 @@
 # require 'cyberweb/sinatra/custom_extensions.rb'
 # include Cyberweb::Sinatra::CustomExtensions
 # =========================================================================== #
+module Cyberweb
+
 begin
   require 'sinatra/base'
 rescue LoadError; end
 
-module Cyberweb
-
 class Sinatra < ::Sinatra::Base
 
 module CustomExtensions
-
+  
   require 'cyberweb/toplevel_methods/escape_html.rb'
+  require 'cyberweb/toplevel_methods/roebe.rb'
+
+  begin
+    require 'colours'
+    include Colours
+    include Colours::E
+  rescue LoadError; end
 
   # ========================================================================= #
   # === web_params?
@@ -45,17 +52,6 @@ module CustomExtensions
   end; alias web_params_as_string? query_string? # === web_params_as_string?
        alias params_as_string?     query_string? # === params_as_string?
 
-  # ========================================================================= #
-  # === are_we_using_sinatra?
-  #
-  # This must return true by "simple logic" - after all we are specifically
-  # using custom extensions for sinatra, so we will assume that the user
-  # wants a sinatra-like web-behaviour as well.
-  # ========================================================================= #
-  def are_we_using_sinatra?
-    true
-  end; alias use_sinatra? are_we_using_sinatra? # === use_sinatra?
-
   # ========================================================================= #
   # === escape_html
   # ========================================================================= #
@@ -128,4 +124,33 @@ module CustomExtensions
     }
   end; alias merge_routes merge_interface # === Cyberweb::Sinatra::CustomExtensions.merge_routes
 
+  # ========================================================================= #
+  # === are_we_using_sinatra?
+  #
+  # This must return true by "simple logic" - after all we are specifically
+  # using custom extensions for sinatra, so we will assume that the user
+  # wants a sinatra-like web-behaviour as well.
+  # ========================================================================= #
+  def are_we_using_sinatra?
+    true
+  end; alias use_sinatra? are_we_using_sinatra? # === use_sinatra?
+
+  # ========================================================================= #
+  # === not_yet_implemented
+  #
+  # This can be added as a placeholder for future changes.
+  # ========================================================================= #
+  def not_yet_implemented
+    p(
+      "Not yet implemented."
+    )
+  end
+
+  # ========================================================================= #
+  # === temp_dir?
+  # ========================================================================= #
+  def temp_dir?
+    '/tmp/'
+  end
+
 end; end; end

data/lib/cyberweb/standalone_classes/all_css_classes.rb

@@ -29,7 +29,7 @@ class AllCssClasses # === Cyberweb::AllCssClasses
   # ========================================================================= #
   # === CSS_DIR
   # ========================================================================= #
-  CSS_DIR = "#{HOME_DIRECTORY_OF_THE_USER_X}DATA/cascading_style_sheets/"
+  CSS_DIR = "#{HOME_DIRECTORY_OF_THE_USER_X}data/cascading_style_sheets/"
 
   # ========================================================================= #
   # === ARRAY_IGNORE_THESE

data/lib/cyberweb/standalone_classes/calculator.rb

@@ -31,6 +31,9 @@ class Calculator < Base # === Cyberweb::Calculator
     if block_given?
       yielded = yield
       case yielded
+      # ===================================================================== #
+      # === :report_the_result_on_the_commandline
+      # ===================================================================== #
       when :report_the_result_on_the_commandline
         @report_result = true
       end
@@ -43,6 +46,9 @@ class Calculator < Base # === Cyberweb::Calculator
   # ========================================================================= #
   def reset
     super()
+    # ======================================================================= #
+    # === @report_result
+    # ======================================================================= #
     @report_result = false
   end
 
@@ -114,7 +120,7 @@ class Calculator < Base # === Cyberweb::Calculator
   end
 
   # ========================================================================= #
-  # === []
+  # === Cyberweb::Calculator[]
   # ========================================================================= #
   def self.[](i = '')
     new(i)

data/lib/cyberweb/standalone_classes/correct_image_entries_in_html_file.rb

@@ -39,7 +39,7 @@ class CorrectImageEntriesInHtmlFile < ::Cyberweb::Base # === Cyberweb::CorrectIm
   # ========================================================================= #
   # === PATH_TO_THE_IMAGE_DIRECTORY
   # ========================================================================= #
-  PATH_TO_THE_IMAGE_DIRECTORY = '/home/x/DATA/IMG/'
+  PATH_TO_THE_IMAGE_DIRECTORY = '/home/x/data/images/'
 
   # ========================================================================= #
   # === ALSO_COPY_IMAGE_FILE
@@ -63,7 +63,12 @@ class CorrectImageEntriesInHtmlFile < ::Cyberweb::Base # === Cyberweb::CorrectIm
   # ========================================================================= #
   def reset
     super()
-    @dataset = nil # Initialize here to nil.
+    # ======================================================================= #
+    # === @dataset
+    #
+    # @dataset must be nil initially. 
+    # ======================================================================= #
+    @dataset = nil 
   end
 
   # ========================================================================= #
@@ -92,11 +97,11 @@ class CorrectImageEntriesInHtmlFile < ::Cyberweb::Base # === Cyberweb::CorrectIm
   # ========================================================================= #
   # === read_in_dataset
   # ========================================================================= #
-  def read_in_dataset
-    if File.exist? input?
-      @dataset = File.read(input?)
+  def read_in_dataset(i = input?)
+    if File.exist? i
+      @dataset = File.read(i)
     else
-      e 'No file at '+sfile(input?)+' exists.'
+      e "No file at #{sfile(i)} exists."
     end
   end
 
@@ -192,7 +197,7 @@ class CorrectImageEntriesInHtmlFile < ::Cyberweb::Base # === Cyberweb::CorrectIm
   def run
     create_images_directory
     read_in_dataset
-    n_entries = data?.scan(/IMG\//).size
+    n_entries = data?.scan(/images\//).size
     opn; e 'There are '+simp(n_entries.to_s)+' occurrences of IMG/'
     opn; e 'We will now modify that dataset.'
     modify_original_dataset

data/lib/cyberweb/standalone_classes/turn_html_into_cyberweb.rb

@@ -22,10 +22,12 @@ class TurnHtmlIntoCyberweb # === Cyberweb::TurnHtmlIntoCyberweb
 
   begin
     require 'colours'
+    include Colours::E
   rescue LoadError; end
-  require 'opn'
 
-  include Colours::E
+  begin
+    require 'opn'
+  rescue LoadError; end
 
   N = "\n"
 
@@ -115,10 +117,9 @@ class TurnHtmlIntoCyberweb # === Cyberweb::TurnHtmlIntoCyberweb
     _ = input?
     _ = _.split(N) if _.is_a? String
     add "require 'cyberweb/autoinclude'"+N+N
-    addn 'w {'
+    addn 'english {'
     addn "title 'SELF'"
     addn "jquery '+'"
-    addn '}'
     _.each {|line|
       if line.include? '!DOCTTYPE html'
         add 'doctype :html'+N+N
@@ -141,15 +142,9 @@ class TurnHtmlIntoCyberweb # === Cyberweb::TurnHtmlIntoCyberweb
         end
       end
     }
+    addn '}'
   end
 
-  # ========================================================================= #
-  # === show_result
-  # ========================================================================= #
-  def show_result
-    e result?
-  end; alias report_result show_result # === report_result
-
   # ========================================================================= #
   # === debug
   # ========================================================================= #
@@ -158,6 +153,13 @@ class TurnHtmlIntoCyberweb # === Cyberweb::TurnHtmlIntoCyberweb
     e input?
   end
 
+  # ========================================================================= #
+  # === show_result
+  # ========================================================================= #
+  def show_result
+    e result?
+  end; alias report_result show_result # === report_result
+
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #

data/lib/cyberweb/svg/standalone/README.md

@@ -0,0 +1,2 @@
+This directory is specifically meant for larger SVG-related
+data that users can load up onto their website, as-is.