render_table_v2 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62aec7ca406a95dfb7f8ff3f9eca4097ee8bebe95b34cec950cd363765658265
+  data.tar.gz: 5523491502145a3c200e1c65a3c187a6890e8c6d86d9e817e42ef1b31725729f
+SHA512:
+  metadata.gz: d303d4fa56e80c423170d67e4506338feccda8978f5268806cd67292bfe6205613da8d2d01196919e748dd92a7844d56df52c8c0992ce600703c3ff14dff6f4d
+  data.tar.gz: f39324b99311062ac6b5c243d616fb670a2c3ed18632e169473c77648ea49f408caf60bdd00cd97c0a56d54be9ead1bc90dbd4dc42b67055b9e860ee7e109b60

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 3.0.3
+before_install: gem install bundler -v 2.2.33

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at morales.jmanuel16@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in render_table.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 manuel morales
+
+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,252 @@
+# RenderTable
+
+RenderTable is a set of extensible table building modules that make displaying tabular data easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'render_table'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install render_table
+
+## Usage
+### Rendering a table
+Invoke the .render method on the table class with the template you want to render.
+
+Within an ERB template:
+```ruby
+<%= RenderTable::Table.render(records: User.all, header: [:id, :email, :name, :created_at]) %>
+```
+Records can be any collection that responds to .each
+
+You can also pass .render a block:
+```ruby
+<%= RenderTable::Table.render do |table| %>
+    <% table.records = User.all
+    <% table.header = [:id, :email, :name, :created_at] %>
+<% end %>
+```
+
+### Table ID and Classes
+To add an id or class to the rendered table
+```ruby
+table.table_id = 'my-table-id'
+table.table_class = 'my-table-class'
+```
+```html
+<table id="my-table-id" class="my-table-class">
+```
+You can also set global defaults for thse values within an initializer.
+```ruby
+RenderTable.configure do |config|
+  config.table_id = 'table-id'
+  config.table_class = 'table-class'
+end
+```
+### Overrides 
+To override the value of a cell regardless of its header pass a hash of procedures mapped to the overriden header.
+```ruby
+<%= RenderTable::Table.render do |table| %>
+    <% table.records = User.all
+    <% table.header = [:id, :not_a_real_method] %>
+    <% table.override = {
+        not_a_real_method: ->(_cell, _cell_index) { 'hello world' }
+    } %>
+<% end %>
+```
+```html
+<table>
+    <thead>
+        <tr>
+            <th>id</th>
+            <th>not_a_real_method</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>1</td>
+            <td>hello world</td>
+        </tr>
+</table>
+```
+Overrides can be any object that responds to .call(record, index)
+```ruby
+class User::NameOverride
+    def self.call(record, index)
+        record.name.upcase
+    end
+end
+
+RenderTable::Table.render do |table|
+    table.records = User.all
+    table.header = [:id, :name]
+    table.override = { name: User::NameOverride }
+end
+```
+
+### Row and Cell CSS
+To add dynamically created class and ids to row and cell elements pass a hash of procedures mapped to the desired class/id names.
+#### Rows
+```ruby
+table.html[:rows][:classes] = {
+    'is-user' => ->(record, _row_index) { record.is_a? User },
+    'is-first' => ->(_record, row_index) { row_index.zero? }
+}
+
+table.html[:rows][:ids] = {
+    'first' => ->(_record, row_index) { row_index.zero? },
+    'last' => ->(record, _index) { record == records.last }
+}
+```
+```html
+<tbody>
+    <tr id="first" class="is-first is-user">...</tr>
+    <tr class="is-user">...</tr>
+    <tr id="last" class="is-user">...</tr>
+</tbody>
+```
+#### Cells
+```ruby
+table.html[:cells][:classes] = {
+    'is-integer' => ->(cell_value, _cell_index) { cell_value == Integer },
+    'is-first' => ->(_cell_value, cell_index) { cell_index.zero? },
+}
+
+table.html[:cells][:ids] = {
+    'first' => ->(_record, cell_index) { cell_index.zero? }
+}
+```
+
+```html
+<tr>
+    <td id="first" class="is-integer is-first">1</td>
+    <td>john.doe@example.com</td>
+</tr>
+```
+### Options Column
+To add control elements to a row you can pass an inline template or file path to the 'options' attribute.
+#### Inline Template
+```ruby
+RenderTable::Table.render do |table|
+    table.records = User.all
+    table.header = [:id, :name]
+    table.options = "<%= link_to 'Edit', edit_user_path(record) %>"
+end
+```
+```html
+<table>
+    <thead>
+        <tr>
+            <th>id</th>
+            <th>name</th>
+            <th></th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>1</td>
+            <td>John Doe</td>
+            <td><a href="users/1/edit/">Edit</a></td>
+        </tr>
+    </tbody>
+</table>
+```
+You may also path a file path where a template can be rendered
+```ruby
+...
+
+table.options = File.join(__dir__, './options.html.erb')
+```
+
+### Custom table templates
+To add a custom table render class, create a new class that inherits from RenderTable::Base and provide a new implementation for .template
+
+Example Div Table template.
+```ruby
+class RenderTable::DivTable < RenderTable::Base
+  def template
+    <<-HTML
+      <div id="<%= table.table_id %>" class="div-table <%= table.table_class %>">
+        <div class="div-table-thead">
+          <div class="div-table-tr">
+            <% table.header.each do |header| %>
+              <div class="div-table-td"><%= header.to_s %></div>
+            <% end %>
+            <% if table.options %>
+              <div class="div-table-td"></div>
+            <% end %>
+          </div>
+        </div>
+        <div class="div-table-tbody">
+        <% table.rows.each do |row| %>
+          <div id="<%= row.id %>" class="div-table-tr <%= row.class %>">
+            <% row.cells.each do |cell| %>
+              <div id="<%= cell.id %>" class="div-table-td <%= cell.class %>">
+                <%= cell.value %>
+              </div>
+            <% end %>
+            <% if table.options %>
+              <div class="div-table-td"><%= options_cell(row.record, row.row_index) %></div>
+            <% end %>
+          </div>
+        <% end %>
+        </div>
+      </div>
+    HTML
+  end
+end
+```
+
+Then call .render on the newly created class.
+
+```ruby
+RenderTable::DivTable.render do |table|
+    table.records = User.all
+    table.header = [:id, :name]
+end
+```
+
+# Changing defaults
+To modify the default values on rendered tables call the .configuration method from a required initializer.
+```ruby
+# config/render_table_config.rb
+  RenderTable.configure do |config|
+    config.table_id = 'test-table-id'
+    config.table_class = 'test-table-class'
+    config.cell_value = '---'
+    config.html = {
+        rows: {
+          classes: {},
+          ids: {}
+        },
+        cells: {
+          classes: {},
+          ids: {}
+        }
+      }
+  end
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mjmorales/render_table. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RenderTable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjmorales/render_table/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'render_table'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/render_table/base.rb

@@ -0,0 +1,57 @@
+require 'erb'
+
+class RenderTable::Base
+  include ERB::Util
+
+  attr_accessor :records, :header, :html, :override, :table_id, :table_class, :options, :records, :header, :html,
+                :override, :table_id, :table_class, :timestamps, :options
+
+  def self.render(args = {})
+    table = new(args)
+    yield table
+    table.render.html_safe
+  end
+
+  def initialize(args = {})
+    @records     = args[:records]     || []
+    @header      = args[:header]      || []
+    @override    = args[:override]    || {}
+    @table_id    = args[:table_id]    || RenderTable.config.table_id
+    @table_class = args[:table_class] || RenderTable.config.table_class
+    @html        = args[:html]        || RenderTable.config.html
+    @timestamps ||= true
+    @options    = args[:options]
+  end
+
+  def rows
+    RenderTable::Row.rows_for_table(self)
+  end
+
+  def render
+    ERB.new(template, 0, '%<>').result(binding)
+  end
+
+  def context
+    binding
+  end
+
+  private
+
+  def table
+    self
+  end
+
+  def options_cell(record, index)
+    RenderTable::Options.generate(table, @options, record, index)
+  end
+
+  def template
+    <<-ERB
+      <% table.rows.each do |row| %>
+      <% row.cells.each do |cell| %>
+      <%= cell.value %>
+      <% end %>
+      <% end %>
+    ERB
+  end
+end

data/lib/render_table/cell.rb

@@ -0,0 +1,33 @@
+class RenderTable::Cell
+  attr_accessor :header, :cell_index, :html
+
+  def self.cells_for_row(row, table)
+    table.header.collect.with_index do |header_cell, cell_index|
+      RenderTable::Cell.new(header_cell, row, cell_index, table)
+    end
+  end
+
+  def initialize(header, row, cell_index, table)
+    @header = header
+    @row = row
+    @cell_index = cell_index
+    @table = table
+    @html = @table.html[:cells]
+  end
+
+  def value
+    record = @row.record
+    overriden_header = @table.override[header]
+    return overriden_header.call(record, @cell_index) if overriden_header
+    return record.send(header) if @row.record.respond_to? header
+    RenderTable.config.cell_value
+  end
+
+  def class
+    RenderTable::Html.html_string(@html[:classes], value, @cell_index)
+  end
+
+  def id
+    RenderTable::Html.html_string(@html[:ids], value, @cell_index)
+  end
+end

data/lib/render_table/configuration.rb

@@ -0,0 +1,37 @@
+class RenderTable::Configuration
+  attr_accessor :table_id, :table_class, :html, :cell_value
+
+  def initialize
+    @table_id = RenderTable::Configuration.default_table_id
+    @table_class = RenderTable::Configuration.default_table_class
+    @html = RenderTable::Configuration.default_html
+    @cell_value = RenderTable::Configuration.default_cell_value
+  end
+
+  class << self
+    def default_html
+      {
+        rows: {
+          classes: {},
+          ids: {}
+        },
+        cells: {
+          classes: {},
+          ids: {}
+        }
+      }
+    end
+
+    def default_table_id
+      ''
+    end
+
+    def default_table_class
+      ''
+    end
+
+    def default_cell_value
+      'N/A'
+    end
+  end
+end

data/lib/render_table/html.rb

@@ -0,0 +1,11 @@
+module RenderTable::Html
+  def self.html_string(html_procedure_hash, record, index)
+    accumulated_html_strings = []
+    html_procedure_hash.each do |html_string, procedure|
+      next unless procedure.call(record, index)
+      accumulated_html_strings << html_string
+    end
+
+    accumulated_html_strings.join(' ')
+  end
+end

data/lib/render_table/options.rb

@@ -0,0 +1,6 @@
+module RenderTable::Options
+  def self.generate(table, template, record, index)
+    template = File.read(template) if File.exist? template
+    ERB.new(template, 0, '%<>').result(binding)
+  end
+end

data/lib/render_table/row.rb

@@ -0,0 +1,29 @@
+
+class RenderTable::Row
+  attr_accessor :record, :row_index, :html
+
+  def self.rows_for_table(table)
+    table.records.collect.with_index do |record, row_index|
+      RenderTable::Row.new(record, row_index, table)
+    end
+  end
+
+  def initialize(record, row_index, table)
+    @record = record
+    @row_index = row_index
+    @table = table
+    @html = @table.html[:rows]
+  end
+
+  def class
+    RenderTable::Html.html_string(@html[:classes], @record, @row_index)
+  end
+
+  def id
+    RenderTable::Html.html_string(@html[:ids], @record, @row_index)
+  end
+
+  def cells
+    RenderTable::Cell.cells_for_row(self, @table)
+  end
+end

data/lib/render_table/table.rb

@@ -0,0 +1,40 @@
+class RenderTable::Table < RenderTable::Base
+  def template
+    <<-HTML
+      <table id="<%= table.table_id %>" class="<%= table.table_class %>">
+        <thead>
+          <tr>
+            <% table.header.each do |header| %>
+              <th><%= header.to_s %></th>
+            <% end %>
+            <% if table.timestamps %>
+              <th>Date Created</th>
+              <th>Last Updated</th>
+            <% end %>
+            <% if table.options %>
+              <th>Options</th>
+            <% end %>
+          </tr>
+        </thead>
+        <tbody>
+        <% table.rows.each do |row| %>
+          <tr id="<%= row.id %>" class="<%= row.class %>">
+            <% row.cells.each do |cell| %>
+              <td id="<%= cell.id %>" class="<%= cell.class %>">
+                <%= cell.value %>
+              </td>
+            <% end %>
+            <% if table.timestamps %>
+              <td><%= row.record.created_at.strftime("%b %e, %Y - %l:%M %p %Z") %></td>
+              <td><%= row.record.updated_at.strftime("%b %e, %Y - %l:%M %p %Z") %></td>
+            <% end %>
+            <% if table.options %>
+              <td><%= options_cell(row.record, row.row_index) %></td>
+            <% end %>
+          </tr>
+        <% end %>
+        </tbody>
+      </table>
+    HTML
+  end
+end

data/lib/render_table/version.rb

@@ -0,0 +1,3 @@
+module RenderTable
+  VERSION = '2.0.1'.freeze
+end

data/lib/render_table.rb

@@ -0,0 +1,23 @@
+require 'render_table/version'
+require 'render_table/configuration'
+require 'render_table/html'
+require 'render_table/base'
+require 'render_table/row'
+require 'render_table/cell'
+require 'render_table/table'
+require 'render_table/options'
+
+module RenderTable
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= RenderTable::Configuration.new
+    yield(configuration)
+  end
+
+  def self.config
+    self.configuration || RenderTable::Configuration.new
+  end
+end

data/render_table.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'render_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'render_table_v2'
+  spec.version       = RenderTable::VERSION
+  spec.authors       = ['Manuel Morales', 'Mary Kniffin', 'Leo Policastro']
+  spec.email         = ['emau757@gmail.com']
+
+  spec.summary       = 'Extensible ruby html table building classes.'
+  spec.homepage      = 'https://github.com/galacticplastic/render_table'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.3.4'
+  spec.add_development_dependency 'rake', '~> 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: render_table_v2
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Manuel Morales
+- Mary Kniffin
+- Leo Policastro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description:
+email:
+- emau757@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/render_table.rb
+- lib/render_table/base.rb
+- lib/render_table/cell.rb
+- lib/render_table/configuration.rb
+- lib/render_table/html.rb
+- lib/render_table/options.rb
+- lib/render_table/row.rb
+- lib/render_table/table.rb
+- lib/render_table/version.rb
+- render_table.gemspec
+homepage: https://github.com/galacticplastic/render_table
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Extensible ruby html table building classes.
+test_files: []