cyberweb 0.4.174

data/bin/cyberweb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb
+#
+# Usage example:
+#
+#   Cyberweb::CGI_Generator.new('test.cgi')
+#
+# =========================================================================== #
+require 'cyberweb/commandline/commandline_interface.rb'
+require 'cyberweb/generator/cgi.rb'
+
+if __FILE__ == $PROGRAM_NAME
+  _ = ARGV.first
+  case _
+  when 'help','HELP','--help','show_help','h'
+    Cyberweb.show_help
+  when 'webrick','server','start','start_server','serve','s'
+    Cyberweb.start_server
+  else
+    Cyberweb.menu(_)
+    Cyberweb.generate_cgi(ARGV)
+  end
+end # cyberweb
+    # cyberweb generate index.cgi

data/cyberweb.gemspec

@@ -0,0 +1,119 @@
+require 'cyberweb/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'cyberweb'
+  s.version = Cyberweb::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+Cyberweb is a tool-set project for the www, including an incomplete
+web "framework". The project attempts to explore different ideas,
+so it has a somewhat medium-to-large size as-is.
+
+As a project, cyberweb is quite far away from being complete or
+reasonably finished - consider it more as a proof-of-concept
+project than something that should be used in production.
+
+The cyberweb project in its present state is not fully documented
+either, which is unfortunate - the documentation will be 
+improved, until the 1.0 release will eventually be uploaded.
+
+The project is used since many years years to augment  
+Ruby-CGI scripts. For these basic needs cyberweb works fairly well.
+Since as of May 2021, sinatra is another option, so the cyberweb
+project tries to adjust to different use cases.
+
+While .cgi scripts are not that common to see in use past the year
+2015, and admittedly nowhere as as flexible as sinatra or rails, I
+consider .cgi scripts still to be extremely SIMPLE to use and I
+appreciate simplicity. Compare a hello-world example in a .cgi
+script with one in rails; in my opinion, the .cgi example is 
+simpler. I don't refer to the default cgi in ruby, though, which is
+admittedly not so great - otherwise I would not have had a need
+to create this project many years ago.
+
+If you need a framework that is more sophisticated then it is 
+recommended to use sinatra and padrino.
+
+For more information about the cyberweb project, please look at the
+following link:
+
+    https://www.rubydoc.info/gems/cyberweb/
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+  
+  s.authors     = ['Robert A. Heiler']
+  s.email       = Roebe.email?
+  s.files       = Dir['**/*']
+  s.homepage    = 'https://rubygems.org/gems/cyberweb'
+  s.licenses    = 'MIT'
+  s.executables = ['cyberweb']
+
+  # ========================================================================= #
+  # Show this when a user installs this project.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+To use this web-related tool-set project, try:
+
+    require 'cyberweb/autoinclude'
+
+A special object, @web_object aka w() aka Cyberweb.new() will
+be created that holds all the dataset describing your app in
+question.
+
+The HTML content is available in the instance_variable @string,
+and can be queried through the .string? method.
+
+You can edit the configuration settings via either:
+
+    webobject edit
+    webobject --edit
+
+For all available commandline options, do:
+
+    cyberweb --help
+
+To generate a new .cgi file, do:
+
+    cyberweb test.cgi
+
+The argument will become the name of the file, so the above command
+will create the file test.cgi.
+
+Also remember that you can add instructions ad-hoc while running
+a .cgi page, such as foobar.cgi?disable_webimages would disable
+webimages. You can view of source of any .cgi page by issuing
+foobar.cgi?show_source - provided that this has been enabled
+in the default configuration.
+
+For more information, have a look at:
+
+    #{Cyberweb::URL_TO_THE_DOCUMENTATION}
+
+  EOF
+
+  # ========================================================================= #
+  # All dependencies will be listed next.
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'html_tags'
+
+  # ========================================================================= #
+  # External projects not written by me are listed past this point:
+  # ========================================================================= #
+  s.add_dependency 'coderay'
+  s.add_dependency 'kramdown'
+  s.add_dependency 'rack'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/doc/AUTHORS.md

@@ -0,0 +1,12 @@
+The main author of the Cyberweb project is:
+
+  Robert A. Heiler
+
+Various addons and components:
+
+  Matz and others:
+
+    They wrote the ruby-cgi main interface which has been updated
+    and integrated into this project in the year 2015, with a few
+    modifications. See the respective file for the copyright,
+    which essentially is a copy-paste of that license.

data/doc/CONVENTIONS.md

@@ -0,0 +1,7 @@
+- The error_log stored in the constant MISSING_IMAGES_ARE_STORED_HERE 
+  and is usually stored at:
+
+    /Depot/Temp/cyberweb_errors.log
+
+- If we want to set the absolute path, we can do so via the toplevel
+  method called Cyberweb.set_path().

