gridy 0.1.0

data/app/assets/stylesheets/gridy.css

@@ -0,0 +1,117 @@
+@import "./gridy/open-props.css";
+@import "./gridy/open-props/normalize.css";
+@import "./gridy/open-props/buttons.css";
+
+.gridy {
+  font-size: 14px;
+
+  .search-form-container {
+    padding: var(--size-2);
+    margin-bottom: var(--size-2);
+
+    form {
+      width: 100%;
+    }
+
+    input[type="search"] {
+      flex-grow: 1;
+      padding: var(--size-1) var(--size-2);
+      border-radius: var(--radius-2);
+      border: 1px solid var(--border-2);
+    }
+  }
+
+  .table-container {
+    max-width: 100%;
+    /* overflow-x: auto; */
+
+    table {
+      width: 100%;
+      border-radius: var(--radius-2);
+
+      thead {
+        position: sticky;
+        top: 0;
+
+        :where(tr:first-child th:first-child) {
+          border-top-left-radius: var(--radius-2);
+        }
+      }
+
+      th,
+      td {
+        padding: var(--size-1) var(--size-3);
+        white-space: nowrap;
+        text-align: left;
+      }
+    }
+  }
+
+  .relative {
+    position: relative;
+  }
+
+  .sticky {
+    position: sticky;
+  }
+
+  .flex-row {
+    display: flex;
+    flex-direction: row;
+    gap: var(--size-1);
+  }
+
+  .flex-col {
+    display: flex;
+    flex-direction: column;
+    gap: var(--size-1);
+  }
+
+  .pagy {
+    display: flex;
+    font-size: 0.875rem;
+    line-height: 1.25rem;
+    font-weight: 500;
+    color: var(--text-2);
+    margin: var(--size-1) 0;
+  }
+  .pagy > :not([hidden]) ~ :not([hidden]) {
+    --space-reverse: 0;
+    margin-right: calc(0.25rem * var(--space-reverse));
+    margin-left: calc(0.25rem * calc(1 - var(--space-reverse)));
+  }
+  .pagy a:not(.gap) {
+    display: block;
+    text-decoration: none;
+    border-radius: 0.25rem;
+    background: var(--surface-4);
+    padding: 0.25rem 0.75rem;
+    color: inherit;
+  }
+  .pagy a:not(.gap):hover {
+    background-color: var(--surface-3);
+  }
+  .pagy a:not(.gap):not([href]) {
+    /* disabled links */
+    cursor: default;
+    background-color: var(--surface-2);
+    color: var(--text-2);
+  }
+  .pagy a:not(.gap).current {
+    background: var(--surface-3);
+    color: var(--text-2);
+  }
+  .pagy label {
+    white-space: nowrap;
+    display: inline-block;
+    border-radius: 0.5rem;
+    background: var(--surface-2);
+    padding: 0.125rem 0.75rem;
+  }
+  .pagy label input {
+    line-height: 1.5rem;
+    border-radius: 0.375rem;
+    border-style: none;
+    background: var(--surface-2);
+  }
+}

data/app/views/application/_form.html.erb

@@ -0,0 +1,24 @@
+<%= form_with(model: resource) do |form| %>
+  <% if resource.errors.any? %>
+    <div style="color: red">
+      <h2>
+        <%= pluralize(resource.errors.count, "error") %> prohibited this <%= resource_name %> from being saved:
+      </h2>
+      <ul>
+        <% resource.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <% resource_attributes.each do |attr| %>
+    <div>
+      <%= form.label attr, style: "display: block" %>
+      <%= form.text_field attr %>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/application/_search_form.html.erb

@@ -0,0 +1,9 @@
+<div class="search-form-container">
+  <%= form_tag nil, method: :get do %>
+    <%= hidden_field_tag :items, params[:items] %>
+    <div class="flex-row">
+      <%= search_field_tag :q, params[:q] %>
+      <%= submit_tag "Search" %>
+    </div>
+  <% end %>
+</div>

data/app/views/application/edit.html.erb

@@ -0,0 +1,9 @@
+<h1>Editing <%= resource_name %></h1>
+
+<%= render "form", resource: @resource %>
+<br>
+
+<div>
+  <%= link_to "Show this #{ resource_name}", @resource %>
+  <%= link_to "Back to #{ resource_name.pluralize }", resource_name.underscore.pluralize.to_sym %>
+</div>

data/app/views/application/index.html.erb

