lato_settings 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dcd1304f183f4e1015babad8e49462c70ebd80eebe262a7e01389e2831fb69e
+  data.tar.gz: 724e4bb40693ab298e25f1f8754e384da6d8c66f4fa8bdc19418e47051f13403
+SHA512:
+  metadata.gz: 326b908f481fc40495c6518cdf05ed96d47db3d6daba68792ca9c294b1be3920a5c73419349a6c9c642b5c23959a68191c9c7c03d7c33d89b79684c90d94ef6b
+  data.tar.gz: 3f33964e6f1be79b250e882f83b02ed8d9d476c1069214712bd4d997b961a295bdc37d9af7fd28c7b0ae1f1169434ef5792970622920f4f00d0489f3fc615521

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Gregorio Galante
+
+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,53 @@
+# Lato Settings
+Manage application settings on Lato projects.
+
+## Installation
+Add required dependencies to your application's Gemfile:
+
+```ruby
+# Use lato as application panel
+gem "lato"
+gem "lato_settings"
+```
+
+Install gem and run required tasks:
+
+```bash
+$ bundle
+$ rails lato_settings:install:application
+$ rails lato_settings:install:migrations
+$ rails db:migrate
+```
+
+Mount lato settings routes on the **config/routes.rb** file:
+
+```ruby
+Rails.application.routes.draw do
+  mount LatoSettings::Engine => "/lato-settings"
+
+  # ....
+end
+```
+
+## Development
+
+Clone repository, install dependencies, run migrations and start:
+
+```shell
+$ git clone https://github.com/Lato-GAM/lato_settings
+$ cd lato_settings
+$ bundle
+$ rails db:migrate
+$ rails db:seed
+$ foreman start -f Procfile.dev
+```
+
+## Publish
+
+```shell
+$ ruby ./bin/publish.rb
+```
+
+## 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("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/lato_settings_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../stylesheets/lato_settings .css
+//= link_directory ../images/lato_settings .jpg
+//= link_tree ../javascripts/lato_settings .js

data/app/assets/javascripts/lato_settings/application.js

@@ -0,0 +1 @@
+console.log("Lato Settings JS loaded");

data/app/assets/javascripts/lato_settings/controllers/lato_settings_form_controller.js

@@ -0,0 +1,25 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [
+    "inputTypology",
+    "linkTypologySelected"
+  ]
+  
+  connect() {
+    this.onInputTypologyChange = this.onInputTypologyChange.bind(this)
+
+    if (this.hasInputTypologyTarget && this.hasLinkTypologySelectedTarget) {
+      this.inputTypologyTarget.addEventListener("change", this.onInputTypologyChange)
+    }
+  }
+
+  onInputTypologyChange(event) {
+    if (!this.hasInputTypologyTarget) return
+    if (!this.hasLinkTypologySelectedTarget) return
+    if (!event.target.value) return
+    
+    this.linkTypologySelectedTarget.href = this.linkTypologySelectedTarget.href.replace(/typology=[^&]*/, `typology=${event.target.value}`)
+    this.linkTypologySelectedTarget.click()
+  }
+}

data/app/assets/stylesheets/lato_settings/application.scss

@@ -0,0 +1,15 @@
+.controller-settings {
+  .lato-index-desk {
+    .table {
+      tbody, thead {
+        td:not(:last-child), th:not(:last-child) {
+          width: 25%;
+        }
+
+        td:last-child {
+          text-align: right;
+        }
+      }
+    }
+  }
+}

data/app/controllers/lato_settings/application_controller.rb

@@ -0,0 +1,20 @@
+module LatoSettings
+  class ApplicationController < Lato::ApplicationController
+    layout 'lato/application'
+    before_action :authenticate_session
+    before_action :authenticate_lato_settings_admin
+    before_action { active_sidebar(:lato_settings); active_navbar(:lato_settings) }
+
+    def index
+      redirect_to lato_settings.settings_path
+    end
+
+    protected
+
+    def authenticate_lato_settings_admin
+      return true if @session.user.lato_settings_admin
+
+      redirect_to lato.root_path, alert: 'You have not access to this section.'
+    end
+  end
+end

data/app/controllers/lato_settings/settings_controller.rb

@@ -0,0 +1,52 @@
+module LatoSettings
+  class SettingsController < ApplicationController
+    def index
+      @settings = lato_index_collection(
+        Setting.all,
+        columns: %i[key label value updated_at actions],
+        searchable_columns: %i[key label value],
+        sortable_columns: %i[updated_at],
+        pagination: true,
+        default_sort_by: "key|asc"
+      )
+    end
+
+    def new
+      @setting = Setting.new(typology: params[:typology])
+    end
+
+    def create
+      @setting = Setting.new(setting_params)
+      if @setting.save
+        redirect_to settings_path
+      else
+        render 'new'
+      end
+    end
+
+    def edit
+      @setting = Setting.find(params[:id])
+    end
+
+    def update
+      @setting = Setting.find(params[:id])
+      if @setting.update(setting_params)
+        redirect_to settings_path
+      else
+        render 'edit'
+      end
+    end
+
+    def destroy
+      @setting = Setting.find(params[:id])
+      @setting.destroy
+      redirect_to settings_path
+    end
+
+    private
+
+    def setting_params
+      params.require(:setting).permit(:key, :value, :label, :description, :typology)
+    end
+  end
+end

