chemistry_paradise 1.4.2

data/lib/chemistry_paradise/verbose_chemical_calculation.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Purpose of this class is to explain what we are doing in a
+# step-by-step wise fashion.
+#
+# Right now this is a stub.
+# =========================================================================== #
+module ChemistryParadise
+
+class VerboseChemicalCalculation
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+e 'This is currently a stub.'
+  end
+
+end; end

data/lib/chemistry_paradise/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'chemistry_paradise/version/version.rb'
+# =========================================================================== #
+module ChemistryParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.4.2'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '10.11.2023'
+
+end

data/lib/chemistry_paradise/wetter/wetter.rb

@@ -0,0 +1,539 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ChemistryParadise::Wetter
+#
+# Code pertaining to the Wetter class will be stored here in this file,
+# or in a subdirectory of the base.
+#
+# What is the purpose of this small class?
+#
+# This class will show the local weather in Vienna, by "parsing"
+# a remote website that contains this information.
+#
+# The main regex in use can also be anchored towards "12.2°", if
+# otherwise the dataset is nil.
+#
+# Usage example:
+#
+#   ChemistryParadise::Wetter.new(ARGV)
+#
+# =========================================================================== #
+# require 'chemistry_paradise/wetter/wetter.rb'
+# =========================================================================== #
+require 'chemistry_paradise/base/base.rb'
+
+module ChemistryParadise
+
+class Wetter < ::ChemistryParadise::Base # === ChemistryParadise::Wetter
+
+  begin
+    require 'open-uri'
+  rescue LoadError; end
+
+  begin
+    # ======================================================================= #
+    # If we want to tap into this functionality here, we only have to
+    # use: opn(namespace: namespace?);
+    # ======================================================================= #
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === REMOTE_URL
+  #
+  # Point to the remote website that holds the information for the
+  # local temperature in the city of Vienna.
+  # ========================================================================= #
+  REMOTE_URL = 'https://www.zamg.ac.at/cms/de/wetter/wetterwerte-analysen/wien'
+
+  # ========================================================================= #
+  # === TRY_TO_MAKE_USE_OF_THE_UNICODE_WEATHER_SYMBOL
+  #
+  # If the next constant is set to true then class Wetter will try to
+  # make use of the unicode symbol for "cloudy weather".
+  # ========================================================================= #
+  TRY_TO_MAKE_USE_OF_THE_UNICODE_WEATHER_SYMBOL = true
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX
+  #
+  # This is the regex handling some remote "Temp:" String.
+  # ========================================================================= #
+  USE_THIS_REGEX = /Temp: (-?\d+.\d+)/ # It also handles negative temperature.
+
+  # ========================================================================= #
+  # === USE_DEGREE_REGEX
+  #
+  # This second regex can be used when we wish to match against &deg values.
+  # ========================================================================= #
+  USE_DEGREE_REGEX = /\>(\d+.\d+)&deg;\</ # See: https://rubular.com/r/FheegP7Hfg
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV, # The commandline arguments are stored here.
+      run_already = true,
+      &block
+    )
+    reset
+    set_commandline_arguments(i)
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_silent
+      # ===================================================================== #
+      when :be_silent
+        set_be_quiet
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    initialize_the_internal_hash
+    # ======================================================================= #
+    # === :debug
+    # ======================================================================= #
+    @internal_hash[:debug] = false
+    # ======================================================================= #
+    # === :data
+    # ======================================================================= #
+    @internal_hash[:data] = nil
+    # ======================================================================= #
+    # === :match
+    # ======================================================================= #
+    @internal_hash[:match] = nil
+    # ======================================================================= #
+    # === :shall_we_report_openssl_errors
+    # ======================================================================= #
+    @internal_hash[:shall_we_report_openssl_errors] = false
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    be_verbose
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === --URL
+      # ===================================================================== #
+      when /^-?-?URL$/i
+        show_the_remote_url
+        exit
+      # ===================================================================== #
+      # === debug
+      # ===================================================================== #
+      when /debug/
+        enable_debug_mode
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === match?
+  # ========================================================================= #
+  def match?
+    @internal_hash[:match]
+  end
+
+  # ========================================================================= #
+  # === enable_debug_mode
+  # ========================================================================= #
+  def enable_debug_mode
+    @internal_hash[:debug] = true
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @internal_hash[:debug]
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    e
+    e '  --URL     # show the remote URL'
+    e '  --sinatra # start the sinatra-interface of this gem'
+    e
+  end
+
+  # ========================================================================= #
+  # === show_the_remote_url
+  #
+  # To invoke this method, do:
+  #
+  #   wetter --URL
+  #
+  # ========================================================================= #
+  def show_the_remote_url
+    e
+    e sfancy("  #{REMOTE_URL}")
+    e
+  end
+
+  # ========================================================================= #
+  # === try_to_make_use_of_the_unicode_weather_symbol?
+  # ========================================================================= #
+  def try_to_make_use_of_the_unicode_weather_symbol?
+    TRY_TO_MAKE_USE_OF_THE_UNICODE_WEATHER_SYMBOL
+  end
+
+  # ========================================================================= #
+  # === data?
+  # ========================================================================= #
+  def data?
+    @internal_hash[:data]
+  end
+
+  # ========================================================================= #
+  # === remote_URL?
+  # ========================================================================= #
+  def remote_URL?
+    REMOTE_URL
+  end
+
+  # ========================================================================= #
+  # === local_file?
+  # ========================================================================= #
+  def local_file?
+    File.absolute_path(File.basename(remote_URL?)+'.html')
+  end
+
+  # ========================================================================= #
+  # === try_to_download_the_remote_webpage
+  #
+  # This method was specifically added in February 2023, to bypass any
+  # issue we may have had when openssl is not available. It will rely
+  # on "wget" to download the webpage.
+  # ========================================================================= #
+  def try_to_download_the_remote_webpage(
+      remote_URL = remote_URL?,
+      be_verbose = be_verbose?
+    )
+    base_dir = '/home/x/Temp/wetter/'
+    if is_on_roebe? and !File.directory?(base_dir)
+      require 'fileutils'
+      FileUtils.mkdir_p(base_dir)
+    end
+    cd(base_dir) if File.directory?(base_dir)
+    local_file = File.absolute_path(File.basename(remote_URL)+'.html')
+    if File.exist?(local_file)
+      File.delete(local_file) # Remove any old file first.
+    end
+    if File.exist?(local_file.delete_suffix('.html'))
+      File.delete(local_file.delete_suffix('.html')) # Remove any old file first.
+    end
+    # ======================================================================= #
+    # Next, download the remote file.
+    # ======================================================================= #
+    esystem(
+      "wget #{remote_URL}", :silence_output_from_system
+    ) { :be_quiet }
+    unless File.exist?(local_file)
+      require 'fileutils'
+      if File.exist? local_file.delete_suffix('.html')
+        FileUtils.mv(
+          local_file.delete_suffix('.html'),
+          local_file
+        )
+      end
+    end
+    if File.exist? local_file and
+       be_verbose and
+       shall_we_report_openssl_errors?
+      opn; e "The remote file was downloaded into `#{sfile(local_file)}`."
+    end
+  end
+
+  # ========================================================================= #
+  # === read_in_the_dataset_from_the_remote_webpage
+  #
+  # This method has to catch OpenSSL errors.
+  # ========================================================================= #
+  def read_in_the_dataset_from_the_remote_webpage
+    begin
+      @internal_hash[:data] = URI.open(remote_URL?).read
+    rescue OpenSSL::SSL::SSLError => _error
+      # ===================================================================== #
+      # Here we know that an OpenSSL connection error occurred.
+      # We will notify the user about this but only one sentence.
+      # ===================================================================== #
+      _ = local_file?
+      if File.exist? _
+        if be_verbose and shall_we_report_openssl_errors?
+          opn; e 'An OpenSSL-error occurred. Trying to read from the'
+          opn; e 'local file at '+sfile(_)+' next.'
+        end
+        internal_hash[:data] = File.read(_)
+      else
+        e 'An OpenSSL-error occurred. Can not continue.' if be_verbose
+      end
+    end
+    if debug?
+      opn; e 'Now showing @internal_hash[:data], as we run in debug-mode.'
+      e cliner
+      e data?
+      e cliner
+    end
+    return @internal_hash[:data]
+  end
+
+  # ========================================================================= #
+  # === shall_we_report_openssl_errors?
+  # ========================================================================= #
+  def shall_we_report_openssl_errors?
+    @internal_hash[:shall_we_report_openssl_errors]
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_dataset
+  # ========================================================================= #
+  def sanitize_the_dataset
+    splitted = data?.split(N)
+    splitted.reject! {|line|
+      ! (line.include?('title="Wien Innere Stadt') and line.include?('Temp: '))
+    }
+    splitted = splitted.first if splitted.is_a? Array
+    if debug?
+      opn; e 'Now showing the sanitized dataset, as we run in debug-mode.'
+      pp splitted
+    end
+    @internal_hash[:data] = splitted # Re-assign it here.
+    if data?.nil?
+      @internal_hash[:data] =~ USE_DEGREE_REGEX
+      unless $1.to_s.dup.empty?
+        @internal_hash[:data] = $1.to_s.dup
+      end
+    end
+  end
+  
+  # ========================================================================= #
+  # === find_the_appropriate_match
+  #
+  # This will find the current degree, in Celsius.
+  # ========================================================================= #
+  def find_the_appropriate_match
+    @internal_hash[:data] =~ USE_THIS_REGEX # Apply the appropriate regex here.
+    @internal_hash[:match] = $1.to_s.dup
+  end
+
+  # ========================================================================= #
+  # === report_the_result
+  # ========================================================================= #
+  def report_the_result
+    if be_verbose?
+      n_degrees_celsius = match?.to_f
+      result = "#{olivedrab('The current temperature in Vienna is: ')}"\
+               "#{sfancy(n_degrees_celsius)} #{gold('°C')}".dup
+      # ===================================================================== #
+      # Next we have to check if we use a fancy unicode weather symbol:
+      # ===================================================================== #
+      if try_to_make_use_of_the_unicode_weather_symbol?
+        begin
+          require 'roebe/toplevel_methods/unicode/popular_unicode_symbols.rb'
+          case n_degrees_celsius
+          when  16 .. 50 # Should be clear weather most of the time.
+            result << " #{tomato(Roebe.clear_weather)}"
+          when   5 .. 15 # Medium-temperature; usually cloudy.
+            result << " #{royalblue(Roebe.cloudy_weather_symbol)}"
+          when -35 .. 4 # It's really quite cold.
+            result << " #{royalblue(Roebe.snowman)}"
+          end
+        rescue LoadError
+        end
+      end
+      # ===================================================================== #
+      # Next display which class reports the output as well:
+      # ===================================================================== #
+      opn; e result
+    end
+  end; alias report report_the_result # === report
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    try_to_download_the_remote_webpage
+    read_in_the_dataset_from_the_remote_webpage
+    sanitize_the_dataset
+    find_the_appropriate_match
+    report
+  end
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.menu                             (menu tag)
+  # ========================================================================= #
+  def self.menu(i)
+    if i.is_a? Array
+      if i.empty?
+        new(i)
+      else
+        i.each {|entry| menu(entry) }
+      end
+    else
+      case i
+      # ===================================================================== #
+      # === wetter --libui
+      # ===================================================================== #
+      when /^-?-?libui$/i
+        puts 'Starting the libui wetter (aka "weather") application next.'
+        require 'chemistry_paradise/gui/libui/wetter/wetter.rb'
+        ChemistryParadise::GUI::LibUI::Wetter.new
+        exit
+      # ===================================================================== #
+      # === wetter --sinatra
+      #
+      # This entry point starts the sinatra-interface of the wetter
+      # project.
+      #
+      # Invocation example:
+      #
+      #   wetter --sinatra
+      #
+      # ===================================================================== #
+      when /^-?-?sinatra$/i,
+           /^-?-?www$/i
+        require 'chemistry_paradise/sinatra/wetter/start_sinatra_interface.rb'
+        ChemistryParadise::Wetter.start_sinatra_interface
+      # ===================================================================== #
+      # === wetter --gtk3
+      # ===================================================================== #
+      when /^-?-?gtk3?$/i,
+           /^-?-?gui$/i # === wetter --gui
+        puts 'Starting the ruby-gtk3 wetter (aka "weather") application next.'
+        require 'chemistry_paradise/gui/gtk3/wetter/wetter.rb'
+        ChemistryParadise::GUI::Gtk::Wetter.run
+        exit
+      # ===================================================================== #
+      # === wetter --temperature-only
+      # ===================================================================== #
+      when /^-?-?temperature(-|_)?only$/i,
+           /^-?-?temperature\??$/i
+        puts Wetter.temperature?
+        exit
+      # ===================================================================== #
+      # === wetter --gtk2
+      # ===================================================================== #
+      when /^-?-?gtk2$/i
+        e 'Support for ruby-gtk2 has been removed in November 2021.'
+        e 'Please use the ruby-gtk3 variant instead.'
+        exit
+      else
+        Wetter.new(i)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.project_base_directory?
+  # ========================================================================= #
+  def self.project_base_directory?
+    "#{ChemistryParadise.project_base_directory?}wetter/"
+  end; self.instance_eval { alias project_base_dir? project_base_directory? } # === RBT.project_base_dir?
+       self.instance_eval { alias project_dir?      project_base_directory? } # === RBT.project_dir?
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ChemistryParadise.send(__method__)
+  end
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.current_degrees
+  #
+  # This method will simply return a Float number, the current temperature
+  # in Vienna by default.
+  #
+  # Usage examples:
+  #
+  #   ChemistryParadise::Wetter.current_degrees
+  #   ChemistryParadise::Wetter.simplified_current_degrees
+  #
+  # ========================================================================= #
+  def self.current_degrees
+    new { :be_silent }.match?.to_f
+  end; self.instance_eval { alias n_degrees_celsius?                   current_degrees } # === ChemistryParadise::Wetter.n_degrees_celsius?
+       self.instance_eval { alias temperature?                         current_degrees } # === ChemistryParadise::Wetter.temperature?
+       self.instance_eval { alias return_temperature                   current_degrees } # === ChemistryParadise::Wetter.return_temperature
+       self.instance_eval { alias return_current_temperature_in_vienna current_degrees } # === ChemistryParadise::Wetter.return_current_temperature_in_vienna
+       self.instance_eval { alias simplified_current_degrees           current_degrees } # === ChemistryParadise::Wetter.simplified_current_degrees
+       self.instance_eval { alias return_current_degrees               current_degrees } # === ChemistryParadise::Wetter.return_current_degrees
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === ChemistryParadise::Wetter.gtk3_widget
+  #
+  # Simpler toplevel-method to obtain a new gtk-widget instance for the
+  # wetter project. It will only work if the gtk3 code has been
+  # required prior to calling this method.
+  # ========================================================================= #
+  def self.gtk3_widget
+    ::Wetter::GUI::Wetter.gtk3_widget
+  end
+
+end
+
+# =========================================================================== #
+# === ChemistryParadise.simplified_current_degrees
+# =========================================================================== #
+def self.simplified_current_degrees
+  ChemistryParadise::Wetter.simplified_current_degrees
+end; self.instance_eval { alias current_temperature_in_vienna? simplified_current_degrees } # === ChemistryParadise.current_temperature_in_vienna?
+     self.instance_eval { alias n_degrees_celsius?             simplified_current_degrees } # === ChemistryParadise.n_degrees_celsius?
+     self.instance_eval { alias return_current_degrees         simplified_current_degrees } # === ChemistryParadise.return_current_degrees
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  ChemistryParadise::Wetter.new(ARGV)
+  e ChemistryParadise.project_base_dir?
+  e ChemistryParadise::Wetter.project_base_dir?
+  e 'Are we on roebe: '+ChemistryParadise::Wetter.is_on_roebe?.to_s
+  # rb wetter.rb --help
+end # wetterrb

