html-table 1.6.3 → 1.7.1

data/Rakefile

@@ -1,146 +1,122 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include("**/*.gem", "**/*.rbc")
-
-namespace :gem do
-  desc 'Build the html-table gem'
-  task :create => [:clean] do
-    require 'rubygems/package'
-    spec = eval(IO.read('html-table.gemspec'))
-    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
-  end
-
-  desc "Install the html-table package as a gem"
-  task :install => [:create] do
-    file = Dir["*.gem"].first
-    sh "gem install -l #{file}"
-  end
-end
-
-namespace 'example' do
-   desc "Run the first simple html-table example"
-   task :simple1 do
-      sh 'ruby -Ilib examples/simple1.rb'
-   end
-
-   desc "Run the second simple html-table example"
-   task :simple2 do
-      sh 'ruby -Ilib examples/simple2.rb'
-   end
-
-   desc "Run the third simple html-table example"
-   task :simple3 do
-      sh 'ruby -Ilib examples/simple3.rb'
-   end
-
-   desc "Run the first intermediate html-table example"
-   task :intermediate1 do
-      sh 'ruby -Ilib examples/intermediate1.rb'
-   end
-
-   desc "Run the second intermediate html-table example"
-   task :intermediate2 do
-      sh 'ruby -Ilib examples/intermediate2.rb'
-   end
-
-   desc "Run the advanced html-table example"
-   task :advanced do
-      sh 'ruby -Ilib examples/advanced.rb'
-   end
-end
-
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
-end
-
-namespace 'test' do 
-  Rake::TestTask.new('attribute_handler') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_attribute_handler.rb']
-  end
-
-  Rake::TestTask.new('body') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_body.rb']
-  end
-
-  Rake::TestTask.new('caption') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_caption.rb']
-  end
-
-  Rake::TestTask.new('col') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_col.rb']
-  end
-
-  Rake::TestTask.new('colgroup') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_colgroup.rb']
-  end
-
-  Rake::TestTask.new('data') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_data.rb']
-  end
-
-  Rake::TestTask.new('foot') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_foot.rb']
-  end
-
-  Rake::TestTask.new('head') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_head.rb']
-  end
-
-  Rake::TestTask.new('header') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_header.rb']
-  end
-
-  Rake::TestTask.new('html_handler') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_html_handler.rb']
-  end
-
-  Rake::TestTask.new('row') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_row.rb']
-  end
-
-  Rake::TestTask.new('table') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_table.rb']
-  end
-
-  Rake::TestTask.new('tablesection') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_tablesection.rb']
-  end
-
-  Rake::TestTask.new('tag_handler') do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_tag_handler.rb']
-  end
-end
-
-task :default => :test
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
+
+namespace :gem do
+  desc 'Build the html-table gem'
+  task :create => [:clean] do
+    require 'rubygems/package'
+    spec = Gem::Specification.load('html-table.gemspec')
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
+  end
+
+  desc "Install the html-table package as a gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+namespace 'example' do
+  desc "Run the first simple html-table example"
+  task :simple1 do
+    sh 'ruby -Ilib examples/simple1.rb'
+  end
+
+  desc "Run the second simple html-table example"
+  task :simple2 do
+    sh 'ruby -Ilib examples/simple2.rb'
+  end
+
+  desc "Run the third simple html-table example"
+  task :simple3 do
+    sh 'ruby -Ilib examples/simple3.rb'
+  end
+
+  desc "Run the first intermediate html-table example"
+  task :intermediate1 do
+    sh 'ruby -Ilib examples/intermediate1.rb'
+  end
+
+  desc "Run the second intermediate html-table example"
+  task :intermediate2 do
+    sh 'ruby -Ilib examples/intermediate2.rb'
+  end
+
+  desc "Run the advanced html-table example"
+  task :advanced do
+    sh 'ruby -Ilib examples/advanced.rb'
+  end
+end
+
+RuboCop::RakeTask.new
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:attribute_handler) do |t|
+    t.pattern = 'spec/attribute_handler_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:body) do |t|
+    t.pattern = 'spec/body_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:caption) do |t|
+    t.pattern = 'spec/caption_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:col) do |t|
+    t.pattern = 'spec/col_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:colgroup) do |t|
+    t.pattern = 'spec/colgroup_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:data) do |t|
+    t.pattern = 'spec/data_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:foot) do |t|
+    t.pattern = 'spec/foot_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:head) do |t|
+    t.pattern = 'spec/head_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:header) do |t|
+    t.pattern = 'spec/header_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:html_handler) do |t|
+    t.pattern = 'spec/html_handler_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:row) do |t|
+    t.pattern = 'spec/row_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:table) do |t|
+    t.pattern = 'spec/table_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:tablesection) do |t|
+    t.pattern = 'spec/tablesection_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:tag_handler) do |t|
+    t.pattern = 'spec/tag_handler_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:all) do |t|
+    t.verbose = false
+    t.pattern = 'spec/*_spec.rb'
+    t.rspec_opts = '-f documentation'
+  end
+end
+
+task :default => ['spec:all', :clean]

