hyper-kitten-tables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83419fee953f6b9bf30e241452485f7618895c4f736958b7fd892da7658c59fe
+  data.tar.gz: e958eb144264555b6107282a2cfb8d3f04466745715a097692be34889f97ef56
+SHA512:
+  metadata.gz: 826fd4136a3ef599cf4e8e16355859b8dd021167a07ea85589282c13e8dc2ea5cecd75b75c51b9c105276c675d1309ed5b3d64da0c52700477a7cc1737928cff
+  data.tar.gz: 192b353c5bbd6a2dffdd29d460e9580e8dc4f6d150335ef163d22d4b4a2d3a2e8295318b400c46d4e6b44d61e0696c4ff569ff9cf857d4194f0433b0818aa228

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Joshua Klina
+
+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,28 @@
+# Tables
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tables"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tables
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/hyper-kitten-tables.rb

@@ -0,0 +1,6 @@
+require "hyper_kitten_tables/version"
+require "hyper_kitten_tables/concerns/table"
+require "hyper_kitten_tables/components/table"
+
+module Tables
+end

data/lib/hyper_kitten_tables/components/table.rb

@@ -0,0 +1,7 @@
+module HyperKittenTables
+  module Components
+    class Table
+      include HyperKittenTables::Concerns::Table
+    end
+  end
+end

data/lib/hyper_kitten_tables/concerns/table.rb

@@ -0,0 +1,134 @@
+require "active_support/concern"
+require "forwardable"
+
+module HyperKittenTables
+  module Concerns
+    module Table
+      extend ActiveSupport::Concern
+
+      included do
+        extend Forwardable
+
+        def_delegators :@view_context, :content_tag, :capture, :request
+
+        Column = Struct.new(:name, :method_name, :sort_key, :block, :sortable, :options)
+      end
+
+      def initialize(collection: [], requested_columns: [], &block)
+        @collection = collection
+        @columns = []
+
+        @table_options = {}
+        @thead_options = {}
+        @tbody_options = {}
+        @tr_options = {}
+        @th_options = {}
+
+        @requested_columns = requested_columns
+        yield self if block_given?
+      end
+
+      def td(name, method_name: nil, sort_key: nil, sortable: true, **options, &block)
+        if method_name.nil?
+          method_name = name.to_s.parameterize.underscore
+          name = name.to_s.titleize unless block_given?
+        end
+        sort_key = method_name if sort_key.blank?
+        @columns << Column.new(name, method_name, sort_key, block, sortable, options)
+      end
+
+      def define_header_sort_url(&block)
+        define_singleton_method(:header_sort_url, &block)
+      end
+
+      def header_sort_url(column, query_params)
+        # Override this method to define the sort url for the header.
+
+        raise NotImplementedError, "You must define #header_sort_url if you want sortable table columns."
+      end
+
+      def footer(&block)
+        @footer = block
+      end
+
+      def table(**options)
+        @table_options = options
+      end
+
+      def tbody(**options)
+        @tbody_options = options
+      end
+
+      def thead(**options)
+        @thead_options = options
+      end
+
+      def tr(**options)
+        @tr_options = options
+      end
+
+      def th(**options)
+        @th_options = options
+      end
+
+      def render_in(view_context)
+        @view_context = view_context
+
+        render_table
+      end
+
+      private
+
+      def visible_columns
+        return @columns if @requested_columns.empty?
+
+        @columns.select { |column| @requested_columns.include?(column.name) }
+      end
+
+      def render_table
+        content_tag(:table, @table_options) { render_header + render_body } + render_footer
+      end
+
+      def render_header
+        content_tag(:thead, @thead_options) do
+          content_tag(:tr, @tr_options) do
+            visible_columns.map do |column|
+              if column.sortable
+                content_tag(:th, @th_options) do
+                  header_sort_url(column, query_params).html_safe
+                end
+              else
+                content_tag(:th, column.name, @th_options)
+              end
+            end.join.html_safe
+          end
+        end
+      end
+
+      def render_body
+        content_tag(:tbody, @tbody_options) do
+          @collection.map do |record|
+            content_tag(:tr, @tr_options) do
+              visible_columns.map do |column|
+                column_content = if column.block
+                  capture(record, &column.block)
+                else
+                  record.public_send(column.method_name)
+                end
+                content_tag(:td, column_content, column.options)
+              end.join.html_safe
+            end
+          end.join.html_safe
+        end
+      end
+
+      def render_footer
+        capture(&@footer) if @footer
+      end
+
+      def query_params
+        request.query_parameters
+      end
+    end
+  end
+end

data/lib/hyper_kitten_tables/engine.rb

@@ -0,0 +1,5 @@
+module HyperKittenMeow
+  class Engine < ::Rails::Engine
+    isolate_namespace HyperKittenTables
+  end
+end

data/lib/hyper_kitten_tables/version.rb

@@ -0,0 +1,3 @@
+module HyperKittenTables
+  VERSION = "0.1.0"
+end

data/lib/tasks/tables_tasks.rake

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

data/spec/components/table_spec.rb

