RubyGems - cyberweb - Versions diffs - 0.4.174 → 0.5.225 - Mend

cyberweb 0.4.174 → 0.5.225

Potentially problematic release.

This version of cyberweb might be problematic. Click here for more details.

Files changed (625) hide show

data/lib/cyberweb/web_object/reset.rb CHANGED Viewed

@@ -8,76 +8,114 @@ require 'cyberweb/base/base.rb'
 module Cyberweb
-class WebObject < Base # === Cyberweb::WebObject
+class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
   # ========================================================================= #
   # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    reset_the_internal_state
+  end
+  # ========================================================================= #
+  # === reset_the_internal_state           (internal reset tag, internal tag)
+  # ========================================================================= #
+  def reset_the_internal_state
     # ======================================================================= #
     # === @internal_hash
     #
     # This Hash will keep a lot of internal data, which is primarily used
-    # to describe the state a given web_object.
+    # to describe the state a given web_object is in.
     #
-    # It should come first, even before the main String stored in :result.
+    # It should come first, even before the main String stored in
+    # :html_string.
     # ======================================================================= #
     @internal_hash = {}
     # ======================================================================= #
-    # === :listing_counter
+    # === :global_CSS_rules_for_all_images
     #
-    # Keep track of the listing counter. This will have an initial value
-    # of 0.
+    # This variable must be nil initially.
+    #
+    # If it is not nil then all images defined via the WebObject will
+    # have the same CSS rules.
     # ======================================================================= #
-    reset_the_listing_counter
+    @internal_hash[:global_CSS_rules_for_all_images] = nil
     # ======================================================================= #
-    # === :result
+    # === :body_content
     #
-    # This is the main String of this class. All the HTML code, CSS stuff
-    # and so forth will be stored into this String.
+    # This variable will store the content of the <body> of the given
+    # HTML page at hand.
     # ======================================================================= #
-    @internal_hash[:result] = ''.dup
+    @internal_hash[:body_content] = ''
     # ======================================================================= #
-    # === :already_served
+    # === :html_string
     #
-    # This variable keeps track whether we already served the webpage.
+    # This is the main String of this class.
+    #
+    # All the HTML code, all CSS components and so forth will be stored
+    # into this String. It will become the String that is served to the
+    # visitor by the web_object, such as as the result of a .cgi page.
     # ======================================================================= #
-    @internal_hash[:already_served] = false
+    @internal_hash[:html_string] = ''.dup
     # ======================================================================= #
-    # === :string_lateron
+    # === :save_into_this_html_page
     # ======================================================================= #
-    @internal_hash[:string_lateron] = ''.dup # ← Unsure if we still need this.
+    @internal_hash[:save_into_this_html_page] = '/Depot/j/foobar.html'
     # ======================================================================= #
-    # === :show_source
+    # === :use_the_internal_CSS_files
     #
-    # If true then we will show the source of a page.
+    # If the following variable is set to true then the WebObject instance
+    # will try to read in the internal .css files.
     # ======================================================================= #
-    @internal_hash[:show_source] = false
+    @internal_hash[:use_the_internal_CSS_files] = true
     # ======================================================================= #
-    # === :is_a_sinatra_application
+    # === :register_the_constants
     #
-    # If this is true then we are running a sinatra application; the custom
-    # extension that I use in this case is .sinatra.
+    # If the following variable is set to true then the method
+    # .register_constants() will be invoked, which in turn will
+    # register various constants.
     # ======================================================================= #
-    @internal_hash[:is_a_sinatra_application] = false
+    @internal_hash[:register_the_constants] = true
+    # ======================================================================= #
+    # === :show_source
+    #
+    # If true then we will show the source of a page.
+    # ======================================================================= #
+    @internal_hash[:show_source] = false
     # ======================================================================= #
     # === :debug
     # ======================================================================= #
     @internal_hash[:debug] = ::Cyberweb.debug? # ← Must come before load_yaml_configuration().
     # ======================================================================= #
-    # === :javascript
+    # === :use_unicode
     #
