thamble 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be087dbd34683e86222c190ef4249057adfe43faad8e372cea1e498d8a62a5cf
-  data.tar.gz: 3bf1c710554f51d5573063d8814791b99257f554215eb53303df1f0a7096d82f
+  metadata.gz: 292f4d36d629c5774c43a3df0b0ef11364aea32d3accf6d31c83cb31756600a4
+  data.tar.gz: 535958ace8a281764f54030d367579d5b551e7d7e915a04e60f3dc51481857ac
 SHA512:
-  metadata.gz: 0ea505f39ff8901cd49c1d65627ae0be026cb564dbca373b68e41028ec629dd629794bb4b7d9e52212fbd1efd72e6eaa4facd58a3697cea7b10b80534f450bd1
-  data.tar.gz: f38d8910459727b2b8c90f6bbd7aa6c6a7e656e7606c4c7a5cf196534c3af7620651336aa4c58b6f91465b3ccba5459b22cab0bd074b3da1aa0defa30ed0b2c8
+  metadata.gz: 5fe7aa6a608b50a2cdef03610b5a061a58901b2cd8795b28e99803c7a7a2bc86b2d60a5817052e79499658615ca973b44200561c90fe733ebd7c63e594709aea
+  data.tar.gz: 72414ab56d9483e93c53b3861eccbeef44a6f5b7e5b97905f4a1c4b4a43fc9d634026486b44bd95f01144fdb4663c562370995b484b4dc1a85d65687e1004cb1

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.2.0 (2022-07-07)
+
+* Make thamble/rails work with modern versions of Rails (jeremyevans)
+
+* Make fallback HTML escaping code use cgi instead of rack (jeremyevans)
+
+* Add Thamble.raw for simpler creation of raw strings (jeremyevans)
+
 === 1.1.0 (2019-11-20)
 
 * Support :column_th option for using th instead of td for first cell in each row (jeremyevans)

data/README.rdoc

@@ -1,72 +1,77 @@
 = Thamble
 
-Thamble exposes a single method, table, for easily creating HTML
-tables from enumerable objects.
+Thamble creates HTML tables from enumerable objects.
 
-= Installation
+== Installation
 
   gem install thamble
 
-= Source Code
+== Source Code
 
 Source code is available on GitHub at https://github.com/jeremyevans/thamble
 
-= Examples
+== Examples
 
-The default behavior just expects an enumerable of arrays (such as an array of
-arrays), and returns a string containing the HTML TABLE output:
+The Thamble.table method expects an enumerable of arrays (such as an array of
+arrays), and returns a string containing the HTML table output:
 
   puts Thamble.table([[1, 2]])
 
-    <table>
-    <tbody>
-    <tr>
-    <td>1</td>
-    <td>2</td>
-    </tr>
-    </tbody>
-    </table>
+output:
+
+  <table>
+  <tbody>
+  <tr>
+  <td>1</td>
+  <td>2</td>
+  </tr>
+  </tbody>
+  </table>
 
 If a block is passed to the method, all items in the enumerable are yielded to
 the block, and the block should return an array with the data to use in the table:
 
   puts Thamble.table([{:a=>1, :b=>2}, {:a=>3, :b=>4}]){|l| [l[:b], l[:a] + 10]}
 
-    <table>
-    <tbody>
-    <tr>
-    <td>2</td>
-    <td>11</td>
-    </tr>
-    <tr>
-    <td>4</td>
-    <td>13</td>
-    </tr>
-    </tbody>
-    </table>
+output:
+
+  <table>
+  <tbody>
+  <tr>
+  <td>2</td>
+  <td>11</td>
+  </tr>
+  <tr>
+  <td>4</td>
+  <td>13</td>
+  </tr>
+  </tbody>
+  </table>
 
 You can use the :headers option to set custom headers:
 
   puts Thamble.table([[1, 2], [3, 4]], :headers=>['A', 'B'])
 
-    <table>
-    <thead>
-    <tr>
-    <th>A</th>
-    <th>B</th>
-    </tr>
-    </thead>
-    <tbody>
-    <tr>
-    <td>1</td>
-    <td>2</td>
-    </tr>
-    <tr>
-    <td>3</td>
-    <td>4</td>
-    </tr>
-    </tbody>
-    </table>
+output:
+
+  <table>
+  <thead>
+  <tr>
+  <th>A</th>
+  <th>B</th>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+  <td>1</td>
+  <td>2</td>
+  </tr>
+  <tr>
+  <td>3</td>
+  <td>4</td>
+  </tr>
+  </tbody>
+  </table>
 
 Other options supported are:
 
@@ -81,7 +86,31 @@ Other options supported are:
        the row that returns a hash
 :widths :: Array of widths for each column
 
