rails_table_for 0.2.2 → 0.4.0

data/lib/rails_table_for/elements/table.rb

@@ -1,63 +1,80 @@
+# frozen_string_literal: true
+
 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 ActionView::Helpers::TagHelper
+module RailsTableFor
+  module Elements
+    class Table
+      include Helpers::Paginate
+      include ActionView::Helpers::TagHelper
 
-    attr_accessor :output_buffer
+      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(**options)
-      columns = options[:columns] || []
-      @columns = columns.map do |field|
-        FieldColumn.new(field)
+      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]
+        @table_class = options[:class]
       end
-      @options = options
-    end
 
-    def column(field=nil, **options, &block)
-      if field.nil? && !block_given?
-        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
 
-      if block_given?
-        @columns << BlockColumn.new(block, options)
-      else
-        @columns << FieldColumn.new(field, options)
+      def to_s
+        return '' if record_count.zero?
+        return '' if columns.empty?
+
+        draw
       end
-    end
 
-    def build(records)
-      return '' if records.nil? || records.empty?
-      return '' if @columns.nil? || @columns.empty?
-      table(records)
-    end
+      private
 
-    private
-    def table(records)
-      content_tag :table, class: @options[:class] do
-        [head, body(records)].join.html_safe
+      def draw
+        content_tag :div do
+          table + pagination_links
+        end
       end
-    end
 
-    def head
-      content_tag :thead do
-        content_tag :tr do
-          @columns.map(&:th).join.html_safe
+      def table
+        content_tag :table, class: @table_class do
+          head + body
         end
       end
-    end
 
-    def body(records)
-      content_tag :tbody do
-        records.map {|record| body_row(record) }.join.html_safe
+      def head
+        content_tag :thead do
+          content_tag :tr do
+            columns.map(&:th).join.html_safe
+          end
+        end
+      end
+
+      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
-end
+end

data/lib/rails_table_for/helpers/auto_link.rb

@@ -1,10 +1,14 @@
-module Helpers
-  module AutoLink
-    include ActionView::Helpers::UrlHelper
+# frozen_string_literal: true
 
-    def auto_link(record, text)
-      path = Rails.application.routes.url_helpers.polymorphic_path(record)
-      link_to(text, path)
+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)
+      end
     end
   end
-end
+end

data/lib/rails_table_for/helpers/paginate.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'byebug'
+
+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
+
+      def current_page_records
+        if paginated?
+          start_index = (current_page_number - 1) * page_size
+          records.slice(start_index, page_size)
+        else
+          records
+        end
+      end
+
+      private
+
+      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
+
+        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
+
+        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}"
+      end
+    end
+  end
+end

data/lib/rails_table_for/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTableFor
   class Railtie < ::Rails::Railtie
   end

data/lib/rails_table_for/table_helper.rb

@@ -1,21 +1,29 @@
+# frozen_string_literal: true
+
 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_url: request.original_url,
-      request_params: request.params
-    })
-    table = Elements::Table.new(options)
-    if block_given?
-      yield table
+    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
+
+    def request_options
+      {
+        request_path: request.path,
+        request_params: request.params.except(:action, :controller)
+      }
     end
-    table.build(records)
   end
 end
 
 ActionView::Base.class_eval do
-  include TableHelper
-end
+  include RailsTableFor::TableHelper
+end

data/lib/rails_table_for/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTableFor
-  VERSION = '0.2.2'
+  VERSION = '0.4.0'
 end

data/rails_table_for.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'nokogiri', '~> 1.10', '>= 1.10.9'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  spec.add_development_dependency 'rubocop', '~> 0.80', '>= 0.80.1'
   spec.add_development_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_table_for
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Austin Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,6 +132,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.80.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -161,9 +181,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/new-user-story.md"
-- ".github/workflows/tests.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -176,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
@@ -183,10 +209,10 @@ files:
 - lib/rails_table_for/elements/field_column.rb
 - lib/rails_table_for/elements/table.rb
 - lib/rails_table_for/helpers/auto_link.rb
+- lib/rails_table_for/helpers/paginate.rb
 - lib/rails_table_for/railtie.rb
 - lib/rails_table_for/table_helper.rb
 - lib/rails_table_for/version.rb
-- lib/tasks/rails_table_for_tasks.rake
 - rails_table_for.gemspec
 homepage: https://github.com/acroos/rails_table_for
 licenses:
@@ -207,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

data/.github/ISSUE_TEMPLATE/new-user-story.md

@@ -1,20 +0,0 @@
----
-name: New User Story
-about: Request for new user functionality
-title: "[Feature Request]"
-labels: ''
-assignees: acroos
-
----
-
-## Story
-
-What is the new functionality?  How will it be used?  Please provide a code snippet if possible
-
-## Acceptance Criteria
-
-- List of criteria to consider this task finished
-
-## Additional Details
-
-- Additional implementation details that may prove helpful

data/lib/tasks/rails_table_for_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :rails_table_for do
-#   # Task goes here
-# end