html_tags 0.1.183

data/lib/html_tags/requires/require_the_img_tag.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/requires/require_the_image_tag.rb'
+# =========================================================================== #
+require 'html_tags/individual_tags/img.rb'

data/lib/html_tags/shared.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+require 'html_tags/checks.rb'
+require 'html_tags/toplevel_methods/newline_or_empty.rb'
+
+module HtmlTags # HtmlTags::Shared
+
+module Shared # require 'html_tags/shared.rb'
+
+  N = "\n"
+
+  # ========================================================================= #
+  # === beautify_string
+  #
+  # First run .squeeze(' '), then delete newlines, to make a string more
+  # beautiful.
+  # ========================================================================= #
+  def beautify_string(i)
+    i.squeeze(' ').delete("\n")
+  end
+
+end; end

data/lib/html_tags/stag.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module HtmlTags
+
+  # ========================================================================= #
+  # === stag
+  #
+  # This method returns a proper HTML tag, including css class, possible
+  # javascript, id, and css style, and then return this as a string.
+  #
+  # By default we will use the <span> tag, hence why we have assigned
+  # the default argument "span" as the first argument to this method.
+  #
+  # "stag" is an alias to this method, a shortcut for "string_tag".
+  #
+  # Note that stag() itself will not return the closing tag.
+  #
+  # Specific Usage Examples for this method:
+  #
+  #   HtmlTags.stag('span','marl1em')
+  #   puts HtmlTags.stag('span','','','margin-left:0.92em; padding-left:6px')
+  #
+  # Would return:
+  #
+  #   <span class="marl1em">
+  #
+  # ========================================================================= #
+  def stag(
+        name_of_the_tag     = 'span',
+        optional_css_class  = '',
+        optional_the_id     = '',
+        optional_css_style  = '',
+        optional_javascript = '',
+        &block
+      )
+    if optional_css_class.is_a? Hash
+      _ = otag(name_of_the_tag, optional_css_class) # otag() is defined in opening_tag.rb
+    else # We assume a string here.
+      optional_css_class = optional_css_class.to_s.chomp.dup
+      _ = otag(
+        name_of_the_tag,
+        css_class:  optional_css_class,
+        id:         optional_the_id,
+        css_style:  optional_css_style,
+        javascript: optional_javascript,
+        &block
+      )
+    end
+    _.to_s
+  end; alias string_tag stag # === string_tag
+
+end

data/lib/html_tags/toplevel_methods/add.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/toplevel_methods/add.rb'
+# =========================================================================== #
+module HtmlTags
+
+  require 'html_tags/toplevel_methods/full_output.rb'
+  # ========================================================================= #
+  # === HtmlTags.add                                                (add tag)
+  #
+  # Add to the main string called @full_output, which is a String.
+  # ========================================================================= #
+  def self.add(*i)
+    i.each {|entry|
+      @full_output << entry.to_s
+    }
+    i.join(' ').strip # Return the input. This is very important, naturally.
+  end
+
+end

data/lib/html_tags/toplevel_methods/full_output.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/toplevel_methods/full_output.rb'
+# =========================================================================== #
+module HtmlTags
+
+  # ========================================================================= #
+  # === @full_output
+  #
+  # The follow class-level instance variable stores all output from
+  # any of the various tags.
+  # ========================================================================= #
+  @full_output = ''.dup
+
+  # ========================================================================= #
+  # === HtmlTags[]
+  # ========================================================================= #
+  def self.[]
+    @full_output
+  end; self.instance_eval { alias output  [] } # Next, we use 3 aliases.
+       self.instance_eval { alias output? [] }
+       self.instance_eval { alias string? [] }
+
+  # ========================================================================= #
+  # === HtmlTags.clear
+  # ========================================================================= #
+  def self.clear
+    @full_output = ''
+  end
+
+end

data/lib/html_tags/toplevel_methods/newline_or_empty.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+# require 'html_tags/toplevel_methods/newline_or_empty.rb'
+# =========================================================================== #
+module HtmlTags
+
+  # ========================================================================= #
+  # === HtmlTags.newline_or_empty
+  #
+  # Either return a newline or return an empty string.
+  # ========================================================================= #
+  def self.newline_or_empty(make_newline = true)
+    if make_newline
+      "\n"
+    else
+      ''
+    end
+  end
+
+end

