spina-admin-conferences-fork 2.1.1 → 3.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c49d67e54dfe8e122eb4fc4ca6e7d333408739c25ce9bc8f4bb1e425af16240
-  data.tar.gz: c33f5d5d1ec3807dd692dea90a507017af41f50ec7381ced7bc1d9ebe8ecca5c
+  metadata.gz: '0924918c23bbaf05550c4f245a658955dc8116dfbdda3e9fe17abfc59576dc97'
+  data.tar.gz: 201b0680cad2c8c4b16a922c11784c1ca170d534288eed0d44c438fe141f2a56
 SHA512:
-  metadata.gz: 3d60e46c9dd93b243fd48c2ffd6bed97eef83d95742d3b011423e273db1c27071c6f5c0e5ddb7c0b5f5baa748bec43c86b1fd2cdde1fd973f7a8e897cb0cf6fc
-  data.tar.gz: 2785f5d514a75333ba1190724fd1bb3444b949478bf7aa9859d09327e90885f7a46bacf76b893454e7a51ff16ef6e3bdb7a108802272fd533460dde43d44d1e5
+  metadata.gz: 71f9d163f9a0e96c5b7202143df4a49e1dc6945fc200fd427c1e3f356aed5f7e04d373916f5a59d9a7827f1c0b4a53ac1a31d554997e507b33b0651c47fefff3
+  data.tar.gz: 805deb378c7202842bf7bbbfaf1bf256341386e978f4566b1a2d71aaaf555fea4bddd5ea6eaa7866f0d8ba08ba51d687981bcccb96f275723c5c1ba353381a2a

data/README.md

@@ -1,33 +1,34 @@
 # Conferences
 
