html_tags 0.1.183

data/lib/html_tags/base/base_module.rb

@@ -0,0 +1,271 @@
+#!/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
+# =========================================================================== #
+module HtmlTags
+
+module BaseModule # === 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'
+
+  # ========================================================================= #
+  # === 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'
+# =========================================================================== #
+module HtmlTags
+
+  require 'html_tags/base/base.rb'
+  require 'html_tags/constants/misc.rb'
+
+  # ========================================================================= #
+  # === HtmlTags.new
+  # ========================================================================= #
+  def self.new
+    HtmlTags::Base.new
+  end
+
+end

data/lib/html_tags/checks.rb

@@ -0,0 +1,58 @@
+require 'html_tags/array_registered_html_tags.rb'
+
+module HtmlTags # require 'html_tags/checks.rb' 
+
+  # ========================================================================= #
+  # === is_valid_html?
+  #
+  # This method will check whether the given input is a valid html tag
+  # or whether it is not. It will delegate towards the class method
+  # HtmlTags.is_valid_html?
+  # ========================================================================= #
+  def is_valid_html?(i = '</br>')
+    return HtmlTags.is_valid_html? i
+  end; alias is_valid?          is_valid_html?
+       alias is_valid_html_tag? is_valid_html?
+
+  # ========================================================================= #
+  # === HtmlTags.is_valid_html?
+  #
+  # This is the real method that does the check.
+  # ========================================================================= #
+  def self.is_valid_html?(i)
+    i = i.delete('<')
+    i = i.delete('>')
+    i = i.delete('/')
+    return ARRAY_REGISTERED_HTML_TAGS.include? i
+  end
+
+  # ========================================================================= #
+  # === HtmlTags.string_contains_only_valid_html_tags?
+  #
+  # This method will test if a whole string will have only valid html
+  # tags. 
+  # ========================================================================= #
+  def self.string_contains_only_valid_html_tags?(i)
+    all_matches = i.scan(/\<.+\>/)
+    return all_matches.all? {|entry| is_valid_html? entry }
+  end
+
+  # ========================================================================= #
+  # === string_contains_only_valid_html_tags?(i)
+  # ========================================================================= #
+  def string_contains_only_valid_html_tags?(i)
+    return HtmlTags.string_contains_only_valid_html_tags?(i)
+  end
+
+end
+
+# =========================================================================== #
+# Here we test the above.
+# =========================================================================== #
+if __FILE__ == $PROGRAM_NAME
+  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>'
+end # rb checks.rb

data/lib/html_tags/closing_tag/closing_tag.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/closing_tag/closing_tag.rb'
+# =========================================================================== #
+module HtmlTags
+
+  require 'html_tags/toplevel_methods/strip_newlines.rb'
+  # ========================================================================= #
+  # === HtmlTags.close
+  #
+  # This method creates the closing tag. It will return that tag as
+  # a string.
+  #
+  # This method also accepts a block, which can be a hash that could
+  # have keys such as { :make_newline => true }.
+  #
+  # Usage example:
+  #
+  #   HtmlTags.close('span')
+  #
+  # ========================================================================= #
+  def self.close(i, &block)
+    append_newline = true
+    # ======================================================================= #
+    # If we strip newlines, then we won't append them logically.
+    # ======================================================================= #
+    append_newline = false if HtmlTags.strip_newlines?
+    i = i.to_s.dup # It should remain a String.
+    # ======================================================================= #
+    # Next, sanitize some wrongful/shortcut tags here.
+    # ======================================================================= #
+    case i
+    when 'link'
+      i = 'a'
+    when 'field',
+         'mini_header'
+      i = 'fieldset'
+    end
+    end_string = ''.dup # This will be be appended.
+    # ======================================================================= #
+    # Intercept blocks passed to the method here.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield # Tap into the block.
+      if yielded.is_a? Hash
+        if yielded.has_key? :make_newline
+          end_string << br if yielded[:make_newline] == true
+        end
+      elsif yielded == :make_newline
+        end_string << br
+      elsif yielded == :no_newline
+        append_newline = false # Do not append a newline in this case here.
+      end
+    end
+    result = ''.dup
+    # result << "\n" if append_newline # This one was disabled in April 2022.
+    result << '</'+i.to_s.dup+'>'
+    result << "\n" if append_newline
+    result << end_string # This is the result we will return. A String.
+    return result
+  end
+
+  # ========================================================================= #
+  # === close                                                     (close tag)
+  #
+  # This is a wrapper towards HtmlTags.close(), which will close a
+  # given HTML tag.
+  # ========================================================================= #
+  def close(i, &block)
+    return HtmlTags.close(i, &block) # Delegate to the above class-method.
+  end; alias ctag close # === ctag
+       # alias c close <- Not sure about that alias yet.
+
+end