data/doc/CYBERWEB_TUTORIAL.cgi

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/DATA/PROGRAMMING_LANGUAGES/RUBY/src/web_object/doc/CYBERWEB_TUTORIAL.cgi
+# =========================================================================== #
+# rf cyberweb_tutorial
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'cyberweb/toplevel_methods/logo.rb'
+
+english {
+t 'SELF#NO_EXTENSION'
+css_style :template1 # Is shorter.
+favicon ::Cyberweb.logo?
+body_css_class 's12px padt0px marpad1px VERDANAs'
+body_css_style 'background-color: #d3d2d1;'
+font_size '1.1em'
+
+# =========================================================================== #
+# === header
+# =========================================================================== #
+def header(i, use_this_css = '')
+  h3 sg(:pfeil5,'marr5px')+i,
+     use_this_css
+end
+
+doc('mart0px s0_5em') {
+  h2 sg(:blue_star,'marr6px')+'Cyberweb Tutorial'+
+     ' <span class="smaller">('+return_date+')</span>'
+  le 'This Tutorial will demonstrate and highlight 
+  capabilities of the <b class="ud">Cyberweb Framework</b>.'
+  br
+  header 'USAGE'+' <span class="smaller">(bl '+
+         ::Cyberweb.absolute_path('USAGE')+')</span>','mart5px'
+  read_and_display 'USAGE.md','pad1em bigger' # bl USAGE
+  header 'README'
+  read_and_display 'README.md','pad1em','','font-size:1.4em'
+  header 'FEATURES'
+  read_and_display 'FEATURES.md','pad1em larger'
+  h4 'The logfile can be found here:'
+  e ::Cyberweb.logfile?
+}}

data/doc/DOCUMENTATION_FOR_CYBERSPRAWL.md

@@ -0,0 +1,50 @@
+# =========================================================================== #
+# Welcome to Cybersprawl, the WebApp of WebObject.
+# =========================================================================== #
+
+Cybersprawl is a WebApp generator for ruby.
+
+It is based on Cyberweb, which is a general web framework written
+in Ruby.
+
+Specific Features of Cybersprawl:
+
+ - It can use a SIMPLE templating language (for an example, look at
+   raw_data.raw)
+   
+   IF you want to use a templating language at all that is.
+
+   Cybersprawl won't force anyone to use one if this is not wanted.
+
+ - Uses a simplified language, see foundation/foundation.rb. This is
+   based on my experience with the www. It is quite easy to use.
+
+   The reasoning behind is is that it is better to use an easier
+   language and let the computer do more work behind it.
+
+ - Describe your application in one central fashion and use flexible 
+   components to add functionality to your application.
+  
+ - Uses blogs, and blog components in an easy manner, including 
+   Tumblelog-like behaviour.
+
+ - Use a Webmin-like system administration.
+
+ - Use "The Matrix" as a meeting point, "The Hub" as an IRC channel.
+
+ - Use graphics easily by providing access to "typical" images
+   (see ADMIN.cgi#std_images for a list of what is available)
+
+ - Use project collaboration (see at Basecamp to get an idea what
+   this means, i.e. IRC-like communication.)
+  
+ - Provide bindings for many external components.
+
+The javascript methods:
+
+ - Certain words are handled as instructional "keywords".
+
+   For instance, you can pass "on_click_select" and this will
+   be interpreted to have the following meaning:
+
+     "on click with your mouse, the whole text will be selected."

data/doc/FUTURE_DESIGN_GOAL_CONSIDERATIONS.md

@@ -0,0 +1,13 @@
+This file just contains some random ideas what/how to improve
+the Cyberweb project in the long run. Sort of a "todo" list,
+but without too much code (yet) to implement these ideas.
+
+The entries will be kept listed via numbers, to make it 
+simpler to keep track of what has all been suggested so far:
+
+-------------------------------------------------------------------------------
+
+1) Add a method called "index" for subclasses that wish to
+render content (e. g. html content) as view to the visitor.
+Index is the method that may be called by default when 
+this class is served to the browser.

data/doc/JQUERY.md

