rails_table_for 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155237f1a1d730b42f5163e83f94f851b333abb4629337028eb46921fdb803ea
-  data.tar.gz: de618efd0f8849900c52e83db411a7960c12039cfc9e1e5437cc427e4cee7a44
+  metadata.gz: a2c69c3a95a5605f310ce4ef150157d44ab326a07d58b0b94ae984c61bc8059b
+  data.tar.gz: 7b6cbf7ddebf42a2cad86d6205e00018b36539be505ca41e01e2bc610dfc4f4f
 SHA512:
-  metadata.gz: a936961884260f6ffed048e9838fa08b1b089903b5a8d6e81618076215452579e73400025f863ca97aebc3c95669eda880ede96e209b62d91cde3b93ceae4073
-  data.tar.gz: 23f1e6a33f112248ca84233af07fcdc815857e348b86a1183cb5bc72b332ae295da34ce229fca428eae3000625cc380b7d541eeb6576c2c5c681a42e35043e47
+  metadata.gz: 51503314ccec53647609524aadee9b411a8725274e5c18a88b26d49c94b8fc4d42c2451f5ee40a5d546e2dbecc776983f6f0f8b2311f68a0e04378d7f82a5361
+  data.tar.gz: 144a74ce2af192f88e587535ec4278a4d46f4d2d92a750131a2834de1cf72f9de2ba6c56af266d0953af5fe86ab7c68232c3d7da949870acc874a65fc99a4028

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/{tests.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Tests
+name: Build & Test
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
     branches: [ master ]
 
 jobs:
-  run_minitest:
+  build_and_test:
 
     runs-on: ubuntu-latest
 
@@ -18,10 +18,12 @@ jobs:
       with:
         ruby-version: 2.6.x
     - name: Install libsqlite3-dev
-      run: |
-        sudo apt-get install -y libsqlite3-dev
-    - name: Build and test
+      run: sudo apt-get install -y libsqlite3-dev
+    - name: Build
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3
-        bundle exec rake
+    - name: Rubocop
+      run: bundle exec rake rubocop
+    - name: Test
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_table_for (0.2.2)
+    rails_table_for (0.3.0)
       rails (>= 5)
 
 GEM
@@ -62,6 +62,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2)
+    ast (2.4.0)
     builder (3.2.4)
     bump (0.9.0)
     byebug (11.1.1)
@@ -72,7 +73,8 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    jaro_winkler (1.5.4)
+    loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -87,6 +89,9 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -116,7 +121,18 @@ GEM
       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)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -127,8 +143,9 @@ GEM
     sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
@@ -145,6 +162,7 @@ DEPENDENCIES
   nokogiri (~> 1.10, >= 1.10.9)
   rails_table_for!
   rake (~> 13.0, >= 13.0.1)
+  rubocop (~> 0.80, >= 0.80.1)
   sqlite3 (~> 1.4, >= 1.4.2)
 
 BUNDLED WITH

data/Rakefile

@@ -24,4 +24,12 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 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
+
 task default: :test

data/lib/rails_table_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_table_for/railtie'
 require 'rails_table_for/table_helper'
 

data/lib/rails_table_for/elements/block_column.rb

@@ -1,20 +1,26 @@
+# frozen_string_literal: true
+
 require 'rails_table_for/helpers/auto_link'
 require 'rails_table_for/elements/column'
 
 module Elements
   class BlockColumn < Column
-    include Helpers::AutoLink, ActionView::Helpers::TagHelper
+    include ActionView::Helpers::TagHelper
+    include Helpers::AutoLink
+
+    attr_reader :block, :title, :auto_link_enabled
+    private :block, :title, :auto_link_enabled
 
     def initialize(block, **options)
       @block = block
       @title = options[:title]
-      @auto_link = options[:auto_link] || false
+      @auto_link_enabled = options[:auto_link] || false
     end
 
     def td(record)
-      text = @block.call(record)
-      content = @auto_link ? auto_link(record, text) : text
+      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,11 +1,13 @@
+# frozen_string_literal: true
+
 module Elements
   class Column
     def th
-      content_tag :th, @title
+      content_tag :th, title
     end
 
-    def td(record)
+    def td(_)
       raise 'Not implemented'
     end
   end
-end
+end

data/lib/rails_table_for/elements/field_column.rb

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
 require 'rails_table_for/helpers/auto_link'
 require 'rails_table_for/elements/column'
 
 module Elements
   class FieldColumn < Column
-    include Helpers::AutoLink, ActionView::Helpers::TagHelper
+    include ActionView::Helpers::TagHelper
+    include Helpers::AutoLink
+
+    attr_reader :field, :title, :auto_link_enabled
+    private :field, :title, :auto_link_enabled
 
     def initialize(field, **options)
-      if field.nil?
-        raise ArgumentError.new("Field cannot be nil")
-      end
+      raise('Field cannot be nil', ArgumentError) if field.nil?
+
       @field = field
       @title = options[:title] || field.to_s.humanize
-      @auto_link = options[:auto_link] || false
+      @auto_link_enabled = options[:auto_link] || false
     end
 
     def td(record)
-      text = record.send(@field)
-      content = @auto_link ? auto_link(record, text) : text
+      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

@@ -1,63 +1,77 @@
+# 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 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)
-      end
-      @options = options
+    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 field.nil? && !block_given?
-        raise 'Must provide either field or block'
-      end
-
+    def column(field = nil, **options, &block)
       if block_given?
-        @columns << BlockColumn.new(block, options)
+        columns << BlockColumn.new(block, options)
+      elsif field
+        columns << FieldColumn.new(field, options)
       else
-        @columns << FieldColumn.new(field, options)
+        raise 'Must provide either field or block'
       end
     end
 
-    def build(records)
-      return '' if records.nil? || records.empty?
-      return '' if @columns.nil? || @columns.empty?
-      table(records)
+    def to_s
+      return '' if record_count.zero?
+      return '' if columns.nil? || columns.empty?
+
+      draw
     end
 
     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
+
+    def table
+      content_tag :table do
+        head + body
       end
     end
 
     def head
       content_tag :thead do
         content_tag :tr do
-          @columns.map(&:th).join.html_safe
+          columns.map(&:th).join.html_safe
         end
       end
     end
 
-    def body(records)
+    def body
       content_tag :tbody do
-        records.map {|record| body_row(record) }.join.html_safe
+        current_page_records.map { |record| body_row(record) }.join.html_safe
       end
     end
 
     def body_row(record)
       content_tag :tr do
-        @columns.map {|column| column.td(record) }.join.html_safe
+        columns.map { |column| column.td(record) }.join.html_safe
       end
     end
   end
-end
+end

data/lib/rails_table_for/helpers/auto_link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helpers
   module AutoLink
     include ActionView::Helpers::UrlHelper
@@ -7,4 +9,4 @@ module Helpers
       link_to(text, path)
     end
   end
-end
+end

data/lib/rails_table_for/helpers/paginate.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+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
+      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

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,27 @@
+# frozen_string_literal: true
+
 require 'rails_table_for/elements/table'
 
 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
-    end
-    table.build(records)
+    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
 end
 
 ActionView::Base.class_eval do
   include TableHelper
-end
+end

data/lib/rails_table_for/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTableFor
-  VERSION = '0.2.2'
+  VERSION = '0.3.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.3.0
 platform: ruby
 authors:
 - Austin Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-04-07 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
@@ -183,10 +204,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:

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