recourse 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4eccbd88eefd636afb76f3e80b0f0f9de7d21edf9dfe98232304ed5e0617602
-  data.tar.gz: 5b7ac4291838abc8e9935f276777400e9f1055a5c9a49a15804a722efc6c7248
+  metadata.gz: cd168efcdd88afa58c1b4bc5a5c7c4fc71bc91caec7b7a8ad344f41d7f2b3eb0
+  data.tar.gz: 4c6858fa894182eda4378571397b962fff778d172f7e749cc31e976776c71f50
 SHA512:
-  metadata.gz: 494bad14557416cc18e4754c2510ff31e2468530766c4ea71fee59677a8402936e2921764c8da74e4b4252822cb68774e52e7a56adc5292840f645f18bfff9ef
-  data.tar.gz: 97d241b130ca12c9db87490a6d41ea971df4478176628af4e3783bb64e7db658ea50c64255cdf25b6ed0cc1af74f59d105d3d69c5a46eddbdc85ea9d33aa52de
+  metadata.gz: 065fcb2ed2b597570045209d931b5dc74f6e12b30f39e3456dbbb7a635038a62d8b4e542764297df205b51c1163fe86937613ac5c6d69cd1def9f2dfeb40262d
+  data.tar.gz: ca93b998e63631993f14b55dc1ed8f2dcd3d9380eb57198f11e235cbaa366520a2f1247a4745e0c5c7b1cdcd9f1daf298b448ef975e29ac255d02ccca6e0340c

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2026 Claudio Baccigalupo
+
+MIT License
+
+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

@@ -1,39 +1,35 @@
-# Recourse
+Recourse
+========
 
-TODO: Delete this and the text below, and describe your gem
+Provides a new `recourses` method that can be invoked in a Rails app inside config/routes.rb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/recourse`. To experiment with that code, run `bin/console` for an interactive prompt.
+`recourses` is like `resources` on steroids for admin-only routes:
 
-## Installation
+- All the routes are included in `Recourse.resources` to easily display in a navbar
+- Their controllers do not need to define the `index` action: they inherit a predefined one
+- There is also a predefined `index.html` view which displays the resources paginated/searchable.
+- The content of each row can be customized defining a new `_row.html.erb` partial
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+How to install
+==============
 
-Install the gem and add to the application's Gemfile by executing:
+1. Add `gem 'resource'` to the `Gemfile` file of your Rails app.
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+Available methods
+=================
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+In config/routes.rb:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+- `recourses` inside the routes
 
-## Usage
+In a resourceful Active Record model:
 
-TODO: Write usage instructions here
+- `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
+- `recourse_searchable?`: whether the model has Ransack enabled for searches
 
-## Development
+Anywhere:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- `Recourse.resources` to list all the routes
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/recourse.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,8 +1,6 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-task default: :spec
+require "bundler/gem_tasks"

data/app/controllers/recourse_controller.rb

@@ -0,0 +1,23 @@
+# 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?
+      @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/helpers/recoursive_helper.rb

@@ -0,0 +1,17 @@
+# 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(' ')
+  end
+end

data/app/helpers/searchable_helper.rb

@@ -0,0 +1,50 @@
+# A collection of helper methods used for navigation link in the admin-only section
+module SearchableHelper
+  # Renders a form with a field to search within +model+ that uses +placeholder+.
+  # @param [String] q the search query.
+  # @param [ApplicationRecord] model the model of each object returned by the search
+  def search_form(q:, model:, url: url_for(model))
+    search_form_for(q, search_form_params(url: url)) do |form|
+      safe_join [filter_field_for(form, model:), search_field_for(form, model:)].compact
+    end
+  end
+
+  # Highlights the search query within the text of the matched content.
+  def search_highlight(content, model:)
+    highlight content.to_s, params.dig(:q, model.search_field)
+  end
+
+private
+
+  def filter_field_for(form, model:)
+    method = model.filter_field
+    choices = model.filter_choices
+    options = { prompt: model.filter_prompt }
+    form.select method, choices, options, filter_field_params if method && choices
+  end
+
+  def search_field_for(form, model:)
+    form.search_field model.search_field, search_field_params(placeholder: model.search_placeholder)
+  end
+
+  def search_form_params(url:)
+    {
+      url: url, class: 'col-8 col-sm-6 col-md-4 d-flex', role: 'search',
+      data: { turbo_frame: :results, turbo_action: :advance },
+    }
+  end
+
+  def search_field_params(placeholder:)
+    {
+      class: 'form-control form-control-sm flex-grow-1', placeholder: placeholder,
+      oninput: 'debouncedSubmit(this.form)', aria: { label: 'Search' }
+    }
+  end
+
+  def filter_field_params
+    {
+      aria: { label: 'Filter' }, class: 'form-control form-control-sm me-3',
+      onchange: 'debouncedSubmit(this.form)',
+    }
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+<% 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/engine.rb

