recourse 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238c0c227f1cd34c3aa991972792acbcdaf26ec64149f833e072fb106cae16e7
-  data.tar.gz: 70769ca47575f9320d2a7acdbe1ec0edcb7db009afcaad594ca60319dfccc1ca
+  metadata.gz: c8ac6749b83bd677e0066b47d0e3137dc3c21d320bfef56e1df5857bb49fa425
+  data.tar.gz: 1bedace6c0dbfc04d6a7bb741e4f21999dd932b8e0d510e4057c75c394ddd36d
 SHA512:
-  metadata.gz: 33d0deb2d2f1300d0cbdf0fa90337564a4325d5bd2a22a28ba8a2683de167f1847d8f2e32650e47943ebdd2ec385947a78abb2ceb25450d206c6eb0f10667514
-  data.tar.gz: 84fb9a4fc6e3daf58b28c99f106a8520ce17a18cc76ae3daeedc14b61f9533806dbc2a82b0f9beb7250826f5d9406a28f00ff7cfbc9549ee77b468e0583c3e78
+  metadata.gz: 9a834ed2627af083af2702471e8b2455c04b9750ef90e4bdd879283900ad7c2dc8a438237311e99768c9ddeee8f49024c17daf029e12aa137cd08423a0650efb
+  data.tar.gz: de580547ed1f66cc50fa6d4214ef665417bbf603989c75b045eb16a4499e8a66967d09e0ed5a1eefbfadd4ef89745e6f088992627f05dcbc1fc852a74f0739a5

data/README.md

@@ -13,7 +13,7 @@ Provides a new `recourses` method that can be invoked in a Rails app inside conf
 How to install
 ==============
 
-1. Add `gem 'resource'` to the `Gemfile` file of your Rails app.
+1. Add `gem 'recourse'` to the `Gemfile` file of your Rails app.
 
 Available methods
 =================
@@ -26,7 +26,6 @@ In a resourceful Active Record model:
 
 - `recourse_includes`: the associations to include when fetching the resources
 - `recourse_order`: the SQL to sort the resources by
-- `recourse_positionable?`: whether the model has a position field to drag'n'drop sort
 
 Anywhere:
 

data/app/controllers/recourses_controller.rb

@@ -0,0 +1,26 @@
+# Base class for recoursive controllers.
+class RecoursesController < ApplicationController
+  helper RecoursiveHelper, SearchableHelper
+  include Pagy::Method
+
+  def index
+    model = controller_name.classify.constantize
+    @where = request.path_parameters.except(:controller, :action)
+    @order = model.recourse_order
+    @includes = model.recourse_includes
+
+    @pagy, @resources = paginate model, where: @where, order: model.recourse_order, includes: model.recourse_includes
+  end
+
+private
+
+  def paginate(model, where: nil, includes: [], order: nil)
+    if model.recourse_searchable? || model.recourse_sortable?
+      @q = model.where(where).ransack params[:q]
+      @q.sorts = (order || 'created_at desc') if @q.sorts.empty?
+      pagy includes.present? ? @q.result.includes(includes) : @q.result.distinct(true)
+    else
+      pagy model.where(where).includes(includes).order(order)
+    end
+  end
+end

data/app/helpers/recoursive_helper.rb

@@ -1,17 +1,10 @@
 # A collection of helper methods used for navigation link in the admin-only section
 module RecoursiveHelper
-  # Adds a link next to the title to add a new resource.
-  def button_link_to_add(name, path)
-    content_for(:edit) { button_link_to "Add #{name}", path, class: 'btn-sm btn-outline ms-3' }
-  end
-
-private
-
-  def button_link_to(name, path, options = {})
-    link_to name, path, with_class('btn theme-primary', options)
-  end
-
-  def with_class(classes, options = {})
-    options.merge class: [options[:class], classes].compact.join(' ')
+  def column(header:, **options, &block)
+    if @recourse_headers
+      tag.th header, **options.merge(scope: :col)
+    else
+      tag.td **options, &block
+    end
   end
 end

data/app/helpers/searchable_helper.rb

@@ -1,4 +1,4 @@
-# A collection of helper methods used for navigation link in the admin-only section
+# A collection of helper methods used to search resources with Ransack.
 module SearchableHelper
   # Renders a form with a field to search within +model+ that uses +placeholder+.
   # @param [String] q the search query.

data/app/views/recourses/_row.html.erb

@@ -0,0 +1,10 @@
+<%# locals: (recourse:) -%>
+<% recourse.attributes.each do |name, value| %>
+  <%= column header: (recourse.class.ransortable_attributes.include?(name) ? sort_link(@q, name, name.upcase_first) : name) do %>
+    <% if recourse.class.ransackable_attributes.include? name %>
+      <%= search_highlight value, model: recourse.class %>
+    <% else %>
+      <%= value %>
+    <% end %>
+  <% end unless recourse.encrypted_attribute?(name) %>
+<% end %>

data/app/views/recourses/_table.html.erb