@@ -0,0 +1,122 @@
+Thanks to JQuery and its drag and drop support, you can enable
+draggable elements based on the id of that element.
+
+There are multiple ways to do this, as far as the Cyberweb
+project is concerned.
+
+Internally, cyberweb will look for the string instruction __drag__.
+
+More generally, however, you can simply use the method drag() and
+pass in the ID in question.
+
+Let's show a specific usage example for the call to the drag() method:
+
+First, create or define an id such a in this way:
+ 
+    div('','some_id_here')
+
+  or simpler
+
+    div(id: some_id_here)
+
+Then:
+
+    drag :some_id_here
+
+A slightly more readable variant may be this one here:
+
+    div(id: 'some_id_here')
+    drag :some_id_here
+
+Whether to use Symbols or Strings does not matter - the Cyberweb 
+project will convert input if necessary.
+
+One "advantage" of Symbols, aside from them requiring no new
+instantiation of an object, unlike String objects, is that you
+can save one character. This may appear hugely insignificant,
+but if you have to type things one thousand times, using one
+less character may make it simply easier to write and read
+something such as:
+
+    enable :drag
+
+As opposed to:
+
+    enable 'drag'
+
+Which variant is nicer to read? I sort of prefer the first variant,
+although the second one is not that much harder to read either.
+It may be a tiny bit faster to write, though.
+
+At any rate - the above shows that drag() expects the id, of the
+HTML element in question.
+
+In our example here, the ID of a div() aka a HTML <div> element. That
+element will have a specific id, if you assigned one.
+  
+Also note that some alternative syntaxes to the above example exist.
+
+For instance:
+
+    div(id: 'some_id_here')
+    drag :some_id_here
+
+This may be easier to read. Note that this passes only one argument,
+a Hash.
+
+Another alternative to the above, rather than forcing you to pass in
+the specific ID, you can simply point to the last id used, like by
+doing this:
+  
+    drag :last_id_used
+    drag :last_id
+
+Since as of January 2015, it is also possible to enable drag-support
+on-the-fly if the elements start with the string 'drag_', as
+identifier to their ID elements.
+
+This can happen like so, in the following two equivalent examples:
+  
+    div('', 'drag_this_div')
+    div(id: 'drag_this_div')
+
+You can see that these IDs start with the string 'drag_', which
+will be used by Cyberweb as an identifier. Past this point,
+the two div-elements can be dragged via the mouse. I use this
+variant usually, even in the year 2021.
+
+For Images, you can also use the following variant here:
+
+    img('foobar.png', 'drag_#NAME#')
+  
+This will use the name of the file in question.
+
+Sometime later in 2015, I have also added this variant:
+  
+    img 'foobar.png','', :drag
+
+That means that you can pass the symbol :drag to the ID, which
+means that we wish to drag this image.
+
+Pick a variant that is fitting to your personal preference.
+
+Note that since as of May 2015 you can also enable this through
+the URL itself.
+
+For instance, .cgi?use_jquery=1 means that we will enable
+jquery, irrelevant over what value the configuration holds.
+
+Examples for the latter:
+
+    http://localhost/MISC/ROEBE_TEMPEL.cgi?use_jquery=1
+    http://localhost/MISC/ROEBE_TEMPEL.cgi?use_jquery
+
+You can enable or disable jquery through the configuration
+file by the way.
+
+Note that you can download jquery via this module method:
+
+    Cyberweb.download_latest_jquery
+
+This will use wget and download into the current working
+directory.

data/doc/MOUSE.md

@@ -0,0 +1,80 @@
+Mouse
+======
+
+The Cyberweb project uses a small DSL for automated mouse input
+in X11 - even though this is currently disabled.
+
+In principle keyboard input can also be handled but this may
+remain on a todo list.
+
+Usage
+-----
+
+Presently, now Cyberweb only does mouse input.
+
+The API will look like this:
+
+    Cyberweb::Mouse.move 200, 300 # puts the cursor at x: 200px, y: 300px
+    Cyberweb::Mouse.down          # presses the primary mouse button
+    Cyberweb::Mouse.up            # releases the primary mouse button
+    Cyberweb::Mouse.click         # clicks with the primary mouse button
+    Cyberweb::Mouse.location      # => [ 200, 300 ]
+
+The first line can also accept a more explicit hash:
+
+    Cyberweb::Mouse.move x: 200, y: 300
+
+Which is all well and good, but the more useful stuff looks like:
+
+    Cyberweb::Mouse.drag :from => [ 200, 300 ], :distance => [ 30, 60 ], :increments => 10 do
+      Cyberweb::Mouse.drag :distance => [ 80, 100 ] do
+        sleep 0.5
+      end
+    end
+
+This may be quite useful if you use it in conjunction with Selenium-based
+Javascript testing.
+
+Complex movements such as a velocity-aware drag, or drag and drop between
+multiple containers with timeouts, may be tested.
+
+Requirements
+------------
+
+The mouse component will require `libxdo`. Libxdo is part of `xdotool`.
+
+Details and installation instructions can be found at:
+
+    http://www.semicomplete.com/projects/xdotool/
+
+Build instructions for Ubuntu:
+
+    $ sudo apt-get install xorg-dev
+    $ wget http://semicomplete.googlecode.com/files/xdotool-2.20100818.3004.tar.gz
+    $ tar xzvf xdotool*.tar.gz
+    $ cd xdotool-*
+    $ sudo make all install
+
+Testing
+-------
+
+Cyberweb in a VM environment set up can be tested via Vagrant.
+
+If you have Vagrant (https://www.vagrantup.com/) set up and running,
+and you have the lucid32.box, you can just do:
+
+    cd test && vagrant up
+
+Once your VM is provisioned and running, ssh in (`vagrant ssh`) and then:
+
+    startx &
+    cd ~/web_object/test
+    ruby web_object_test.rb
+
+If you do not happen to have Vagrant set up, you can follow the getting
+started guide at:
+
+    http://www.vagrantup.com/
+
+or you can install the necessary dependencies on your local machine
+and test locally.