data/lib/chemistry_paradise/www/wetter/embeddable_interface.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ChemistryParadise::Wetter::EmbeddableInterface
+#
+# The code in this file can be used to "embed" the functionality of
+# Wetter in web-applications, in particular in sinatra.
+#
+# This depends on the cyberweb project.
+# =========================================================================== #
+# require 'chemistry_paradise/www/www/embeddable_interface.rb'
+# include ChemistryParadise/Wetter::EmbeddableInterface
+# =========================================================================== #
+require 'chemistry_paradise/base/base.rb'
+
+module ChemistryParadise
+
+class Wetter < ::ChemistryParadise::Base # === ChemistryParadise::Wetter
+
+module EmbeddableInterface # === Wetter::EmbeddableInterface
+
+  require 'chemistry_paradise/wetter/wetter.rb'
+
+  begin
+    require 'html_tags'
+    include HtmlTags::BaseModule
+  rescue LoadError; end
+
+  begin
+    require 'cyberweb/sinatra/custom_extensions.rb'
+    include Cyberweb::Sinatra::CustomExtensions
+  rescue LoadError; end
+
+  begin
+    require 'cyberweb/html_template/html_template.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === return_root_string
+  # ========================================================================= #
+  def return_root_string
+    current_temperature = ChemistryParadise.n_degrees_celsius?.to_s.dup
+    append_this = ''.dup
+    if current_temperature.to_f > 12
+      append_this << '°C</b><br><style>'+
+                     Cyberweb.return_css_for_sunny_weather+
+                     "</style>\n"+
+                     '<div class="weather_container"><div class="weather_sunny"></div></div>'
+    else
+      append_this << '°C</b><br>'
+    end
+    Cyberweb::HtmlTemplate[
+      title: 'The weather/temperature in Vienna',
+      body:  div('The current temperature in Vienna is: <br><br>'\
+             '<b style="padding:1em; margin:0.5em; font-size: larger">'+
+             current_temperature+
+             append_this,'','',
+             'font-size: 1.8em'
+      )
+    ].to_s
+  end
+
+end; end
+
+# =========================================================================== #
+# === ChemistryParadise::Wetter.embeddable_interface
+#
+# This method can be used to "embed" a fake-object that implements the
+# module defined above.
+# =========================================================================== #
+def self.embeddable_interface
+  object = Object.new
+  object.extend(ChemistryParadise::Wetter::EmbeddableInterface)
+  return object
+end
+
+end

data/lib/chemistry_paradise/www/wetter/wetter.cgi

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/chemistry_paradise/lib/chemistry_paradise/www/wetter/wetter.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'chemistry_paradise/wetter/wetter.rb'
+
+german('Wetter') {
+created_on '27.07.2022' # Wednesday.
+autoextend
+ruby_favicon
+default_template Cyberweb.return_css_for_sunny_weather
+body_css_class 'mar0px pad0px VERDANAs'
+font_size '1.2em'
+
+doc('mar0px pad0px s0_6em') {
+  h1 dot(106, 'marr8px')+
+     'Wetter',
+     'mart1px marb0_5em'
+  current_temperature = ChemistryParadise.n_degrees_celsius?.to_s.dup
+  div {
+    e 'The current temperature is: <b>'+
+      current_temperature.to_s+'</b>'
+  }
+  ee '<div class="weather_container"><div class="weather_sunny"></div></div>'
+}}