-![Rails tests](https://github.com/jmalcic/spina-admin-conferences/workflows/Rails%20tests/badge.svg?branch=master&event=push)
-[![Coverage Status](https://coveralls.io/repos/github/jmalcic/spina-admin-conferences/badge.svg?branch=master)](https://coveralls.io/github/jmalcic/spina-admin-conferences?branch=master)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/jmalcic/spina-admin-conferences.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmalcic/spina-admin-conferences/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/jmalcic/spina-admin-conferences.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmalcic/spina-admin-conferences/context:javascript)
-[![Code quality](https://www.codefactor.io/repository/github/jmalcic/spina-admin-conferences/badge)](https://www.codefactor.io/repository/github/jmalcic/spina-admin-conferences)
-[![Inline docs](http://inch-ci.org/github/jmalcic/spina-admin-conferences.svg?branch=master)](http://inch-ci.org/github/jmalcic/spina-admin-conferences)
-[![Visual testing](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ulab/spina-admin-conferences)
-
-*Conferences* is a plugin for [Spina](https://www.spinacms.com 'Spina website') (a [Rails](http://rubyonrails.org 'Ruby on Rails website') content management system) to add conference management functionality.
-With the plugin, you'll be able to manage details of conferences, delegates, and presentations.
-See the wiki for details of the types of data supported.
+*Conferences* is a plugin for [Spina](https://www.spinacms.com/) that provides conference management functionality. With the plugin, you'll be able to manage details of conferences, delegates, and presentations.
+
+Spina is a content management system built in [Ruby on Rails](http://rubyonrails.org/). *Conferences* augments Spina by providing an admin interface for managing conferences.
+
+![Rails tests](https://github.com/louis-vs/spina-admin-conferences-fork/workflows/Verify/badge.svg?branch=main&event=push)
+[![CodeFactor](https://www.codefactor.io/repository/github/louis-vs/spina-admin-conferences-fork/badge)](https://www.codefactor.io/repository/github/louis-vs/spina-admin-conferences-fork)
+
+## Features
+
+The conferences plugin covers many important aspects of managing a conferences, including:
+
+- Simple interface that builds upon Spina's own.
+- Manage details about delegates, including dietary requirements.
+- Manage conferences, supporting conferences with multiple host institutions.
+- Manage presentations, including presentation types.
+
+Currently, a submissions management system is not included, but this is planned for a future release. This will allow you to manage the submissions process for conferences in a manner integrated with the CMS.
 
 ## Usage
 
 The plugin will add a **Conferences** item to Spina's primary navigation menu.
 The menu structure will then be as follows:
 
-* *Other menu items*
-
-* Conferences
-
-    * Institutions
-    
-    * Conferences
-    
-    * Delegates
-    
-    * Presentations
+- *Other menu items*
+- Conferences
+  - Institutions
+  - Conferences
+  - Delegates
+  - Presentations
 
 After installing the plugin, you just need to start your server in the usual way:
 ```bash
@@ -37,63 +38,45 @@ $ rails s
 ## Installation
 
 ### From scratch
+Make sure you have a working installation of Ruby on Rails 7. You can find a setup guide [here](https://guides.rubyonrails.org/getting_started.html).
 
-You'll need [Rails](http://rubyonrails.org 'Ruby on Rails website') installed if it isn't already.
-Read how to do this in the [Rails getting started guide](https://guides.rubyonrails.org/getting_started.html 'Getting Started with Rails').
+You then need to install Spina, following the guide [on the Spina website](https://spinacms.com/docs).
 
-Then run:
-```bash
-$ rails new your_app --database postgresql
-$ rails db:create
-$ rails active_storage:install
-```
-
-Add this line to your application's Gemfile:
+To install the plugin, add this line to your application's Gemfile:
 
 ```ruby
-gem 'spina'
+gem 'spina-admin-conferences-fork', '~> 3.0'
 ```
 
-And then execute:
-```bash
-$ bundle:install
-```
+Then execute:
 
-Run the Spina install generator:
 ```bash
-$ rails g spina:install
+$ bundle install
 ```
 
-And follow the prompts.
-Then follow the instructions below.
-
-### For existing Spina installations
-
-Add this line to your application's Gemfile:
+You'll then need to install and run the migrations from the plugin:
 
-```ruby
-gem 'spina-admin-conferences'
+```bash
+$ bin/rails spina_admin_conferences:install:migrations
+$ bin/rails db:migrate
 ```
 
-You'll then need to install and run the migrations from Conferences (the Spina install generator does this for Spina).
+You can then start a local server to test that everything's working.
 
-First install the migrations and then migrate the database:
 ```bash
-$ rake spina_admin_conferences:install:migrations
-$ rake db:migrate
+$ bin/rails s
 ```
 
+You can manually populate the database from within the app, or alternatively you can use seed data for testing. A sample `seeds.rb` file can be found [here](../master/test/dummy/db/seeds.rb).
+
+
 ### Configuring the main Rails app
 
-Conferences requires a job queueing backend for import functionality, and you'll also want to cache pages listing
-presentations, conferences, and so on. Read about this in the Rails guides covering
-[Active Job](https://guides.rubyonrails.org/active_job_basics.html) and
-[caching](https://guides.rubyonrails.org/caching_with_rails.html).
+Conferences requires a job queueing backend for import functionality, and you'll also want to cache pages listing presentations, conferences, and so on. Read about this in the Rails guides covering [Active Job](https://guides.rubyonrails.org/active_job_basics.html) and [caching](https://guides.rubyonrails.org/caching_with_rails.html).
 
 ## Contributing
 
-You're very welcome to contribute, particularly to translations.
-If there's a bug, or you have a feature request, make an issue on GitHub first.
+Bug reports and feature requests are welcome in the [Issues](https://github.com/louis-vs/spina-admin-conferences-fork/issues) section. Translations are also very welcome!
 
 ## License
 

data/app/assets/config/spina_admin_conferences_manifest.js

@@ -1,3 +1,3 @@
-//= link spina_manifest.js
-//= link spina/admin/conferences/application.css
-//= link_tree ../javascripts
+//= link_directory ../javascripts/spina/admin/conferences/controllers
+
+//= link spina/admin/conferences/application.js

data/app/assets/javascripts/spina/admin/conferences/application.js

@@ -1,4 +0,0 @@
-document.addEventListener('turbo:load', (event) => {
-  const customEvent = new CustomEvent('turbolinks:load', { cancelable: event.cancelable, bubbles: true, detail: event.detail })
-  document.documentElement.dispatchEvent(customEvent)
-})

data/app/assets/javascripts/{controllers/spina/admin/conferences → spina/admin/conferences/controllers}/select_options_controller.js

@@ -2,7 +2,7 @@
  * @external Controller
  * @see {@link https://stimulusjs.org}
  */
-import { Controller } from 'stimulus'
+import { Controller } from '@hotwired/stimulus'
 
 /**
  * @classdesc Controller that links related select elements.

data/app/components/spina/admin/conferences/application_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Base class for components.
+      class ApplicationComponent < Spina::ApplicationComponent
+      end
+    end
+  end
+end

data/app/components/spina/admin/conferences/form_group_component.html.haml

@@ -0,0 +1,4 @@
+.mt-6
+  %label.block.text-sm.leading-5.font-medium.text-gray-700= label
+  .text-gray-400.text-sm= description
+  .mt-1= content

data/app/components/spina/admin/conferences/form_group_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Correctly styles label, description and content of form fields.
+      class FormGroupComponent < ApplicationComponent
+        attr_reader :label, :description
+
+        def initialize(label:, description: '')
+          @label = label
+          @description = description
+        end
+      end
+    end
+  end
+end

data/app/controllers/spina/admin/conferences/application_controller.rb

@@ -9,11 +9,18 @@ module Spina
 
         add_flash_types :success
 
-        layout 'spina/admin/conferences/application', only: %i[new edit]
+        layout :admin_layout
+
         before_action :set_locale
 
+        admin_section :conferences
+
         private
 
+        def admin_layout
+          'spina/admin/admin'
+        end
+
         def set_locale
           @locale = params[:locale] || I18n.default_locale
         end

data/app/controllers/spina/admin/conferences/conferences_controller.rb

@@ -19,7 +19,7 @@ module Spina
         ].freeze
         CONTENT_PARAMS = Spina.config.locales.inject({}) { |params, locale| params.merge("#{locale}_content_attributes": [*PARTS_PARAMS]) }
         PARAMS = [:start_date, :finish_date, :name, **CONTENT_PARAMS,
-          events_attributes: %i[id name start_datetime finish_datetime description location] ].freeze
+          events_attributes: %i[id name start_datetime finish_datetime description location]].freeze
         PARTS = %w[text submission_url submission_email_address submission_date submission_text gallery sponsors].freeze
 
         before_action :set_conference, only: %i[edit update destroy]
@@ -52,51 +52,39 @@ module Spina
 
         # Creates a conference.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @conference = Conference.new(conference_params)
 
           if @conference.save
             redirect_to admin_conferences_conferences_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @conference.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates a conference.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @conference.update(conference_params)
             redirect_to admin_conferences_conferences_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @conference.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @conference.errors } }
-            end
+            add_breadcrumb @conference.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys a conference.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @conference.destroy
             redirect_to admin_conferences_conferences_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @conference.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @conference.errors } }
-            end
+            add_breadcrumb @conference.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/spina/admin/conferences/delegates_controller.rb

@@ -33,51 +33,39 @@ module Spina
 
         # Creates a delegate.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @delegate = Delegate.new(delegate_params)
 
           if @delegate.save
             redirect_to admin_conferences_delegates_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @delegate.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates a delegate.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @delegate.update(delegate_params)
             redirect_to admin_conferences_delegates_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @delegate.full_name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @delegate.errors } }
-            end
+            add_breadcrumb @delegate.full_name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys a delegate.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @delegate.destroy
             redirect_to admin_conferences_delegates_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @delegate.full_name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @delegate.errors } }
-            end
+            add_breadcrumb @delegate.full_name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/spina/admin/conferences/dietary_requirements_controller.rb

@@ -33,51 +33,39 @@ module Spina
 
         # Creates a dietary requirement.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @dietary_requirement = DietaryRequirement.new dietary_requirement_params
 
           if @dietary_requirement.save
             redirect_to admin_conferences_dietary_requirements_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @dietary_requirement.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates a dietary requirement.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @dietary_requirement.update(dietary_requirement_params)
             redirect_to admin_conferences_dietary_requirements_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @dietary_requirement.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @dietary_requirement.errors } }
-            end
+            add_breadcrumb @dietary_requirement.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys a dietary requirement.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @dietary_requirement.destroy
             redirect_to admin_conferences_dietary_requirements_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @dietary_requirement.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @dietary_requirement.errors } }
-            end
+            add_breadcrumb @dietary_requirement.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/spina/admin/conferences/institutions_controller.rb

@@ -33,51 +33,39 @@ module Spina
 
         # Creates an institution.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @institution = Institution.new(conference_params)
 
           if @institution.save
             redirect_to admin_conferences_institutions_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @institution.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates an institution.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @institution.update(conference_params)
             redirect_to admin_conferences_institutions_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @institution.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @institution.errors } }
-            end
+            add_breadcrumb @institution.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys an institution.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @institution.destroy
             redirect_to admin_conferences_institutions_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @institution.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @institution.errors } }
-            end
+            add_breadcrumb @institution.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/spina/admin/conferences/presentation_attachment_types_controller.rb

@@ -32,51 +32,39 @@ module Spina
 
         # Creates a presentation attachment type.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @presentation_attachment_type = PresentationAttachmentType.new presentation_attachment_type_params
 
           if @presentation_attachment_type.save
             redirect_to admin_conferences_presentation_attachment_types_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_attachment_type.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates a presentation attachment type.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @presentation_attachment_type.update(presentation_attachment_type_params)
             redirect_to admin_conferences_presentation_attachment_types_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @presentation_attachment_type.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_attachment_type.errors } }
-            end
+            add_breadcrumb @presentation_attachment_type.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys a presentation attachment type.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @presentation_attachment_type.destroy
             redirect_to admin_conferences_presentation_attachment_types_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @presentation_attachment_type.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_attachment_type.errors } }
-            end
+            add_breadcrumb @presentation_attachment_type.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/spina/admin/conferences/presentation_types_controller.rb

@@ -10,8 +10,6 @@ module Spina
         before_action :set_breadcrumbs
         before_action :set_tabs
 
-        layout 'spina/admin/conferences/conferences'
-
         # @!group Actions
 
         # Renders a list of presentation types.
@@ -35,51 +33,39 @@ module Spina
 
         # Creates a presentation type.
         # @return [void]
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           @presentation_type = PresentationType.new presentation_type_params
 
           if @presentation_type.save
             redirect_to admin_conferences_presentation_types_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb t('.new')
-                render :new
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_type.errors } }
-            end
+            add_breadcrumb t('.new')
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         # Updates a presentation type.
         # @return [void]
-        def update # rubocop:disable Metrics/MethodLength
+        def update
           if @presentation_type.update(presentation_type_params)
             redirect_to admin_conferences_presentation_types_path, success: t('.saved')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @presentation_type.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_type.errors } }
-            end
+            add_breadcrumb @presentation_type.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
         # Destroys a presentation type.
         # @return [void]
-        def destroy # rubocop:disable Metrics/MethodLength
+        def destroy
           if @presentation_type.destroy
             redirect_to admin_conferences_presentation_types_path, success: t('.destroyed')
           else
-            respond_to do |format|
-              format.html do
-                add_breadcrumb @presentation_type.name
-                render :edit
-              end
-              format.turbo_stream { render partial: 'errors', locals: { errors: @presentation_type.errors } }
-            end
+            add_breadcrumb @presentation_type.name
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end