html_tags 0.1.120

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.120'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '02.10.2022'
+
+end

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:
+#
+#   http://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

data/test/testing_the_a_tag.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'html_tags'
+require 'colours/colours_e_autoinclude.rb'
+
+@index = 0
+# =========================================================================== #
+# === esb
+#
+# This will also increment a counter automatically.
+# =========================================================================== #
+def esb(i)
+  @index += 1
+  e royalblue(@index.to_s+') ')+
+    steelblue(i)
+end
+
+# =========================================================================== #
+# === pad_yellow
+# =========================================================================== #
+def pad_yellow(i)
+  e '  '+
+    yellowgreen(i.to_s)
+end
+
+e
+esb "Testing the HtmlTags.a() tag next - first via :content, "\
+    "then also with \n:css_class in the second run:"
+e
+pad_yellow HtmlTags.a(
+  'https://de.wikipedia.org/wiki/Lampensockel#Edisonsockel',
+  content: 'SELF'
+)
+e
+pad_yellow HtmlTags.a(
+  [
+    'https://de.wikipedia.org/wiki/Lampensockel#Edisonsockel',
+    {content:'SELF', css_class:'mars2em'}
+  ]
+)
+# =========================================================================== #
+# === 2
+# =========================================================================== #
+e
+esb 'Next testing the html tag <a> via the symbol :br meaning <br>:'
+e
+pad_yellow HtmlTags.a(
+  'https://de.wikipedia.org/wiki/Lampensockel#Edisonsockel',
+  'SELF',
+  :make_newline
+)
+# =========================================================================== #
+# === 3
+# =========================================================================== #
+e
+esb 'Next testing it with a String as first argument, and a Hash '\
+  'as the second argument:'
+e
+pad_yellow HtmlTags.a('https://geizhals.at/?cat=hhleuchtled&xf=1299_G9',
+  content: 'G9 Sockel auf geizhals.at'
+)
+e
+
+# =========================================================================== #
+# === 4
+# =========================================================================== #
+e
+esb 'Next testing css_style: as the second argument:'
+e
+pad_yellow HtmlTags.a(
+  'https://rubygems.org/gems/ansi/',
+  css_style: 'margin-left:1em'
+)
+e
+
+# =========================================================================== #
+# === 5
+# =========================================================================== #
+e
+esb 'Next testing a Hash:'
+e
+pad_yellow HtmlTags.a(
+  content: 'https://en.wikipedia.org/wiki/Bacteriochlorophyll',
+  description: 'SELF'
+)
+e
+
+# =========================================================================== #
+# === 6
+# =========================================================================== #
+e
+esb 'Next testing another Hash with :link_description:'
+e
+pad_yellow HtmlTags.a(
+  'https://en.wikipedia.org/wiki/Bacteriochlorophyll',
+  link_description: 'yo there',
+  description: 'SELF'
+)
+e
+
+# =========================================================================== #
+# === 7
+# =========================================================================== #
+e
+esb 'Next testing with →'
+e
+pad_yellow HtmlTags.a(
+  '→ https://en.wikipedia.org/wiki/Bacteriochlorophyll',
+  :self
+)
+e

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: html_tags
+version: !ruby/object:Gem::Version
+  version: 0.1.120
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-02 00:00:00.000000000 Z
+dependencies: []
+description: "\n    This library is called html_tags.\n\n    Its basic core idea is
+  to collect all valid html tags into\n    a single project, and then make this data
+  available to other\n    projects.\n\n    Other ideas are to autogenerate closing
+  tags (helper\n    methods), and of course to generate string representations\n    of
+  these html tags. This can then be used by other \n    web-projects.\n\n    A simple
+  usage example follows:\n\n      require 'html_tags'\n      HtmlTags.p 'hello world!'
+  # => \"<p>\nhello world!\n</p>\"\n\n    Since Version 0.0.10 (April 2014) we can
+  also now query\n    whether a string contains only valid HTML tags or whether\n
+  \   it does not.\n\n"
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- USAGE.md
+- doc/README.gen
+- html_tags.gemspec
+- lib/html_tags.rb
+- lib/html_tags/array_registered_html_tags.rb
+- lib/html_tags/autoinclude.rb
+- lib/html_tags/autoinclude_base_module.rb
+- lib/html_tags/base/README.md
+- lib/html_tags/base/base.rb
+- lib/html_tags/base/base_module.rb
+- lib/html_tags/base/prototype.rb
+- lib/html_tags/checks.rb
+- lib/html_tags/closing_tag/closing_tag.rb
+- lib/html_tags/constants.rb
+- lib/html_tags/constants/array_strip_newlines.rb
+- lib/html_tags/constants/misc.rb
+- lib/html_tags/html_closing_tags.rb
+- lib/html_tags/html_comment.rb
+- lib/html_tags/html_tags.rb
+- lib/html_tags/html_tags_constants.rb
+- lib/html_tags/individual_tags/a.rb
+- lib/html_tags/individual_tags/abbr.rb
+- lib/html_tags/individual_tags/audio.rb
+- lib/html_tags/individual_tags/b.rb
+- lib/html_tags/individual_tags/blockquote.rb
+- lib/html_tags/individual_tags/body.rb
+- lib/html_tags/individual_tags/br.rb
+- lib/html_tags/individual_tags/button.rb
+- lib/html_tags/individual_tags/canvas.rb
+- lib/html_tags/individual_tags/details.rb
+- lib/html_tags/individual_tags/div.rb
+- lib/html_tags/individual_tags/figure.rb
+- lib/html_tags/individual_tags/footer.rb
+- lib/html_tags/individual_tags/form.rb
+- lib/html_tags/individual_tags/h1.rb
+- lib/html_tags/individual_tags/h2.rb
+- lib/html_tags/individual_tags/h3.rb
+- lib/html_tags/individual_tags/h4.rb
+- lib/html_tags/individual_tags/h5.rb
+- lib/html_tags/individual_tags/h6.rb
+- lib/html_tags/individual_tags/head.rb
+- lib/html_tags/individual_tags/header.rb
+- lib/html_tags/individual_tags/html.rb
+- lib/html_tags/individual_tags/i.rb
+- lib/html_tags/individual_tags/img.rb
+- lib/html_tags/individual_tags/input.rb
+- lib/html_tags/individual_tags/label.rb
+- lib/html_tags/individual_tags/legend.rb
+- lib/html_tags/individual_tags/li.rb
+- lib/html_tags/individual_tags/main.rb
+- lib/html_tags/individual_tags/nav.rb
+- lib/html_tags/individual_tags/object.rb
+- lib/html_tags/individual_tags/ol.rb
+- lib/html_tags/individual_tags/p.rb
+- lib/html_tags/individual_tags/pre.rb
+- lib/html_tags/individual_tags/span.rb
+- lib/html_tags/individual_tags/strong.rb
+- lib/html_tags/individual_tags/style.rb
+- lib/html_tags/individual_tags/table.rb
+- lib/html_tags/individual_tags/tbody.rb
+- lib/html_tags/individual_tags/td.rb
+- lib/html_tags/individual_tags/textarea.rb
+- lib/html_tags/individual_tags/th.rb
+- lib/html_tags/individual_tags/thead.rb
+- lib/html_tags/individual_tags/title.rb
+- lib/html_tags/individual_tags/tr.rb
+- lib/html_tags/individual_tags/ul.rb
+- lib/html_tags/individual_tags/video.rb
+- lib/html_tags/module.rb
+- lib/html_tags/opening_tag/opening_tag.rb
+- lib/html_tags/project/project_base_directory.rb
+- lib/html_tags/requires/require_the_html_tags_project.rb
+- lib/html_tags/requires/require_the_img_tag.rb
+- lib/html_tags/shared.rb
+- lib/html_tags/stag.rb
+- lib/html_tags/toplevel_methods/add.rb
+- lib/html_tags/toplevel_methods/full_output.rb
+- lib/html_tags/toplevel_methods/newline_or_empty.rb
+- lib/html_tags/toplevel_methods/strip_newlines.rb
+- lib/html_tags/version/version.rb
+- lib/html_tags/yaml/valid_tags_in_a_head_tag.yml
+- test/testing_html_tags.rb
+- test/testing_the_a_tag.rb
+homepage: https://rubygems.org/gems/html_tags
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.7
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: '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> hello world! </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.'
+test_files: []