st_html_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e8c0354612db1e00143ffc4adf6b6371a5760ae
+  data.tar.gz: 468dd0fb9f9aa78950afe172f5fffed7760b8ac1
+SHA512:
+  metadata.gz: 39c5ef3a76ff3306952564764f18dc91596d2a8f53d252a5d08f044c47e2ac38c7ac242c85de16b1fda9c33e696207ca1c1703b6346cbd69c95e71429b630fa6
+  data.tar.gz: ba7a3ea3fded9d6484d44b20775c7cc850e62385d65643163b4ed4eb0165ced33b565d0ed2560153b18ee89c74496d444b8aa113514f75f45efb580878ec3670

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stan Zhuravlev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# StHtmlTable
+
+Библиотека StHtmlTable позволяет формировать красиво форматированные таблицы в формате HTML, например,
+для передаче по электроннйо почты. Библиотека предназначена для использования в составе различных CLI-скриптов,
+в частности, в составе библиотеки [cli_application](https://github.com/StanZhuravlev/cli_application).
+
+Библиотека имеет ограниченные возможности по созданию таблиц, поскольку ее изначальная цель - отсылка админстраторам
+писем с различными статусами. Поэтому вся таблица имеет несколько вариантов оформления строк. В частности:
+
+|Тип строки|Значение|
+-----
+|:success|Черный текст на бледно-зеленом фоне|
+|:fail|Черный текст на бледно-крансом фоне|
+|:warn|Черный текст на желтом фоне|
+|:neutral|Черный текст на сером фоне|
+
+Тип строки задается для каждой строки таблицы.
+
+## Создание таблицы
+

data/lib/st_html_table.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "st_html_table/version"
+require 'rubygems'
+
+
+module StHtmlTable
+  require 'st_html_table/cell'
+  require 'st_html_table/row'
+  require 'st_html_table/table'
+
+end

data/lib/st_html_table/cell.rb

@@ -0,0 +1,76 @@
+module StHtmlTable
+  class Cell
+    attr_accessor :text
+    attr_reader :row
+    attr_reader :table
+    attr_accessor :is_header
+    attr_accessor :cols
+    attr_accessor :col_id
+    attr_accessor :row_id
+    attr_accessor :bold
+    attr_accessor :italic
+    attr_accessor :align
+    attr_accessor :valign
+    attr_accessor :type
+
+    def initialize(table, row)
+      @text = ' '
+      @row = row
+      @table = table
+      @is_header = false
+      @cols = 1
+      @col_id = 0
+      @row_id = 0
+      @type = :neutral
+      @valign = :top
+
+      @bold = false
+      @italic = false
+      @align = :left
+
+      @ident = 6
+    end
+
+    def prefix=(value)
+      @prefix = value
+    end
+
+    def suffix=(value)
+      @suffix = value
+    end
+
+    def to_s
+      @text.gsub(%r{</?[^>]+?>}, '')
+    end
+
+    def to_html
+      type = @is_header ? 'th' : 'td'
+
+      out = Array.new
+      out << (' ' * @ident) + build_cell_arguments(type)
+      out << (' ' * (@ident + 2)) + @text.to_s
+      out << (' ' * @ident) + "</#{type}>"
+      out.join("\n")
+    end
+
+    private
+
+
+    def build_cell_arguments(type)
+      out = Array.new
+      style = Array.new
+
+      style << "font-weight:bold;" if @bold
+      style << "font-style:italic;" if @italic
+      style << "border: 1px solid #eaeaea;"
+
+      out << "align=#{@align.to_s.inspect}"
+      out << "valign=#{@valign.to_s.inspect}" if @valign != :top
+      out << "style='#{style.join}'" unless style.empty?
+      out << "cols=\"#{@cols}\"" if @cols != 1
+      "<#{type} " + out.join(' ') + ">"
+    end
+
+
+  end
+end

data/lib/st_html_table/row.rb

@@ -0,0 +1,124 @@
+module StHtmlTable
+  class Row
+
+    def initialize(table) # :nodoc:
+      @table = table
+      @cells = Hash.new
+      @id = :none
+      @type = :neutral
+
+      @ident = 4
+    end
+
+    # Метод позволяет установить для строки таблицы один из следующих стилей: [:neutral, :fail, :success, :warn]
+    #
+    # @param [Sym] value тип строки. При изменении типа строки, все ячейи строки таблицы получат эти же значения
+    # @return [None] нет
+    def type=(value)
+      types = [:neutral, :fail, :success, :warn]
+      raise "Ошибка: тип строки должен быть одним из: #{types.inspect}" unless types.include?(value.to_sym)
+      @type = value.to_sym
+      @cells.each { |id, cell| cell.type = @type }
+    end
+
+    # Метод добавляет или изменяет ячейку таблицы, устанавливая ее соедержание, выравнивание, стиль оформления
+    #
+    # @param [Object] col_id идентифкатор столбца таблицы
+    # @param [Object] text содержание ячейки
+    # @param [Object] align выравнивание [:left, :center, :right]
+    # @param [Object] bold жирное начертание
+    # @param [Object] italic наклонное начертание
+    # @return [StHtmlTable::Cell] измененная ячейка
+    def add(col_id, text, align: :left, bold: false, italic: false)
+      add_cell(col_id, text, align, bold, italic)
+    end
+
+    def get_cell(col_id)
+      @cells[col_id]
+    end
+
+    def row_keys
+      @cells.keys
+    end
+
+    def add_header(header)
+      header.each do |id, name|
+        cell = ::StHtmlTable::Cell.new(@table, self)
+        cell.col_id = id.to_sym
+        cell.row_id = self.id
+        cell.is_header = true
+        cell.text = name
+        cell.align = :center
+        cell.bold = true
+
+        @cells[id.to_sym] = cell
+      end
+    end
+
+    def to_html
+      out = Array.new
+      out << (' ' * @ident) + "<tr #{build_color_scheme}>"
+      @cells.each do |id, cell|
+        out << cell.to_html
+      end
+      out << (' ' * @ident) + "</tr>"
+      out.join("\n")
+    end
+
+    def id=(id)
+      @id = id
+    end
+
+    def id
+      @id
+    end
+
+    def init_row # :nodoc:
+      keys = @table.row_keys
+      keys.each do |id|
+        cell = ::StHtmlTable::Cell.new(@table, self)
+        cell.col_id = id.to_sym
+        cell.row_id = self.id
+        cell.type = @type
+
+        @cells[id.to_sym] = cell
+      end
+    end
+
+
+    private
+
+
+
+    def build_color_scheme # :nodoc:
+      if @cells.values.first.is_header
+        return "style=\"color:#ffffff;background:#389bb9;\" valign=\"center\""
+      end
+
+      case @type
+        when :warn
+          return "bgcolor=\"efe685\""
+        when :success
+          return "bgcolor=\"#c4d7be\""
+        when :fail
+          return "bgcolor=\"#efbcbe\""
+        else
+          return "bgcolor=\"#e6e6e6\""
+      end
+    end
+
+    def add_cell(col_id, text, align, bold, italic) # :nodoc:
+      cell = get_cell(col_id)
+      raise "Ошибка: не найдена ячейка HTML-таблицы (#{col_id.inspect}, #{self.id.inspect})" if cell.nil?
+
+      cell.text = text
+      cell.align = align
+      cell.bold = bold
+      cell.italic = italic
+
+      cell
+    end
+
+
+  end
+end

data/lib/st_html_table/table.rb

@@ -0,0 +1,89 @@
+module StHtmlTable
+  class Table
+
+    def initialize # :nodoc:
+      init_table
+    end
+
+    # Метод создает таблицу с строкой-заголовком. Данный метод должен быть вызван первым, поскольку
+    # именно он определяет число столбцов в будущей таблице
+    #
+    # @param [Hash] header хеш вида column id => title of column
+    # @param [Integer] padding аналог cellpadding тега <table>
+    # @param [Integer] width ширина таблицы в процентах
+    # @return [None] нет
+    def create(header, padding: 5, width: 0)
+      init_table
+      @padding = padding
+      @width = width
+      init_header(header)
+    end
+
+    # Метод возвращает все идентифкаторы столбцов таблицы
+    #
+    # @return [Array] массив идентификаторов столбцов таблицы
+    def row_keys
+      @header.row_keys
+    end
+
+    # Метод возвращает ряд таблицы по идентификатору ряда. Если ряд с таким id отсуствует - он будет создан
+    #
+    # @param [Object] id идентфикатор строки
+    # @return [StHtmlTable::Row] класс со строкой (<tr>) таблицы
+    def get_row(id)
+      init_row(id) if @rows[id].nil?
+      @rows[id]
+    end
+
+    # Метод переводит таблицы в форматированный HTML
+    #
+    # @return [String] таблица в формате HTML
+    def to_html
+      out = Array.new
+      out << build_table_row
+      out << build_header_row
+      @rows.each do |row_id, row|
+        out << row.to_html
+      end
+      out << "</table>"
+      out.join("\n")
+    end
+
+
+
+    private
+
+
+
+    def init_header(header) # :nodoc:
+      @header = ::StHtmlTable::Row.new(self)
+      @header.id = :html_table_header
+      @header.add_header(header)
+    end
+
+    def build_header_row # :nodoc:
+      @header.to_html
+    end
+
+    def build_table_row # :nodoc:
+      out = Array.new
+      out << "table"
+      out << "cellpadding=\"#{@padding}px\""
+      out << "cellspacing=\"0\""
+      out << "style=\"border: 1px solid #eaeaea; border-collapse:collapse;\""
+      out << "width=\"#{@width}%\"" unless @width == 0
+      "<" + out.join(' ') + ">"
+    end
+
+    def init_row(row_id) # :nodoc:
+      @rows[row_id] = ::StHtmlTable::Row.new(self)
+      @rows[row_id].init_row
+    end
+
+    def init_table # :nodoc:
+      @rows = Hash.new
+      @header = Hash.new
+    end
+
+  end
+end

data/lib/st_html_table/version.rb

@@ -0,0 +1,3 @@
+module StHtmlTable
+  VERSION = "0.1.0"
+end

data/test/cell_lib_spec.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+require 'st_html_table'
+
+
+describe 'Проверка методов StHtmlTable::Cell.*' do
+
+  it 'Test 1' do
+    cell = ::StHtmlTable::Cell.new(nil, nil)
+    cell.text = 'Content'
+    expect(cell.to_s).to eq 'Content'
+    expect(cell.to_html).to include 'Content'
+    expect(cell.to_html).to include '<td'
+    expect(cell.to_html).to include '/td>'
+    expect(cell.to_html).to_not include 'cols'
+    puts cell.to_html
+  end
+
+  it 'Test 2' do
+    cell = ::StHtmlTable::Cell.new(nil, nil)
+    cell.text = 'Content'
+    cell.cols = 2
+    expect(cell.to_s).to eq 'Content'
+    expect(cell.to_html).to include 'Content'
+    expect(cell.to_html).to include '<td'
+    expect(cell.to_html).to include 'cols'
+    expect(cell.to_html).to include '/td>'
+    puts cell.to_html
+  end
+
+  it 'Test 3' do
+    cell = ::StHtmlTable::Cell.new(nil, nil)
+    cell.text = 'Content'
+    cell.cols = 2
+    cell.td_style = 'class="cell_class_name"'
+    expect(cell.to_s).to eq 'Content'
+    expect(cell.to_html).to include 'Content'
+    expect(cell.to_html).to include '<td'
+    expect(cell.to_html).to include 'cols'
+    expect(cell.to_html).to include 'class'
+    expect(cell.to_html).to include '/td>'
+    puts cell.to_html
+  end
+
+  it 'Test 4' do
+    cell = ::StHtmlTable::Cell.new(nil, nil)
+    cell.text = 'Content <b>bold</b>'
+    cell.cols = 2
+    cell.td_style = 'class="cell_class_name"'
+    expect(cell.to_s).to eq 'Content bold'
+    expect(cell.to_html).to include 'Content <b>bold</b>'
+    expect(cell.to_html).to include '<td'
+    expect(cell.to_html).to include 'cols'
+    expect(cell.to_html).to include 'class'
+    expect(cell.to_html).to include '/td>'
+    puts cell.to_html
+  end
+
+end

data/test/table_lib_spec.rb

@@ -0,0 +1,39 @@
+require 'rspec'
+require 'st_html_table'
+
+
+describe 'Проверка методов StHtmlTable::Cell.*' do
+
+  it 'Test 1' do
+    table = ::StHtmlTable::Table.new
+    table.create({id: 'id', url: 'URL', views: 'Views' }, padding: 3)
+
+    row = table.get_row(0)
+    row.type = :success
+    row.add(:id, 0, align: :right)
+    row.add(:url, "http://st-html-table.ru", align: :left, italic: true)
+    row.add(:views, 456, align: :center)
+
+    row = table.get_row(100)
+    row.type = :fail
+    row.add(:id, 100, align: :right)
+    row.add(:url, "http://big-url-of-st-html-table.ru", align: :left, italic: true)
+    row.add(:views, 6374637, align: :center)
+
+    row = table.get_row(200)
+    row.type = :neutral
+    row.add(:id, 200, align: :right)
+    row.add(:url, "http://big-st-html-table-200.ru", align: :left, italic: true)
+    row.add(:views, 63645, align: :center)
+
+    row = table.get_row(300)
+    row.type = :warn
+    row.add(:id, 300, align: :right)
+    row.add(:url, "http://big-st-html-table-300.ru", align: :left, italic: true)
+    row.add(:views, 343, align: :center)
+
+
+    puts table.to_html
+  end
+
+end

data/test/test.html

@@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<html>
+<head lang="en">
+    <meta charset="UTF-8">
+    <title></title>
+</head>
+<body>
+
+<table cellpadding="3px" cellspacing="0" style="border: 1px solid #eaeaea; border-collapse:collapse;">
+    <tr style="color:#ffffff;background:#389bb9;" valign="center">
+        <th align="center" style='font-weight:bold;border: 1px solid #eaeaea;'>
+            id
+        </th>
+        <th align="center" style='font-weight:bold;border: 1px solid #eaeaea;'>
+            URL
+        </th>
+        <th align="center" style='font-weight:bold;border: 1px solid #eaeaea;'>
+            Views
+        </th>
+    </tr>
+    <tr bgcolor="#c4d7be">
+        <td align="right" style='border: 1px solid #eaeaea;'>
+            0
+        </td>
+        <td align="left" style='font-style:italic;border: 1px solid #eaeaea;'>
+            http://st-html-table.ru
+        </td>
+        <td align="center" style='border: 1px solid #eaeaea;'>
+            456
+        </td>
+    </tr>
+    <tr bgcolor="#efbcbe">
+        <td align="right" style='border: 1px solid #eaeaea;'>
+            100
+        </td>
+        <td align="left" style='font-style:italic;border: 1px solid #eaeaea;'>
+            http://big-url-of-st-html-table.ru
+        </td>
+        <td align="center" style='border: 1px solid #eaeaea;'>
+            6374637
+        </td>
+    </tr>
+    <tr bgcolor="#e6e6e6">
+        <td align="right" style='border: 1px solid #eaeaea;'>
+            200
+        </td>
+        <td align="left" style='font-style:italic;border: 1px solid #eaeaea;'>
+            http://big-st-html-table-200.ru
+        </td>
+        <td align="center" style='border: 1px solid #eaeaea;'>
+            63645
+        </td>
+    </tr>
+    <tr bgcolor="efe685">
+        <td align="right" style='border: 1px solid #eaeaea;'>
+            300
+        </td>
+        <td align="left" style='font-style:italic;border: 1px solid #eaeaea;'>
+            http://big-st-html-table-300.ru
+        </td>
+        <td align="center" style='border: 1px solid #eaeaea;'>
+            343
+        </td>
+    </tr>
+</table>
+
+
+
+</body>
+</html>

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: st_html_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- StanZhuravlev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Библиотека позволяет формировать красиво форматированные таблицы в формате HTML, например,
+  для передаче по электроннйо почты. Библиотека предназначена для использования в составе различных CLI-скриптов,
+  в частности, в составе библиотеки cli_application
+email:
+- stan@post-api.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/st_html_table.rb
+- lib/st_html_table/cell.rb
+- lib/st_html_table/row.rb
+- lib/st_html_table/table.rb
+- lib/st_html_table/version.rb
+- test/cell_lib_spec.rb
+- test/table_lib_spec.rb
+- test/test.html
+homepage: https://github.com/StanZhuravlev/st_html_table
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/st_html_table
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.2.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: "Формирование таблиц в формате HTML"
+test_files: []