cyberweb 0.4.174

data/lib/cyberweb/html_tags/th.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Th
+  # ========================================================================= #
+  class Th < WebBase
+
+    # ======================================================================= #
+    # === @th_css_class
+    # ======================================================================= #
+    @th_css_class = nil
+
+    # ======================================================================= #
+    # === Th.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @th_css_class = i
+    end
+
+    # ======================================================================= #
+    # === Th.to_s
+    # ======================================================================= #
+    def self.to_s; @th_css_class; end
+
+  end
+
+  # ========================================================================= #
+  # === th
+  #
+  # The <th> tag defines a header cell in an HTML table.
+  #
+  # An HTML table has two kinds of cells:
+  #
+  #   Header cells   - contains header information (created with the <th>
+  #                    element)
+  #   Standard cells - contains data (created with the <td> element)
+  #
+  # The text in <th> elements are bold and centered by default.
+  # The text in <td> elements are regular and left-aligned by default.
+  #
+  # Some documentation for the <th> tag can be found here:
+  #   http://www.w3schools.com/tags/tag_th.asp
+  # ========================================================================= #
+  def th(
+      optional_input = '',
+      css_class      = Th.to_s,
+      the_id         = '',
+      css_style      = ''
+    )
+    tag 'th', css_class, the_id, css_style
+    unless optional_input.empty?
+      ee optional_input
+      cth
+    end
+  end
+
+  # ========================================================================= #
+  # === cth
+  # ========================================================================= #
+  def cth
+    eclose :th
+  end
+
+end

data/lib/cyberweb/html_tags/thead.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+  
+  # ========================================================================= #
+  # === Thead
+  # ========================================================================= #
+  class Thead < WebBase
+    # ======================================================================= #
+    # === @thead_css_class
+    # ======================================================================= #
+    @thead_css_class = nil
+    # ======================================================================= #
+    # === Thead.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @thead_css_class = i
+    end
+    # ======================================================================= #
+    # === Thead.to_s
+    # ======================================================================= #
+    def self.to_s; @thead_css_class; end
+  end
+
+  # ========================================================================= #
+  # === thead                                                     (thead tag)
+  #
+  # This will simply create a <thead> tag.
+  # ========================================================================= #  
+  def thead(css_class = Thead.to_s, the_id = '', css_style = '')
+    tag :thead, css_class, the_id, css_style
+  end
+
+end

data/lib/cyberweb/html_tags/tr.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/html_tags/tr.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Tr
+  # ========================================================================= #
+  class Tr < WebBase
+
+    # ======================================================================= #
+    # === @tr_css_class
+    # ======================================================================= #
+    @tr_css_class = nil
+
+    # ======================================================================= #
+    # === Tr.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @tr_css_class = i
+    end
+
+    # ======================================================================= #
+    # === Tr.to_s
+    # ======================================================================= #
+    def self.to_s; @tr_css_class; end
+
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.tr
+  #
+  # The first argument is the input that has to be displayed. If it
+  # is omitted then we will display just a <tr> tag.
+  # ========================================================================= #
+  def self.tr(
+      optional_input        = '',
+      optional_second_input = '',
+      css_class             = Tr.to_s, 
+      the_id                = '',
+      css_style             = '',
+      &block
+    )
+    ee ::Cyberweb.string_tr(
+         optional_input,
+         optional_second_input,
+         css_class, 
+         the_id,
+         css_style,
+         &block
+       )
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_tr
+  #
+  # This method will ultimately return a String containing, at the very
+  # least, the <tr> tag; and often a lot more.
+  # ========================================================================= #
+  def self.string_tr(
+      optional_input        = '',
+      optional_second_input = '',
+      css_class             = Tr.to_s, 
+      the_id                = '',
+      css_style             = '',
+      &block
+    )
+    # ======================================================================= #
+    # Make the <tr> tag anyway.
+    # ======================================================================= #
+    result = string_tag('tr', css_class, the_id, css_style).dup
+    if block_given?
+      result << yield.to_s
+      result << string_ctr
+    else
+      unless optional_input.empty?
+        result << string_td(optional_input)
+        unless optional_second_input.empty? # Add the second input here.
+          result << string_td(optional_input)
+        end
+        result << string_ctr
+      end
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === tr
+  # ========================================================================= #
+  def tr(a = '', b = '', c = Tr.to_s, d = '', e = '', &block)
+    ::Cyberweb.tr(a, b, c, d, e, &block)
+  end
+
+end