data/app/helpers/lato_settings/application_helper.rb

@@ -0,0 +1,4 @@
+module LatoSettings
+  module ApplicationHelper
+  end
+end

data/app/helpers/lato_settings/settings_helper.rb

@@ -0,0 +1,26 @@
+module LatoSettings
+  module SettingsHelper
+    def lato_settings_setting_label(setting)
+      content_tag(:div, class: 'd-flex flex-column') do
+        concat content_tag(:strong, setting.label)
+        if setting.description
+          concat content_tag(:small, setting.description, class: 'text-muted')
+        end
+      end
+    end
+    
+    def lato_settings_setting_updated_at(setting)
+      setting.updated_at.strftime('%d/%m/%Y %H:%M')
+    end
+
+    def lato_settings_setting_actions(setting)
+      content_tag(:div, class: 'btn-group btn-group-sm') do
+        concat link_to(I18n.t('lato_settings.cta_edit'), lato_settings.edit_setting_path(setting), class: 'btn btn-primary', data: { lato_action_target: 'trigger', turbo_frame: dom_id(setting, 'form'), action_title: I18n.t('lato_settings.edit_setting') })
+
+        unless setting.required
+          concat link_to(I18n.t('lato_settings.cta_delete'), lato_settings.setting_path(setting), class: 'btn btn-danger', data: { turbo_confirm: 'Are you sure?', turbo_method: :delete })
+        end
+      end
+    end
+  end
+end

data/app/jobs/lato_settings/application_job.rb

@@ -0,0 +1,4 @@
+module LatoSettings
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/lato_settings/application_mailer.rb

@@ -0,0 +1,6 @@
+module LatoSettings
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/lato_settings/setting.rb

@@ -0,0 +1,81 @@
+module LatoSettings
+  class Setting < ApplicationRecord
+    attr_accessor :actions
+
+    enum :typology, {
+      string: 0,
+      number: 1,
+      date: 2,
+      select: 3,
+    }, prefix: true
+
+    validates :key, presence: true, uniqueness: true, format: { with: /\A[a-zA-Z0-9_]+\z/ }
+    validates :typology, presence: true
+    validates :value, presence: true
+    validates :label, presence: true
+
+    # Hooks
+    ##
+
+    # normalize key before validation
+    before_validation do
+      self.key = key&.to_s&.downcase&.parameterize&.underscore
+    end
+
+    # do not permit destroy if required is true
+    before_destroy do
+      throw(:abort) if required
+    end
+
+    after_save :reload_cache
+    after_destroy :reload_cache
+    def reload_cache
+      Rails.cache.delete('LatoSettings::Setting/cache')
+      @@cache = nil
+    end
+
+    # Helpers
+    ##
+    
+    def option_min
+      options&.dig('min') || nil
+    end
+
+    def option_max
+      options&.dig('max') || nil
+    end
+
+    def option_step
+      options&.dig('step') || 1
+    end
+
+    def option_values
+      options&.dig('values') || []
+    end
+
+    # Class
+    ##
+    
+    def self.get(key, default = nil)
+      load_cache
+
+      @@cache[key] || default
+    end
+
+    def self.load_cache
+      return true if defined?(@@cache) && @@cache
+
+      @@cache = Rails.cache.fetch('LatoSettings::Setting/cache') do
+        cache = {}
+        LatoSettings::Setting.all.select(:key, :value, :typology).each do |setting|
+          cache[setting.key] = setting.value
+        end
+
+        cache
+      end
+
+      true
+    end
+
+  end
+end

data/app/views/lato_settings/settings/_form.html.erb