-= Rails Support
+== Escaping 
+
+By default, Thamble escapes all output.  You can use the Thamble.raw method
+to return a string marked as already being escaped.
+
+  puts Thamble.table([['&1234;', Thamble.raw('&1234;')]])
+
+output:
+
+  <table>
+  <tbody>
+  <tr>
+  <td>&amp;1234;</td>
+  <td>&1234;</td>
+  </tr>
+  </tbody>
+  </table>
+
+The raw method is also exposed on the second object yielded to Thamble.table:
+
+  puts Thamble.table([['1', '&1234;']]) do |row, table|
+    row.map{|value| table.raw(value )}
+  end
+
+== Rails Support
 
 Thamble comes with basic rails support via:
 
@@ -92,10 +121,10 @@ This allows you to use the following style in your templates:
 
   <%= thamble([[1, 2], [3, 4]], :headers=>['A', 'B']) %>
 
-= License
+== License
 
 MIT
 
-= Author
+== Author
 
 Jeremy Evans <code@jeremyevans.net>

data/lib/thamble/rails.rb

@@ -1,13 +1,13 @@
 # frozen-string-literal: true
 
-require 'thamble'
+require_relative '../thamble'
 require 'active_support/core_ext/string/output_safety'
 ActiveSupport::SafeBuffer.send(:include, Thamble::Raw)
 
 module Thamble
   module RailsHelper
     def thamble(*a, &block)
-      raw Thamble.table(*a, &block)
+      Thamble.table(*a, &block).html_safe
     end
   end
 end

data/lib/thamble.rb

@@ -36,6 +36,12 @@ module Thamble
   end
   module_function :table
 
+  # Return a raw string, which will not be HTML escaped in Thamble's output.
+  def raw(s)
+    RawString.new(s)
+  end
+  module_function :raw
+
   # The Table class stores the rows and attributes to use for the HTML tags,
   # and contains helper methods for common formatting.
   class Table
@@ -197,18 +203,20 @@ module Thamble
     
     begin
       require 'cgi/escape'
+    rescue LoadError
+      # :nocov:
+      # Handle old Ruby versions not supporting cgi/escape
+      require 'cgi'
+    else
       unless CGI.respond_to?(:escapeHTML) # work around for JRuby 9.1
         CGI = Object.new
         CGI.extend(defined?(::CGI::Escape) ? ::CGI::Escape : ::CGI::Util)
       end
-      def escape_html(value)
-        CGI.escapeHTML(value.to_s)
-      end
-    rescue LoadError
-      require 'rack/utils'
-      def escape_html(value)
-        Rack::Utils.escape_html(value.to_s)
-      end
+      # :nocov:
+    end
+
+    def escape_html(value)
+      CGI.escapeHTML(value.to_s)
     end
 
     # A HTML-escaped version of the given argument.

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: thamble
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-global_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-global_expectations
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 description: |
   Thamble exposes a single method, table, for easily creating HTML
   tables from enumerable objects.
@@ -66,14 +66,16 @@ files:
 - CHANGELOG
 - MIT-LICENSE
 - README.rdoc
-- Rakefile
 - lib/thamble.rb
 - lib/thamble/rails.rb
-- spec/thamble_spec.rb
 homepage: http://github.com/jeremyevans/thamble
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/thamble/issues
+  changelog_uri: https://github.com/jeremyevans/thamble/blob/master/CHANGELOG
+  mailing_list_uri: https://github.com/jeremyevans/thamble/discussions
+  source_code_uri: https://github.com/jeremyevans/thamble
 post_install_message: 
 rdoc_options:
 - "--quiet"
@@ -89,14 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Create HTML Tables from Enumerables

data/Rakefile

@@ -1,46 +0,0 @@
-require "rake"
-require "rake/clean"
-
-CLEAN.include ["thamble-*.gem", "rdoc", "coverage"]
-
-desc "Build thamble gem"
-task :package=>[:clean] do |p|
-  sh %{#{FileUtils::RUBY} -S gem build thamble.gemspec}
-end
-
-### Specs
-
-desc "Run specs"
-task :spec do
-  sh "#{FileUtils::RUBY} -I lib spec/thamble_spec.rb"
-end
-
-task :default => :spec
-
-### RDoc
-
-RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'Thamble: Create HTML Tables from Enumerables']
-
-begin
-  gem 'rdoc', '= 3.12.2'
-  gem 'hanna-nouveau'
-  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
-rescue Gem::LoadError
-end
-
-rdoc_task_class = begin
-  require "rdoc/task"
-  RDoc::Task
-rescue LoadError
-  require "rake/rdoctask"
-  Rake::RDocTask
-end
-
-RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
-
-rdoc_task_class.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.options += RDOC_OPTS
-  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
-end
-

data/spec/thamble_spec.rb