data/doc/attributes.md

@@ -0,0 +1,160 @@
+## Description
+   A list of attributes handled by html-table.  Each of the writers has a
+   corresponding reader unless otherwise stated.
+
+## Attributes
+`abbr=(string)`
+
+Sets the value for the abbr attribute.
+
+`align=(string)`
+
+Sets the align attribute. Valid arguments are 'left', 'center' and
+'right'.  An ArgumentError is raised if an invalid argument is passed.
+
+`axis=(string)`
+
+Sets the value for the axis attribute.
+
+`background=(url)`
+
+Sets the background attribute. The url must be a String or a TypeError
+is raised. This is a non-standard extension.
+
+`bgcolor=(color)`
+
+Sets the color for the bgcolor attribute. Hex values should still be
+quoted, e.g. "#F80000".
+
+`border=(num)`
+
+Sets the value for the border attribute.
+
+`bordercolor=(color)`
+
+Sets the color for the bordercolor attribute. This is a non-standard extension.
+
+`bordercolordark=(color)`
+
+Sets the color for the bordercolordark attribute. This is a non-standard extension.
+
+`bordercolorlight=(color)`
+
+Sets the color for the bordercolorlight attribute. This is a non-standard extension.
+
+`cellpadding=(num)`
+
+Sets the value for the cellpadding attribute.  Raises an ArgumentError if num.to_i is less than 0.
+
+`cellspacing=(num)`
+
+Sets the value for the cellspacing attribute.  Raises an ArgumentError if num.to_i is less than 0.
+
+`char=(character)`
+
+Sets the value for the char attribute.  An ArgumentError is raised if the
+argument passed has a length greater than 1 (i.e. it may only be a char).
+
+`charoff=(value)`
+
+Sets the value for the charoff attribute.
+
+`colspan=(num)`
+
+Sets the colspan attribute.
+
+`content=(*args)`
+
+The behavior of this method varies largely based on the type of instance
+that invokes it. Here are the rules for each argument in `args`:
+    
+* `Table`:
+    
+If `arg` is a `Row`, `Head`, `Foot`, `Body` or `ColGroup` object, it is
+pushed onto the table. If `arg` is a string, one `Row` object with
+one one `Data` object is pushed onto the `Table`. If `arg` is an `Array`,
+then one `Row` object is created and each element of the array is pushed
+onto that Row.
+    
+* `Table::Row`:
+    
+If `arg` is a `Header` or `Data` object, it is pushed onto the `Row`. If
+`arg` is a `String`, it is created as a single `Data` object. Any attempt
+to assign any other type will raise a `TypeError`.
+       
+* `Table::Head`, `Table::Foot`, `Table::Body`:
+    
+Behave identically to `Table::Row` except that they accept Table::Row objects as well.
+       
+* `Table::ColGroup`:
+    
+Behaves identically to Table::Row except that it only accepts Col objects.
+       
+* `Table::Col`:
+    
+This method is undefined for Table::Col, because they do not accept content.
+       
+* `Table::Data and Table::Header`:
+    
+Sets the text string for the `Data` or `Header` object. Arrays are join'd.
+Any other type raises a `TypeError`.
+
+`frame=(type)`
+
+Sets the value for the frame attribute. Valid values are border, void,
+above, below, hsides, lhs, rhs, vsides, and box. An ArgumentError is
+raised if an invalid type is detected.
+
+`height=(num)`
+
+Sets the value for the height attribute. Raises an ArgumentError if
+num.to_i is less than 0.
+
+`hspace=(num)`
+
+Sets the value for the hspace attribute. Raises an ArgumentError if
+num.to_i is less than 0.
+
+`nowrap=(bool)`
+
+Sets the value for the nowrap attribute. Setting it to true means it will be
+included as an attribute for the Table object. The default is false (i.e. not included).
+
+`rowspan=(num)`
+
+Sets the value for the rowspan attribute.
+
+`rules=(edges)`
+
+Sets the value for the rules attribute. Valid values are "all", "groups",
+"rows", "cols", or "none". An `ArgumentError` is raised if an invalid edges value
+is detected.
+
+`scope=(scope)`
+
+Sets the value for the scope attribute.  Valid values for +scope+ are
+row, col, rowgroup or colgroup.  An ArgumentError is raised if an invalid
+scope value is passed.
+
+`span=(num)`
+
+Sets the span attribute. If num.to_i is less than 0, and ArgumentError is raised.
+
+`summary=(string)`
+
+Sets the value for the summary attribute.
+
+`valign=(position)`
+
+Sets the value for the valign attribute. Valid values are top, center,
+bottom, and baseline. This is a non-standard extension.
+
+`vspace=(num)`
+
+Sets the value for the vspace attribute. This is a non-standard extension.
+
+`width=(num)`
+
+Sets the value for the width attribute.  If num is in 'x%' format, it
+is retained as a string.  If num is a Fixnum (or stringified number), an
+ArgumentError is raised if num.to_i is less than 0.