data/lib/html_tags/toplevel_methods/strip_newlines.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/toplevel_methods/strip_newlines.rb'
+# =========================================================================== #
+module HtmlTags
+
+  require 'html_tags/constants/array_strip_newlines.rb'
+
+  # ========================================================================= #
+  # === HtmlTags.strip_newlines
+  #
+  # We use this method to strip away "\n" newlines.
+  # ========================================================================= #
+  def self.strip_newlines
+    ARRAY_STRIP_NEWLINES[0] = true
+  end
+
+  # ========================================================================= #
+  # === HtmlTags.strip_newlines?
+  # ========================================================================= #
+  def self.strip_newlines?
+    ARRAY_STRIP_NEWLINES.first
+  end
+
+end

data/lib/html_tags/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module HtmlTags
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.1.183'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '19.02.2024'
+
+end

data/lib/html_tags/yaml/available_html_tags.yml

@@ -0,0 +1,135 @@
+# ============================================================================ #
+# Available HTML5 tags:
+#
+#   https://dev.to/flippedcoding/the-ultimate-html5-tag-list-4i2a
+#   https://www.w3.org/TR/2012/WD-html-markup-20121025/elements.html
+#   https://www.tutorialrepublic.com/html-reference/html5-tags.php
+#
+# ============================================================================ #
+
+# - !--...--
+# - !doctype
+- a
+- abbr
+# - acronym         # Not available in HTML5, so the html_tag gem will not support it.
+- address
+# - applet          # Not available in HTML5, so the html_tag gem will not support it.
+- area
+- article
+- aside
+- audio
+- b
+- base              # Not sure if this will be implemented by the html_tag gem.
+- basefont          # Not available in HTML5, so the html_tag gem will not support it.
+- bb                # Not available in HTML5, so the html_tag gem will not support it.
+- bdo               # bdo stands for "bi-directional override".
+- big               # Not available in HTML5, so the html_tag gem will not support it.
+- blockquote        # Supported by the html_tags gem.
+- body              # Supported by the html_tags gem.
+- br                #
+- button            # Supported by the html_tags gem.
+- canvas            # Supported by the html_tags gem.
+- caption           # Supported by the html_tags gem.
+- center
+- cite              # Supported by the html_tags gem.
+- code              # Supported by the html_tags gem.
+- col
+- colgroup
+- command
+- datagrid
+- datalist
+- dd
+- del               # Supported by the html_tags gem.
+- details           # Supported by the html_tags gem.
+- dfn
+- dialog            # Supported by the html_tags gem.
+# - dir             # This feature is no longer recommended. See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dir
+- div               # Supported by the html_tags gem.
+- dl
+- dt
+- em                # Supported by the html_tags gem.
+- embed             # This one does not seem that useful anymore.
+# - eventsource     # This tag was removed from HTML5, so the HtmlTags won't support it.
+- fieldset          # Supported by the html_tags gem.
+- figcaption
+- figure            # Supported by the html_tags gem.
+# - font            # NOT supported in HTML5.
+- footer            # Supported by the html_tags gem.
+- form              # Supported by the html_tags gem.
+# - frame           # NOT supported in HTML5.
+# - frameset        # The <frameset> tag was used in HTML4 to define a frameset. It is not part of HTML5. 
+- h1                # Supported by the html_tags gem.
+- h2                # Supported by the html_tags gem.
+- h3                # Supported by the html_tags gem.
+- h4                # Supported by the html_tags gem.
+- h5                # Supported by the html_tags gem.
+- h6                # Supported by the html_tags gem.
+- head              # Supported by the html_tags gem.
+- header            # Supported by the html_tags gem.
+- hgroup            # Supported by the html_tags gem.
+- hr                # Supported by the html_tags gem.
+- html              # Supported by the html_tags gem.
+- i                 # Supported by the html_tags gem.
+- iframe            # Supported by the html_tags gem.
+- img               # Supported by the html_tags gem.
+- input             # Supported by the html_tags gem.
+- ins               # Supported by the html_tags gem.
+# - isindex         # This has been removed from HTML5.
+- kbd               # Supported by the html_tags gem. The kbd element represents user input.
+- keygen            # Supported by the html_tags gem.
+- label             # Supported by the html_tags gem.
+- legend            # Supported by the html_tags gem.
+- li                # Supported by the html_tags gem.
+- link              # Supported by the html_tags gem.
+- map               # Supported by the html_tags gem.
+- mark              # Supported by the html_tags gem.
+- menu              # Supported by the html_tags gem.
+- meta
+- meter
+- nav
+- noframes
+- noscript
+- object            # Supported by the html_tags gem.
+- ol
+- optgroup
+- option
+- output
+- p
+- param
+- pre
+- progress          # Supported by the html_tags gem.
+- q
+- rp
+- rt
+- ruby
+- s
+- samp
+- script
+- section
+- select
+- small
+- source            # Supported by the html_tags gem.
+- span
+- strike
+- strong
+- style             # Supported by the html_tags gem.
+- sub
+- summary           # Supported by the html_tags gem.
+- sup               # Supported by the html_tags gem.
+- table             # Supported by the html_tags gem.
+- tbody
+- td
+- textarea          # Supported by the html_tags gem.
+- tfoot
+- th                # Supported by the html_tags gem.
+- thead             # Supported by the html_tags gem.
+- time              # Supported by the html_tags gem.
+- title             # Supported by the html_tags gem.
+- tr                # Supported by the html_tags gem.
+- track             # Supported by the html_tags gem.
+# - tt              # This is no longer valid as of HTML5.
+- u                 # Supported by the html_tags gem.
+- ul                # Supported by the html_tags gem.
+- var               # Supported by the html_tags gem.
+- video             # Supported by the html_tags gem.
+- wbr               # This is the "Word Break Opportunity" tag.