data/lib/cyberweb/html_tags/ul.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/html_tags/ul.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/css.rb'
+
+  # ========================================================================= #
+  # === Ul
+  # ========================================================================= #
+  class Ul < WebBase
+
+    # ======================================================================= #
+    # === @ul_css_class
+    # ======================================================================= #
+    @ul_css_class = nil
+
+    # ======================================================================= #
+    # === Ul.set_css_class
+    # ======================================================================= #
+    def self.set_css_class(i = DEFAULT_CSS_CLASS)
+      @ul_css_class = i
+    end
+    # ======================================================================= #
+    # === Ul.to_s
+    # ======================================================================= #
+    def self.to_s; @ul_css_class; end
+  end
+
+  # ========================================================================= #
+  # === ul                                                           (ul tag)
+  #
+  # The HTML <ul> tag sits here.
+  # ========================================================================= #
+  def ul(
+      css_class  = Ul.to_s,
+      the_id     = '',
+      css_style  = '',
+      javascript = ''
+    )
+    tag :ul, css_class, the_id, css_style, javascript; n
+    if block_given?
+      yield
+      eclose :ul
+    end
+  end
+
+end

data/lib/cyberweb/html_template/html_template.rb

@@ -0,0 +1,352 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::HtmlTemplate
+#
+# The idea for this class is to be used solely via HtmlTemplate[], while
+# passing in a Hash that describes the object. This is then presented
+# to visitors.
+#
+# All methods that begin with "html_" will correspond to generated HTML.
+# For example, "html_title?" will embed title? into <title></title> tags.
+#
+#   HtmlTemplate.new {
+#     title: 'Foo'
+#   }
+#
+# A more complete example:
+#
+#   Cyberweb::HtmlTemplate[
+#     title: 'The weather/temperature in Vienna',
+#     body:  p('Hey there','','','font-size:1.8em')
+#   ].to_s
+#
+# Usage example:
+#
+#   Cyberweb::HtmlTemplate.new(ARGV)
+#
+# =========================================================================== #
+# require 'cyberweb/html_template/html_template.rb'
+# Cyberweb::HtmlTemplate.new {{ title: 'Foo', body: HtmlTags.p1('Hey there') }}
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
+
+  begin
+    require 'rack'
+  rescue LoadError; end
+
+  include Colours
+
+  begin
+    require 'html_tags'
+    include HtmlTags
+  rescue LoadError; end
+
+  require 'cyberweb/toplevel_methods/charsets.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true,
+      &block
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    if commandline_arguments.is_a? Hash
+      # ===================================================================== #
+      # This is the default entry point, how this class should be used.
+      # We will assume a Hash is to be used.
+      # ===================================================================== #
+      parse_this_hash(commandline_arguments)
+    # ======================================================================= #
+    # === Handle blocks passed to this class
+    # ======================================================================= #
+    elsif block_given?
+      parse_this_hash(yield)
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :title
+    # ======================================================================= #
+    @internal_hash[:title] = nil
+    # ======================================================================= #
+    # === :body
+    # ======================================================================= #
+    @internal_hash[:body] = nil
+    # ======================================================================= #
+    # === :css_classes
+    # ======================================================================= #
+    @internal_hash[:css_classes] = nil
+    # ======================================================================= #
+    # === :special_actions
+    # ======================================================================= #
+    @internal_hash[:special_actions] = nil
+    # ======================================================================= #
+    # === :body_css_style
+    # ======================================================================= #
+    @internal_hash[:body_css_style] = nil
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    @internal_hash[:title]
+  end
+
+  # ========================================================================= #
+  # === parse_this_hash                                           (parse tag)
+  #
+  # This method is very important, because it will parse the given Hash
+  # into constituent members.
+  # ========================================================================= #
+  def parse_this_hash(hash)
+    # ======================================================================= #
+    # === :title
+    # ======================================================================= #
+    if hash.has_key? :title
+      @internal_hash[:title] = hash.delete(:title)
+    end
+    # ======================================================================= #
+    # === :body_css_style
+    # ======================================================================= #
+    if hash.has_key? :body_css_style
+      @internal_hash[:body_css_style] = hash.delete(:body_css_style)
+    end
+    # ======================================================================= #
+    # === :body
+    # ======================================================================= #
+    if hash.has_key? :body
+      @internal_hash[:body] = hash.delete(:body)
+    end
+    # ======================================================================= #
+    # === :css_classes
+    # ======================================================================= #
+    if hash.has_key? :css_classes
+      @internal_hash[:css_classes] = hash.delete(:css_classes)
+    # ======================================================================= #
+    # === :css_class
+    # ======================================================================= #
+    elsif hash.has_key? :css_class
+      @internal_hash[:css_classes] = hash.delete(:css_class)
+    end
+    # ======================================================================= #
+    # === :special_actions
+    #
+    # This is special and must come last. We can, for example, use
+    # this to read in a .html file and display that.
+    # ======================================================================= #
+    if hash.has_key? :special_actions
+      @internal_hash[:special_actions] = hash.delete(:special_actions)
+    end
+  end
+
+  # ========================================================================= #
+  # === html_title?
+  # ========================================================================= #
+  def html_title?(
+      i = title?
+    )
+    HtmlTags.title(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === body?
+  # ========================================================================= #
+  def body?
+    @internal_hash[:body]
+  end
+
+  # ========================================================================= #
+  # === css_classes?
+  # ========================================================================= #
+  def css_classes?
+    @internal_hash[:css_classes]
+  end
+
+  # ========================================================================= #
+  # === return_the_css_classes
+  #
+  # This method will identify the correct CSS class. In order for this
+  # to work, the class must have been defined in one of the default
+  # .css files. And these files have to be found by ruby as well -
+  # otherwise the method will not work properly.
+  # ========================================================================= #
+  def return_the_css_classes
+    css_classes = css_classes?
+    if css_classes
+      css_classes = [css_classes].flatten.map {|entry|
+        if entry.include? ' '
+          entry = entry.split(' ')
+        end
+        entry
+      }.flatten
+      _ = ''.dup
+      css_content = ''.dup
+      # ===================================================================== #
+      # Obtain the various .css files next and store them in `css_content`:
+      # ===================================================================== #
+      Dir[project_base_dir?+'cascading_style_sheets/*.css'].each {|entry|
+        css_content << File.read(entry)+N
+      }
+      css_classes.each {|this_css_class|
+        # =================================================================== #
+        # See: https://rubular.com/r/7LUM1vaN45GDQ6
+        # =================================================================== #
+        use_this_regex =
+          /(\.#{this_css_class}).+{(.+)}$/
+        css_content =~ use_this_regex
+        if $2
+          _ << $1.to_s.ljust(15)+' { '+$2.to_s.lstrip.squeeze(' ')+' }'+N
+        end
+      }
+      '<style>'+N+
+      _.to_s+N+
+      '</style>'+N
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === main_string?
+  # ========================================================================= #
+  def main_string?
+    @internal_hash[:main_string].to_s
+  end; alias to_s    main_string? # === to_s
+       alias string? main_string? # === string?
+       # alias to_str main_string? # === to_str # This would imply "behaves like string".
+
+  # ========================================================================= #
+  # === call                                                       (call tag)
+  #
+  # Rack expects an application to be an object with a .call() method
+  # accepting env (hash containing all the information about a request) 
+  # and returning a 3-element tuple.
+  #
+  # This Array should be:
+  #
+  #   [status_code, headers_hash, body_array]
+  #
+  # ========================================================================= #
+  def call(env = nil)
+    [
+      200, # Status code.
+      {
+        'Content-Type'   => 'text/html',
+        'Content-Length' => main_string?.size # Headers.
+      },
+      main_string? # body array.
+    ]
+  end
+
+  # ========================================================================= #
+  # === generate_the_main_string                                   (main tag)
+  #
+  # This method will build up the full HTML string that can be served.
+  # ========================================================================= #
+  def generate_the_main_string
+    case @internal_hash[:special_actions]
+    # ======================================================================= #
+    # === :use_raw_body
+    #
+    # This entry point will simply allow us to use a passed <body>
+    # tag as-is, without any special modification to that.
+    # ======================================================================= #
+    when :use_raw_body
+      @internal_hash[:main_string] = body?.to_s
+    else # This is the default.
+      body_string = '<body'.dup
+      # ===================================================================== #
+      # === :body_css_style
+      # ===================================================================== #
+      if @internal_hash[:body_css_style] and !@internal_hash[:body_css_style].empty?
+        body_string << ' style="'+@internal_hash[:body_css_style].to_s+'"'
+      end
+      body_string << '>'+N
+      @internal_hash[:main_string] =
+      '<!DOCTYPE html>'+N+
+      '<html lang="en">'+N+
+      '<head>'+N+
+      Cyberweb.return_utf_charset+
+      html_title?+N+
+      return_the_css_classes+N+
+      '</head>'+N+
+      body_string+
+      @internal_hash[:body].to_s+N+
+      '</body>'+N+
+      '</html>'+N
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    generate_the_main_string
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::HtmlTemplate[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::HtmlTemplate.new(ARGV)
+end # htmltemplate

data/lib/cyberweb/images/embed_this_image.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/images/embed_this_image.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/ee.rb'
+  # ========================================================================= #
+  # === Cyberweb.embed_this_image
+  #
+  # This method can be used to quickly "embed" an image - which just
+  # means to use the <img> tag.
+  #
+  # The method will return a String.
+  # ========================================================================= #
+  def self.embed_this_image(
+      this_image         = 'lyxandras-das-Dorf-Nadorp.jpg',
+      optional_css_class = ''
+    )
+    return '<img src="'+this_image.to_s+
+           '" class="'+optional_css_class.to_s+
+           '" alt="Image_is_missing">'
+  end
+
+  # ========================================================================= #
+  # === embed_this_image
+  # ========================================================================= #
+  def embed_this_image(
+      this_image         = 'lyxandras-das-Dorf-Nadorp.jpg',
+      optional_css_class = ''
+    )
+    ::Cyberweb.embed_this_image(this_image, optional_css_class)
+  end
+
+end