@@ -0,0 +1,35 @@
+<%# locals: (recourses:, pagy: nil, cached: true) -%>
+<% name = @lookup_context.find_template('row', @lookup_context.prefixes, true).short_identifier.split('/')[-2] %>
+<% key = name.singularize.to_sym %>
+
+<%= turbo_frame_tag :results, data: { turbo_action: :advance }, class: 'w-100' do %>
+  <% if recourses.empty? %>
+    <p>No <%= controller_path.split('/').last %>.</p>
+  <% else %>
+    <% cache_if cached, [recourses, (recourses.unscoped.size if cached)].compact do %>
+      <table class='table caption-top table-hover table-responsive'>
+        <thead>
+          <tr>
+            <% @recourse_headers = true %>
+            <%= render 'row', key => recourses.first %>
+          </tr>
+        </thead>
+        <tbody class='table-group-divider'>
+        <% @recourse_headers = false %>
+        <% recourses.each do |recourse| %>
+          <% cache_if (cached && !params.key?(:q)), recourse do %>
+            <tr><%= render 'row', key => recourse %></tr>
+          <% end %>
+        <% end %>
+        </tbody>
+      </table>
+
+      <% if pagy %>
+        <div class='d-flex align-items-center'>
+          <div class='ps-2 flex-grow-1'><%== pagy.info_tag %></div>
+          <div class='pe-2'><%== pagy.series_nav(:bootstrap, classes: 'pagination mb-0') if pagy.last > 1 %></div>
+        </div>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,30 @@
+<% resources = instance_variable_get("@#{controller_path.split('/').last}") || @resources %>
+
+<% content_for :title, controller_path.split('/').last.humanize if @where&.empty? %>
+
+<% model = controller_name.classify.constantize %>
+
+<% content_for :search do %>
+  <script>
+    function debounce(method) {
+      let timer
+      return (...args) => {
+        clearTimeout(timer)
+        timer = setTimeout(() => { method.apply(this, args) }, 300);
+      }
+    }
+    const debouncedSubmit = debounce((form) => form.requestSubmit())
+  </script>
+  <%= search_form q: @q, model: model, url: request.path %>
+<% end if model.recourse_searchable? %>
+
+<% content_for :actions do %>
+  <% begin %>
+    <%= link_to "Add #{controller_path.split('/').last.singularize}", url_for(action: :new), class: 'btn theme-primary btn-sm btn-outline ms-3'%>
+  <% rescue ActionController::UrlGenerationError %>
+  <% end %>
+<% end %>
+
+<% locals = { @lookup_context.find_template('table', @lookup_context.prefixes, true).short_identifier.split('/')[-2].to_sym => resources } %>
+
+<%= render 'table', locals.merge(pagy: @pagy, cached: model.recourse_cachable?) %>

data/db/migrate/20260323234318_add_baby_to_posts.rb

@@ -0,0 +1,5 @@
+class AddBabyToPosts < ActiveRecord::Migration[8.1]
+  def change
+    add_reference :posts, :baby, null: true, foreign_key: true
+  end
+end

data/lib/recourse/engine.rb

@@ -4,7 +4,8 @@ module Recourse
   class Engine < ::Rails::Engine
     config.to_prepare do
       require 'recourse/routing'
-      require 'recourse/model'
+      require 'recourse/recoursive'
+      require 'recourse/searchable'
     end
   end
 end

data/lib/recourse/{model/recoursive.rb → recoursive.rb}

@@ -7,13 +7,6 @@ module Recourse
       %i[]
     end
 
-    # Return the actions available for the model (among :new, :edit, :destroy)
-    def recourse_actions
-      default = %i[new edit destroy]
-      options = Recourse.resources[name.underscore.pluralize.to_sym]
-      (Array(options.fetch :only, default) & default) - Array(options.fetch :except, [])
-    end
-
     # Return the fields to .order when loading all the models.
     def recourse_order
     end
@@ -23,19 +16,18 @@ module Recourse
       true
     end
 
-    # Return whether the model has a position field to use for drag'n'drop sorting.
-    def recourse_positionable?
-      false
-    end
-
     # @return [Boolean] whether Ransack search attributes are defined on the resource.
     def recourse_searchable?
-      ransackable_attributes.any?
+      ransackable_attributes.any? || ransackable_associations.any?
     end
 
     # @return [Boolean] whether Ransack sort attributes are defined on the resource.
     def recourse_sortable?
-       ransortable_attributes.any?
+      ransortable_attributes.any?
     end
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  extend Recourse::Recoursive
+end

data/lib/recourse/routing.rb

@@ -4,10 +4,31 @@ module Recourse
   module Routing
     # This method is equivalent to Rails `resources` with the added bonus that we store
     # the name of these administered resources so we can display them to admins in the navbar.
