cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/requires/require_the_constants.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 module Cyberweb
 
-  require 'cyberweb/constants/project_constants.rb'
+  require 'cyberweb/constants/constants.rb'
 
   # ========================================================================= #
   # === Cyberweb.require_the_constants
@@ -23,4 +23,6 @@ module Cyberweb
     }
   end
 
+  Cyberweb.require_the_constants
+
 end

data/lib/cyberweb/requires/require_the_cyberweb_project.rb

@@ -42,17 +42,7 @@ require 'cyberweb/requires/do_require_web_object_files.rb'
 # =========================================================================== #
 # We also need colours support, so pull in the relevant .rb file next:
 # =========================================================================== #
-require 'cyberweb/colours/colours.rb'
-
-# =========================================================================== #
-# Load up CSV support next.
-# =========================================================================== #
-require 'cyberweb/csv/csv.rb'
-
-# =========================================================================== #
-# Next, the io-related part.
-# =========================================================================== #
-require 'cyberweb/io/io.rb'
+require 'cyberweb/colours/colour_chart.rb' # This pulls in 'cyberweb/colours/colours.rb'
 
 # =========================================================================== #
 # Load up favicon-related code next.
@@ -80,11 +70,6 @@ require 'cyberweb/classes/tooltips.rb'
 # =========================================================================== #
 require 'cyberweb/debug/debug.rb'
 
-# =========================================================================== #
-# The help functionality will be required next.
-# =========================================================================== #
-require 'cyberweb/help/help.rb'
-
 # =========================================================================== #
 # Next, load all files arranged within the requires/ subdirectory,
 # including support for yaml and the generators.
@@ -123,24 +108,12 @@ require 'cyberweb/configuration/load_the_configuration_file.rb'
 require 'cyberweb/requires/require_the_toplevel_methods_files.rb'
 Cyberweb.require_toplevel_methods_files
 
-# =========================================================================== #
-# Require the charts file next:
-# =========================================================================== #
-require 'cyberweb/requires/require_charts.rb'
-Cyberweb.require_charts_files
-
 # =========================================================================== #
 # Next require the generators.
 # =========================================================================== #
 require 'cyberweb/requires/require_generators.rb'
 Cyberweb.require_generators
 
-# =========================================================================== #
-# Next, add support for the greek alphabet.
-# =========================================================================== #
-require 'cyberweb/html_codes/greek_letters.rb'
-Cyberweb.include_greek_letters # Include the greek letters here.
-
 require 'cyberweb/requires/require_html_tags_files.rb'
 Cyberweb.require_html_tags_files
 
@@ -154,8 +127,6 @@ Cyberweb.require_javascript_files
 
 require 'cyberweb/predefined_and_freeform_methods/header.rb'
 
-require 'cyberweb/charts/google_charts.rb'
-
 # =========================================================================== #
 # Require .cgi support next:
 # =========================================================================== #
@@ -169,4 +140,14 @@ require 'cyberweb/html_template/html_template.rb'
 # method and then batch-load these .rb files:
 # =========================================================================== #
 require 'cyberweb/requires/require_objectified_html_tags_files.rb'
-Cyberweb.require_objectified_html_tags_files # And call them too.
+Cyberweb.require_objectified_html_tags_files # And call them too.
+
+# =========================================================================== #
+# Next, add support for the greek alphabet.
+# =========================================================================== #
+# require 'cyberweb/html_codes/greek_letters.rb'
+Cyberweb.include_greek_letters # Include the greek letters here.
+
+require 'cyberweb/css_manager/css_manager.rb'
+
+require 'cyberweb/utility_scripts/images_to_html/images_to_html.rb'

data/lib/cyberweb/requires/require_the_toplevel_methods_files.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 module Cyberweb
 
-  require 'cyberweb/constants/project_constants.rb'
+  require 'cyberweb/constants/constants.rb'
 
   # ========================================================================= #
   # === Cyberweb.require_toplevel_methods_files

data/lib/cyberweb/requires/require_web_object_files.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 module Cyberweb
 
-  require 'cyberweb/constants/project_constants.rb'
+  require 'cyberweb/constants/constants.rb'
 
   # ========================================================================= #
   # === Cyberweb.require_web_object_files

data/lib/cyberweb/requires/require_yaml.rb

@@ -4,8 +4,8 @@
 # =========================================================================== #
 # require 'cyberweb/requires/require_yaml.rb'
 # =========================================================================== #
-# In the past, syck was used, but as of August 2018, we will simply
-# default to yaml (psych), thus not needing any modifications to a
-# simple require 'yaml' statement.
+# In the past, syck was used, but as of August 2018, we will simply default
+# to yaml (psych), thus not needing any modifications to a simple require
+# 'yaml' statement.
 # =========================================================================== #
 require 'yaml'

