Spreadsheet-HTML 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be82883c6b2f3f1eb50695360be61c9a74d11d45
-  data.tar.gz: 7934c3ca46e633193984d46e3bfc9fdd7417ce00
+  metadata.gz: 612af177715bcdf3a5a7f501b589e6e024510584
+  data.tar.gz: 70722e9638560cbe20a7009ec90cc71d5739dc29
 SHA512:
-  metadata.gz: 61a247d27d8f1aea4eadd5c1024234add596fde13e6a070c944468290484a4dbbcb6510f5dc9f132b56fdbcd52f1ff6e47a746d0733b734c578ea60971ab598b
-  data.tar.gz: 9f5b69f0eb818ee9ec8e2ed8c7d71a06f795bd98e38d655f749850c6708c08beb657768e74cf5fde3b7bf534d24d05224965059b8b3387c58da6f90697290a18
+  metadata.gz: c18b62c5538242233732ec5ef6220c08a05fd39f7cbc4e3d3492b6fab0de584cd04195b49aff3aeea0adda670b0c5b2e5be2b7025168738b3b4d1d1a2ad7beba
+  data.tar.gz: f4ae6f8eb48f98b519cc75317849df37e09cecf8e4cbe18bee880c98532cf452e429f0e81de9cf89f56e9b5ed0a41cf430eca775e78564384fe1da2ab12ee634

data/Changes

@@ -1,5 +1,8 @@
 Revision history for html-autotag-ruby
 
+0.0.3
+    - added docs (hopefully in the right place)
+
 0.0.2
     - no real changes, just ensuring that all new files are published
 

data/Spreadsheet-HTML.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rake'
   spec.add_runtime_dependency 'HTML-AutoTag', '~> 1.0', '>= 1.0.1'
 end

data/doc/HTML.rdoc

@@ -0,0 +1,137 @@
+== Description
+    Just another HTML table generator for ruby.
+    Generate HTML tables with ease (HTML4, XHTML and HTML5).
+    Generate portrait, landscape and other rotated views. Handles
+    rotating table attributes via HTML-AutoTag.
+
+== Installation
+
+    gem install Spreadsheet-HTML
+
+== Synopsis
+    require 'Spreadsheet/HTML'
+
+    data = Array[ [1,2,3], [4,5,6] ]
+    generator = Spreadsheet::HTML.new()
+    puts generator.generate( data )
+    puts generator.generate( 'data' => data )
+
+    generator = Spreadsheet::HTML.new( 'data' => data )
+    puts generator.portrait( 'indent' => "\t" )
+    puts generator.landscape( 'encodes' => 1 )
+
+    puts generator.generate( 'tgroups' => 1 )
+    puts generator.generate( 'tgroups' => 2 )
+
+    puts generator.generate( 'tr' => { 'class' => %w{ odd even } } )
+
+    # See t/ directory for more examples
+
+== Methods
+    With the exception of new, all methods return an HTML table as a string.
+
+new( params )
+    Constructs a new generator configured with given params. These params will be used
+    for each call to a generator method. Any params specified in the constructor
+    may be overriden in a subsequent call to a generator method (which are listed next).
+
+generate( params )
+portrait( params )
+north( params )
+    These three methods all generate an HTML table with headings positioned at the top.
+
+landscape( params )
+west( params )
+    These two methods generate an HTML table with headings positioned at the left.
+    
+south( params )
+    This method generates an HTML table with headings positioned at the bottom.
+
+east( params )
+    This method generates an HTML table with headings positioned at the right.
+
+== Literal Parameters
+    Literal Parameters provides the means to modify the macro aspects of the table,
+    such as indentation, encoding, data source and table orientation.
+
+data
+    The data to be rendered as an HTML table. Array of Arrays.
+
+tgroups
+    Integer (0, 1 or 2). Group table rows into <thead>, <tbody> and <tfoot> sections.
+    When tgroups is set to 1, the <tfoot> section is omitted. The last row of the data
+    is found at the end of the <tbody> section instead. (loose) When tgroups is set to 2,
+    the <tfoot> section is found in between the <thead> and <tbody> sections. (strict)
+
+indent
+    The string to indent each row by. Defaults to undefined which produces no indentation.
+    Automatically adds newlines when set to any defined value.
+
+level
+    Positive integer. The level to start indentation at. This is useful for matching the nesting styles of
+    original HTML text that you may wish in insert into. (A value of 4 says "apply the repitition operator
+    to the value of indent 4 times.)
+
+empty
+    String. Render any empty cells with this value. Defaults to &nbps; 
+
+matrix
+    Boolean. Render the headings row with only <td> tags, no <th> tags.
+
+headless
+    Boolean. Render the table without the headings row at all.
+
+theta
+    Rotates table clockwise for positive values and counter-clockwise for negative values.
+    Default is 0: headings at top. 90 yields headings at right, 180 yields headings at bottom.
+    270 yields headings at left. To achieve landscape, use -270.
+
+flip
+    Flips the table horizontally from the perspective of the headings "row" by
+    negating the value of theta.
+
+== Dynamic Parameters
+    There currently are no Dynamic Parameters, but they will be implemented soon enough.
+    They will allow the client to modify headings by name and row/columns by their indices.
+
+== Tag Parameters
+    Tag Parameters provide a means to control the attributes of the table's tags, and in
+    the case of <th> and <td> the contents via callback subroutines (TODO!). Although
+    similar in form, they are differentiated from litertal parameters because they share
+    the names of the actual HTML table tags.
+
+table
+thead
+tfoot
+tbody
+tr
+    Hash. Apply these attributes to the specified tag.
+
+th
+td
+    <th> and <td> will be the only Tag Parameters that accept callback methods, but this is still TODO.
+    In the meantime they behave the same as other Tag Parameters.
+
+thead.tr
+    When tgroups is 1 or 2, this tag parameter is available to control the attributes of
+    the <tr> tag within the <thead> group.
+
+tfoot.tr
+    When tgroups is 2, this tag parameter is available to control the attributes of
+    the <tr> tag within the <tfoot> group.
+
+== License
+    MIT
+
+== Copyright
+   (C) 2015 Jeff Anderson
+   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
+    Jeff Anderson
+    jeffa@cpan.org

data/lib/Spreadsheet/HTML/version.rb

@@ -1,5 +1,5 @@
 module Spreadsheet
   class HTML
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Spreadsheet-HTML
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - jeffa
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -72,6 +72,7 @@ files:
 - License.md
 - Rakefile
 - Spreadsheet-HTML.gemspec
+- doc/HTML.rdoc
 - lib/Spreadsheet/HTML.rb
 - lib/Spreadsheet/HTML/version.rb
 - readme.md