@@ -0,0 +1,65 @@
+<%
+
+setting ||= LatoSettings::Setting.new
+
+%>
+
+<%= turbo_frame_tag dom_id(setting, 'form') do %>
+  <%= form_with model: setting, url: setting.persisted? ? lato_settings.setting_path(setting) : lato_settings.settings_path, data: { turbo_frame: '_self', controller: 'lato-form lato-settings-form' } do |form| %>
+    <%= lato_form_notices class: %w[mb-3] %>
+    <%= lato_form_errors setting, class: %w[mb-3] %>
+
+    <% if setting.typology %>
+      <%= form.hidden_field :typology %>
+
+      <div class="mb-3">
+        <%= lato_form_item_label form, :key %>
+        <%= lato_form_item_input_text form, :key, required: true, disabled: setting.persisted? %>
+      </div>
+
+      <% if setting.typology == 'number' %>
+        <div class="mb-3">
+          <%= lato_form_item_label form, :value %>
+          <%= lato_form_item_input_number form, :value, required: true, min: setting.option_min, max: setting.option_max, step: setting.option_step %>
+        </div>
+      <% elsif setting.typology == 'date' %>
+        <div class="mb-3">
+          <%= lato_form_item_label form, :value %>
+          <%= lato_form_item_input_date form, :value, required: true, min: setting.option_min, max: setting.option_max %>
+        </div>
+      <% elsif setting.typology == 'select' %>
+        <div class="mb-3">
+          <%= lato_form_item_label form, :value %>
+          <%= lato_form_item_input_select form, :value, options_for_select(setting.option_values, setting.value), required: true %>
+        </div>
+      <% else %>
+        <div class="mb-3">
+          <%= lato_form_item_label form, :value %>
+          <%= lato_form_item_input_text form, :value, required: true %>
+        </div>
+      <% end %>
+
+      <div class="mb-3">
+        <%= lato_form_item_label form, :label %>
+        <%= lato_form_item_input_text form, :label, required: true %>
+      </div>
+
+      <div class="mb-3">
+        <%= lato_form_item_label form, :description %>
+        <%= lato_form_item_input_textarea form, :description %>
+      </div>
+
+      <div class="d-flex justify-content-end">
+        <%= lato_form_submit form, setting.persisted? ? I18n.t('lato_settings.cta_update') : I18n.t('lato_settings.cta_confirm'), class: %w[btn-success] %>
+      </div>
+    <% elsif !setting.persisted? %>
+      <div class="mb-3">
+        <%= lato_form_item_label form, :typology %>
+        <%= lato_form_item_input_select form, :typology, options_for_select(LatoSettings::Setting.typologies.keys.map { |s| [s.humanize, s] }, setting.typology), required: true, data: { lato_settings_form_target: 'inputTypology' } %>
+      </div>
+
+      <%= link_to '', lato_settings.new_setting_path(typology: ''), class: 'd-none', data: { lato_settings_form_target: 'linkTypologySelected' } %>
+    <% end %>
+
+  <% end %>
+<% end %>

data/app/views/lato_settings/settings/edit.html.erb

@@ -0,0 +1,13 @@
+<%= lato_page_head I18n.t('lato_settings.edit_setting'), [
+  { label: I18n.t('lato_settings.settings'), path: lato_settings.settings_path },
+  { label: I18n.t('lato_settings.edit_setting') }
+] %>
+
+<div class="card mb-4">
+  <div class="card-header">
+    <h2 class="fs-4 mb-0"><%= I18n.t('lato_settings.edit_setting') %></h2>
+  </div>
+  <div class="card-body">
+    <%= render 'lato_settings/settings/form', setting: @setting %>
+  </div>
+</div>

data/app/views/lato_settings/settings/index.html.erb

@@ -0,0 +1,17 @@
+<%= lato_page_head I18n.t('lato_settings.settings') %>
+
+<div class="card mb-4">
+  <div class="card-body">
+    <%= lato_index @settings,
+      custom_actions: {
+        create: {
+          path: lato_settings.new_setting_path,
+          icon: 'bi bi-plus',
+          aria_label: I18n.t('lato_settings.add_setting'),
+          title: I18n.t('lato_settings.add_setting'),
+          data: { lato_action_target: 'trigger', turbo_frame: dom_id(LatoSettings::Setting.new, 'form'), action_title: I18n.t('lato_settings.add_setting') },
+        }
+      }
+    %>
+  </div>
+</div>

data/app/views/lato_settings/settings/new.html.erb

@@ -0,0 +1,13 @@
+<%= lato_page_head I18n.t('lato_settings.add_setting'), [
+  { label: I18n.t('lato_settings.settings'), path: lato_settings.settings_path },
+  { label: I18n.t('lato_settings.add_setting') }
+] %>
+
+<div class="card mb-4">
+  <div class="card-header">
+    <h2 class="fs-4 mb-0"><%= I18n.t('lato_settings.add_setting') %></h2>
+  </div>
+  <div class="card-body">
+    <%= render 'lato_settings/settings/form', setting: @setting %>
+  </div>
+</div>

data/config/importmap.rb

@@ -0,0 +1,2 @@
+pin "lato_settings/application", to: "lato_settings/application.js"
+pin_all_from LatoSettings::Engine.root.join("app/assets/javascripts/lato_settings/controllers"), under: "controllers", to: "lato_settings/controllers"

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  lato_settings:
+    settings: Settings
+    add_setting: Add Setting
+    edit_setting: Edit Setting
+    cta_edit: Edit
+    cta_update: Update
+    cta_delete: Delete
+    cta_confirm: Confirm

