html_tags 0.1.120

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d94c80b6faf2a9ce84bc5d028e244e3690369b19bf5be86bdad272195bea60d0
+  data.tar.gz: fad073d362656d9d3648e5436d54506a56ff5ecbaabdc7d97389144dd9ec8125
+SHA512:
+  metadata.gz: 0a7b1adc827a08965a73d1c7e572dca9fe368fdb7073b658d641e6317113b0b059c0fb89988026b0be415cd341d1ae11e1259af2aaa9ca07093872f76220b11f
+  data.tar.gz: 7fe499252e1c779313d2f30a743759aba2ba1127ddfd37870e22d5cf86e5ddada70a19c2ddc7c6c9b439256c56c2aafe3d29537f1792e9d697c58b8261831fbc

data/README.md

@@ -0,0 +1,110 @@
+
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">02.10.2022</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">03:21:22</span> o'clock.
+
+## New ideas (playground)
+
+We could replace:
+
+    <button onclick="show_source()">Click me</button>
+
+With:
+
+    button.text('Click me').onclick('show_source')
+
+This is currently not implemented, though. Need to think
+more about it first.
+
+## Using HTML headers
+
+The following example shows how to use the h1 tag:
+
+    HtmlTags.h1('Hello world!') # => "<h1>\nHello world!\n</h1>"
+
+You can include the module HtmlTags. Then you can just type h1().
+
+Another example:
+
+    puts HtmlTags.div("Hello, #{name}") # => <div>Hello, 2</div>
+
+## HtmlTags.a
+
+The HTML a tag is for hyperlinks; typically it contains a 
+**href** entry.
+
+You can pass a Hash, too, including a few supported
+JavaScript functions.
+
+Example for the latter:
+
+    onclick: 'change_the_colour_to()'
+
+Note that you still have to write the function somewhere and pull it
+into the .html file (or .cgi file or whatever else you are using).
+I added support for this in October 2021, as I needed to have clickable
+links that change colour upon being clicked. I used that to memorize
+which links I clicked, without having to depend on CSS.
+
+## Objectified HTML Tags
+
+This is mostly for clarification. An objectified HTML tag is
+a HTML tag that can be used like an object.
+
+Example:
+
+    Span.new('Hello world!') # => <span>Hello world!</span>
+
+The html_tags gem currently does not support this, but support for this
+may be added in the future, depending on whether that use case turns
+out to be sufficiently useful.
+
+## How to use HtmLTags.a()
+
+Usage example:
+
+    HtmlTags.a(
+      remote_url: remote_url,
+      text: title?.to_s,
+      css_style: 'font-weight: bold; color: darkblue'
+    )
+
+
+## Contact information and mandatory 2FA coming up in 2022
+
+If your creative mind has ideas and specific suggestions to make this gem
+more useful in general, feel free to drop me an email at any time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In order to limit this
+explanation here, allow me to just briefly state that I do not feel as if I
+want to promote any Google service anymore, for various reasons.
+
+Do keep in mind that responding to emails may take some time, depending on
+the amount of work I may have at that moment.
+
+In 2022 rubygems.org decided to make 2FA mandatory for every gem owner:
+see https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
+
+As I can not use 2FA, for reasons I will skip explaining here (see
+various github issue discussions in the past), this effectively means that
+Betty Li and others who run the show at rubygems.org will perma-ban me
+from using rubygems as a developer.
+
+As I disagree with that decision completely, this will mean that all my
+gems will be removed from rubygems.org prior to that sunset date, e. g.
+before they permanently lock me out from the code that I used
+to maintain. It is pointless to want to discuss this with them anymore -
+they have made up their minds and decided that you can only use
+the code if 2FA is in place, even though the code itself works just
+fine. If you don't use 2FA you are effectively locked out from your
+own code; I consider this a malicious attack. See also how they limited
+discussions to people with mandatory 2FA on the ruby-bugtracker, thus
+banning everyone permanently without 2FA:  
+
+https://bugs.ruby-lang.org/issues/18800
+
+Guess it may indeed be time to finally abandon ruby - not because
+ruby is a bad language, but there are people now in charge who
+really should not be part of ruby in the first place.
+

data/USAGE.md