data/lib/html_tags/yaml/valid_tags_in_a_head_tag.yml

@@ -0,0 +1,16 @@
+# =========================================================================== #
+# The listing of allowed elements can be found here:
+#
+#   https://www.w3schools.com/tags/tag_head.asp
+#
+# Do note that in HTML5, the <head> element can be omitted.
+# =========================================================================== #
+# The following elements can go inside the <head> element:
+# =========================================================================== #
+- title # This element is required in an HTML document.
+- style
+- base
+- link
+- meta
+- script
+- noscript

data/lib/html_tags.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'html_tags/requires/require_the_html_tags_project.rb'

data/test/testing_html_tags.rb

@@ -0,0 +1,158 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+require 'cliner/autoinclude' # Make the Cliner module known automatically.
+require 'colours/autoinclude'
+require 'beautiful_url'
+require 'html_tags'
+begin
+  require 'colours'
+rescue LoadError; end
+N = "\n"
+Cliner.set_colour 'lightblue'
+
+# =========================================================================== #
+# === _
+#
+# Simply colourize the input in a blue colour.
+# =========================================================================== #
+def _(i)
+  if Object.const_defined? :Colours
+    Colours.slateblue(i)
+  else
+    bold_blue(i)
+  end
+end
+
+# =========================================================================== #
+# === orange
+# =========================================================================== #
+def orange(i)
+  Colours.orange(i.chomp)
+end
+cliner {
+  e _('Testing some closing tags next (note that '+
+    'we will keep trailing newlines:')
+  e HtmlTags.close 'p'
+  e HtmlTags.close 'div'
+  e 'Finished testing closing tags.'
+}; e
+# =========================================================================== #
+# Include the HtmlTags namespace next.
+# =========================================================================== #
+include HtmlTags
+cliner { # Test <p> paragraph next.
+  e _('Next testing some <p> paragraphs:')
+  e p 'Hello World', :css_style => 'border: 1px solid red'
+}
+
+
+puts Colours.beautiful 'lightblue'
+Cliner.set_colour 'lightblue'
+
+# =========================================================================== #
+# Next display all registered HTML tags:
+# =========================================================================== #
+e _('Registered Tags:')
+registered_html_tags?
+e p 'Good Bye', :css_class => 'border: 1px solid red',
+                :id        => 'goodbye'
+e; e
+
+e 'Next, we test the String Good Bye, with a css class and an id.'
+e p 'Good Bye', :css_class => 'border: 1px solid red',
+                :id        => 'goodbye'
+e
+# =========================================================================== #
+# Next, we will test the <a> tag.
+# =========================================================================== #
+cliner {
+  e _('Next we will test the <a> tag in various combinations.')
+  e orange(a('connect'))
+  e orange(a('connect', :no_newline))
+  e orange(a('connect', :make_newline))
+  e orange(a('LINUX_DESIGNING.cgi', :copy_description))
+  e orange(a('connect', 'marl1em','great_link','color: blue'))
+  e orange(a('/test', :description => 'Link to test'))
+  e orange(a('/test', css_style: 'margin-left:1em'))
+}
+
+e N+N+_('Next testing the <tbody> tag.')
+e HtmlTags.tbody 'testing','this'
+e N+N+_('Now testing the output of the BR tag:')
+e HtmlTags::BR
+e N+N+_('Next, we try to find out whether ch4() works:')
+e ch4.lstrip
+e N+N+_('Next, testing whether cbody() and chtml() works:')
+e orange(cbody+chtml)
+pp cbody+chtml
+HtmlTags.strip_newlines
+e cbody+chtml
+pp cbody+chtml
+e N+N+_('Next checking whether <hr> and <bb> are valid HTML tags:')
+e is_valid_html? '<hr>'
+e is_valid_html? '<bb>'
+e N+N+_('Next testing the method stag() for capturing HTML tags as strings:')
+e stag('span', 'padl1em')
+cliner {
+  e N+_('Next testing comments in .html files:')
+  e HtmlTags.html_comment('This is a comment.')
+}
+e N+_('Next testing <span> with a hash as second argument:')+N+N
+e span('wget', :css_style => 'margin-left:2em')
+e orange(HtmlTags.stag('h3', :javascript => 'on-click: { this.color = "blue" }'))
+e orange(HtmlTags.stag('h2', 'ud mart10px'))
+cliner
+e N+N+_('Next, we will test whether we can use button() combined with blocks:')+N+N
+e orange(button('Click me!', 'pad1em', 'yo', '', :on_click => 'go back in history'))
+e orange(HtmlTags.link 'http://google.com')
+e orange(HtmlTags.link 'http://google.com', :desc => 'Google')
+# x = HtmlTags.stag( :button, 'pad1em', 'yo', '', :on_click => 'go back in history') {{ :value => 'yo man' }}
+e orange(stag 'h3', id: 'yo')
+e orange(stag 'h3', id: 'yo', css_class: 'ok')
+e orange(stag 'h3', id: 'yo', css_class: 'blue', css_style: 'margin:5em')
+e orange(stag 'h3', id: 'yo', css_class: 'blue', css_style: 'margin:5em', content: 'yo there')
+e orange(h3 'oki doki', id: 'hmm')
+e 'We will next test the storage-functionality of HtmlTags:'
+e 'First we clear the old entries.'
+HtmlTags.clear
+e
+e 'Now we run three <h2> statements.'
+h2 'Test'
+h2 'Yo'
+h2 'Hello world!'
+e 'Next we show these:'
+e orange(HtmlTags[])
+e 'Now we clear it again. Then we run HtmlTags.clear'
+HtmlTags.clear
+e orange(HtmlTags.add 'hello', 'world!')
+e orange(HtmlTags.add 'hello')
+e 'Now we will check whether the 3 following HTML Tags are valid within a <head> element:'
+e orange('p: ')+is_this_an_allowed_tag_in_head_element?('p').to_s
+e orange('<div>: ')+is_this_an_allowed_tag_in_head_element?('<div>').to_s
+e orange('<base>: ')+is_this_an_allowed_tag_in_head_element?('<base>').to_s
+e
+e "Next we will test: HtmlTags.a('google.com','Go to Google') {{ description: 'yo there' }}"
+e
+e '  '+orange(HtmlTags.a('google.com','s1em') {{ description: 'yo there' }}).delete(N)
+e
+cliner
+e 'Next we will test '+orange('label()')+':'
+e
+e HtmlTags.label 'John Doe'
+e
+cliner
+e h2('Showing the axe-icon next', 'marl1em','','',
+     'on_click: show_image(:axe))') # Last one is javascript.
+cliner
+e 'Next testing:'
+e "HtmlTags.a(BeautifulUrl[:my_gems], description: 'my gems')"
+e HtmlTags.a(BeautifulUrl[:my_gems], description: 'my gems')
+cliner
+e 'HtmlTags.h2(text, css_class, the_id, css_style, javascript)'
+e HtmlTags.h2('Hello world!','mars1em','','','onmouseover="this.style.textDecoration=\'underline\';"')
+cliner
+e 'Next testing the HtmlTags.img() tag:'
+e "HtmlTags.img('foobar.png')"
+e HtmlTags.img('foobar.png')
+# ttags