hotwire_datatables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5c84200f972eff2640380af43571a74c722bbe8e1e03d8ed63eabe03969b64a
+  data.tar.gz: 183ba63a958b6b98e1e6950e3c0de2cff2e95dbe454710c7cd6d5bc4b538f44e
+SHA512:
+  metadata.gz: c6702f8b08b8c0c865221e9fcd740cbb342538da66cacd7339917398eef166577b25bffa7b2df94b2ac8e10a231671771b30074f6151e058cb94b33ffc69536e
+  data.tar.gz: 5a00851240e78a6caf99fa9c7228ab30d8ccee76c3737aeedecaee417e679f6c941f2c6f659948f411e873f90fe7ceb81a2d8d4cb07547f431012bed5a15cfd4

data/README.md

@@ -0,0 +1,125 @@
+# HotwireDatatables
+
+HotwireDatatables is a modern, Hotwire-powered DataTables implementation for Ruby on Rails that provides sorting, searching, and pagination capabilities with a beautiful UI.
+
+## Features
+
+- 🚀 Fast, server-side processing
+- 🔍 Real-time search with PostgreSQL full-text search
+- ↕️ Column sorting
+- 📄 Pagination with Pagy
+- 🎨 Beautiful UI with Tailwind CSS
+- ⚡ Hotwire/Turbo powered for smooth updates
+- 🛠️ Easy to customize and extend
+
+## Requirements
+
+- Ruby >= 3.0.0
+- Rails >= 7.0
+- PostgreSQL database
+- Turbo Rails
+- Tailwind CSS
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hotwire_datatables'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install hotwire_datatables
+```
+
+Then run the installer:
+
+```bash
+$ rails generate hotwire_datatables:install
+```
+
+## Usage
+
+1. Include the Datatable concern in your model:
+
+```ruby
+class Employee < ApplicationRecord
+  include Datatable
+
+  datatable_columns :name, :position, { age: "Employee Age" }
+  datatable_search_columns :name, :position, :office
+end
+```
+
+2. Set up your controller:
+
+```ruby
+class EmployeesController < ApplicationController
+  include Pagy::Backend
+
+  def index
+    @employees = Employee.all
+    @employees = @employees.search(params[:query]) if params[:query].present?
+    @pagy, @employees = pagy @employees.reorder(sort_column(Employee.get_datatable_columns.map(&:name)) => sort_direction)
+  end
+end
+```
+
+3. Add the datatable to your view:
+
+```erb
+<%= render partial: "hotwire_datatables/datatable", locals: {
+  collection: @employees,
+  columns: Employee.get_datatable_columns,
+  frame_id: "employees_table",
+  row_partial: "employee_row",
+  pagy: @pagy
+} %>
+```
+
+4. Create a row partial for your records (_employee_row.html.erb):
+
+```erb
+<%= render partial: "hotwire_datatables/datatable_row", locals: {
+  record: record,
+  columns: columns
+} %>
+```
+
+## Configuration
+
+You can configure HotwireDatatables in `config/initializers/hotwire_datatables.rb`:
+
+```ruby
+HotwireDatatables.configure do |config|
+  config.per_page = 10
+  config.per_page_options = [10, 25, 50, 100]
+  config.default_direction = :asc
+  config.enable_search = true
+  config.enable_sorting = true
+  config.table_class = "table"
+  config.header_class = "table-header-group"
+  config.row_class = "table-row-group"
+  config.cell_class = "table-cell pr-4"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/hotwire_datatables.
+
+## 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 HotwireDatatables project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hotwire_datatables/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/hotwire_datatables/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HotwireDatatables
+  VERSION = "0.1.0"
+end

data/lib/hotwire_datatables.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "hotwire_datatables/version"
+
+module HotwireDatatables
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: hotwire_datatables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Maciel
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A modern, Hotwire-powered DataTables implementation for Ruby on Rails
+  that provides sorting, searching, and pagination capabilities with a beautiful UI
+email:
+- alan.maciel.salcedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/hotwire_datatables.rb
+- lib/hotwire_datatables/version.rb
+homepage: https://github.com/alanmaciel/hotwire_datatables
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alanmaciel/hotwire_datatables
+  source_code_uri: https://github.com/alanmaciel/hotwire_datatables
+  changelog_uri: https://github.com/alanmaciel/hotwire_datatables/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: DataTables implementation for Ruby on Rails using Hotwire
+test_files: []