@@ -0,0 +1,209 @@
+require "rails_helper"
+
+RSpec.describe HyperKittenTables::Components::Table do
+  User = Struct.new(:name)
+
+  describe "rendering a table" do
+    it "with defaults" do
+      component = described_class.new(collection: []) do |table|
+        table.td(:name, sortable: false)
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "thead" do
+          assert_select "tr" do
+            assert_select "th", text: "Name"
+          end
+        end
+        assert_select "tbody" do
+          assert_select "tr", count: 0
+        end
+      end
+    end
+
+    it "with custom column options" do
+      user = User.new("Hyper Kitten")
+      component = described_class.new(collection: [user]) do |table|
+        table.td(:name, sortable: false, class: "custom-class")
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "tbody" do
+          assert_select "tr" do
+            assert_select "td.custom-class", text: "Hyper Kitten"
+          end
+        end
+      end
+    end
+
+    it "with custom table options" do
+      component = described_class.new(collection: []) do |table|
+        table.td(:name, sortable: false)
+        table.table(class: "custom-class")
+      end
+
+      render component
+
+      assert_select "table.custom-class"
+    end
+
+    it "with custom tbody options" do
+      component = described_class.new(collection: []) do |table|
+        table.tbody(class: "custom-class")
+        table.td(:name, sortable: false)
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "tbody.custom-class"
+      end
+    end
+
+    it "with custom thead options" do
+      component = described_class.new(collection: []) do |table|
+        table.thead(class: "custom-class")
+        table.td(:name, sortable: false)
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "thead.custom-class"
+      end
+    end
+
+    it "with custom tr options" do
+      component = described_class.new(collection: []) do |table|
+        table.tr(class: "custom-class")
+        table.td(:name, sortable: false)
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "thead" do
+          assert_select "tr.custom-class"
+        end
+      end
+    end
+
+    it "with custom th options" do
+      component = described_class.new(collection: []) do |table|
+        table.th(class: "custom-class")
+        table.td(:name, sortable: false)
+      end
+
+      render component
+
+      assert_select "table" do
+        assert_select "thead" do
+          assert_select "tr" do
+            assert_select "th.custom-class"
+          end
+        end
+      end
+    end
+
+    it "rendered only the specified columns when requested" do
+      component = described_class.new(collection: [], requested_columns: ["Name"]) do |table|
+        table.td(:name, sortable: false)
+        table.td(:email, sortable: false)
+      end
+
+      html = render component
+
+      assert_select "table" do
+        assert_select "thead" do
+          assert_select "tr" do
+            assert_select "th", text: "Name"
+            assert_select "th", text: "Email", count: 0
+          end
+        end
+        assert_select "tbody" do
+          assert_select "tr", count: 0
+        end
+      end
+    end
+
+    it "with sortable columns" do
+      component = described_class.new(collection: []) do |table|
+        table.define_header_sort_url do |column, params|
+          link_direction = case params
+          when { column.sort_key => "asc" }
+            "desc"
+          when { column.sort_key => "" }
+            "desc"
+          else
+            "asc"
+          end
+          "<a href='/?order[#{column.sort_key}]=#{link_direction}'>#{column.name}</a>"
+        end
+        table.td(:name, sortable: true)
+        table.td(:age, sortable: true)
+      end
+
+      render component, params: { "name" => "asc" }
+
+      assert_select "table" do
+        assert_select "thead" do
+          assert_select "tr" do
+            assert_select "th" do
+              assert_select "a", text: "Name" do
+                assert_select "[href=?]", "/?order[name]=desc"
+              end
+              assert_select "a", text: "Age" do
+                assert_select "[href=?]", "/?order[age]=asc"
+              end
+            end
+          end
+        end
+        assert_select "tbody" do
+          assert_select "tr", count: 0
+        end
+      end
+    end
+
+    it "with a footer " do
+      component = described_class.new(collection: []) do |table|
+        table.td(:name, sortable: false)
+        table.footer do
+          "Footer"
+        end
+      end
+
+      html = render component
+
+      assert_select "body", text: /Footer/
+      assert_select "table", text: /Footer/, count: 0
+    end
+
+    def render(component, params: {})
+      request = Struct.new(:query_parameters).new(params)
+
+      view = Class.new(ActionView::Base.with_empty_template_cache) do
+        attr_accessor :request
+        def view_cache_dependencies; []; end
+        # def params; parameters; end
+
+        def combined_fragment_cache_key(key)
+          [ :views, key ]
+        end
+      end.with_view_paths([])
+
+      view.request = request
+
+      html = view.render component
+
+      @html_document = Nokogiri::HTML::Document.parse(html)
+    end
+
+    def document_root_element
+      @html_document.root
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../javascripts/hyper_kitten_meow .js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,3 @@
+class PagesController < ApplicationController
+  include ::HyperKittenMeow::Concerns::Controllers::PagesController
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/spec/dummy/app/views/hyper_kitten_meow/pages/hardcoded_page.html.haml

@@ -0,0 +1,4 @@
+%h2 This is a hardcoded page
+
+%p Used for testing that the pages controller falls back to reading templates from the pages directory.
+

data/spec/dummy/app/views/pages/app_hardcoded_page.html.haml

@@ -0,0 +1,4 @@
+%h2 This is an app hardcoded page
+
+%p Used for testing that the pages controller falls back to reading templates from the pages directory.
+

data/spec/dummy/app/views/pages/show.html.haml

@@ -0,0 +1,3 @@
+.container
+  %h2= @page.title
+  != @page.body

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require_relative "boot"
+
+require "action_controller/railtie"
+require "action_view/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # For compatibility with applications that use this config
+    config.action_controller.include_all_helpers = false
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+    config.autoload_paths << Rails.root.join("lib")
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,16 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  host:     <%= ENV['APP_DB_HOST'] || 'localhost' %>
+  database: <%= ENV['APP_DB_NAME'] %>
+  username: <%= ENV['APP_DB_USERNAME'] || 'root' %>
+  password: <%= ENV['APP_DB_PASSWORD'] || '' %>
+  port: 5432
+
+development:
+  <<: *default
+  database: hyper_kitten_meow_development
+test:
+  <<: *default
+  database: hyper_kitten_meow_test
+

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!