data/doc/table.md

@@ -0,0 +1,173 @@
+## Description
+An interface for generating HTML Tables with Ruby.
+
+## Synopsis
+```ruby
+require "html/table"
+include HTML
+
+table = HTML::Table.new{ |t|
+  t.border  = 1
+  t.bgcolor = "red"
+}
+
+table.push Table::Row.new{ |r|
+  r.align   = "left"
+  r.bgcolor = "green"
+  r.content = ["foo","bar","baz"]
+}
+
+row = Table::Row.new{ |r|
+  r.align   = "right"
+  r.bgcolor = "blue"
+  r.content = "hello world"
+}
+
+table[1] = row
+
+puts table.html
+
+#### output ####
+<table border=1 bgcolor='red'>
+  <tr align='left' bgcolor='green'>  # row 0
+     <td>foo</td>                    # column 0
+     <td>bar</td>                    # column 1
+     <td>baz</td>                    # column 2
+  </tr>
+  <tr align='right' bgcolor='blue'>  # row 1
+     <td>hello world</td>            # column 0
+  </tr>
+</table>
+```
+
+See the 'examples' directory for more examples.
+
+## Mixins
+`Table` is a subclass of `Array`, and therefore mixes in `Enumerable`. The
+`push`, `unshift` and `[]=` methods have been modified. See below for details.    
+    
+Table also mixes in the `AttributeHandler` module which provides methods
+for adding attributes to each of the tag types. See attributes.md for
+more details.
+
+## Constants
+`VERSION`
+
+The current version number (a String). This serves as the VERSION number
+for the entire html-table package.
+
+## Class Methods
+```
+Table.new(arg=nil)
+Table.new(arg=nil){ |t| ... }
+```
+
+Creates a new Table instance.  You can set attributes for the Table by
+passing a block.
+    
+If `arg` is supplied, it is automatically interpreted to be content. This
+is a shortcut for `Table.new{ |t| t.content = '...' }`.
+
+`Table.global_end_tags?`
+
+Returns the value of the `global_end_tags` class variable.  By default,
+this is true.
+
+`Table.global_end_tags=(true|false)`
+
+Sets the `global_end_tags` class variable. This determines class-wide, for
+those classes where end tags are optional, whether or not end tags are
+included in the final html. Classes where end tags are not optional are
+not affected.
+    
+If set to false, this overrides individual class end tags settings.
+
+## Instance Methods
+`Table#[]=(index, object)`
+
+Assigns `object` to `index`. There are restrictions to the data
+types that you can assign to a Table instance. They include `Caption`,
+`ColGroup`, `Body`, `Foot`, `Head` and `Row`. You cannot assign a slice (yet).
+
+`Table#configure(row_num, col_num=0){ |td_object| block }`
+
+Configures column `col_num` at row `row_num`, using a block to set
+options. If only `row_num` is specified, then you'll be configuring
+only the row. Generally speaking, that means you'll be configure a
+Table::Row and not a Data or Header object.
+
+`Table#content`
+
+Returns the HTML content.
+
+`Table#content=(arg)`
+
+Adds data to the Table. The `arg` may be a Table::Row object, an
+Array of Table::Row objects, an Array of Array's, an Array of Strings,
+or a single String. In the last two cases, a single Table::Row with a
+single Table::Row::Data object is created, with the string as the content.
+
+`Table#html`
+
+Returns the entire HTML content for the Table Object. This is what you
+want to print when you're done creating your Table.
+
+`Table#push(obj)`
+
+Pushes `obj` onto the Table, where `obj` must be a Row, Caption,
+ColGroup, Body, Foot or Head object. Also note that the Caption and Head
+objects will automatically put themselves at row 0 (or possibly 1, in the
+case of a Head object where a Caption already exists).
+
+`Table#unshift(obj)`
+
+Unshifts `obj` onto the Table. The same rules apply to `unshift` as
+they do to `push`.
+
+## Notes
+A Table consists of Table::Row, Table::Caption, Table::ColGroup,
+Table::Body, Table::Foot, Table::Head and Table::Row objects.
+
+Table::Row objects in turn consist of Table::Row::Data and Table::Row::Header objects.
+
+Table::ColGroup objects consist of Table::ColGroup::Col objects.
+
+Table::Head, Table::Body and Table::Foot objects consist of Table::Row objects.
+
+String attributes are quoted. Numeric attributes are not.
+
+Some attributes have type checking. Some check for valid arguments. In
+the latter case, it is case-insensitive. See the documentation on
+specific methods for more details.
+
+Using a non-standard extension (e.g. "background") will send a warning to
+STDERR in `$VERBOSE` (-w) mode.
+
+## Known Bugs
+None that I'm aware of. Please report bugs on the project page at
+https://github.com/djberg96/html-table
+
+## Future Plans
+Allow standard html tags to be added to elements as appropriate, such
+as `<B>`, `<I>`, etc.
+
+CSS support.
+
+## Acknowledgements
+Anthony Peacock, for giving me ideas with his HTML::Table Perl module.
+Holden Glova and Culley Harrelson for API suggestions and comments.
+
+## License
+Apache-2.0
+
+## Copyright
+(C) 2003-2021 Daniel J. Berger
+All Rights Reserved
+
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Author
+Daniel J. Berger

