rails_table_for 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2c69c3a95a5605f310ce4ef150157d44ab326a07d58b0b94ae984c61bc8059b
-  data.tar.gz: 7b6cbf7ddebf42a2cad86d6205e00018b36539be505ca41e01e2bc610dfc4f4f
+  metadata.gz: 62eb739afea2cf82a0adf56d8f2b5a274c841a242b60ef52a5442cd2ae710404
+  data.tar.gz: 595f796250f115a9618511fec2f32aafd49e1366530aa72f1b476909c52cfa3e
 SHA512:
-  metadata.gz: 51503314ccec53647609524aadee9b411a8725274e5c18a88b26d49c94b8fc4d42c2451f5ee40a5d546e2dbecc776983f6f0f8b2311f68a0e04378d7f82a5361
-  data.tar.gz: 144a74ce2af192f88e587535ec4278a4d46f4d2d92a750131a2834de1cf72f9de2ba6c56af266d0953af5fe86ab7c68232c3d7da949870acc874a65fc99a4028
+  metadata.gz: 9b74e9fb8d73aadb0a55d5157af96a4df488442aad4af7728b2dfd70d1c683251e1a0f1b57cdd85b84777bcf436d913ce1eb955896917bdd4dc85bedc1144a60
+  data.tar.gz: d8e86a815cddf774c524f694101706feb046db52962e904948cc1569899e0abf512f292233111371ca69f43a97a09967e43b84cccc2b07305ac4efa9c6580bf0

data/.rubocop.yml

@@ -1,8 +1,19 @@
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - 'lib/**/*.rb'
+    - 'test/**/*.rb'
+  Exclude:
+    - 'test/dummy/bin/*'
+    - 'test/dummy/db/schema.rb'
+
 Style/Documentation:
   Enabled: false
 
 Layout/LineLength:
   Max: 100
+  Exclude:
+    - 'test/elements/table_test.rb'
 
 Style/HashEachMethods:
   Enabled: true
@@ -11,4 +22,4 @@ Style/HashTransformKeys:
   Enabled: true
 
 Style/HashTransformValues:
-  Enabled: true
+  Enabled: true

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # CHANGELOG
 ## Master
 