@@ -0,0 +1,17 @@
+= Usage of this Library
+
+== Requiring it
+
+  require 'html_tags'
+
+== Using it in a project
+
+  puts HtmlTags.is_valid_html? '<br>'
+  puts HtmlTags.is_valid_html? '<div>'
+  puts HtmlTags.is_valid_html? '<dav>'
+  puts HtmlTags.string_contains_only_valid_html_tags? 'hello ruby </br>'
+  puts HtmlTags.string_contains_only_valid_html_tags? 'hello ruby<haha>'
+
+  include HtmlTags # Or simply include it, but be careful with this.
+
+  p 'hi there' # This now works - it has however redefined p().

data/doc/README.gen

@@ -0,0 +1,69 @@
+ADD_TIME_STAMP
+
+## New ideas (playground)
+
+We could replace:
+
+    <button onclick="show_source()">Click me</button>
+
+With:
+
+    button.text('Click me').onclick('show_source')
+
+This is currently not implemented, though. Need to think
+more about it first.
+
+## Using HTML headers
+
+The following example shows how to use the h1 tag:
+
+    HtmlTags.h1('Hello world!') # => "<h1>\nHello world!\n</h1>"
+
+You can include the module HtmlTags. Then you can just type h1().
+
+Another example:
+
+    puts HtmlTags.div("Hello, #{name}") # => <div>Hello, 2</div>
+
+## HtmlTags.a
+
+The HTML a tag is for hyperlinks; typically it contains a 
+**href** entry.
+
+You can pass a Hash, too, including a few supported
+JavaScript functions.
+
+Example for the latter:
+
+    onclick: 'change_the_colour_to()'
+
+Note that you still have to write the function somewhere and pull it
+into the .html file (or .cgi file or whatever else you are using).
+I added support for this in October 2021, as I needed to have clickable
+links that change colour upon being clicked. I used that to memorize
+which links I clicked, without having to depend on CSS.
+
+## Objectified HTML Tags
+
+This is mostly for clarification. An objectified HTML tag is
+a HTML tag that can be used like an object.
+
+Example:
+
+    Span.new('Hello world!') # => <span>Hello world!</span>
+
+The html_tags gem currently does not support this, but support for this
+may be added in the future, depending on whether that use case turns
+out to be sufficiently useful.
+
+## How to use HtmLTags.a()
+
+Usage example:
+
+    HtmlTags.a(
+      remote_url: remote_url,
+      text: title?.to_s,
+      css_style: 'font-weight: bold; color: darkblue'
+    )
+
+ADD_EMAIL

data/html_tags.gemspec

@@ -0,0 +1,53 @@
+# =========================================================================== #
+# Gemspec for Project HtmlTags.
+# =========================================================================== #
+require 'html_tags/version/version.rb'
+require 'roebe/toplevel_methods/misc.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'html_tags'
+  s.version = HtmlTags::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+    This library is called html_tags.
+
+    Its basic core idea is to collect all valid html tags into
+    a single project, and then make this data available to other
+    projects.
+
+    Other ideas are to autogenerate closing tags (helper
+    methods), and of course to generate string representations
+    of these html tags. This can then be used by other 
+    web-projects.
+
+    A simple usage example follows:
+
+      require 'html_tags'
+      HtmlTags.p 'hello world!' # => "<p>\nhello world!\n</p>"
+
+    Since Version 0.0.10 (April 2014) we can also now query
+    whether a string contains only valid HTML tags or whether
+    it does not.
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.extra_rdoc_files = %w()
+
+  s.authors   = ['Robert A. Heiler']
+  s.email     = Roebe.email?
+  s.files     = Dir['**/*']
+  s.files    << 'USAGE.md'
+  s.license   = 'MIT'
+  s.homepage  = 'https://rubygems.org/gems/html_tags'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/lib/html_tags/array_registered_html_tags.rb

