cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/web_object/params.rb

@@ -1,289 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'cyberweb/web_object/params.rb'
-# =========================================================================== #
-require 'cyberweb/base/base.rb'
-
-module Cyberweb
-
-class WebObject < Base # === Cyberweb::WebObject
-
-  require 'cyberweb/toplevel_methods/params.rb'
-
-  # ========================================================================= #
-  # === obtain_the_parameters_passed
-  #
-  # This query-method will return which params have been passed into,
-  # for example, a .cgi page.parameters_as_string?
-  #
-  # Typical invocation may go like this:
-  #
-  #   w.obtain_the_parameters_passed
-  #
-  # ========================================================================= #
-  def obtain_the_parameters_passed
-    ::Cyberweb.params? # This is part of params.rb actually.
-  end; alias return_params_hash obtain_the_parameters_passed # === return_params_hash
-       alias web_params?        obtain_the_parameters_passed # === web_params?
-       alias web_params         obtain_the_parameters_passed # === web_params
-       alias params?            obtain_the_parameters_passed # === params?
-       alias params             obtain_the_parameters_passed # === params
-       alias params_as_string?  obtain_the_parameters_passed # === params_as_string?
-       # ^^^ Not yet sure if we can use this alias. I think we actually
-       #     can. I will add support for Sinatra via a module instead.
-
-  # ========================================================================= #
-  # === get_param_called
-  #   
-  # Use this method to obtain a specific parameter. The argument given
-  # should be the name of the formular in question.
-  # ========================================================================= #
-  def get_param_called(i)
-    i = i.to_s # Just in case.
-    _ = obtain_the_parameters_passed # Tap into the params() method.
-    if _.has_key? i # Should be a Hash.
-      i = _[i]
-      i = i.first if i.is_a? Array
-    end
-    return i # Return it.
-  end; alias get_param get_param_called # === get_param
-
-  # ========================================================================= #
-  # === query_string?
-  #
-  # This method will return the query-string that was passed via the URL.
-  # This refers to the part after the '?'.
-  # ========================================================================= #
-  def query_string?(i = cgi?)
-    i.query_string
-  end; alias env?                  query_string? # === env?
-       alias parameters_as_string? query_string? # === parameters_as_string?
-
-  # ========================================================================= #
-  # === show_known_params
-  #
-  # This method outputs the given params, which may be helpful when
-  # you want to debug.
-  # ========================================================================= #
-  def show_known_params(
-      use_this_css = 'red larger marl5em'
-    )
-    div {
-      h2 'These Parameters are known:'
-      cyberweb_params?
-    }
-  end
-
-  # ========================================================================= #
-  # === check_on_params                               (params tag, param tag)
-  #
-  # We check on the parameter issued here, and enable/disable certain
-  # functionality based on that.
-  #
-  # You can try these when you append a ? to the URL, such as:
-  #
-  #   ?disable_webimages
-  #   ?time
-  #   ?view_source
-  #
-  # ========================================================================= #
-  def check_on_params
-    _ = return_params_hash # Remember that this is a Hash.
-    unless _.empty?
-      # ===================================================================== #
-      # Grab the keys in String-form next.
-      # ===================================================================== #
-      keys = _.keys.join(' ').strip
-      # ===================================================================== #
-      # First, use a simpler case-menu to check for real keys.
-      # ===================================================================== #
-      case keys # case tag
-      # ===================================================================== #
-      # === time?
-      #
-      #   http://localhost/data/personal/fotos/fotos.cgi?time?
-      #
-      # ===================================================================== #
-      when /^time\??/i
-        result = Cyberweb::HtmlTemplate[
-          title: 'Show the current time',
-          body:  '<div class="BG_Black White" style="padding: 0.25em">Time: '+
-                 Time.now.strftime('%d.%m.%Y')+
-                 ' '+
-                 Time.now.strftime('%H:%M:%S')+
-                 '</div>'
-        ].to_s
-        print result
-        exit
-      # ===================================================================== #
-      # === jquery?
-      #
-      # Specific examples for this flag:
-      #
-      #   http://localhost/data/personal/fotos/fotos.cgi?jquery?
-      #   http://localhost/data/personal/fotos/fotos.cgi?jquery
-      #
-      # ===================================================================== #
-      when /^jquery\??$/i
-        e 'Is jquery used? '+
-           use_jquery?.to_s
-      # ===================================================================== #
-      # === config?
-      #
-      # Specific example for this flag:
-      #
-      #   http://localhost/data/personal/fotos/fotos.cgi?config?
-      #
-      # ===================================================================== #
-      when /^config\?/i,
-           /^quit/i
-        pp @config
-        exit
-      # ===================================================================== #
-      # === view_source
-      #
-      # Specific example for this:
-      #
-      #   http://localhost/data/video/play_this_video_file.cgi?source
-      #
-      # ===================================================================== #
-      when /^view(_|-)?source$/i,
-           /^source$/
-        do_show_source
-      # ===================================================================== #
-      # === debug
-      # ===================================================================== #
-      when 'debug' # ?debug
-        ::Cyberweb.enable_debug
-      # ===================================================================== #
-      # === view_file=ruby_todo
-      #
-      # This entry point can be used to view a file specifically,
-      # globally.
-      #
-      # Usage example:
-      #
-      #   http://localhost/data/misc/sitemap.cgi?view_file=ruby_todo
-      #
-      # ===================================================================== #
-      when /^view(_|-)?file/i
-        if view_file?
-          # ================================================================== #
-          # In this case the Hash may look like this:
-          #
-          #   {"view_file"=>["beautiful_url"]}
-          #
-          # ================================================================== #
-          result = _['view_file']
-          result = result.first if result.is_a? Array
-          result = ::Cyberweb.sanitize_url(result)
-          if result.start_with? 'http://localhost/'
-            result = result.dup if result.frozen?
-            result.sub!(/^http:\/\/localhost\//, USER_X)
-          end
-          read_and_display(result)
-        else
-          clear_the_main_string
-          print 'Viewing a file has been disabled in the configuration setting.'
-          serve
-          exit
-        end
-      # ===================================================================== #
-      # === redirect_to=ruby_todo
-      #
-      # This entry point can be used to redirect to another page.
-      #
-      # Usage example:
-      #
-      #   http://localhost/data/misc/sitemap.cgi?redirect_to=ruby_todo
-      #
-      # ===================================================================== #
-      when /^redirect(_|-)?to/i
-        # ==================================================================== #
-        # In this case the Hash may look like this:
-        #
-        #   {"redirect_to"=>["ruby_todo"]}
-        #
-        # ==================================================================== #
-        result = _['redirect_to']
-        result = result.first if result.is_a? Array
-        result = ::Cyberweb.sanitize_url(result)
-        redirect_to(result)
-      # ===================================================================== #
-      # === hello_world
-      # ===================================================================== #
-      when 'hello_world'
-        h2 'Hello World!'
-      else
-        # ===================================================================== #
-        # === use_jquery
-        #
-        # Ok, next use a somewhat more flexible if/else/elsif conditional.
-        #
-        # First, enable the use of jquery, if the user supplied use_jquery.
-        # ===================================================================== #
-        if keys.include? 'use_jquery' # This should be enough.
-          use_jquery
-        # ===================================================================== #
-        # === time
-        # ===================================================================== #
-        elsif keys.include? 'time'
-          result = Cyberweb::HtmlTemplate[
-          title: 'Show the current time',
-          body:  '<div class="BG_Black White" style="padding: 0.25em">Time: '+
-                 Time.now.strftime('%H:%M:%S')+
-                 '-'+
-                 Time.now.strftime('%d.%m.%Y')+
-                 '</div>'
-          ].to_s
-          print result
-          exit
-        # ===================================================================== #
-        # === ?show_source
-        # ===================================================================== #
-        elsif keys.include? 'show_source' or keys.include? 'source'
-          do_show_source # This allows us to display the source of a given file.
-        # ===================================================================== #
-        # === ?pdf
-        # ===================================================================== #
-        elsif keys.include? 'pdf'
-          if use_prawn?
-            try_to_generate_pdf_file # Bundled into this method here.
-          else
-            e 'You normally do not seem to want to use prawn.'
-            e 'Shall we override this? Not yet sure. (Stub).'
-          end
-        # ===================================================================== #
-        # === disable_webimages
-        # ===================================================================== #
-        elsif keys.include? 'disable_webimages'
-          disable_webimages
-        # ===================================================================== #
-        # === environment
-        # ===================================================================== #
-        elsif keys.include? 'environment'
-          display_environmental_variables
-        # ===================================================================== #
-        # === sys_information
-        # ===================================================================== #
-        elsif keys =~ /sys_information/ or keys =~ /sys/ or keys =~ /status/
-          display_system_information
-        else
-          # ================================================================= #
-          # Next, things did fail. If we are in debug mode, we
-          # show more information.
-          # ================================================================= #
-          if debug? # Ok, we may want to show more debug information.
-            e 'Showing more debug-information next (since '\
-              'Cyberweb.debug was set to true):'
-            pp params?
-            exit
-          end
-        end
-      end
-    end
-  end
-
-end; end

data/lib/cyberweb/web_object/sinatra_related_functionality.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'cyberweb/web_object/sinatra_related_functionality.rb'
-# =========================================================================== #
-require 'cyberweb/base/base.rb'
-
-module Cyberweb
-
-class WebObject < Base # === Cyberweb::WebObject
-
-  # ========================================================================= #
-  # === is_a_sinatra_application?
-  # ========================================================================= #
-  def is_a_sinatra_application?
-    @internal_hash[:is_a_sinatra_application]
-  end; alias uses_sinatra?         is_a_sinatra_application? # === uses_sinatra?
-       alias are_we_using_sinatra? is_a_sinatra_application? # === are_we_using_sinatra?
-
-  # ========================================================================= #
-  # === is_a_sinatra_application
-  #
-  # Setter method to designate a given application as a sinatra-application.
-  # ========================================================================= #
-  def is_a_sinatra_application
-    @internal_hash[:is_a_sinatra_application] = true
-  end; alias enable_sinatra_application is_a_sinatra_application # === enable_sinatra_application
-
-end; end

data/lib/cyberweb/web_object/sitemap.rb

@@ -1,176 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'cyberweb/web_object/sitemap.rb'
-# =========================================================================== #
-require 'cyberweb/base/base.rb'
-
-module Cyberweb
-
-class WebObject < Base # === Cyberweb::WebObject
-
-  require 'cyberweb/toplevel_methods/sitemap.rb'
-
-  # ========================================================================= #
-  # === autogenerated_sitemap
-  #
-  # This method will autogenerate a default Sitemap (an intralink).
-  #
-  # If the second argument for `optional_id` is :sort, then we will sort
-  # the result first before displaying it.
-  # ========================================================================= #
-  def autogenerated_sitemap(
-      css_class          = '',
-      optional_id        = '',
-      optional_css_style = 'top: 2px; right: 2px; background-color: #eee;',
-      append_css         = true, # By default we will append more CSS rules.
-      &block
-    )
-    # ======================================================================= #
-    # Obtain the dataset first.
-    # ======================================================================= #
-    registered_sitemaps = ::Cyberweb.array_registered_sitemaps?
-    css_for_li_elements = 'marl1px darkblue'
-    default_css_class_to_use = 'pad5px bblack1 black posab'
-    if block_given?
-      yielded = yield
-      # ===================================================================== #
-      # === Handle Blocks next
-      # ===================================================================== #
-      if yielded.is_a? Hash
-        # =================================================================== #
-        # === :css_style
-        # =================================================================== #
-        if yielded.has_key? :css_style
-          _ = yielded.delete :css_style
-          default_css_class_to_use = ''
-          optional_css_style = _
-        end
-      end
-    end
-    case optional_id
-    # ======================================================================= #
-    # === :sort
-    # ======================================================================= #
-    when :sort
-      registered_sitemaps.sort!
-      optional_id = ''
-    end
-    if css_class.empty?
-      if append_css # This is the default.
-        css_class = css_class.dup if css_class.frozen?
-        css_class << " #{default_css_class_to_use}"
-      end
-    else # Else, user passed arguments here.
-      css_class = css_class.dup if css_class.frozen?
-      css_class << " #{default_css_class_to_use}"
-    end
-    # ======================================================================= #
-    # Next comes the <div> that will hold our sitemap. For now this
-    # will always be a <div> element.
-    # ======================================================================= #
-    div(css_class, optional_id, optional_css_style) {
-      ee html_comment('Sitemap tag')
-      h2 'Sitemap','black whi martb2px pad2px s4px yel mar1px',
-         'SitemapHeader',
-         'background-color:darkblue;'
-      # ===================================================================== #
-      # Build up the proper <ul> tag next.
-      # ===================================================================== #
-      ul(id: 'SitemapNavigation') {
-        registered_sitemaps.each { |sitemap_id|
-          li('',css_for_li_elements) {
-            a '#'+sanitize_id(sitemap_id),
-              content: sitemap_id,
-              css_class: 'darkblue'
-          }
-        }
-      }
-    }
-  end; alias show_sitemap    autogenerated_sitemap # === show_sitemap
-       alias display_sitemap autogenerated_sitemap # === display_sitemap
-       alias asitemap        autogenerated_sitemap # === asitemap
-       alias add_sitemap     autogenerated_sitemap # === add_sitemap
-
-  # ========================================================================= #
-  # === header_for_sitemap
-  #
-  # This is a header that can be used to generate a sitemap.
-  #
-  # Note that if it is used it will also automatically generate
-  # a sitemap on the top right of the page. This was one major
-  # reason why this method was created - I wanted to automatically
-  # use a sitemap if I use such a header.
-  # ========================================================================= #
-  def header_for_sitemap(i)
-    id = i.tr(' ','_').tr('⁺','')
-    register_sitemap(i, id)
-    h2(i, '',id)
-  end
-
-  # ========================================================================= #
-  # === register_sitemap
-  #
-  # Use only this method to register an id to a sitemap. This is
-  # done automatically when we invoke the method sitemap().
-  #
-  # This method will delegate towards the toplevel-method, on the Cyberweb
-  # namespace.
-  #
-  # If the second argument `modify_input` is set to true, we will
-  # replace all occurrences of '_' with ' '. The reason for this
-  # is that HTML ids should not contain ' ' characters.
-  # ========================================================================= #
-  def register_sitemap(
-      i, modify_input = false
-    )
-    # ======================================================================= #
-    # Next simply delegate onto the toplevel method called
-    # Cyberweb.register_sitemap().
-    # ======================================================================= #
-    ::Cyberweb.register_sitemap(i, modify_input)
-  end; alias add_to_sitemap register_sitemap # === register_sitemap
-       alias sitemap        register_sitemap # === sitemap
-
-  # ========================================================================= #
-  # === array_for_sitemap?
-  #
-  # Accessor-method towards the array-constant.
-  # ========================================================================= #
-  def array_for_sitemap?
-    ::Cyberweb.array_for_sitemap?
-  end; alias array_for_sitemap array_for_sitemap? # === array_for_sitemap
-
-  # ========================================================================= #
-  # === add_roebe_sitemap_link
-  #
-  # This method will add a link to my (local) sitemap. This is fairly
-  # useless for other people, so don't use this method really.
-  # ========================================================================= #
-  def add_roebe_sitemap_link(
-      optional_css_class = 'mars1em steelblue BOLD'
-    )
-    use_this_as_the_content = :self
-    if block_given?
-      yielded = yield
-      case yielded
-      # ===================================================================== #
-      # === :right_arrow
-      # ===================================================================== #
-      when :right_arrow
-        use_this_as_the_content = '→ Local Sitemap'
-      end
-    end
-    abr :local_sitemap,
-        content: use_this_as_the_content,
-        css_class: optional_css_class
-  end; alias roebe_sitemap             add_roebe_sitemap_link # === roebe_sitemap
-       alias to_the_roebe_sitemap      add_roebe_sitemap_link # === to_the_roebe_sitemap
-       alias to_roebe_sitemap          add_roebe_sitemap_link # === to_roebe_sitemap
-       alias to_roebe                  add_roebe_sitemap_link # === to_roebe
-       alias back_to_sitemap           add_roebe_sitemap_link # === back_to_sitemap
-       alias to_the_sitemap            add_roebe_sitemap_link # === to_the_sitemap
-       alias link_to_the_local_sitemap add_roebe_sitemap_link # === link_to_the_local_sitemap
-
-end; end