data/lib/html_tags/constants/array_strip_newlines.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/constants/array_strip_newlines.rb'
+# =========================================================================== #
+module HtmlTags 
+
+  # ========================================================================= #
+  # === HtmlTags::ARRAY_STRIP_NEWLINES
+  # ========================================================================= #
+  ARRAY_STRIP_NEWLINES = [false]
+
+end

data/lib/html_tags/constants/misc.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'html_tags/constants/misc.rb'
+# =========================================================================== #
+module HtmlTags
+
+  # ========================================================================= #
+  # === DOCTYPE_HTML
+  # ========================================================================= #
+  DOCTYPE_HTML = '<!DOCTYPE html>'
+
+  # ========================================================================= #
+  # === HtmlTags.doctype_html
+  # ========================================================================= #
+  def self.doctype_html
+    DOCTYPE_HTML
+  end
+
+end

data/lib/html_tags/constants.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'yaml'
+require 'html_tags/project/project_base_directory.rb'
+
+module HtmlTags
+
+  # ========================================================================= #
+  # === FILE_VALID_TAGS_IN_A_HEAD_TAG
+  #
+  # This specifies the path to a yaml-file that keeps an Array.
+  # ========================================================================= #
+  FILE_VALID_TAGS_IN_A_HEAD_TAG = "#{PROJECT_YAML_DIR}valid_tags_in_a_head_tag.yml"
+
+  # ========================================================================= #
+  # === VALID_TAGS_IN_A_HEAD_TAG
+  # ========================================================================= #
+  if File.exist? FILE_VALID_TAGS_IN_A_HEAD_TAG
+    VALID_TAGS_IN_A_HEAD_TAG = YAML.load_file(FILE_VALID_TAGS_IN_A_HEAD_TAG)
+  else
+    VALID_TAGS_IN_A_HEAD_TAG = []
+  end
+
+end

data/lib/html_tags/html_closing_tags.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+# All html closing tags are autogenerated here.
+# =========================================================================== #
+require 'html_tags/array_registered_html_tags.rb'
+require 'html_tags/html_tags_constants.rb'
+require 'html_tags/closing_tag/closing_tag.rb'
+
+module HtmlTags
+
+  # ========================================================================= #
+  # Next, generate all closing html tags. A respective closing tag is 
+  # the name of the tag, and a 'c' preprended.
+  #
+  # Example:
+  #   The closing tag for h1() method call will be ch1(). Of course the
+  #   () can be omitted in Ruby, so we can use:
+  # ch1
+  # chtml
+  #
+  # Some html tags do not have a closing tag though.
+  # ========================================================================= #
+  ( ARRAY_REGISTERED_HTML_TAGS - ARRAY_TAGS_WITHOUT_CLOSING_TAG ).each {|entry|
+    define_method('c'+entry.to_s) {
+      close(entry.to_s.dup) # This method is defined in the file close.rb
+    }
+  }
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  include HtmlTags
+  p HtmlTags::methods
+  p ch6 # Close a <h6> tag that way.
+end # html_closing_tags

data/lib/html_tags/html_comment.rb

@@ -0,0 +1,29 @@
+module HtmlTags # require 'html_tags/html_comment.rb'
+
+  # ========================================================================= #
+  # === HtmlTags.html_comment
+  # ========================================================================= #
+  def self.html_comment(your_comment = '')
+    return '<!--  '+your_comment.to_s+'  --> '+NL
+  end; self.instance_eval { alias comment html_comment } # HtmlTags.comment
+
+  # ========================================================================= #
+  # === html_comment
+  #
+  # This method will make a html comment - as in, make a valid comment within
+  # the source of a html file. This is done by putting <!-- --> around
+  # the content in question.
+  #
+  # Specific Usage Examples:
+  #   HtmlTags.html_comment 'yup'
+  #   ee HtmlTags.html_comment 'yup'
+  #   ee html_comment 'this is for displaying some data'
+  #
+  # Resources for Comments in HTML:
+  #   http://www.tutorialspoint.com/html/html_comments.htm
+  # ========================================================================= #
+  def html_comment(your_comment = '')
+    HtmlTags.html_comment(your_comment)
+  end; alias comment html_comment
+
+end