-    # This string will be appended onto the javascript string.
+    # Whether we want to make use of Unicode or not, in a given .cgi or
+    # html page.
     # ======================================================================= #
-    @internal_hash[:javascript] = ''.dup
+    @internal_hash[:use_unicode] = true
     # ======================================================================= #
-    # === :use_body_tag
+    # === :body_css_style
+    # ======================================================================= #
+    @internal_hash[:body_css_style] = ''.dup
+    # ======================================================================= #
+    # === :meta_collection
     #
-    # If this variable is false then we won't use the <body> tag.
+    # This variable is used to add the meta-collection entries for the
+    # web-object.
+    # ======================================================================= #
+    @internal_hash[:meta_collection] = ''.dup
+    # ======================================================================= #
+    # === :head_string
     #
-    # This is needed when we want to use framesets specifically.
+    # This variable will include the content of the head string, aka
+    # all of <head>.
     # ======================================================================= #
-    @internal_hash[:use_body_tag] = true
+    @internal_hash[:head_string] = ''.dup
     # ======================================================================= #
     # === :mail
     #
@@ -86,50 +124,41 @@ class WebObject < Base # === Cyberweb::WebObject
     # ======================================================================= #
     @internal_hash[:mail] = nil
     # ======================================================================= #
-    # === :register_the_constants
-    # ======================================================================= #
-    @internal_hash[:register_the_constants] = true
-    # ======================================================================= #
-    # === :use_unicode
-    # ======================================================================= #
-    @internal_hash[:use_unicode] = false
-    # ======================================================================= #
-    # === :language
+    # === :use_body_tag
     #
-    # This variable keeps track as to which language a website is
-    # mostly written in. It defaults to english.
+    # If this variable is false then we won't use the <body> tag.
+    #
+    # This is needed when we want to use framesets specifically.
     # ======================================================================= #
-    @internal_hash[:language] = :english
+    @internal_hash[:use_body_tag] = true
     # ======================================================================= #
-    # === :frame_string
+    # == :body_css_class
     # ======================================================================= #
-    @internal_hash[:frame_string] = '' # The frame string.
+    @internal_hash[:body_css_class] = nil
     # ======================================================================= #
     # === :body_javascript
     # ======================================================================= #
     @internal_hash[:body_javascript] = ''.dup
     # ======================================================================= #
-    # === :do_not_display_empty_files
-    # ======================================================================= #
-    @internal_hash[:do_not_display_empty_files] = false
-    # ======================================================================= #
     # === :n_total_lines
     #
     # Keep track how many lines we generated in total.
     # ======================================================================= #
-    @internal_hash[:n_total_lines]   = 0
+    @internal_hash[:n_total_lines] = 0
     # ======================================================================= #
-    # === :register_ids
+    # === :encoding_to_use
     # ======================================================================= #
-    @internal_hash[:register_ids] = []
+    @internal_hash[:encoding_to_use] = :default
     # ======================================================================= #
-    # == :body_css_class
+    # === :register_ids
     # ======================================================================= #
-    @internal_hash[:body_css_class] = nil
+    @internal_hash[:register_ids] = []
     # ======================================================================= #
-    # === :body_css_style
+    # === :body_id
+    #
+    # Populate the id of the <body> tag as an empty String.
     # ======================================================================= #
-    @internal_hash[:body_css_style] = ''.dup
+    @internal_hash[:body_id] = ''.dup
     # ======================================================================= #
     # === :database
     #
@@ -141,7 +170,8 @@ class WebObject < Base # === Cyberweb::WebObject
     # === :remove_newlines
     #
     # By default, we will keep newlines in the main String, so this
-    # variable defaults to false.
+    # variable defaults to false. If set to true, however had, then
+    # the result-string will lose all newlines.
     # ======================================================================= #
     @internal_hash[:remove_newlines] = false
     # ======================================================================= #
@@ -151,26 +181,84 @@ class WebObject < Base # === Cyberweb::WebObject
     # ======================================================================= #
     @internal_hash[:enable_title_for_reading_files] = []
     # ======================================================================= #