@@ -0,0 +1,49 @@
+<div class="gridy">
+  <%= turbo_frame_tag resource_name.underscore.pluralize, "data-turbo-action" => :advance do %>
+  <% if searchable? %>
+    <%= render "search_form"  %>
+  <% end %>
+  <div class="table-container">
+    <div class="relative">
+      <table>
+        <thead>
+          <tr>
+            <% resource_attributes.each do |attr| %>
+              <th>
+                <%= gridy_table_header(attr, sortable: sortable?) %>
+              </th>
+            <% end %>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @records.each do |record| %>
+            <tr>
+              <% resource_attributes.each_with_index do |attr, idx| %>
+                <td>
+                  <% if idx.zero? %>
+                    <%= link_to record.send(attr), record, "data-turbo" => false %>
+                  <% else %>
+                    <%= record.send(attr) %>
+                  <% end %>
+                </td>
+              <% end %>
+              <td>
+                <span><%= link_to "Show", record, "data-turbo" => false %></span>
+                <span><%= link_to "Edit", [:edit, record], "data-turbo" => false %></span>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+        <tfoot>
+          <tr>
+            <td colspan="<%= resource_attributes.count + 1 %>">
+              <%== pagy_nav(@pagy) %>
+            </td>
+          </tr>
+        </tfoot>
+      </table>
+    </div>
+  </div>
+  <% end %>
+</div>

data/app/views/application/new.html.erb

@@ -0,0 +1,8 @@
+<h1>New <%= resource_name %></h1>
+
+<%= render "form", resource: @resource %>
+<br>
+
+<div>
+  <%= link_to "Back to #{ resource_name.pluralize }", resource_name.underscore.pluralize.to_sym %>
+</div>

data/app/views/application/show.html.erb

@@ -0,0 +1,16 @@
+<p style="color: green"><%= notice %></p>
+
+<div id="<%= dom_id(@resource) %>">
+  <% resource_attributes.each do |attr| %>
+    <p>
+      <strong><%= attr.to_s.humanize %>:</strong>
+      <%= @resource.send(attr) %>
+    </p>
+  <% end %>
+</div>
+<div>
+  <%= link_to "Edit this #{ resource_name}", [:edit, @resource] %>
+  <%= link_to "Back to #{ resource_name.pluralize }", resource_name.underscore.pluralize.to_sym %>
+
+  <%= button_to "Destroy this #{resource_name}", @resource, method: :delete %>
+</div>

data/lib/gridy/controller/actions.rb

@@ -0,0 +1,73 @@
+require "pagy"
+
+module Gridy
+  module Controller
+    module Actions
+      extend ActiveSupport::Concern
+
+      included do
+        include Gridy::Controller
+        before_action :set_resource, only: %i[ show edit update destroy ]
+      end
+
+      def index
+        gridy_collection(collection, params)
+        render "index"
+      end
+
+      def show
+      end
+
+      def new
+        self.resource_instance = resource_class.new
+      end
+
+      def edit
+      end
+
+      def create
+        self.resource_instance = resource_class.new(resource_params)
+
+        if resource_instance.save
+          redirect_to resource_instance, notice: "#{resource_name.titleize} was successfully created."
+        else
+          render :new, status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if resource_instance.update(resource_params)
+          redirect_to resource_instance, notice: "#{resource_name.titleize} was successfully updated."
+        else
+          render :edit, status: :unprocessable_entity
+        end
+      end
+
+      def destroy
+        resource_instance.destroy!
+        redirect_to resource_index_url, notice: "#{resource_name.titleize} was successfully destroyed."
+      end
+
+      private
+
+      def resource_class
+        self.class.resource
+      end
+
+      def collection
+        resource_class.all
+      end
+
+      def set_resource
+        self.resource_instance = resource_class.find(params[:id])
+      end
+
+      def resource_params
+        resource_named_params = "#{resource_name}_params"
+        return send(resource_named_params) if respond_to?(resource_named_params)
+
+        params.require(resource_name.underscore.to_sym).permit(*resource_attributes)
+      end
+    end
+  end
+end

data/lib/gridy/controller.rb

@@ -0,0 +1,94 @@
+require "pagy"
+require "ransack"
+
+module Gridy
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      include Pagy::Backend
+
+      helper_method :resource_attributes_types, :resource_attributes, :resource_name, :searchable?, :sortable?
+    end
+
+    class_methods do
+      def gridy(options)
+        options.symbolize_keys!
+        @resource = options[:model] if options[:model].present?
+        @resource_attributes = options[:attributes] if options[:attributes].present?
+        @searchable = options[:searchable].presence || false
+        @sortable = options[:sortable].presence || true
+      end
+
+      def resource
+        @resource.presence || controller_name.classify.constantize
+      end
+
+      def resource_attributes_types
+        resource.attributes_builder.types
+      end
+
+      def resource_attributes
+        @resource_attributes.presence || resource_attributes_types.keys
+      end
+
+      def searchable?
+        @searchable
+      end
+
+      def sortable?
+        @sortable
+      end
+    end
+
+    def gridy_collection(collection, options = {})
+      @ransack = gridy_query(collection, options)
+      @pagy, @records = pagy(@ransack.result(distinct: true), items: options[:items] || 20)
+      instance_variable_set("@#{resource_name.pluralize.underscore}", @records)
+    end
+
+    def gridy_query(collection, options = {})
+      query = {}
+
+      query[self.class.resource.searchable_key] = options[:q] if searchable?
+      query[:s] = options[:sort] if sortable?
+
+      collection.ransack(query)
+    end
+
+    private
+
+    def searchable?
+      self.class.searchable?
+    end
+
+    def sortable?
+      self.class.sortable?
+    end
+
+    def resource_attributes_types
+      self.class.resource_attributes_types
+    end
+
+    def resource_attributes
+      self.class.resource_attributes
+    end
+
+    def resource_name
+      self.class.resource.name
+    end
+
+    def resource_index_url
+      send "#{resource_name.underscore.pluralize}_url"
+    end
+
+    def resource_instance
+      instance_variable_get("@#{resource_name.underscore}")
+    end
+
+    def resource_instance=(value)
+      @resource = value
+      instance_variable_set("@#{resource_name.underscore}", @resource)
+    end
+  end
+end