-    def recourses(*administered_resources, concerns: nil, **options, &block)
-      # NOTE: only is not enough, I need the except as well
-      administered_resources.each { |resource| Recourse.resources[resource] = options }
-      resources *administered_resources, concerns: concerns, **options, &block
+    def recourses(*args, **kwargs, &block)
+      store_recourses args, kwargs
+      resources(*args, **kwargs, &scoped(args, &block))
+    end
+
+  private
+
+    def store_recourses(args, kwargs)
+      if @scope[:scope_level_resource]
+        Recourse.resources[@scope[:scope_level_resource].name.to_sym][:nested] = args
+      else
+        routes = Array(kwargs.fetch :only, self.class::Resource.default_actions(false))
+        routes-= Array(kwargs.fetch :except, [])
+
+        Recourse.resources.merge! args.to_h { |arg| [arg, { module: @scope[:module], routes: routes }] }
+      end
+    end
+
+    def scoped(args, &block)
+      return unless block_given?
+
+      parent_module = args.sole
+      Proc.new { scope module: parent_module, &block }
+    rescue Enumerable::SoleItemExpectedError
+      raise ArgumentError, 'recourses accepts only one resource if a block is given'
     end
   end
 end

data/lib/recourse/{model/searchable.rb → searchable.rb}

@@ -38,3 +38,7 @@ module Recourse
     end
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  extend Recourse::Searchable
+end

data/lib/recourse/version.rb

@@ -1,3 +1,3 @@
 module Recourse
-  VERSION = '1.0.2'
+  VERSION = '1.2.0'
 end

data/lib/recourse.rb

@@ -1,11 +1,9 @@
-require 'bh'
 require 'pagy'
 require 'ransack'
 require 'recourse/engine'
 
 # @see https://ddnexus.github.io/pagy/resources/initializer/
 Pagy::OPTIONS[:limit] = 15
-# Pagy.options[:limit] = 15
 
 # A module to manage administered resources.
 module Recourse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recourse
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bh
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -103,17 +89,18 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/controllers/recourse_controller.rb
+- app/controllers/recourses_controller.rb
 - app/helpers/recoursive_helper.rb
 - app/helpers/searchable_helper.rb
-- app/views/recourse/_row.html.erb
-- app/views/recourse/index.html.erb
+- app/views/recourses/_row.html.erb
+- app/views/recourses/_table.html.erb
+- app/views/recourses/index.html.erb
+- db/migrate/20260323234318_add_baby_to_posts.rb
 - lib/recourse.rb
 - lib/recourse/engine.rb
-- lib/recourse/model.rb
-- lib/recourse/model/recoursive.rb
-- lib/recourse/model/searchable.rb
+- lib/recourse/recoursive.rb
 - lib/recourse/routing.rb
+- lib/recourse/searchable.rb
 - lib/recourse/version.rb
 homepage: https://github.com/claudiob/recourse
 licenses:

data/app/controllers/recourse_controller.rb

@@ -1,23 +0,0 @@
-# Base class for controllers that require admin access
-class RecourseController < ApplicationController
-  helper RecoursiveHelper, SearchableHelper
-  include Pagy::Method
-
-  def index
-    @model = controller_name.classify.constantize
-    @pagy, @resources = paginate @model, order: @model.recourse_order, includes: @model.recourse_includes
-    render 'recourse/index'
-  end
-
-private
-
-  def paginate(model, includes: [], order: nil)
-    if model.recourse_searchable? || model.recourse_sortable?
-      @q = model.ransack params[:q]
-      @q.sorts = (order || 'created_at desc') if @q.sorts.empty?
-      pagy includes.present? ? @q.result.includes(includes) : @q.result.distinct(true)
-    else
-      pagy @model.includes(includes).order(order)
-    end
-  end
-end

data/app/views/recourse/_row.html.erb

@@ -1,4 +0,0 @@
-<%# locals: (resource:, section:) -%>
-<%= column section: section, header: 'ID' do %>
-  <%= resource.id %>
-<% end %>

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

@@ -1,21 +0,0 @@
-<% content_for :title, @model.name.pluralize %>
-
-<% content_for :search do %>
-  <script>
-    function debounce(method) {
-      let timer
-      return (...args) => {
-        clearTimeout(timer)
-        timer = setTimeout(() => { method.apply(this, args) }, 300);
-      }
-    }
-    const debouncedSubmit = debounce((form) => form.requestSubmit())
-  </script>
-  <%= search_form q: @q, model: @model %>
-<% end if @model.recourse_searchable? %>
-
-<% button_link_to_add @model.name.underscore, url_for(action: :new) if @model.recourse_actions.include? :new %>
-
-<%= table items: @resources, cached: @model.recourse_cachable?, positioned: @model.recourse_positionable?, pagy: @pagy, empty_label: "No #{@model.name.underscore.pluralize}" do |resource, section| %>
-  <%= render 'row', resource: resource, section: section %>
-<% end %>

data/lib/recourse/model.rb

@@ -1,8 +0,0 @@
-require 'recourse/model/recoursive'
-require 'recourse/model/searchable'
-
-
-ActiveSupport.on_load(:active_record) do
-  extend Recourse::Recoursive
-  extend Recourse::Searchable
-end