-    # === :encoding_to_use
+    # === :do_not_display_empty_files
     # ======================================================================= #
-    @internal_hash[:encoding_to_use] = :default
+    @internal_hash[:do_not_display_empty_files] = false
     # ======================================================================= #
-    # === :body_id
+    # === :string_lateron
     #
-    # Populate it as an empty String.
+    # This string can be appended at a "later" time. It is still useful
+    # for e. g. disabling right click events.
     # ======================================================================= #
-    @internal_hash[:body_id] = ''.dup
+    @internal_hash[:string_lateron] = ''.dup
+    # ======================================================================= #
+    # === :already_served
+    #
+    # This variable keeps track whether we already served the webpage.
+    # ======================================================================= #
+    @internal_hash[:already_served] = false
+    # ======================================================================= #
+    # === :is_a_sinatra_application
+    #
+    # If this is true then we are running a sinatra application; the custom
+    # extension that I use in this case is .sinatra.
+    # ======================================================================= #
+    @internal_hash[:is_a_sinatra_application] = false
+    # ======================================================================= #
+    # === :language
+    #
+    # This variable keeps track as to which language a website is
+    # mostly written in. It defaults to english.
+    #
+    # Keep in mind that this is more a "recommendation"; I myself use
+    # websites that mix german with english, so it may not be 100%
+    # correct. Thus assume it refers mostly to "the main language"
+    # used on a website.
+    # ======================================================================= #
+    @internal_hash[:language] = :english
+    # ======================================================================= #
+    # === :javascript
+    #
+    # This string will be appended onto the javascript string.
+    # ======================================================================= #
+    @internal_hash[:javascript] = ''.dup
+    # ======================================================================= #
+    # === :frame_string
+    # ======================================================================= #
+    @internal_hash[:frame_string] = '' # The frame string.
     # ======================================================================= #
-    # Now we have finished the initial loadup. We can continue to describe
-    # our web object. We do this by calling the proper base directory.
+    # === :relative_path
+    # ======================================================================= #
+    @internal_hash[:relative_path] = nil
+    # ======================================================================= #
+    # === set_proper_base_directory()
+    #
+    # Now we have finished the initial loadup and description of the
+    # @internal_hash. We can now continue to describe our remaining web
+    # object. We do this by calling the proper base directory next.
+    #
+    # This should come after @internal_hash has already been populated
+    # with the correct dataset.
     # ======================================================================= #
     set_proper_base_directory # Initial setup.
     # ======================================================================= #
+    # === :listing_counter
+    #
+    # Keep track of the listing counter. This will have an initial value
+    # of 0.
+    # ======================================================================= #
+    reset_the_listing_counter
+    # ======================================================================= #
     # === The configuration dataset
     #
-    # Load up the main configuration next.
+    # Load up the main configuration next. This should come before
+    # we call use_commandline_mode().
     # ======================================================================= #
     load_yaml_configuration
+    use_commandline_mode
+    set_title
+    use_utf_encoding # Use ISO or UTF encoding. Current default is UTF.
+    # add_http_response_header
     # ======================================================================= #
     # Some entries must come after the configuration has been loaded.
     # One such method-call is the call to no-jquery. However had, since
@@ -184,9 +272,7 @@ class WebObject < Base # === Cyberweb::WebObject
     if enable_jquery_for_every_page?
       do_use_jquery
     end
-    use_utf_encoding # Use ISO or UTF encoding. Current default is UTF.
-    use_commandline_mode
-    # add_http_response_header
+    determine_the_relative_path
   end
 end; end

data/lib/cyberweb/web_object/run.rb CHANGED Viewed

@@ -8,7 +8,7 @@ require 'cyberweb/base/base.rb'
 module Cyberweb
-class WebObject < Base # === Cyberweb::WebObject
+class WebObject < ::Cyberweb::Base # === Cyberweb::WebObject
   # ========================================================================= #
   # === run                                                         (run tag)