data/doc/table_body.md

@@ -0,0 +1,9 @@
+## Description
+A Table::Body object represents a single `<TBODY></TBODY>` instance for an HTML Table.
+
+## Notes
+In virtually every respect the Table::Body class is identical to
+the Table or Table::Row class. Unlike Table::Foot or Table::Head, there
+can be more than one instance (i.e. it's not a singleton class).
+    
+A Table::Body contains Table::Row objects.

data/doc/table_caption.md

@@ -0,0 +1,10 @@
+## Description
+A Table::Caption object represents a single `<CAPTION></CAPTION>` instance
+for an HTML Table.
+
+## Notes
+The Table::Caption class is virtually identical to the Table::Row::Data
+class. There is one important behavioral difference, however. First,
+there can only be one Table::Caption. If you attempt to add a second one,
+it will merely overwrite the existing one. Second, a Table::Caption is
+always bumped to index 0.

data/doc/table_colgroup.md

@@ -0,0 +1,8 @@
+## Description
+A Table::ColGroup object represents a single `<COLGROUP></COLGROUP>`
+instance for an HTML Table.
+
+## Notes
+In virtually every respect the Table::ColGroup class is identical to the
+Table::Row class.  The only difference, beyond the begin and end tags, is
+that a ColGroup may only contain instances of the Col class.

data/doc/table_colgroup_col.md

@@ -0,0 +1,7 @@
+## Description
+A Table::ColGroup::Col object represents a single `<COL>` instance for an HTML Table.
+
+## Notes
+In virtually every respect the Table::ColGroup::Col class is identical to
+the Table::Row::Data class. The only differences are that a Table::ColGroup::Col
+instance does not contain any content, nor does it include an end tag.

data/doc/table_content.md

@@ -0,0 +1,17 @@
+## Description
+A Table::Content is a wrapper for content used for Table::Row::Data and
+Table::Row::Header objects.  Although it can be instantiated directly, in
+practice it is autogenerated for you.
+
+## Notes
+Table::Content is a subclass of String and was mostly created in order
+to support a DSL style syntax as well as physical tags.
+
+## Synopsis
+```ruby
+content = Table::Content.new('my content') do
+  bold        true
+  italics     true
+  underline   true
+end
+```

data/doc/table_foot.md

@@ -0,0 +1,8 @@
+## Description
+A Table::Foot object represents a single `<TFOOT></TFOOT>` instance for an HTML Table.
+
+## Notes
+In virtually every respect the Table::Foot class is identical to the
+Table or Table::Row class. There is one significant difference. The
+Table::Foot class is a singleton. There can be only one Table::Foot
+instance per table.

data/doc/table_head.md

@@ -0,0 +1,10 @@
+## Description
+A Table::Head object represents a single `<THEAD></THEAD>` instance for an HTML Table.
+
+## Notes
+In virtually every respect the Table::Head class is identical to
+the Table or Table::Row class. There are two significant differences.
+First, the Table::Head class is a singleton. There can be only one
+Table::Head instance per table. Second, if an instance of Table::Head
+is added to a table, it will be automatically be put at index 0 (or 1
+if a Table::Caption exists).