@@ -0,0 +1,10 @@
+# A module to manage administered resources.
+module Recourse
+  # Makes Recourse methods like `recourses` available in config/routes.rb
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      require 'recourse/routing'
+      require 'recourse/model'
+    end
+  end
+end

data/lib/recourse/model/recoursive.rb

@@ -0,0 +1,36 @@
+# A module to manage administered resources.
+module Recourse
+  # Ensures every Active Record object is compatible with recourse.
+  module Recoursive
+    # Return the associations to .include when loading all the resources.
+    def recourse_includes
+      %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
+
+    # Return whether the content to display all the models can be cached.
+    def recourse_cachable?
+      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 attributes are defined on the resource.
+    def recourse_searchable?
+      ransackable_attributes.any? || ransortable_attributes.any?
+    end
+  end
+end

data/lib/recourse/model/searchable.rb

@@ -0,0 +1,40 @@
+# A module to manage administered resources.
+module Recourse
+  # Extends any model to be searchable with Ransack.
+  module Searchable
+    # Returns the attributes that can be searched.
+    def ransackable_attributes(auth_object = nil)
+      %w[ ]
+    end
+
+    # Returns the associations that can be searched (by default: none).
+    def ransackable_associations(auth_object = nil)
+      %w[ ]
+    end
+
+    # Returns the associations that can be sorted by (by default: none).
+    def ransortable_attributes(auth_object = nil)
+      %w[ ]
+    end
+
+    # @note to be overriden by subclasses -- the name of the field to search with.
+    def search_field
+    end
+
+    # @note to be overriden by subclasses -- the placeholder for the field to search with.
+    def search_placeholder
+    end
+
+    # @note to be overriden by subclasses -- the name of the field to filter by.
+    def filter_field
+    end
+
+    # @note to be overriden by subclasses -- the prompt for the field to filter by.
+    def filter_prompt
+    end
+
+    # @note to be overriden by subclasses -- the values for the field to filter by.
+    def filter_choices
+    end
+  end
+end

data/lib/recourse/model.rb

@@ -0,0 +1,6 @@
+require 'recourse/model/recoursive'
+require 'recourse/model/searchable'
+
+# TODO: Replace these with on_load
+ActiveRecord::Base.extend Recourse::Recoursive
+ActiveRecord::Base.extend Recourse::Searchable

data/lib/recourse/routing.rb

@@ -0,0 +1,15 @@
+# A module to manage administered resources.
+module Recourse
+  # Makes Recourse methods like `recourses` available in config/routes.rb
+  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
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.include Recourse::Routing

data/lib/recourse/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Recourse
-  VERSION = "0.1.0"
+  VERSION = '1.0.0'
 end

data/lib/recourse.rb

@@ -1,8 +1,15 @@
-# frozen_string_literal: true
+require 'bh'
+require 'pagy'
+require 'ransack'
+require 'recourse/engine'
 
-require_relative "recourse/version"
+# @see https://ddnexus.github.io/pagy/resources/initializer/
+Pagy::OPTIONS[:limit] = 15
+# Pagy.options[:limit] = 15
 
+# A module to manage administered resources.
 module Recourse
-  class Error < StandardError; end
-  # Your code goes here...
+  # Return all the administered resources.
+  mattr_reader :resources
+  @@resources = {}
 end

metadata

@@ -1,14 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: recourse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
-- claudiob
-bindir: exe
+- Claudio Baccigalupo
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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
+    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: ransack
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Turns resources into recourses
 email:
 - claudiob@users.noreply.github.com
@@ -16,21 +100,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- CHANGELOG.md
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/recourse_controller.rb
+- app/helpers/recoursive_helper.rb
+- app/helpers/searchable_helper.rb
+- app/views/recourse/_row.html.erb
+- app/views/recourse/index.html.erb
 - lib/recourse.rb
+- lib/recourse/engine.rb
+- lib/recourse/model.rb
+- lib/recourse/model/recoursive.rb
+- lib/recourse/model/searchable.rb
+- lib/recourse/routing.rb
 - lib/recourse/version.rb
-- sig/recourse.rbs
 homepage: https://github.com/claudiob/recourse
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/claudiob/recourse
-  source_code_uri: https://github.com/claudiob/recourse
-  changelog_uri: https://github.com/claudiob/recourse
+  source_code_uri: https://github.com/claudiob/recourse/
+  changelog_uri: https://github.com/claudiob/recourse/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -38,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Rails admin tool.
+summary: Rails admin tool
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2025-07-02
-
-- Initial release

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 claudiob
-
-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/sig/recourse.rbs

@@ -1,4 +0,0 @@
-module Recourse
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end