+---
+## 0.3.0
+
+### Features:
+- Pagination: [#3](https://github.com/acroos/rails_table_for/issues/3)
+
 ---
 ## 0.2.2
 
 ### Bugs Fixed:
-- `table_for` method was nested, resulting in initial load rendering "table_for" as text
+- `table_for` method was nested, resulting in initial load rendering "table_for" as text

data/Gemfile

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

data/Gemfile.lock

@@ -1,71 +1,71 @@
 PATH
   remote: .
   specs:
-    rails_table_for (0.3.0)
+    rails_table_for (0.3.1)
       rails (>= 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.2)
-      actionpack (= 6.0.2.2)
+    actioncable (6.0.3.1)
+      actionpack (= 6.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionmailbox (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       mail (>= 2.7.1)
-    actionmailer (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
+    actionmailer (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actiontext (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       nokogiri (>= 1.8.5)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    activejob (6.0.3.1)
+      activesupport (= 6.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activestorage (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activestorage (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
       marcel (~> 0.3.1)
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
     builder (3.2.4)
     bump (0.9.0)
-    byebug (11.1.1)
+    byebug (11.1.3)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     erubi (1.9.0)
@@ -73,7 +73,6 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -82,56 +81,58 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.4)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
-    parser (2.7.0.5)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.2)
-      actioncable (= 6.0.2.2)
-      actionmailbox (= 6.0.2.2)
-      actionmailer (= 6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actiontext (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    rails (6.0.3.1)
+      actioncable (= 6.0.3.1)
+      actionmailbox (= 6.0.3.1)
+      actionmailer (= 6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actiontext (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       bundler (>= 1.3.0)
-      railties (= 6.0.2.2)
+      railties (= 6.0.3.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
     rexml (3.2.4)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.84.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
@@ -145,8 +146,8 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    websocket-driver (0.7.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
     zeitwerk (2.3.0)

data/Rakefile

@@ -27,9 +27,6 @@ end
 require 'rubocop/rake_task'
 
 desc 'Run RuboCop on the lib directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
-  task.fail_on_error = true
-end
+RuboCop::RakeTask.new
 
 task default: :test

data/bin/test

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-$: << File.expand_path("../test", __dir__)
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rails/plugin/test"
+$LOAD_PATH << File.expand_path('../test', __dir__)
+
+require 'bundler/setup'
+require 'rails/plugin/test'

data/docs/Gemfile

@@ -1,16 +1,17 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 group :jekyll_plugins do
-  gem "github-pages", "~> 204"
+  gem 'github-pages', '~> 204'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.
-install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
-  gem "tzinfo", "~> 1.2"
-  gem "tzinfo-data"
+install_if -> { RUBY_PLATFORM =~ /mingw|mswin|java/ } do
+  gem 'tzinfo', '~> 1.2'
+  gem 'tzinfo-data'
 end
 
 # Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
-
+gem 'wdm', '~> 0.1.0', install_if: Gem.win_platform?

data/docs/Gemfile.lock

@@ -246,8 +246,6 @@ PLATFORMS
 
 DEPENDENCIES
   github-pages (~> 204)
-  jekyll-feed (~> 0.6)
-  minima (~> 2.0)
   tzinfo (~> 1.2)
   tzinfo-data
   wdm (~> 0.1.0)

data/docs/guides/auto-linking-rows.md

@@ -0,0 +1,44 @@
+---
+layout: default
+title: rails_table_for
+---
+
+# Auto-linking Rows
+
+With the last example, we displayed a link for each row by passing a block to the `column` method
+and using `link_to`.  This is a whole lot of extra code for something so simple.  Let's see how we
+can do something similar in a single line:
+
+```
+<%=
+table_for @records do |table|
+  table.column :name, auto_link: true
+end
+%>
+```
+
+This will generate the following HTML:
+
+```html
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><a href="/records/1">Austin Roos</a></td>
+    </tr>
+  </tbody>
+</table>
+```
+
+You can also pass a block to `column` still, whatever value you return will be placed inside
+the anchor tag
+
+If no route can be found for the record, a `NoMethodError`  will be thrown.
+
+Now that we've simplified the linking, we should move on to some more features to make the table
+more user-friendly.  It's likely that some collections are going to be much too large to display
+on a single page, so let's try out [pagination](./pagination)

data/docs/guides/customizing-column-headers.md

@@ -0,0 +1,36 @@
+---
+layout: default
+title: rails_table_for
+---
+
+# Customizing Column Headers
+
+A one-line table is a delight, but we're a bit limited by only getting values and headers directly from our models.
+Let's start by customizing the column header.  The `table_for` method accepts a block with a single `Table` argument.
+This object has a single method (`.column`) that allows you some customization.  You can use it like this:
+
+```
+<%= table_for @records do |table| %>
+  <% table.column :name, title: 'Naam' %>
+<% end %>
+```
+
+The title of the column will now be `Naam` and the rest of the table will be the same as the first example:
+```html
+<table>
+  <thead>
+    <tr>
+      <th>Naam</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Austin Roos</td>
+    </tr>
+    ...
+  </tbody>
+</table>
+```
+
+So... we've got a pretty simple table here with our header in Dutch... there must be more right?  Indeed, next let's see
+how to do more than print out values directly off the model.  Move on to [customizing row values](./customizing-row-values)

data/docs/guides/customizing-row-values.md

@@ -0,0 +1,41 @@
+---
+layout: default
+title: rails_table_for
+---
+
+# Customizing Row Values
+
+It's great that we can change the header on a column displaying a user's name, but we must be able to do more than just show
+simple strings from our models in these rows, right?  Right.  You can pass a block to the `Table#column` method and return
+anything your heart desires.  Let's add a column that gives us a link to 'Show' the user.
+
+```
+<%= 
+table_for @records do |table|
+  table.column :name, title: 'Naam'
+  table.column title: 'Link' { |record| link_to 'Show', record }
+end
+%>
+```
+
+Assuming the route exists to show that record, this will generate HTML like this:
+
+```html
+<table>
+  <thead>
+    <tr>
+      <th>Naam</th>
+      <th>Link</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Austin Roos</td>
+      <td><a href="/records/1">Show</a></td>
+    </tr>
+  </tbody>
+</table>
+```
+
+So... this gets us through most of the basics, but let's see if we can do things a little more simply.  Check out
+[auto-linking rows](./auto-linking-rows)

data/docs/guides/getting-started.md

@@ -0,0 +1,35 @@
+---
+layout: default
+title: rails_table_for
+---
+
+# Getting Started
+
+For a simple table displaying some attributes of your ActiveRecord model, simply
+call `table_for` with an ActiveRecord collection and an array of columns:
+
+```
+<%= table_for @records, columns: [:full_name] %>
+```
+
+The columns must correspond to methods/properties on the model class.  The column header
+will be the method/property name "humanized" (capitalized, split into words).
+
+Example output:
+```html
+<table>
+  <thead>
+    <tr>
+      <th>Full Name</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Austin Roos</td>
+    </tr>
+    ...
+  </tbody>
+</table>
+```
+
+This is a good start, but surely you'd like to customize things a little bit.   Move on to [customizing columns](./customizing-column-headers)

data/docs/guides/pagination.md

@@ -0,0 +1,55 @@
+---
+layout: default
+title: rails_table_for
+---
+
+# Pagination (beta)
+
+If you've made it this far, you know how to create some basic tables to present your data
+in whatever way you see fit.  Now you're so happy with your table that you want to present
+50 million rows.  This... is a little much for a single page.  Enter pagination:
+
+```
+<%= table_for @records, columns: [:id, :name], page_size: 10 %>
+```
+
+and voila!  you have a table showing only 10 rows per page as well as a set of links beneath
+the table to take you to each page
+
+```html
+<div>
+  <table>
+    <thead>
+      <tr>
+        <th>Id</th>
+        <th>Name</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>Austin Roos</td>
+        <td>1</td>
+      </tr>
+      ...
+    </tbody>
+  </table>
+  <div class="pagination-links">
+    1
+    <a href="/users?page=2">2</a>
+    <a href="/users?page=3">3</a>
+    <a href="/users?page=4">4</a>
+    <a href="/users?page=5">5</a>
+  </div>
+</div>
+```
+
+This feature is still in beta and there are some known limitations.
+
+### Known Issues
+
+If there are multiple tables on a single web page, the pages of the table will always be
+synced because of the query parameter.
+
+If the number of pages is very large, every pagination link is still shown instead of 
+something a bit more elegant like a few pages before and after the current one as well as
+a link to first and last page

data/docs/index.md

@@ -3,6 +3,12 @@ layout: default
 title: rails_table_for
 ---
 
+# Introduciton
+
+No more writing out dozens of <tr>, <th>, <td> elements.  Write a few lines of ruby code (or even a single line) and
+get a lovely little table generated for you.  You can present data from your records directly with almost no work, or 
+do a little customization if you'd like something extra special.  More features are coming soon, but pagination
+already comes included (only if you want it).
 
 # Installation
 
@@ -18,100 +24,14 @@ And then execute:
 $ bundle
 ```
 
-# Simple Table
-
-For the simplest table, just pass an ActiveRecord collection and an array of columns
-```
-<%= table_for @records, columns: [:name] %>
-```
-
-The columns must correspond to methods/properties on the record class.  The column header
-will be the method/property name "humanized".
-
-Example output:
-```html
-<table>
-  <thead>
-    <tr>
-      <th>Name</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>Austin</td>
-    </tr>
-  </tbody>
-</table>
-```
+# Code Examples
 
-# Customize Column Headers
-
-You can can change the default column headers by passing a block to `table_for` and using the `Table#column` method:
-
-```
-<%= table_for @records do |table| %>
-  <% table.column :name, title: 'Naam' %>
-<% end %>
-```
-
-The title of the column will now be `Naam` and the rest of the table will be the same as the first example:
-```html
-<table>
-  <thead>
-    <tr>
-      <th>Naam</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>Austin</td>
-    </tr>
-  </tbody>
-</table>
-```
+- [Getting Started](./guides/getting-started) (a one-liner?!)
+- [Customizing Column Headers](./guides/customizing-column-headers)
+- [Customizing Row Values](./guides/customizing-row-values)
+- [Auto-linking Rows](./guides/auto-linking-rows)
+- [Pagination](./guides/pagination)
 
-# Pass Blocks to `Table#column`
-
-You can pass a block to the `Table#column` method to display values not directly accessible
-from the model's methods/properties:
-
-```
-<%= 
-table_for @records do |table|
-  table.column title: 'Link' do |record|
-    link_to record.name, record
-  end
-end
-%>
-```
-
-Assuming the route exists to show that record, this will generate HTML like this:
-
-```html
-<table>
-  <thead>
-    <tr>
-      <th>Link</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><a href="/records/1">Record 1</a></td>
-    </tr>
-  </tbody>
-</table>
-```
-
-# Auto-linking columns
-
-Automatically get a link to the record represented by each row like this:
-
-```
-<%=
-table_for @records do |table|
-  table.column :id, auto_link: true
-end
-%>
-```
+# Wanna Help?
 
-If no route can be found for the record, a `NoMethodError`  will be thrown.
+Happily accepting bug reports, feature requests, and pull requests.  Visit https://github.com/acroos/rails_table_for

data/lib/rails_table_for/elements/block_column.rb

@@ -3,24 +3,27 @@
 require 'rails_table_for/helpers/auto_link'
 require 'rails_table_for/elements/column'
 
-module Elements
-  class BlockColumn < Column
-    include ActionView::Helpers::TagHelper
-    include Helpers::AutoLink
+module RailsTableFor
+  module Elements
+    class BlockColumn
+      include ActionView::Helpers::TagHelper
+      include Helpers::AutoLink
+      include Column
 
-    attr_reader :block, :title, :auto_link_enabled
-    private :block, :title, :auto_link_enabled
+      attr_reader :block, :title, :auto_link_enabled
+      private :block, :title, :auto_link_enabled
 
-    def initialize(block, **options)
-      @block = block
-      @title = options[:title]
-      @auto_link_enabled = options[:auto_link] || false
-    end
+      def initialize(block, **options)
+        @block = block
+        @title = options[:title]
+        @auto_link_enabled = options[:auto_link] || false
+      end
 
-    def td(record)
-      text = block.call(record)
-      content = auto_link_enabled ? auto_link(record, text) : text
-      content_tag :td, content
+      def td(record)
+        text = block.call(record)
+        content = auto_link_enabled ? auto_link(record, text) : text
+        content_tag :td, content
+      end
     end
   end
 end

data/lib/rails_table_for/elements/column.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
-module Elements
-  class Column
-    def th
-      content_tag :th, title
-    end
+module RailsTableFor
+  module Elements
+    module Column
+      def th
+        content_tag :th, title
+      end
 
-    def td(_)
-      raise 'Not implemented'
+      def td(_)
+        raise 'Not implemented'
+      end
     end
   end
 end

data/lib/rails_table_for/elements/field_column.rb

@@ -3,26 +3,29 @@
 require 'rails_table_for/helpers/auto_link'
 require 'rails_table_for/elements/column'
 
-module Elements
-  class FieldColumn < Column
-    include ActionView::Helpers::TagHelper
-    include Helpers::AutoLink
+module RailsTableFor
+  module Elements
+    class FieldColumn
+      include ActionView::Helpers::TagHelper
+      include Helpers::AutoLink
+      include Column
 
-    attr_reader :field, :title, :auto_link_enabled
-    private :field, :title, :auto_link_enabled
+      attr_reader :field, :title, :auto_link_enabled
+      private :field, :title, :auto_link_enabled
 
-    def initialize(field, **options)
-      raise('Field cannot be nil', ArgumentError) if field.nil?
+      def initialize(field, **options)
+        raise('Field cannot be nil', ArgumentError) if field.nil?
 
-      @field = field
-      @title = options[:title] || field.to_s.humanize
-      @auto_link_enabled = options[:auto_link] || false
-    end
+        @field = field
+        @title = options[:title] || field.to_s.humanize
+        @auto_link_enabled = options[:auto_link] || false
+      end
 
-    def td(record)
-      text = record.send(field)
-      content = auto_link_enabled ? auto_link(record, text) : text
-      content_tag :td, content
+      def td(record)
+        text = record.send(field)
+        content = auto_link_enabled ? auto_link(record, text) : text
+        content_tag :td, content
+      end
     end
   end
 end

data/lib/rails_table_for/elements/table.rb

@@ -4,73 +4,75 @@ require 'rails_table_for/elements/block_column'
 require 'rails_table_for/elements/field_column'
 require 'rails_table_for/helpers/paginate'
 
-module Elements
-  class Table
-    include Helpers::Paginate
-    include ActionView::Helpers::TagHelper
+module RailsTableFor
+  module Elements
+    class Table
+      include Helpers::Paginate
+      include ActionView::Helpers::TagHelper
 
-    attr_accessor :columns, :output_buffer, :page_size, :record_count, :records, :request_params,
-                  :request_path
-    private :columns, :page_size, :record_count, :records, :request_params, :request_path
+      attr_accessor :columns, :output_buffer, :page_size, :record_count, :records, :request_params,
+                    :request_path
+      private :columns, :page_size, :record_count, :records, :request_params, :request_path
 
-    def initialize(records, **options)
-      @records = records
-      @record_count = records.count
-      @columns = []
-      options[:columns]&.each { |field| column(field) }
-      @page_size = options[:page_size]
-      @request_path = options[:request_path]
-      @request_params = options[:request_params]
-    end
+      def initialize(records, **options)
+        @records = records
+        @record_count = records.count
+        @columns = []
+        options[:columns]&.each { |field| column(field) }
+        @page_size = options[:page_size]
+        @request_path = options[:request_path]
+        @request_params = options[:request_params]
+      end
 
-    def column(field = nil, **options, &block)
-      if block_given?
-        columns << BlockColumn.new(block, options)
-      elsif field
-        columns << FieldColumn.new(field, options)
-      else
-        raise 'Must provide either field or block'
+      def column(field = nil, **options, &block)
+        if block_given?
+          columns << BlockColumn.new(block, options)
+        elsif field
+          columns << FieldColumn.new(field, options)
+        else
+          raise 'Must provide either field or block'
+        end
       end
-    end
 
-    def to_s
-      return '' if record_count.zero?
-      return '' if columns.nil? || columns.empty?
+      def to_s
+        return '' if record_count.zero?
+        return '' if columns.empty?
 
-      draw
-    end
+        draw
+      end
 
-    private
+      private
 
-    def draw
-      content_tag :div do
-        table + pagination_links
+      def draw
+        content_tag :div do
+          table + pagination_links
+        end
       end
-    end
 
-    def table
-      content_tag :table do
-        head + body
+      def table
+        content_tag :table do
+          head + body
+        end
       end
-    end
 
-    def head
-      content_tag :thead do
-        content_tag :tr do
-          columns.map(&:th).join.html_safe
+      def head
+        content_tag :thead do
+          content_tag :tr do
+            columns.map(&:th).join.html_safe
+          end
         end
       end
-    end
 
-    def body
-      content_tag :tbody do
-        current_page_records.map { |record| body_row(record) }.join.html_safe
+      def body
+        content_tag :tbody do
+          current_page_records.map { |record| body_row(record) }.join.html_safe
+        end
       end
-    end
 
-    def body_row(record)
-      content_tag :tr do
-        columns.map { |column| column.td(record) }.join.html_safe
+      def body_row(record)
+        content_tag :tr do
+          columns.map { |column| column.td(record) }.join.html_safe
+        end
       end
     end
   end

data/lib/rails_table_for/helpers/auto_link.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-module Helpers
-  module AutoLink
-    include ActionView::Helpers::UrlHelper
+module RailsTableFor
+  module Helpers
+    module AutoLink
+      include ActionView::Helpers::UrlHelper
 
-    def auto_link(record, text)
-      path = Rails.application.routes.url_helpers.polymorphic_path(record)
-      link_to(text, path)
+      def auto_link(record, text)
+        path = Rails.application.routes.url_helpers.polymorphic_path(record)
+        link_to(text, path)
+      end
     end
   end
 end

data/lib/rails_table_for/helpers/paginate.rb

@@ -2,59 +2,61 @@
 
 require 'byebug'
 
-module Helpers
-  module Paginate
-    include ActionView::Helpers::UrlHelper
-
-    protected
-
-    def pagination_links
-      return '' unless paginated?
-
-      content_tag :div, class: 'pagination-links' do
-        (1..num_pages).map do |page_number|
-          if page_number == current_page_number
-            page_number.to_s
-          else
-            page_link(page_number)
-          end
-        end.join.html_safe
+module RailsTableFor
+  module Helpers
+    module Paginate
+      include ActionView::Helpers::UrlHelper
+
+      protected
+
+      def pagination_links
+        return '' unless paginated?
+
+        content_tag :div, class: 'pagination-links' do
+          (1..num_pages).map do |page_number|
+            if page_number == current_page_number
+              page_number.to_s
+            else
+              page_link(page_number)
+            end
+          end.join.html_safe
+        end
       end
-    end
 
-    def current_page_records
-      if paginated?
-        start_index = (current_page_number - 1) * page_size
-        records.slice(start_index, page_size)
-      else
-        records
+      def current_page_records
+        if paginated?
+          start_index = (current_page_number - 1) * page_size
+          records.slice(start_index, page_size)
+        else
+          records
+        end
       end
-    end
 
-    private
+      private
 
-    def paginated?
-      page_size != nil
-    end
+      def paginated?
+        page_size != nil
+      end
 
-    def num_pages
-      full_pages = record_count / page_size
-      partial_final_page = (record_count % page_size).zero? ? 0 : 1
+      def num_pages
+        full_pages = record_count / page_size
+        partial_final_page = (record_count % page_size).zero? ? 0 : 1
 
-      full_pages + partial_final_page
-    end
+        full_pages + partial_final_page
+      end
 
-    def current_page_number
-      page = request_params[:page]&.to_i || 1
-      raise 'Invalid page number' if page < 1 || page > num_pages
+      def current_page_number
+        page = request_params[:page]&.to_i || 1
+        raise 'Invalid page number' if page < 1 || page > num_pages
 
-      page
-    end
+        page
+      end
 
-    def page_link(page_number)
-      path = request_path
-      query = request_params.merge({ page: page_number }).to_query
-      link_to page_number, "#{path}?#{query}"
+      def page_link(page_number)
+        path = request_path
+        query = request_params.merge({ page: page_number }).to_query
+        link_to page_number, "#{path}?#{query}"
+      end
     end
   end
 end

data/lib/rails_table_for/table_helper.rb

@@ -2,26 +2,28 @@
 
 require 'rails_table_for/elements/table'
 
-module TableHelper
-  include ActionView::Helpers::TagHelper
+module RailsTableFor
+  module TableHelper
+    include ActionView::Helpers::TagHelper
 
-  def table_for(records, **options)
-    options.merge!(request_options)
-    table = Elements::Table.new(records, options)
-    yield table if block_given?
-    table.to_s
-  end
+    def table_for(records, **options)
+      options.merge!(request_options)
+      table = Elements::Table.new(records, options)
+      yield table if block_given?
+      table.to_s
+    end
 
-  private
+    private
 
-  def request_options
-    {
-      request_path: request.path,
-      request_params: request.params.except(:action, :controller)
-    }
+    def request_options
+      {
+        request_path: request.path,
+        request_params: request.params.except(:action, :controller)
+      }
+    end
   end
 end
 
 ActionView::Base.class_eval do
-  include TableHelper
+  include RailsTableFor::TableHelper
 end

data/lib/rails_table_for/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsTableFor
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_table_for
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Austin Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -197,6 +197,11 @@ files:
 - docs/Gemfile
 - docs/Gemfile.lock
 - docs/_config.yml
+- docs/guides/auto-linking-rows.md
+- docs/guides/customizing-column-headers.md
+- docs/guides/customizing-row-values.md
+- docs/guides/getting-started.md
+- docs/guides/pagination.md
 - docs/index.md
 - lib/rails_table_for.rb
 - lib/rails_table_for/elements/block_column.rb
@@ -228,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: HTML tables for ActiveRecord collections, made simple