spina-admin-conferences 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa2b8b1274af18cc7e12e10334bdf485b21993dc2d108147fb32ecc401a427bb
+  data.tar.gz: 92a089aac4a4a99e52d6f2837d2ae7ba8f297994dd940646c8aeace2c0460397
+SHA512:
+  metadata.gz: e842dbe6a4ddcf77c74e1df2809e84dc85dda7252b2239cbd67fa53644b55c8ebe8eb87986ae4a33a4f4bcba9594c1ace8d7400d20a19c86e0f314024998303f
+  data.tar.gz: 5a3286da4f42372a7136cb24447dd001b5c48bec7bbb3f0239eef84827ed2f09e7e8269d969f41baa3fd720c1e33cfa4bc189170ec41d398bbe05ed4f9a8065d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Justin Malčić
+
+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,101 @@
+# Conferences
+
+[![Build Status](https://travis-ci.com/jmalcic/spina-conferences.svg?branch=master)](https://travis-ci.com/jmalcic/spina-conferences)
+![Rails tests](https://github.com/jmalcic/spina-conferences/workflows/Rails%20tests/badge.svg?branch=master&event=push)
+[![Coverage Status](https://coveralls.io/repos/github/jmalcic/spina-conferences/badge.svg?branch=master)](https://coveralls.io/github/jmalcic/spina-conferences?branch=master)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/jmalcic/spina-conferences.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmalcic/spina-conferences/alerts/)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/jmalcic/spina-conferences.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmalcic/spina-conferences/context:javascript)
+[![Code quality](https://www.codefactor.io/repository/github/jmalcic/spina-conferences/badge)](https://www.codefactor.io/repository/github/jmalcic/spina-conferences)
+[![Inline docs](http://inch-ci.org/github/jmalcic/spina-conferences.svg?branch=master)](http://inch-ci.org/github/jmalcic/spina-conferences)
+[![Visual testing](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ulab/spina-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.
+
+## 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
+
+After installing the plugin, you just need to start your server in the usual way:
+```bash
+$ rails s
+```
+
+## Installation
+
+### From scratch
+
+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').
+
+Then run:
+```bash
+$ rails new your_app --database postgresql
+$ rails db:create
+$ rails active_storage:install
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spina'
+```
+
+And then execute:
+```bash
+$ bundle:install
+```
+
+Run the Spina install generator:
+```bash
+$ rails g spina:install
+```
+
+And follow the prompts.
+Then follow the instructions below.
+
+### For existing Spina installations
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spina-conferences', github: 'jmalcic/spina-conferences'
+```
+
+You'll then need to install and run the migrations from Conferences (the Spina install generator does this for Spina).
+
+First install the migrations and then migrate the database:
+```bash
+$ rake spina_conferences:install:migrations
+$ rake db:migrate
+```
+
+### 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).
+
+## 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.
+
+## 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,40 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Spina::Admin::Conferences'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+  t.ruby_opts = %w[-W:no-deprecated]
+end
+
+task default: :test
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new

data/app/assets/config/spina_admin_conferences_manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link spina/admin/conferences/application.js
+//= link spina/admin/conferences/application.css
+//= link spina_manifest.js

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

@@ -0,0 +1,20 @@
+//= require stimulus
+//= require_directory ./controllers
+
+/**
+ * @external Stimulus
+ */
+/* global Stimulus, SelectOptionsController, PresentationAttachmentsFormController, ConferenceEventsFormController */
+const application = Stimulus.Application.start()
+application.register('select-options', SelectOptionsController)
+application.register('presentation-attachments-form', PresentationAttachmentsFormController)
+application.register('conference-events-form', ConferenceEventsFormController)
+
+document.addEventListener('turbolinks:load', () => {
+  Array.from(document.getElementsByClassName('conference-datepicker')).forEach(element => {
+    $(element).datepicker({
+      dateFormat: 'yy-mm-dd',
+      firstDay: 1
+    })
+  })
+})

data/app/assets/javascripts/spina/admin/conferences/controllers/conference_events_form_controller.es6

@@ -0,0 +1,175 @@
+/* global Stimulus */
+
+/**
+ * @external Stimulus
+ * @see {@link https://stimulusjs.org}
+ */
+
+/**
+ * @classdesc Controller that manages conference event inputs.
+ */
+class ConferenceEventsFormController extends Stimulus.Controller { // eslint-disable-line no-unused-vars
+  // noinspection JSUnusedGlobalSymbols
+  static get targets() {
+    return [
+      /**
+       * @private
+       * @property {HTMLElement[]} formLinkTargets - The form link elements.
+       */
+      'formLink',
+      /**
+       * @private
+       * @property {HTMLElement} addFormLinkTarget - The button element for adding forms.
+       */
+      'addFormLink',
+      /**
+       * @private
+       * @property {HTMLElement[]} formPaneTargets - The form pane elements.
+       */
+      'formPane',
+      /**
+       * @private
+       * @property {HTMLElement[]} destroyFieldTargets - The destroy field hidden inputs.
+       */
+      'destroyField',
+      /**
+       * @private
+       * @property {HTMLElement[]} formLinkLabelTargets - The form link label elements.
+       */
+      'formLinkLabel'
+    ]
+  }
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * @private
+   * @property {string} activeClass - The class used to mark elements as active.
+   */
+  static get classes() {
+    return ['active']
+  }
+
+  /**
+   * Returns visible form pane targets.
+   * @private
+   * @return {HTMLElement[]} Form pane targets currently shown.
+   */
+  get visibleFormPaneTargets() {
+    return this.getVisibleTargets(this.formPaneTargets)
+  }
+
+  /**
+   * Returns visible form link targets.
+   * @private
+   * @return {HTMLElement[]} Form link targets currently shown.
+   */
+  get visibleFormLinkTargets() {
+    return this.getVisibleTargets(this.formLinkTargets)
+  }
+
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * Removes the form for the button firing the event.
+   * @param {Event} event - The event fired by the button.
+   */
+  removeForm(event) {
+    if (!(event.currentTarget instanceof HTMLElement)) return
+    const index = this.getIndexOfChild(this.formPaneTargets, event.currentTarget)
+    const visibleIndex = this.getIndexOfChild(this.visibleFormPaneTargets, event.currentTarget)
+    this.destroyFieldTargets[index].value = true.toString()
+    this.hideTargetPair(index)
+    if (this.visibleFormPaneTargets.length > 0) {
+      let newIndex = visibleIndex <= this.visibleFormPaneTargets.length - 1 ? visibleIndex : visibleIndex - 1
+      this.makeTargetPairActive(newIndex)
+    }
+    this.updateURL()
+  }
+
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * Updates the form link labels with new type.
+   * @param {Event} event - The event fired by the select element.
+   */
+  updateType(event) {
+    if (!(event.currentTarget instanceof HTMLSelectElement)) return
+    const index = this.getIndexOfChild(this.formPaneTargets, event.currentTarget)
+    this.formLinkLabelTargets[index].textContent = event.currentTarget.selectedOptions[0].label
+  }
+
+  /**
+   * Updates the URL used to get new forms.
+   */
+  updateURL() {
+    const params = new URLSearchParams(this.addFormLinkTarget.search)
+    params.set('index', String(this.formPaneTargets.length))
+    params.set('active', String(this.visibleFormPaneTargets.length === 0))
+    this.addFormLinkTarget.search = params.toString()
+  }
+
+  /**
+   * Hides a form pane and form link target sharing an index.
+   * @private
+   * @private
+   * @param {Number} index - The index of the targets to hide.
+   */
+  hideTargetPair(index) {
+    this.hide(this.formPaneTargets[index])
+    this.hide(this.formLinkTargets[index])
+  }
+
+  /**
+   * Marks a form pane and form link target sharing an index as active.
+   * @private
+   * @param {Number} index - The index of the targets to show.
+   */
+  makeTargetPairActive(index) {
+    this.makeActive(this.visibleFormPaneTargets[index])
+    this.makeActive(this.visibleFormLinkTargets[index])
+  }
+
+  /**
+   * Makes an element inactive and hides it.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  hide(element) {
+    this.makeInactive(element)
+    element.hidden = true
+  }
+
+  /**
+   * Makes an element inactive.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  makeInactive(element) {
+    element.classList.remove(this.activeClass)
+  }
+
+  /**
+   * Makes an element active.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  makeActive(element) {
+    element.classList.add(this.activeClass)
+  }
+
+  /**
+   * Gets the index of an element within a collection.
+   * @private
+   * @param {HTMLElement[]} collection
+   * @param {HTMLElement} child
+   */
+  getIndexOfChild(collection, child) {
+    return collection.indexOf(collection.find(element => element.contains(child)))
+  }
+
+  /**
+   * Gets visible targets within a collection.
+   * @private
+   * @param {HTMLElement[]} targets
+   */
+  getVisibleTargets(targets) {
+    return targets.filter(target => target.hidden === false)
+  }
+}

data/app/assets/javascripts/spina/admin/conferences/controllers/presentation_attachments_form_controller.es6

@@ -0,0 +1,175 @@
+/* global Stimulus */
+
+/**
+ * @external Stimulus
+ * @see {@link https://stimulusjs.org}
+ */
+
+/**
+ * @classdesc Controller that manages presentation attachment inputs.
+ */
+class PresentationAttachmentsFormController extends Stimulus.Controller { // eslint-disable-line no-unused-vars
+  // noinspection JSUnusedGlobalSymbols
+  static get targets() {
+    return [
+      /**
+       * @private
+       * @property {HTMLElement[]} formLinkTargets - The form link elements.
+       */
+      'formLink',
+      /**
+       * @private
+       * @property {HTMLElement} addFormLinkTarget - The button element for adding forms.
+       */
+      'addFormLink',
+      /**
+       * @private
+       * @property {HTMLElement[]} formPaneTargets - The form pane elements.
+       */
+      'formPane',
+      /**
+       * @private
+       * @property {HTMLElement[]} destroyFieldTargets - The destroy field hidden inputs.
+       */
+      'destroyField',
+      /**
+       * @private
+       * @property {HTMLElement[]} formLinkLabelTargets - The form link label elements.
+       */
+      'formLinkLabel'
+    ]
+  }
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * @private
+   * @property {string} activeClass - The class used to mark elements as active.
+   */
+  static get classes() {
+    return ['active']
+  }
+
+  /**
+   * Returns visible form pane targets.
+   * @private
+   * @return {HTMLElement[]} Form pane targets currently shown.
+   */
+  get visibleFormPaneTargets() {
+    return this.getVisibleTargets(this.formPaneTargets)
+  }
+
+  /**
+   * Returns visible form link targets.
+   * @private
+   * @return {HTMLElement[]} Form link targets currently shown.
+   */
+  get visibleFormLinkTargets() {
+    return this.getVisibleTargets(this.formLinkTargets)
+  }
+
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * Removes the form for the button firing the event.
+   * @param {Event} event - The event fired by the button.
+   */
+  removeForm(event) {
+    if (!(event.currentTarget instanceof HTMLElement)) return
+    const index = this.getIndexOfChild(this.formPaneTargets, event.currentTarget)
+    const visibleIndex = this.getIndexOfChild(this.visibleFormPaneTargets, event.currentTarget)
+    this.destroyFieldTargets[index].value = true.toString()
+    this.hideTargetPair(index)
+    if (this.visibleFormPaneTargets.length > 0) {
+      let newIndex = visibleIndex <= this.visibleFormPaneTargets.length - 1 ? visibleIndex : visibleIndex - 1
+      this.makeTargetPairActive(newIndex)
+    }
+    this.updateURL()
+  }
+
+  // noinspection JSUnusedGlobalSymbols
+  /**
+   * Updates the form link labels with new type.
+   * @param {Event} event - The event fired by the select element.
+   */
+  updateType(event) {
+    if (!(event.currentTarget instanceof HTMLSelectElement)) return
+    const index = this.getIndexOfChild(this.formPaneTargets, event.currentTarget)
+    this.formLinkLabelTargets[index].textContent = event.currentTarget.selectedOptions[0].label
+  }
+
+  /**
+   * Updates the URL used to get new forms.
+   */
+  updateURL() {
+    const params = new URLSearchParams(this.addFormLinkTarget.search)
+    params.set('index', String(this.formPaneTargets.length))
+    params.set('active', String(this.visibleFormPaneTargets.length === 0))
+    this.addFormLinkTarget.search = params.toString()
+  }
+
+  /**
+   * Hides a form pane and form link target sharing an index.
+   * @private
+   * @private
+   * @param {Number} index - The index of the targets to hide.
+   */
+  hideTargetPair(index) {
+    this.hide(this.formPaneTargets[index])
+    this.hide(this.formLinkTargets[index])
+  }
+
+  /**
+   * Marks a form pane and form link target sharing an index as active.
+   * @private
+   * @param {Number} index - The index of the targets to show.
+   */
+  makeTargetPairActive(index) {
+    this.makeActive(this.visibleFormPaneTargets[index])
+    this.makeActive(this.visibleFormLinkTargets[index])
+  }
+
+  /**
+   * Makes an element inactive and hides it.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  hide(element) {
+    this.makeInactive(element)
+    element.hidden = true
+  }
+
+  /**
+   * Makes an element inactive.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  makeInactive(element) {
+    element.classList.remove(this.activeClass)
+  }
+
+  /**
+   * Makes an element active.
+   * @private
+   * @param {HTMLElement} element - The element.
+   */
+  makeActive(element) {
+    element.classList.add(this.activeClass)
+  }
+
+  /**
+   * Gets the index of an element within a collection.
+   * @private
+   * @param {HTMLElement[]} collection
+   * @param {HTMLElement} child
+   */
+  getIndexOfChild(collection, child) {
+    return collection.indexOf(collection.find(element => element.contains(child)))
+  }
+
+  /**
+   * Gets visible targets within a collection.
+   * @private
+   * @param {HTMLElement[]} targets
+   */
+  getVisibleTargets(targets) {
+    return targets.filter(target => target.hidden === false)
+  }
+}