@@ -0,0 +1,125 @@
+module HtmlTags # require 'html_tags/array_registered_html_tags.rb'
+
+  # ========================================================================= #
+  # === ARRAY_REGISTERED_HTML_TAGS
+  #
+  # Please also add to this array whenever you add a new html tag.
+  #
+  # Sort alphabetically.
+  #
+  # For references, look at the periodic table for HTML tags to find out
+  # which ones are available:
+  #
+  #     https://developer.mozilla.org/en-US/docs/Web/HTML/Element
+  #     https://developer.mozilla.org/de/docs/Web/HTML/Element
+  #
+  # In January 2014 it stated that 107 Elements are known. However, the
+  # mozilla reference in March 2015 listed 136 HTML elements.
+  #
+  # <b> is no longer valid in HTML5 it seems.
+  # ========================================================================= #
+  ARRAY_REGISTERED_HTML_TAGS = %w(
+
+a
+abbr
+audio
+
+b
+blockquote
+body
+br
+button
+
+canvas
+
+div
+dd
+dl
+dt
+
+fieldset
+figure
+form
+
+head
+html
+h1
+h2
+h3
+h4
+h5
+h6
+hr
+
+i
+img
+input
+
+label
+legend
+li
+
+nav
+
+object
+
+p
+pre
+
+q
+
+strong
+style
+
+table
+tbody
+td
+textarea
+th
+thead
+tr
+
+ul
+
+  )#+ # The following elements I did not yet think about much at all
+      # We may add these one after the other eventually though.
+   # %w(
+   #   html head span title # meta rt base rp link noscript
+   #   style script dfn abbr q cite em time var samp i b
+   #   sub sup small strong mark ruby ins del bdi bdo s
+   #   kbd wbr code br hr figcaption figure p ol ul li
+   #   div pre blockquote fieldset metr legend
+   #   label input textarea form select opgroup option
+   #   output button body aside address datalist keygen
+   #   progress h1 h2 h3 h4 h5 h6 section header nav
+   #   article footer hgroup col colgroup caption menu
+   #   command summary details table tr td th tbody thead
+   #   tfoot img area map embed object param source iframe
+   #   canvas track audio video
+   #)
+
+  # ========================================================================= #
+  # === ARRAY_TAGS_WITHOUT_CLOSING_TAG
+  #
+  # The following array keeps track of which tags have no closing tag.
+  # Please sort alphabetically.
+  # ========================================================================= #
+  # The <img> tag is no longer a part of the above Array since as
+  # of June 2016.
+  # ========================================================================= #
+  ARRAY_TAGS_WITHOUT_CLOSING_TAG = %w(
+
+    br
+
+  )
+
+  # ========================================================================= #
+  # === registered_html_tags?
+  #
+  # Feedback all registered HTML tags next.
+  # ========================================================================= #
+  def registered_html_tags?
+    Kernel.p ARRAY_REGISTERED_HTML_TAGS 
+  end
+
+end

data/lib/html_tags/autoinclude.rb

@@ -0,0 +1,2 @@
+require 'html_tags'
+include HtmlTags

data/lib/html_tags/autoinclude_base_module.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'html_tags'
+
+include HtmlTags::BaseModule

data/lib/html_tags/base/README.md

@@ -0,0 +1,3 @@
+Code in this directory can be used to subclass from a HtmlTags::Base
+class that may allow you to make use of the registered html-tags in
+this project.

data/lib/html_tags/base/base.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/base/base.rb'
+# =========================================================================== #
+module HtmlTags
+
+class Base
+
+end; end

data/lib/html_tags/base/base_module.rb