data/lib/cyberweb/rest

@@ -0,0 +1 @@
+REST

data/lib/cyberweb/route_handler/class_based_test.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Run via `ruby test.rb`
+# =========================================================================== #
+require 'cyberweb/route_handler/route_handler.rb'
+
+class ClassBasedTest < Cyberweb::RouteHandler::Base
+
+  require 'open'
+
+  require 'cyberweb/route_handler/route_handler_module.rb'
+  include ::Cyberweb::RouteHandlerModule
+
+  get('/') {
+    'Hey there!'
+  }
+
+  get('/test') {
+    Cyberweb::HtmlTemplate[
+      title: 'This is a test',
+      css_class: 'tomato',
+      body: '<pre style="font-size:150%">'+
+            "This is a "\
+            "<b class=\"tomato\">TEST</b>."+
+            '</pre>'
+     ].to_s
+  }
+
+end
+
+port_to_use = Cyberweb::RouteHandler::Base.port?
+
+Thread.new {
+  sleep 1.5
+  Open.open_in_browser(port: port_to_use)
+}
+
+Rack::Handler::WEBrick.run(
+  ClassBasedTest.new,
+  Port: port_to_use
+)

data/lib/cyberweb/route_handler/module/misc.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/route_handler/module/misc.rb'
+# =========================================================================== #
+module Cyberweb
+
+module RouteHandlerModule # === Cyberweb::RouteHandlerModule
+
+  # ========================================================================= #
+  # === return_route_404_error
+  #
+  # This route will be returned when an entry was not (yet) registered.
+  # ========================================================================= #
+  def return_route_404_error(
+      verb,
+      custom_error_page = custom_error_page?
+    )
+    [404, {},
+      [
+        Cyberweb::HtmlTemplate[
+          title: 'Route 404 error',
+          use_these_css_classes:
+            'pad1em mar0_5em bblack1 bblack2 error_404_css_class '\
+            'mar1em marl3em inline',
+          body_css_style: 'padding: 8px',
+          body: custom_error_page
+        ].to_s
+      ]
+    ]
+  end
+
+  # ========================================================================= #
+  # === request?
+  # ========================================================================= #
+  def request?
+    @request
+  end; alias request request? # === request
+
+  # ========================================================================= #
+  # === request_method?
+  # ========================================================================= #
+  def request_method?
+    request?.request_method
+  end
+
+  # ========================================================================= #
+  # === call                                                       (call tag)
+  # ========================================================================= #
+  def call(env)
+    # ======================================================================= #
+    # We must create a new rack-request next:
+    # ======================================================================= #
+    @request = rack_request(env)
+    # ======================================================================= #
+    # Capture which verb is requested by the visitor:
+    # ======================================================================= #
+    verb = request_method?
+    requested_path = path_info?
+    # ======================================================================= #
+    # Next we have to find the proper handler, based on the verb.
+    #
+    # This will be stored as a Hash like this:
+    #
+    #   {"GET"=>
+    #         {"/"=>#<Proc:0x00007f92cd194af8 test.rb:10>,
+    #         "/test"=>#<Proc:0x00007f92cd194698 test.rb:14>}}
+    #
+    # ======================================================================= #
+    handler = @routes.fetch(verb, {}).
+                      fetch(requested_path, nil)
+    if handler
+      result = instance_eval(&handler)
+      if result.is_a? String
+        # =================================================================== #
+        # This simplifies serving the proper result a little bit.
+        # =================================================================== #
+        [200, {}, [result]]
+      else
+        result
+      end
+    else # else tag
+      return_route_404_error(verb) # Else the verb was not registered yet.
+    end
+  end
+
+  # ========================================================================= #
+  # === params?                                                  (params tag)
+  #
+  # Obtain all params, by asking Rack.
+  # ========================================================================= #
+  def params?
+    @request.params
+  end; alias params params? # === params
+
+  # ========================================================================= #
+  # === requested_path?
+  #
+  # This method will return the requested path.
+  #
+  # It will return a String such as "/test".
+  # ========================================================================= #
+  def requested_path?
+    @request.path_info
+  end; alias path_info? requested_path? # === path_info?
+
+end; end