data/config/locales/it.yml

@@ -0,0 +1,19 @@
+it:
+  lato_settings:
+    settings: Impostazioni
+    add_setting: Aggiungi Impostazione
+    edit_setting: Modifica Impostazione
+    cta_edit: Modifica
+    cta_update: Aggiorna
+    cta_delete: Cancella
+    cta_confirm: Conferma
+  activerecord:
+    attributes:
+      lato_settings/setting:
+        typology: Tipologia
+        key: Chiave
+        label: Etichetta
+        value: Valore
+        description: Descrizione
+        updated_at: Aggiornato il
+        actions: Azioni

data/config/routes.rb

@@ -0,0 +1,5 @@
+LatoSettings::Engine.routes.draw do
+  root 'application#index'
+
+  resources :settings
+end

data/db/migrate/20250328072343_add_lato_settings_admin_to_lato_user.rb

@@ -0,0 +1,5 @@
+class AddLatoSettingsAdminToLatoUser < ActiveRecord::Migration[7.1]
+  def change
+    add_column :lato_users, :lato_settings_admin, :boolean, default: false
+  end
+end

data/db/migrate/20250328073205_create_lato_settings_settings.rb

@@ -0,0 +1,14 @@
+class CreateLatoSettingsSettings < ActiveRecord::Migration[7.1]
+  def change
+    create_table :lato_settings_settings do |t|
+      t.string :key, null: false, index: { unique: true }
+      t.integer :typology, default: 0
+      t.string :value
+      t.string :label
+      t.string :description
+      t.boolean :required, default: false
+      t.json :options
+      t.timestamps
+    end
+  end
+end

data/lib/lato_settings/config.rb

@@ -0,0 +1,10 @@
+module LatoSettings
+  # Config
+  # This class contains the default configuration of the engine.
+  ##
+  class Config
+    
+    def initialize
+    end
+  end
+end

data/lib/lato_settings/engine.rb

@@ -0,0 +1,13 @@
+module LatoSettings
+  class Engine < ::Rails::Engine
+    isolate_namespace LatoSettings
+
+    initializer 'lato_settings.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+    end
+
+    initializer "lato_settings.precompile" do |app|
+      app.config.assets.precompile << "lato_settings_manifest.js"
+    end
+  end
+end

data/lib/lato_settings/version.rb

@@ -0,0 +1,3 @@
+module LatoSettings
+  VERSION = "3.0.0"
+end

data/lib/lato_settings.rb

@@ -0,0 +1,15 @@
+require "lato_settings/version"
+require "lato_settings/engine"
+require "lato_settings/config"
+
+module LatoSettings
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/tasks/lato_settings_tasks.rake

@@ -0,0 +1,11 @@
+require 'fileutils'
+
+namespace :lato_settings do
+  namespace :install do
+    desc 'Install Lato settings engine and run tasks on main rails application'
+    # Usage: rails lato_settings:install:application
+    task :application do
+      # Free for future use...
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: lato_settings
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Gregorio Galante
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.1
+- !ruby/object:Gem::Dependency
+  name: lato
+  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'
+description: A Rails engine to manage application settings on Lato projects!
+email:
+- me@gregoriogalante.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/lato_settings_manifest.js
+- app/assets/javascripts/lato_settings/application.js
+- app/assets/javascripts/lato_settings/controllers/lato_settings_form_controller.js
+- app/assets/stylesheets/lato_settings/application.scss
+- app/controllers/lato_settings/application_controller.rb
+- app/controllers/lato_settings/settings_controller.rb
+- app/helpers/lato_settings/application_helper.rb
+- app/helpers/lato_settings/settings_helper.rb
+- app/jobs/lato_settings/application_job.rb
+- app/mailers/lato_settings/application_mailer.rb
+- app/models/lato_settings/setting.rb
+- app/views/lato_settings/settings/_form.html.erb
+- app/views/lato_settings/settings/edit.html.erb
+- app/views/lato_settings/settings/index.html.erb
+- app/views/lato_settings/settings/new.html.erb
+- config/importmap.rb
+- config/locales/en.yml
+- config/locales/it.yml
+- config/routes.rb
+- db/migrate/20250328072343_add_lato_settings_admin_to_lato_user.rb
+- db/migrate/20250328073205_create_lato_settings_settings.rb
+- lib/lato_settings.rb
+- lib/lato_settings/config.rb
+- lib/lato_settings/engine.rb
+- lib/lato_settings/version.rb
+- lib/tasks/lato_settings_tasks.rake
+homepage: https://github.com/Lato-org/lato_settings
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Lato-org/lato_settings
+  source_code_uri: https://github.com/Lato-org/lato_settings
+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.1
+signing_key:
+specification_version: 4
+summary: Another engine for Lato projects
+test_files: []