@@ -0,0 +1,224 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Note that not necessarily every HTML tag will be made available in
+# HtmlTags::BaseModule for the time being. For now I will only add
+# tags that I commonly need to re-use in other projects. In the long
+# run, I may just batch-generate the required tags, though. (28.04.2019)
+# =========================================================================== #
+# require 'html_tags/base/base_module.rb'
+# include HtmlTags::BaseModule
+# =========================================================================== #
+require 'html_tags/individual_tags/a.rb'
+require 'html_tags/individual_tags/div.rb'
+require 'html_tags/individual_tags/form.rb'
+require 'html_tags/individual_tags/li.rb'
+require 'html_tags/individual_tags/h1.rb'
+require 'html_tags/individual_tags/h2.rb'
+require 'html_tags/individual_tags/h3.rb'
+require 'html_tags/individual_tags/h4.rb'
+require 'html_tags/individual_tags/h5.rb'
+require 'html_tags/individual_tags/h6.rb'
+require 'html_tags/individual_tags/html.rb'
+require 'html_tags/individual_tags/ol.rb'
+require 'html_tags/individual_tags/p.rb'
+require 'html_tags/individual_tags/pre.rb'
+
+module HtmlTags
+
+module BaseModule # === HtmlTags::BaseModule
+
+  # ========================================================================= #
+  # === HtmlTags::BaseModule.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+  # ========================================================================= #
+  # === pre
+  # ========================================================================= #
+  def pre(
+      i = '', css_class = '', the_id = '', css_style = '', &block
+    )
+    HtmlTags.pre(
+      i, css_class, the_id, css_style, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === li                                                           (li tag)
+  # ========================================================================= #
+  def li(
+      i = '', optional_css_class = '', optional_id = '', optional_css_style = '', &block
+    )
+    HtmlTags.li(
+      i, optional_css_class, optional_id, optional_css_style, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === ol                                                           (ol tag)
+  # ========================================================================= #
+  def ol(
+      i = '', optional_css_class = '', optional_id = '', optional_css_style = '', &block
+    )
+    HtmlTags.ol(
+      i, optional_css_class, optional_id, optional_css_style, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h1
+  # ========================================================================= #
+  def h1(
+      i = '', css_class = '', the_id = '', css_style = '', javascript_code = '', &block
+    )
+    HtmlTags.h1(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h2
+  # ========================================================================= #
+  def h2(
+      i               = '',
+      css_class       = '',
+      the_id          = '',
+      css_style       = '',
+      javascript_code = '',
+      &block
+    )
+    HtmlTags.h2(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h3
+  # ========================================================================= #
+  def h3(
+      i = '', css_class = '', the_id = '', css_style = '', javascript_code = '', &block
+    )
+    HtmlTags.h3(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h4
+  # ========================================================================= #
+  def h4(
+      i = '', css_class = '', the_id = '', css_style = '', javascript_code = '', &block
+    )
+    HtmlTags.h4(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h5
+  # ========================================================================= #
+  def h5(
+      i = '', css_class = '', the_id = '', css_style = '', javascript_code = '', &block
+    )
+    HtmlTags.h5(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === h6
+  # ========================================================================= #
+  def h6(
+      i = '', css_class = '', the_id = '', css_style = '', javascript_code = '', &block
+    )
+    HtmlTags.h6(
+      i, css_class, the_id, css_style, javascript_code, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === p
+  #
+  # This method can be used to create the html <p> tag.
+  # ========================================================================= #
+  def p(
+      i         = '',
+      css_class = '',
+      the_id    = '',
+      css_style = '',
+      &block
+    )
+    HtmlTags.p(i, css_class, the_id, css_style, &block)
+  end
+
+  # ========================================================================= #
+  # === div
+  #
+  # This method can be used to create the html <div> tag.
+  # ========================================================================= #
+  def div(
+      i         = '',
+      css_class = '',
+      the_id    = '',
+      css_style = '',
+      &block
+    )
+    HtmlTags.div(i, css_class, the_id, css_style, &block)
+  end
+
+  # ========================================================================= #
+  # === a                                                             (a tag)
+  # ========================================================================= #
+  def a(
+      i          = '',
+      css_class  = '',
+      the_id     = '',
+      css_style  = '',
+      javascript = '',
+      &block
+    )
+    HtmlTags.a(
+      i, css_class, the_id, css_style, javascript, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === form                                                       (form tag)
+  # ========================================================================= #
+  def form(
+      i          = '',
+      css_class  = '',
+      the_id     = '',
+      css_style  = '',
+      &block
+    )
+    HtmlTags.form(
+      i, css_class, the_id, css_style, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === br
+  # ========================================================================= #
+  def br
+    HtmlTags.br
+  end
+
+  # ========================================================================= #
+  # === html
+  # ========================================================================= #
+  def html(
+      i               = '',
+      css_class       = '',
+      the_id          = '',
+      css_style       = '',
+      &block
+    )
+    HtmlTags.html(i, css_class, the_id, css_style, &block)
+  end
+
+end; end

data/lib/html_tags/base/prototype.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/base/prototype.rb'
+# =========================================================================== #
+require 'html_tags/base/base.rb'
+require 'html_tags/constants/misc.rb'
+
+module HtmlTags
+
+  # ========================================================================= #
+  # === HtmlTags.new
+  # ========================================================================= #
+  def self.new
+    HtmlTags::Base.new
+  end
+
+end