cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/html_tables.rb

@@ -0,0 +1,818 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# In this file <table>-related methods will be stored.
+#
+# This will also include code elements such as:
+#
+#   Table.set_cellspacing
+#
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/html_tables.rb'
+# Cyberweb.string_table2(css_class = '', id = '', css_style = '', *content)
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/html_tags/table.rb'
+  require 'cyberweb/toplevel_methods/css.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.string_table4
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def self.string_table4(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # If content is empty then we will replace the content with the
+      # value of the passed block next.
+      # ===================================================================== #
+      if content.empty? and !yielded.empty?
+        content = yielded
+      end
+    end
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style) unless css_style.empty?
+    _ << '>'
+    _ << "\n"
+    content.each_with_index { |item, index|
+      position = (index % 4)
+      case position
+      when 0
+        _ << '<tr>'+N+'  <td>'+item+'</td>'+N
+      else
+        _ << '  <td>'+item+'</td>'+N
+        _ << '</tr>'+N if position == 3
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+    return _
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table2
+  #
+  # This returns the string form of a <table> tag.
+  #
+  # Arguments to this method could look like this:
+  #
+  #   Cyberweb.string_table2('mars1em') { an_array_here } # To pass an array as the main dataset.
+  #   Cyberweb.string_table2('mars1em') { [1,2,3,4,5,6] } # ^^^ as stated above
+  #
+  # ========================================================================= #
+  def self.string_table2(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # If content is empty then we will replace the content with the
+      # value of the passed block next.
+      # ===================================================================== #
+      if content.empty? and !yielded.empty?
+        content = yielded
+      end
+    end
+    css_class = css_class.to_s
+    
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    content.each_with_index { |item, index|
+      if index % 2 == 0
+        _ << '<tr>'+N+'  <td>'+item.to_s+'</td>'+N
+      else
+        _ << "  <td>#{item}</td>#{N}</tr>#{N}"
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+    return _
+  end; self.instance_eval { alias string_table string_table2 } # === Cyberweb.string_table
+
+  # ========================================================================= #
+  # === Cyberweb.string_table7
+  # ========================================================================= #
+  def self.string_table7(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style) unless css_style.empty?
+    _ << '>'
+    _ << "\n"
+    content.each_with_index { |item, index|
+      result = index % 7
+      _ << '<tr>'+N if result == 0 # 0 means to add a '<tr>' tag first.
+      # when 0, 1, 2, 3, 4, 5, 6 
+      _ << '<td>'+item+'</td>'+N
+      _ << '</tr>'+N if result == 6 # This must be 1 less.
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+    return _
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table5
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def self.string_table5(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style) unless css_style.empty?
+    _ << '>'
+    _ << "\n"
+    content.each_with_index { |item, index|
+      result = index % 5
+      _ << '<tr>'+N if result == 0 # 0 means to add a '<tr>' tag first.
+      # when 0, 1, 2, 3
+      _ << '<td>'+item+'</td>'+N
+      _ << '</tr>'+N if result == 4 # This must be 1 less.
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+    return _
+  end
+
+  # ========================================================================= #
+  # === table4
+  # ========================================================================= #
+  def table4(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    customized_table(
+      4, css_class, id, css_style, *content, &block
+    )
+  end
+
+  # ========================================================================= #
+  # === customized_table                               (customized_table tag)
+  #
+  # This is a "feature-rich" table.
+  #
+  # If we yield true to this method then we will assume it is a table
+  # with headers - in that case, the first two contents will be treated
+  # as denoting the header.
+  # ========================================================================= #
+  def customized_table(
+      how_many_rows = 1,
+      css_class     = '',
+      id            = '',
+      css_style     = '',
+      *content,
+      &block
+    )
+    # ======================================================================= #
+    # Build up the string that is to be returned, into the variable
+    # table_string.
+    # ======================================================================= #
+    table_string = '<table'.dup
+    table_string << return_css_class(css_class)
+    table_string << return_the_id(id)
+    table_string << return_css_style(css_style)
+    table_string << ">#{N}"
+    ee table_string
+    if block_given?
+      if content.empty?
+        content << yield
+      end
+    end
+    content.flatten.each_with_index { |item, index|
+      _ = index % how_many_rows
+      ee '<tr>'+N if _ == 0
+      # ===================================================================== #
+      # === Table Headers
+      #
+      # Right now we assume that the block given to this method is just
+      # "true". In the future this assumption may perhaps change.
+      #
+      # In that case when a block is issued, we will use table headers.
+      #
+      # At 18.09.2015 I have changed this approach - now we need to
+      # pass a symbol such as :use_headers instead.
+      # ===================================================================== #
+      if block_given? and (index < how_many_rows) and (yield == :use_headers)
+        th item
+      else
+        td item
+      end
+      if ( index % how_many_rows ) == (how_many_rows - 1)
+        ee string_ctr+N
+      end
+    }
+    ctable
+    ::Cyberweb.add_this_to_the_registered_tables(table_string)
+  end
+
+  # ========================================================================= #
+  # === string_table2
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def string_table2(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table2(css_class, id, css_style, *content)
+  end
+
+  # ========================================================================= #
+  # === string_table3
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def string_table3(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table3(
+      css_class, id, css_style, *content
+    )
+  end
+  
+  # ========================================================================= #
+  # === Cyberweb.string_table3
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def self.string_table3(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    content.each_with_index { |item, index|
+      if index % 3 == 0
+        _ << '<tr>'+N+'  <td>'+item+'</td>'+N
+      elsif index % 3 == 2
+        _ << '  <td>'+item+'</td>'+N+'</tr>'+N
+      else
+        _ << '  <td>'+item+'</td>'+N+N
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+  end
+
+  # ========================================================================= #
+  # === table3
+  # ========================================================================= #
+  def table3(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(
+      3, css_class, id, css_style, *content
+    ) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.parse_table
+  #
+  # This can be used to parse a string into a html table.
+  #
+  # Right now the only allowed delimiter is the '|' character, so this
+  # is hardcoded. See the usage example below.
+  #
+  # Usage example:
+  #
+  #    Cyberweb.parse_table('Name|Typus|Wo?|Wann?')
+  #
+  # ========================================================================= #
+  def self.parse_table(*args)
+    delimiter = '|'
+    _ = '<table'.dup
+    # ======================================================================= #
+    # === Add Table css information next
+    # ======================================================================= #
+    unless Table.to_s.to_s.empty?
+      _ << return_css_class(Table.to_s)
+    end
+    _ << '>'
+    args.flatten!
+    args.each {|line|
+      splitted = line.split(delimiter)
+      _ << '<tr>'
+      _ << '<td'
+      _ << ' class="'+Td.to_s+'"' unless Td.to_s.empty?
+      _ << '>'
+      _ << N
+      _ << splitted.join('</td><td>')+N
+      _ << '</td></tr>'+N
+    }
+    _ << '</table>'
+    return _ # Return our String finally.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.populate_html_table
+  #
+  # This method can be used to generate a html table with data.
+  #
+  # Usage example:
+  #
+  #   dataset = CsvParadise["/home/x/DATA/GAMES/magic_the_gathering/Kartenliste_mit_Preisen_15.09.2016.csv"]; dataset = Cyberweb.populate_html_table(dataset.result?); pp dataset; ''
+  #
+  # ========================================================================= #
+  def self.populate_html_table(
+      use_this_dataset = nil
+    )
+    if use_this_dataset
+      yielded = use_this_dataset
+    else
+      if block_given?
+        yielded = yield
+      else
+        yielded = []
+      end
+    end
+    _ = ''.dup # Our return string. We will build it up next.
+    _ << '<table>'
+    yielded.each {|line|
+      _ << '<tr><td>'+line.join('</td><td>')+'</td></tr>'+N
+    }
+    _ << '</table>'
+    return _
+  end
+
+  # ========================================================================= #
+  # === table2_with_headers
+  #
+  # This method will invoke customized_table() with a block
+  # variable called :use_headers.
+  # ========================================================================= #
+  def table2_with_headers(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(
+      2, css_class, id, css_style, *content
+    ) { :use_headers }
+  end
+
+  # ========================================================================= #
+  # === table5
+  #
+  # A table with 5 rows.
+  # ========================================================================= #
+  def table5(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(
+      5, css_class, id, css_style, *content
+    ) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table6
+  #
+  # A table with 6 rows.
+  # ========================================================================= #
+  def table6(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(
+      6, css_class, id, css_style, *content
+    ) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table7
+  #
+  # A table with 7 rows.
+  # ========================================================================= #
+  def table7(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(7, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table8
+  #
+  # A table with 8 rows.
+  # ========================================================================= #
+  def table8(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(8, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table9
+  #
+  # A table with 9 rows.
+  # ========================================================================= #
+  def table9(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(9, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table10
+  #
+  # A table with 10 rows.
+  # ========================================================================= #
+  def table10(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(10, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table11
+  #
+  # A table with 11 rows.
+  # ========================================================================= #
+  def table11(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(11, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table12
+  #
+  # A table with 12 rows.
+  # ========================================================================= #
+  def table12(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(12, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === table13
+  #
+  # A table with 13 rows.
+  # ========================================================================= #
+  def table13(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(13, css_class, id, css_style, *content) { yield if block_given? }
+  end
+  
+  # ========================================================================= #
+  # === table14
+  #
+  # A table with 14 rows.
+  # ========================================================================= #
+  def table14(
+      css_class = '', id = '', css_style = '', *content
+    )
+    customized_table(14, css_class, id, css_style, *content) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === simple_table2
+  #
+  # Pass it an array. It will then create a HTML table.
+  #
+  # You can also use css-class options etc... after that Array.
+  # ========================================================================= #
+  def simple_table2(
+      array,
+      optional_css_class = '',
+      optional_id        = '',
+      optional_css_style = ''
+    )
+    table(optional_css_class, optional_id, optional_css_style)
+      # Display our links here.
+      array.each_with_index { |a_link, index|
+        case (index % 2)
+        when 0
+          trtd
+            ee(a_link)
+          ctd
+        when 1
+          td
+            ee(a_link)
+          ctdctr
+        end
+      }
+    ctable
+  end
+
+  # ========================================================================= #
+  # === table2
+  #
+  # Also known as the "zebra table".
+  # ========================================================================= #
+  def table2(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    customized_table(
+      2, css_class, id, css_style, *content
+    ) { yield if block_given? }
+  end; alias zebra_table table2 # Courtesy of Ox0dea - he wanted to have a zebra-table.
+
+  # ========================================================================= #
+  # === string_table11_with_heading
+  # ========================================================================= #
+  def string_table11_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table11_with_heading(css_class, id, css_style, *content)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table11_with_heading
+  # ========================================================================= #
+  def self.string_table11_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    first_header  = content.shift
+    _ << '<tr>
+          <th>'+first_header.to_s+'</th>'
+    second_header = content.shift
+    _ << "<th>#{second_header}</th>"
+    third_header  = content.shift
+    _ << "<th>#{third_header}</th>"
+    fourth_header = content.shift
+    _ << "<th>#{fourth_header}</th>"
+    fifth_header  = content.shift
+    _ << "<th>#{fifth_header}</th>"
+    header_six  = content.shift
+    _ << "<th>#{header_six}</th>"
+    header_seven  = content.shift
+    _ << "<th>#{header_seven}</th>"
+    header_eight  = content.shift
+    _ << "<th>#{header_eight}</th>"
+    header_nine  = content.shift
+    _ << "<th>#{header_nine}</th>"
+    header_ten  = content.shift
+    _ << "<th>#{header_ten}</th>"
+    header_eleven  = content.shift
+    _ << "<th>#{header_eleven}</th></tr>"
+    content.each_with_index { |item, index|
+      td_tag = '<td>'
+      if item.to_s.start_with? '#ALIGN_RIGHT#'
+        td_tag = '<td align="right">'
+        item = item.to_s.sub(/#ALIGN_RIGHT#/,'')
+      end
+      case index % 11
+      when 0 # New row.
+        _ << '<tr>'+N+'  '+td_tag+item+'</td>'+N
+      when 10 # End row.
+      _ << N+'  '+td_tag+item+'</td>'+N+'</tr>'
+      else # else it is a simple td-entry.
+        _ << '  '+td_tag+item+'</td>'+N
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+  end
+
+  # ========================================================================= #
+  # === string_table12_with_heading
+  # ========================================================================= #
+  def string_table12_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table12_with_heading(
+      css_class, id, css_style, *content
+    )
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table12_with_heading
+  # ========================================================================= #
+  def self.string_table12_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    first_header  = content.shift
+    _ << '<tr>
+          <th>'+first_header.to_s+'</th>'
+    second_header = content.shift
+    _ << "<th>#{second_header}</th>"
+    third_header  = content.shift
+    _ << "<th>#{third_header}</th>"
+    fourth_header = content.shift
+    _ << "<th>#{fourth_header}</th>"
+    fifth_header  = content.shift
+    _ << "<th>#{fifth_header}</th>"
+    header_six  = content.shift
+    _ << "<th>#{header_six}</th>"
+    header_seven  = content.shift
+    _ << "<th>#{header_seven}</th>"
+    header_eight  = content.shift
+    _ << "<th>#{header_eight}</th>"
+    header_nine  = content.shift
+    _ << "<th>#{header_nine}</th>"
+    header_ten  = content.shift
+    _ << "<th>#{header_ten}</th>"
+    header_eleven  = content.shift
+    _ << "<th>#{header_eleven}</th>"
+    header_twelve  = content.shift
+    _ << "<th>#{header_twelve}</th></tr>"
+    content.each_with_index { |item, index|
+      td_tag = '<td>'
+      if item.to_s.start_with? '#ALIGN_RIGHT#'
+        td_tag = '<td align="right">'
+        item = item.to_s.sub(/#ALIGN_RIGHT#/,'')
+      end
+      case index % 12
+      when 0 # New row.
+        _ << '<tr>'+N+'  '+td_tag+item+'</td>'+N
+      when 11 # End row.
+      _ << N+'  '+td_tag+item+'</td>'+N+'</tr>'
+      else # else it is a simple td-entry.
+        _ << '  '+td_tag+item+'</td>'+N
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+  end
+
+  # ========================================================================= #
+  # === string_table5_with_heading
+  # ========================================================================= #
+  def string_table5_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table5_with_heading(css_class, id, css_style, *content)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table5_with_heading
+  # ========================================================================= #
+  def self.string_table5_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    first_header  = content.shift
+    _ << '<tr>
+          <th>'+first_header.to_s+'</th>'
+    second_header = content.shift
+    _ << "<th>#{second_header}</th>"
+    third_header  = content.shift
+    _ << "<th>#{third_header}</th>"
+    fourth_header = content.shift
+    _ << "<th>#{fourth_header}</th>"
+    fifth_header  = content.shift
+    _ << "<th>#{fifth_header}</th></tr>"
+    content.each_with_index { |item, index|
+      td_tag = '<td>'
+      if item.to_s.start_with? '#ALIGN_RIGHT#'
+        td_tag = '<td align="right">'
+        item = item.to_s.sub(/#ALIGN_RIGHT#/,'')
+      end
+      case index % 5
+      when 0 # New row.
+        _ << '<tr>'+N+'  '+td_tag+item+'</td>'+N
+      when 4 # End row.
+      _ << N+'  '+td_tag+item+'</td>'+N+'</tr>'
+      else # else it is a simple td-entry.
+        _ << '  '+td_tag+item+'</td>'+N
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+  end
+
+  # ========================================================================= #
+  # === string_table2_with_heading
+  # ========================================================================= #
+  def string_table2_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table2_with_heading(css_class, id, css_style, *content)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_table2_with_heading
+  # ========================================================================= #
+  def self.string_table2_with_heading(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    content = content.flatten.compact # Make it more useful to our case.
+    _ = '<table'.dup
+    _ << return_css_class(css_class)
+    _ << return_the_id(id)
+    _ << return_css_style(css_style)
+    _ << '>'
+    _ << "\n"
+    first_header  = content.shift
+    _ << '<tr>
+          <th>'+first_header.to_s+'</th>'
+    second_header = content.shift
+    _ << '<th>'+second_header.to_s+'</th></tr>'
+    content.each_with_index { |item, index|
+      case index % 2
+      when 0
+        _ << '<tr>'+N+'  <td>'+item+'</td>'+N
+      else
+        _ << '  <td>'+item+'</td>'+N+'</tr>'+N
+      end
+    }
+    _ << ::Cyberweb.string_ctable.to_s
+  end
+
+  # ========================================================================= #
+  # === string_table4
+  #
+  # This returns the string form of a <table> tag.
+  # ========================================================================= #
+  def string_table4(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table4(css_class, id, css_style, *content)
+  end
+
+end