data/lib/cyberweb/route_handler/module/route_handler_module.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::RouteHandlerModule
+# =========================================================================== #
+# require 'cyberweb/route_handler/module/route_handler_module.rb'
+# include ::Cyberweb::RouteHandlerModule
+# =========================================================================== #
+require 'cyberweb/toplevel_methods/custom_error_page.rb'
+
+module Cyberweb
+
+module RouteHandlerModule # === Cyberweb::RouteHandlerModule
+
+  require 'cyberweb/route_handler/module/misc.rb'
+  require 'cyberweb/route_handler/module/verbs.rb'
+
+  require 'rack'
+  require 'cyberweb/requires/require_the_html_template.rb'
+
+  # ========================================================================= #
+  # === DEFAULT_PORT_TO_USE
+  # ========================================================================= #
+  DEFAULT_PORT_TO_USE = 9292
+
+  # ========================================================================= #
+  # === Cyberweb::RouteHandlerModule.use_this_webserver
+  # ========================================================================= #
+  def self.use_this_webserver(
+      i = :webrick
+    )
+    @use_this_webserver = i.to_sym
+    case @use_this_webserver
+    # ======================================================================= #
+    # === :webrick
+    # ======================================================================= #
+    when :webrick
+      unless Object.const_defined? :WEBrick
+        begin
+          require 'webrick'
+        rescue LoadError; end
+      end
+      Rack::Handler.pick(i.to_s)
+    # ======================================================================= #
+    # === :puma
+    # ======================================================================= #
+    when :puma
+      unless Object.const_defined? :Puma
+        begin
+          require 'puma'
+        rescue LoadError; end
+      end
+      Rack::Handler.pick(i.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::RouteHandlerModule.use_which_webserver?
+  # ========================================================================= #
+  def self.use_which_webserver?
+    @use_this_webserver.to_s
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    reset
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    @routes = {}
+    # ======================================================================= #
+    # === @port_to_use
+    # ======================================================================= #
+    @port_to_use = DEFAULT_PORT_TO_USE
+  end
+
+  # ========================================================================= #
+  # === rack_request
+  # ========================================================================= #
+  def rack_request(i)
+    # ======================================================================= #
+    # Instantiate a new Rack::Request object.
+    # ======================================================================= #
+    @request = Rack::Request.new(i)
+    return @request
+  end
+
+  # ========================================================================= #
+  # === custom_error_page?
+  # ========================================================================= #
+  def custom_error_page?
+    # ======================================================================= #
+    # First, we need to allow the user to define a different error page.
+    # ======================================================================= #
+    _ = ::Cyberweb.custom_error_page?
+    if _.nil?
+      # ===================================================================== #
+      # Alright: in this event the user did NOT specify a custom error
+      # page, so we can build up our 404-error page here.
+      # ===================================================================== #
+      code = '<br>'.dup
+      code << "# in #{$PROGRAM_NAME}\n"
+      code << "class #{self.class}\n"
+      code << '  '+request_method?.downcase+" '"+request.path_info+"'"
+      code = '<br><div id="c" style="font-size: 1.8em; margin-left: 1em;">
+            <pre>You could possibly try code as follows:
+            '+code+' do
+    "Hello World"
+  end'
+      code << "\nend\n"
+      code << '</pre>'
+      code << '</div>'
+      _ = ''+
+        '<div class="error_404_css_class inline" style="float:left;">404</div>'+
+        Cyberweb.return_base64_image(:error_404, 'bblack2 mar1em marl4em')+
+        '<pre style="font-size:150%">'+
+        "Oops! No route for #{request_method?.downcase} "\
+        "<b style=\"color: darkblue\">#{requested_path?}</b> "\
+        "has been defined."\
+        '</pre><br>'+ # +'The path is at: <b>'+path_info?+'</b>.<br>'
+        'Additional information will be shown next.'+
+        HtmlTags.div(
+        'The handler (<b>webserver</b>) in use is: '\
+        '<b>'+which_handler_is_used?+'</b><br>'+
+        code,
+        css_class: 'pad1em mar0_5em'
+      )
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === which_handler_is_used?
+  #
+  # This method will be guaranteed to return a String.
+  # ========================================================================= #
+  def which_handler_is_used?
+    _ = Cyberweb::RouteHandlerModule.use_which_webserver?
+    case _
+    when /Puma/i
+      _ = 'puma'
+    when /WEBrick/i
+      _ = 'webrick'
+    else
+      _ = 'unknown handler ('+_+')'
+    end
+    return _.to_s
+  end
+
+  # ========================================================================= #
+  # === session?
+  #
+  # This method will access the underlying Rack-session.
+  # ========================================================================= #
+  def session?
+    request?.session
+  end; alias session session? # === session
+
+  # ========================================================================= #
+  # === routes?
+  # ========================================================================= #
+  def routes?
+    @routes
+  end; alias routes routes? # === routes
+
+  # ========================================================================= #
+  # === route                                                     (route tag)
+  #
+  # This method can be used to register a new route.
+  #
+  # The first argument is the verb, which describes what this route is
+  # supposed to be doing, such as GET or POST.
+  #
+  # It is important to store the proper verb in the hash, so that we
+  # can have routes such as POST /hello and GET /hello work without
+  # a conflict.
+  # ========================================================================= #
+  def route(verb, path, &handler)
+    @routes[verb] ||= {}
+    # ======================================================================= #
+    # Register it next:
+    # ======================================================================= #
+    @routes[verb][path] = handler
+  end; private :route
+
+  # ========================================================================= #
+  # === Cyberweb::RouteHandler::Base.port?
+  # ========================================================================= #
+  def self.port?
+    DEFAULT_PORT_TO_USE
+  end
+
+end
+
+# =========================================================================== #
+# === Cyberweb.use_puma
+# =========================================================================== #
+def self.use_puma
+  Cyberweb::RouteHandlerModule.use_this_webserver(:puma)
+end; self.instance_eval { alias puma use_puma } # === Cyberweb.puma
+
+# =========================================================================== #
+# === Cyberweb.use_webrick
+# =========================================================================== #
+def self.use_webrick
+  Cyberweb::RouteHandlerModule.use_this_webserver(:webrick)
+end; self.instance_eval { alias webrick use_webrick } # === Cyberweb.webrick
+
+end

data/lib/cyberweb/route_handler/module/verbs.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/route_handler/module/verbs.rb'
+# =========================================================================== #
+module Cyberweb
+
+module RouteHandlerModule # === Cyberweb::RouteHandlerModule
+
+  # ========================================================================= #
+  # === get                                                         (get tag)
+  # ========================================================================= #
+  def get(path, &handler)
+    route('GET', path, &handler)
+  end
+
+  # ========================================================================= #
+  # === post
+  # ========================================================================= #
+  def post(path, &handler)
+    route('POST', path, &handler)
+  end
+
+  # ========================================================================= #
+  # === put
+  # ========================================================================= #
+  def put(path, &handler)
+    route('PUT', path, &handler)
+  end
+
+  # ========================================================================= #
+  # === patch
+  # ========================================================================= #
+  def patch(path, &handler)
+    route('PATCH', path, &handler)
+  end
+
+  # ========================================================================= #
+  # === delete
+  # ========================================================================= #
+  def delete(path, &handler)
+    route('DELETE', path, &handler)
+  end
+
+  # ========================================================================= #
+  # === head
+  # ========================================================================= #
+  def head(path, &handler)
+    route('HEAD', path, &handler)
+  end
+
+end; end

data/lib/cyberweb/route_handler/route_handler.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::RouteHandler::Base
+#
+# Originally based on:
+#
+#   https://thoughtbot.com/blog/lets-build-a-sinatra
+#
+# =========================================================================== #
+module Cyberweb
+
+module RouteHandler
+
+class Base # === Cyberweb::RouteHandler::Base
+
+  require 'cyberweb/route_handler/module/route_handler_module.rb'
+  include ::Cyberweb::RouteHandlerModule
+
+end
+
+# =========================================================================== #
+# === Cyberweb::RouteHandler::Application
+# =========================================================================== #
+Application = Base.new
+
+module Delegator
+
+  # ========================================================================= #
+  # === Delegator.delegate
+  # ========================================================================= #
+  def self.delegate(*methods, to:)
+    work_on_these_entries = Array(methods) # Such as: [:get, :patch, :put, :post, :delete, :head]
+    work_on_these_entries.each { |use_this_method_name|
+      # ===================================================================== #
+      # Define the toplevel method next:
+      # ===================================================================== #
+      define_method(use_this_method_name) { |*args, &block|
+        to.send(use_this_method_name, *args, &block)
+      }
+      private use_this_method_name
+    }
+  end
+  delegate(
+    :get,
+    :patch,
+    :put,
+    :post,
+    :delete,
+    :head,
+    to: Application
+  )
+end; end; end
+
+include Cyberweb::RouteHandler::Delegator

data/lib/cyberweb/route_handler/test.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Run via `ruby test.rb`
+# =========================================================================== #
+require 'open'
+require 'cyberweb/route_handler/route_handler.rb'
+
+get('/') {
+  'Hey there!'
+}
+
+get('/test') {
+  Cyberweb::HtmlTemplate[
+    title: 'This is a test',
+    css_class: 'tomato',
+    body: '<div style="font-size:150%">'+
+          "This is a "\
+          "<b class=\"tomato\">TEST</b>."+
+          '</div><br>'+
+          'The requested path has been: <b>'+
+          requested_path?.to_s+'</b>'
+  ].to_s
+}
+
+port_to_use = Cyberweb::RouteHandlerModule.port?
+
+Thread.new {
+  sleep 1.5
+  Open.open_in_browser(port: port_to_use)
+}
+
+# =========================================================================== #
+# === Use webrick or puma
+# =========================================================================== #
+# Cyberweb.use_webrick
+Cyberweb.use_puma
+# Rack::Handler::WEBrick.run(
+Rack::Handler::Puma.run(
+  Cyberweb::RouteHandler::Application,
+  Port: port_to_use
+)