@@ -1,82 +0,0 @@
-require 'rubygems'
-require File.join(File.dirname(File.expand_path(__FILE__)), '../lib/thamble')
-ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
-require 'minitest/global_expectations/autorun'
-
-describe "Thamble.table" do
-  def table(*a, &block)
-    Thamble.table(*a, &block).gsub(/\s+\n/m, '').gsub("\n", '')
-  end
-
-  it 'should return string with HTML table for enumerable' do
-    table([[1, 2]]).must_equal '<table><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should :support :column_th option for first column being th' do
-    table([[1, 2]], :column_th=>true).must_equal '<table><tbody><tr><th>1</th><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :headers option for the headers' do
-    table([[1, 2]], :headers=>%w'a b').must_equal '<table><thead><tr><th>a</th><th>b</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :headers option as a string with comma separators' do
-    table([[1, 2]], :headers=>'a,b').must_equal '<table><thead><tr><th>a</th><th>b</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :widths option for setting width for each column' do
-    table([[1, 2]], :widths=>[3,4]).must_equal '<table><colgroup><col width="3" /><col width="4" /></colgroup><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should yield each object in enumerable to block to return data row to use' do
-    table([[1, 2]]){|l, t| l.map{|i| i*2}}.must_equal '<table><tbody><tr><td>2</td><td>4</td></tr></tbody></table>'
-  end
-
-  it 'should be able to create tags using the table.tag method' do
-    table([[1, 2]]){|l, t| l.map{|i| t.tag(:b, i*2)}}.must_equal '<table><tbody><tr><td><b>2</b></td><td><b>4</b></td></tr></tbody></table>'
-    table([[1, 2]]){|l, t| l.map{|i| t.tag(:b, i*2, i=>i)}}.must_equal '<table><tbody><tr><td><b 1="1">2</b></td><td><b 2="2">4</b></td></tr></tbody></table>'
-  end
-
-  it 'should be able to create links using the table.a method' do
-    table([[1, 2]]){|l, t| l.map{|i| t.a(i*2, 'foo')}}.must_equal '<table><tbody><tr><td><a href="foo">2</a></td><td><a href="foo">4</a></td></tr></tbody></table>'
-    table([[1, 2]]){|l, t| l.map{|i| t.a(i*2, 'foo', i=>i)}}.must_equal '<table><tbody><tr><td><a 1="1" href="foo">2</a></td><td><a 2="2" href="foo">4</a></td></tr></tbody></table>'
-  end
-
-  it 'should support :table option for the table attribtues' do
-    table([[1, 2]], :table=>{:class=>'foo'}).must_equal '<table class="foo"><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :tr option for the tr attributes' do
-    table([[1, 2]], :tr=>{:class=>'foo'}).must_equal '<table><tbody><tr class="foo"><td>1</td><td>2</td></tr></tbody></table>'
-    table([[1, 2]], :headers=>%w'a b', :tr=>{:class=>'foo'}).must_equal '<table><thead><tr class="foo"><th>a</th><th>b</th></tr></thead><tbody><tr class="foo"><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :td option for the td attributes' do
-    table([[1, 2]], :td=>{:class=>'foo'}).must_equal '<table><tbody><tr><td class="foo">1</td><td class="foo">2</td></tr></tbody></table>'
-  end
-
-  it 'should support :th option for the th attributes' do
-    table([[1, 2]], :headers=>%w'a b', :th=>{:class=>'foo'}).must_equal '<table><thead><tr><th class="foo">a</th><th class="foo">b</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support a proc for the :tr option' do
-    table([[1, 2]], :tr=>proc{|row| {:class=>"foo#{row.join}"}}).must_equal '<table><tbody><tr class="foo12"><td>1</td><td>2</td></tr></tbody></table>'
-    table([[1, 2]], :headers=>%w'a b', :tr=>proc{|row| {:class=>"foo#{row.join}"}}).must_equal '<table><thead><tr class="fooab"><th>a</th><th>b</th></tr></thead><tbody><tr class="foo12"><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support a proc for the :td option' do
-    table([[1, 2]], :td=>proc{|v, i, row| {:class=>"foo#{row.join}-#{v}-#{i}"}}).must_equal '<table><tbody><tr><td class="foo12-1-0">1</td><td class="foo12-2-1">2</td></tr></tbody></table>'
-  end
-
-  it 'should support a proc for the :th option' do
-    table([[1, 2]], :headers=>%w'a b', :th=>proc{|v| {:class=>"foo#{v}"}}).must_equal '<table><thead><tr><th class="fooa">a</th><th class="foob">b</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should support :caption option for the table caption' do
-    table([[1, 2]], :headers=>%w'a b', :caption=>'Foo').must_equal '<table><caption>Foo</caption><thead><tr><th>a</th><th>b</th></tr></thead><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-
-  it 'should be callable as a method if including the module' do
-    Class.new{include Thamble}.new.send(:table, [[1, 2]]).gsub(/\s+\n/m, '').gsub("\n", '').must_equal '<table><tbody><tr><td>1</td><td>2</td></tr></tbody></table>'
-  end
-end