data/lib/gridy/model.rb

@@ -0,0 +1,33 @@
+require "ransack"
+
+module Gridy
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def searchable_attributes
+        column_names.select { |field| attributes_builder.types[field.to_s].type.eql?(:string) }
+      end
+
+      def searchable_key
+        searchable_attributes.join("_or_") + "_cont"
+      end
+
+      def sortable_attributes
+        column_names
+      end
+
+      def ransackable_attributes(auth_object = nil)
+        searchable_attributes
+      end
+
+      def ransortable_attributes(auth_object = nil)
+        sortable_attributes
+      end
+
+      def ransackable_associations(auth_object = nil)
+        []
+      end
+    end
+  end
+end

data/lib/gridy/railtie.rb

@@ -0,0 +1,23 @@
+module Gridy
+  class Railtie < ::Rails::Engine
+    PRECOMPILE_ASSETS = [
+      "gridy.css",
+      "gridy/open-props.css",
+      "gridy/open-props/normalize.css",
+      "gridy/open-props/buttons.css"
+    ].freeze
+
+    initializer "gridy.assets" do
+      if Rails.application.config.respond_to?(:assets)
+        Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
+      end
+    end
+
+    initializer "gridy.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        require "gridy/view_helpers"
+        include Gridy::ViewHelpers
+      end
+    end
+  end
+end

data/lib/gridy/version.rb

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

data/lib/gridy/view_helpers.rb

@@ -0,0 +1,36 @@
+module Gridy
+  module ViewHelpers
+    include Turbo::FramesHelper
+    include Pagy::Frontend
+
+    def gridy_search_url
+      uri = URI(request.url)
+      params = Rack::Utils.parse_query(uri.query)
+      params.delete("page")
+      uri.query = params.to_query
+      uri.to_s
+    end
+
+    def gridy_table_header(field, title = nil, sortable: false)
+      unless sortable
+        return content_tag(:th, title || field.to_s.titleize)
+      end
+
+      uri = URI(request.url)
+      params = Rack::Utils.parse_query(uri.query)
+
+      if params["sort"].to_s.start_with?(field.to_s)
+        icon = params["sort"].to_s.end_with?("asc") ? "▲" : "▼"
+      else
+        icon = ""
+      end
+
+      params["sort"] = "#{field} #{params["sort"] == "#{field} asc" ? "desc" : "asc"}"
+      uri.query = params.to_query
+
+      link_to(uri.to_s, class: "") do
+        content_tag(:span, "#{title || field.to_s.titleize} #{icon}".html_safe)
+      end
+    end
+  end
+end

data/lib/gridy.rb

@@ -0,0 +1,10 @@
+require "gridy/version"
+require "gridy/railtie"
+require "zeitwerk"
+require "turbo-rails"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Gridy
+end

data/lib/tasks/gridy_tasks.rake

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

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: gridy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Melvin Sembrano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.6'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby on Rails grid made easy
+email:
+- melv@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/gridy.css
+- app/assets/stylesheets/gridy/open-props.css
+- app/assets/stylesheets/gridy/open-props/buttons.css
+- app/assets/stylesheets/gridy/open-props/normalize.css
+- app/views/application/_form.html.erb
+- app/views/application/_search_form.html.erb
+- app/views/application/edit.html.erb
+- app/views/application/index.html.erb
+- app/views/application/new.html.erb
+- app/views/application/show.html.erb
+- lib/gridy.rb
+- lib/gridy/controller.rb
+- lib/gridy/controller/actions.rb
+- lib/gridy/model.rb
+- lib/gridy/railtie.rb
+- lib/gridy/version.rb
+- lib/gridy/view_helpers.rb
+- lib/tasks/gridy_tasks.rake
+homepage: http://github.com/melvinsembrano/gridy
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/melvinsembrano/gridy
+  source_code_uri: https://github.com/melvinsembrano/gridy
+  changelog_uri: https://github.com/melvinsembrano/gridy/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails grid helper
+test_files: []