data/lib/html_tags/html_tags.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === HtmlTags
+#
+# This project can generate HTML tags. We will also create the corresponding
+# closing tags to said actions - see the file html_closing_tags.rb for
+# close-related actions.
+#
+# If you want to autoinclude this project, do this:
+#   require 'html_tags/autoinclude'
+# =========================================================================== #
+require 'pathname'
+require 'html_tags/array_registered_html_tags.rb' # bl $HTML_TAGS/array_registered_html_tags.rb
+require 'html_tags/constants/array_strip_newlines.rb'
+require 'html_tags/constants.rb'
+require 'html_tags/html_closing_tags.rb'
+require 'html_tags/html_comment.rb'
+require 'html_tags/html_tags_constants.rb'
+require 'html_tags/opening_tag/opening_tag.rb'
+require 'html_tags/shared.rb'
+require 'html_tags/stag.rb'
+require 'html_tags/version/version.rb'
+require 'html_tags/toplevel_methods/full_output.rb'
+require 'html_tags/toplevel_methods/strip_newlines.rb'
+
+# =========================================================================== #
+# Next, require the individual tags from the individual_tags/ directory.
+# =========================================================================== #
+Dir[RbConfig::CONFIG['sitelibdir']+'/html_tags/individual_tags/*.rb'].each {|file|
+  require file
+}
+
+module HtmlTags # require 'html_tags'
+
+  include HtmlTags::Shared
+
+  # ========================================================================= #
+  # === NL
+  # ========================================================================= #
+  NL = "\n"
+
+  # ========================================================================= #
+  # === is_this_an_allowed_tag_in_head_element?
+  #
+  # This method will return true or false depending on whether the given
+  # tag may be part of a <head> tag.
+  # ========================================================================= #
+  def is_this_an_allowed_tag_in_head_element?(i)
+    i = i.to_s # Ought to be a String.
+    # ======================================================================= #
+    # Get rid of <> tags.
+    # ======================================================================= #
+    i.delete!('<')
+    i.delete!('>')
+    VALID_TAGS_IN_A_HEAD_TAG.include? i
+  end
+
+  # ========================================================================= #
+  # === q
+  #
+  # The quote tag, <q>.
+  # ========================================================================= #
+  def q(i = '', css_class = '', the_id = '', css_style = '')
+    return HtmlTags.add(
+      opening_tag(__method__, css_class, the_id, css_style)+
+      i.to_s+
+      close(__method__)
+    )
+  end; alias quote q # === quote
+
+  # ========================================================================= #
+  # === hr
+  # ========================================================================= #
+  def hr
+    return HtmlTags.add(
+      otag(__method__)
+    )
+  end
+
+  # ========================================================================= #
+  # === sbody
+  #
+  # Start of body tag.
+  # ========================================================================= #
+  def sbody
+    unless string?.include?('</head>')
+      HtmlTags.add('</head><body>')
+    end
+  end
+
+  extend self
+
+end
+
+# =========================================================================== #
+# Now some testing of the HTML components:
+# =========================================================================== #
+if __FILE__ == $PROGRAM_NAME
+  include HtmlTags
+  puts li 'Hi there.'
+  puts 'Now testing some components:'
+  ARRAY_REGISTERED_HTML_TAGS.each {|entry|
+    puts send(entry.to_sym)
+  }
+  puts head {'Ok'}
+  puts button 'ack','s1em'
+  ARRAY_REGISTERED_HTML_TAGS.each {|entry|
+    begin
+      puts send(entry.to_sym, 'Test','bblack1')
+    rescue Exception => error
+      pp error
+    end
+  }
+  puts h4 'Test','bblack1'
+  puts h4 'Test','bblack1','foo','border:1px solid black'
+end # htmltags

data/lib/html_tags/html_tags_constants.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+module HtmlTags # require 'html_tags/html_tags_constants.rb'
+
+  # ========================================================================= #
+  # Some hardcoded HTML-constants will be defined here.
+  # ========================================================================= #
+  TABLE = '<table>'
+  TR    = '<tr>'
+  TD    = '<td>'
+  BR    = '<br/>'
+
+end