base_editing_bootstrap 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08a32d00b8f2ec8a1b5898b42308ad3b663bfe222d8f7cd42cd94bae50b564f1'
+  data.tar.gz: 5f6154c097db9ea920cec28721799fec8d187fbeca4486d033d280230b029b81
+SHA512:
+  metadata.gz: 4641e3d44871f28c5b01546060f55e4cd85cab31978bd14c2501ba0b9ca4967bb09852a8fd4ff52190f9923ebe10b689d40060fe17679ce1008abaf4e61ce97b
+  data.tar.gz: 2c1b036feca870757414e6dae00f11966356fe9f6cbb73ea80f1b8653ef670e30c87bb96443bb0f4ff1e949d7c4e5ac17d4b7c51b959ff206fc75b3bb8515859

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,57 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.3.0
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /app
+
+# Set production environment
+ENV RAILS_ENV="production"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build_dev_image
+
+# Install packages needed to build gems and node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential curl git libvips node-gyp pkg-config python-is-python3
+
+# Install JavaScript dependencies
+ARG NODE_VERSION=20.11.1
+ARG YARN_VERSION=1.22.22
+ENV PATH=/usr/local/node/bin:$PATH
+RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
+    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
+    npm install -g yarn@$YARN_VERSION && \
+    rm -rf /tmp/node-build-master
+
+#------------------------------------------------------------
+# IMMAGINE DI SVILUPPO
+FROM build_dev_image as development_image
+
+ARG default_editor
+RUN apt-get install -y nano gpg gpg-agent git-lfs git ssh
+#questo serve per editare le credentials
+ENV EDITOR='nano' \
+    BUNDLE_PATH="/bundle"
+# helper per webpacker
+RUN touch /.yarnrc && chmod 777  /.yarnrc
+RUN mkdir /.cache && chmod 777 /.cache
+RUN adduser --system -D --uid 1000  -h /home/nobody  --shell /bin/bash rails rails
+
+
+RUN mkdir /bundle && chmod -R ugo+rwt /bundle
+VOLUME /bundle
+
+RUN gem install foreman
+##
+# Installiamo:
+# bundle-audit  : gemma per controllo di sicurezza https://github.com/rubysec/bundler-audit
+# bummr         : gemma per upgrade automatizzato delle gemme con singoli commit per gemma
+RUN gem install bundle-audit bummr
+
+RUN mkdir -p /home/nobody && chmod 777 /home/nobody
+ENV HOME="/home/nobody"
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Marino Bonetti
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 
+
+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,130 @@
+# BaseEditingBootstrap
+WIP
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "base_editing_bootstrap"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install base_editing_bootstrap
+```
+
+### TODO generators
+Then Install dependency (WIP TO TRANSLATE IN INSTALLATION TASK):
+```bash
+
+bundle exec rails g pundit:install
+```
+Aggiungere ad ApplicationController 
+```ruby
+  include Pundit::Authorization
+```
+
+Installare bootstrap e questo dipende dal sistema scelto di assets bundling.  
+La versione più semplice è attraverso: https://github.com/rails/cssbundling-rails  
+Una volta installato basta lanciare bin/rails css:install:bootstrap come da
+documentazione e avrete la vostra versione di boostrap installata.
+
+Installare `gem "factory_bot_rails"` e configurarlo correttamente in application.rb
+```ruby
+config.generators do |g|
+  g.test_framework :rspec
+  g.fixture_replacement :factory_bot
+  g.factory_bot dir: 'spec/factories'
+end
+```
+## Usage
+Utilizzo per modello base, in questo esempio prendiamo come modello Post come esempio del dummy.
+
+- Creare il Modello ed includere `include BaseEditingBootstrap::BaseModel`
+- Creare Controller:
+  ```ruby
+    class PostsController < BaseEditingController
+    end
+  ```
+- Aggiungere la rotta: `resources :posts`
+- Creare la policy:
+  ```ruby
+  class PostPolicy < BaseModelPolicy
+  
+  def editable_attributes
+  [
+  :title,
+  :description
+  ]
+  end
+  
+  def permitted_attributes
+  [
+  :title,
+  :description
+  ]
+  end
+  
+  def search_result_fields
+  [:title]
+  end
+  end
+
+  ```
+- [OPTIONAL] nel caso si volesse fare override dei campi della form:  
+  Per il campo che si vuole fare override creare un nuovo file nella cartella 
+  del modello `app/views/posts/post/form_field/_NOME_CAMPO.html.erb`  
+  al cui interno renderizzare il campo come si preferisce:
+  ```erbruby
+    <%# locals: (form:, field:) -%>
+    <%= form.text_field(field) %>
+  ```
+- [OPTIONAL] la medesima cosa è possibile fare con il rendering dei campi
+  delle celle della tabella della pagina index.  
+  La cartella da generare in questo caso sarà: `app/views/posts/post/cell_field/_NOME_CAMPO.html.erb`
+  ```erbruby
+  <%# locals: (obj:,field:)  -%>
+  <td><%= obj.read_attribute(field) %></td>
+  ```
+- [OPTIONAL] Base overrides:  
+  E' possibile anche fare un override generico dei campi, sono previsti questi tipi di partial
+  legati al tipo di dati:  
+  **Cell Field**:
+  - created_at => timestamps.html.erb
+  - updated_at => timestamps.html.erb
+  - default    => base.html.erb
+  **Form Field**
+  - Integer          => _integer.html.erb
+  - Float            => _decimal.html.erb
+  - Decimal          => _decimal.html.erb
+  - DateTime         => _detetime.html.erb
+  - Date             => _date.html.erb
+  - Default/String    => _base.html.erb
+  
+  In futuro si prevede di aggiungere automatismi per renderizzare senza 
+  l'intervento dell'utente dei campi.
+- [OPTIONAL] Search Form:  
+  Per poter aggiungere una form di ricerca basta aggiungere alla policy
+  del modello in questione i campi di ricerca che verranno poi utilizzati da ransack
+  per eseguire le ricerche  
+  ES:
+  ```ruby 
+  # file app/policies/post_policy.rb
+  #...
+  def search_fields
+  [:title_i_cont]
+  end
+  #...
+  ```
+
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/base_editing_controller.rb

@@ -0,0 +1,209 @@
+class BaseEditingController < RestrictedAreaController
+  before_action :load_object, only: [:edit, :update, :destroy]
+  helper_method :base_class,
+                :destroy_custom_polymorphic_path,
+                :edit_custom_polymorphic_path,
+                :form_attributes,
+                :form_builder,
+                :index_custom_polymorphic_path,
+                :new_custom_polymorphic_path,
+                :show_custom_polymorphic_path
+
+  def index
+    authorize base_class
+
+    q = policy_scope(base_scope)
+
+    @search_instance = search_class.new(q, current_user, params: params.permit(:page, :q => {})) # FIXME trovare modo per essere più "STRONG"
+    @search_instance = yield(@search_instance) if block_given?
+  end
+
+  def new
+    @object = base_class.new
+    @object = yield(@object) if block_given?
+    authorize @object
+
+    respond_to do |format|
+      format.html
+    end
+  end
+
+  def edit
+    @object = yield(@object) if block_given?
+  end
+
+  def update
+    @object = yield(@object) if block_given?
+    respond_to do |format|
+      if @object.update(permitted_attributes(@object))
+        _successful_update(format)
+      else
+        Rails.logger.debug { "#{base_class} non creato: #{@object.errors.messages.inspect}" }
+        _failed_update(format)
+      end
+    end
+  end
+
+  def create
+    @object = base_class.new(permitted_attributes)
+    @object = yield(@object) if block_given?
+    authorize @object
+
+    respond_to do |format|
+      if @object.save
+        _successful_create(format)
+      else
+        Rails.logger.debug { "#{base_class} non creato: #{@object.errors.messages.inspect}" }
+        _failed_create(format)
+      end
+    end
+  end
+
+  def destroy
+    @object = yield(@object) if block_given?
+
+    respond_to do |format|
+      if @object.destroy
+        _successful_destroy(format)
+      else
+        _failed_destroy(format)
+      end
+    end
+  end
+
+  protected
+
+  def base_class
+    return @_base_class if @_base_class
+    controller = controller_name
+    modello = controller.singularize.camelize.safe_constantize
+    logger.debug { "Editazione del controller:#{controller} per modello: #{modello.to_s}" }
+    raise "Non riesco a restituire la classe base per il controller #{controller}" if modello.nil?
+
+    @_base_class = modello
+  end
+
+  private
+
+  def search_class
+    BaseEditingBootstrap::Searches::Base
+  end
+
+  def form_builder
+    BaseEditingBootstrap::Forms::Base
+  end
+
+  def form_attributes(model = base_class.new, action = override_pundit_action_name)
+    policy = policy(model)
+    method_name = if policy.respond_to?("editable_attributes_for_#{action}")
+                    "editable_attributes_for_#{action}"
+                  else
+                    "editable_attributes"
+                  end
+    policy.public_send(method_name)
+  end
+
+  def load_object
+    @object = base_class.find(params[:id])
+    authorize @object
+    logger.debug { "Oggetto #{@object.inspect}" }
+  end
+
+  ##
+  # Scope iniziale per index, viene passato al policy_scope in index.
+  def base_scope
+    base_class
+  end
+
+  ##
+  # Semplice override per avere un debug
+  # @param record [ActiveRecord::Base] oggetto per cui estrapolare gli attributi ripuliti, di default utilizza
+  #                                    la classe base
+  # @param [nil] action
+  # @return [Hash{String->Object}]
+  def permitted_attributes(record = base_class.new, action = override_pundit_action_name)
+    super.tap do |p|
+      Rails.logger.debug { "Permitted Attributes: #{pundit_params_for(record).inspect}" }
+      Rails.logger.debug { "Parametri puliti [#{action}]: #{p.inspect}" }
+    end
+  end
+
+  ##
+  # In casi in cui l'azione non è quella di pundit per poter ricercarne le policy
+  # possiamo fare override, altrimenti il default è l'action_name standard
+  def override_pundit_action_name
+    action_name
+  end
+
+  ##
+  # Versione più addolcita del require params, nel caso non sia presente il parametro corretto viene
+  # restituito un hash vuoto
+  def pundit_params_for(record)
+    params.fetch(Pundit::PolicyFinder.new(record).param_key, {})
+  end
+
+  def new_custom_polymorphic_path(*base_class)
+    new_polymorphic_path(*base_class)
+  end
+
+  def edit_custom_polymorphic_path(...)
+    edit_polymorphic_path(...)
+  end
+
+  def show_custom_polymorphic_path(...)
+    polymorphic_path(...)
+  end
+
+  def index_custom_polymorphic_path(...)
+    polymorphic_path(...)
+  end
+
+  def destroy_custom_polymorphic_path(...)
+    polymorphic_path(...)
+  end
+
+  def _failed_destroy(format)
+    format.all {
+      redirect_to index_custom_polymorphic_path(base_class),
+                  flash: {error: @object.errors.full_messages.join(',')}
+    }
+  end
+
+  def _successful_destroy(format)
+    format.all do
+      redirect_to index_custom_polymorphic_path(base_class),
+                  status: :see_other,
+                  notice: t('activerecord.successful.messages.destroyed', model: base_class.model_name.human)
+    end
+  end
+
+  def _failed_create(format)
+    format.html do
+      flash.now.alert = t('activerecord.unsuccessful.messages.created', model: base_class.model_name.human)
+      render action: :new, status: :unprocessable_entity
+    end
+  end
+
+  def _successful_create(format)
+    format.all do
+      redirect_to edit_custom_polymorphic_path(@object),
+                  status: :see_other,
+                  notice: t('activerecord.successful.messages.created', model: base_class.model_name.human)
+    end
+  end
+
+  def _failed_update(format)
+    format.html do
+      flash.now.alert = t('activerecord.unsuccessful.messages.updated', model: base_class.model_name.human)
+      render action: :edit, status: :unprocessable_entity
+    end
+  end
+
+  def _successful_update(format)
+    format.all do
+      redirect_to edit_custom_polymorphic_path(@object),
+                  status: :see_other,
+                  notice: t('activerecord.successful.messages.updated', model: base_class.model_name.human)
+    end
+  end
+end

data/app/controllers/restricted_area_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class RestrictedAreaController < BaseEditingBootstrap.inherited_controller.constantize
+  include Pundit::Authorization
+  after_action :verify_authorized
+  after_action :verify_policy_scoped, only: :index
+  rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+
+
+  # :nocov:
+  # Essendo un placeholder per after_action andiamo a non doverlo coprire con il coverage, se viene richiamato fallisce.
+  def index
+    raise "NOT implemented"
+  end
+
+  # :nocov:
+
+  private
+
+  def user_not_authorized(exception)
+    policy_name = exception.policy.class.to_s.underscore
+
+    flash[:error] = t "#{policy_name}.#{exception.query}", scope: "pundit", default: :default
+    redirect_back(fallback_location: root_path)
+  end
+end

data/app/helpers/base_editing_helper.rb

@@ -0,0 +1,22 @@
+module BaseEditingHelper
+  include Utilities::PageHelper
+  include Utilities::EnumHelper
+  include Utilities::SearchHelper
+  include Utilities::FormHelper
+
+
+  ##
+  # Genera le icone di Bootstrap icons
+  def icon( name, text = nil, html_options = {})
+    text, html_options = nil, text if text.is_a?(Hash)
+
+    content_class = "bi-#{name}"
+    content_class << " #{html_options[:class]}" if html_options.key?(:class)
+    html_options[:class] = content_class
+    html_options['aria-hidden'] ||= true
+
+    html = content_tag(:i, nil, html_options)
+    html << ' ' << text.to_s unless text.blank?
+    html
+  end
+end

data/app/helpers/utilities/enum_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Utilities
+  module EnumHelper
+    # @param [BaseModel] model class
+    # @param [Symbol] attribute
+    # @param [nil|String] variant
+    def enum_collection(model, attribute, variant = nil)
+      model.send(attribute.to_s.pluralize(2).to_sym).collect { |key, val|
+        [enum_translation(model, attribute, key, variant), key]
+      }.to_h
+    end
+
+    # @param [BaseModel] model class
+    # @param [Symbol] attribute
+    # @param [Symbol|nil] value
+    # @param [nil|String] variant
+    def enum_translation(model, attribute, value, variant = nil)
+      return '' if value.nil?
+      variant = "_#{variant}" unless variant.nil?
+      model.human_attribute_name("#{attribute}.#{value}#{variant}")
+    end
+  end
+end