spina-admin-journal 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf3f41e632c032cf855ea7be3d2d6297e0f3d0eba015906afcb2c7497b8a0e16
-  data.tar.gz: 59e90ab32fa02f5400870002cffa3a0b7f7fe1f590ca03f8f2b22f008a72b074
+  metadata.gz: c43ca7425af717514efb0bc6a142651eae11fd79446019ab19b87bb8c952f497
+  data.tar.gz: 3af013de932268d05fb32013c7d1f09a89166eedd43276ce73c1756819cdea75
 SHA512:
-  metadata.gz: d8aebef70619bebbab5d5832639aa4dff527f909e4828a62aea7210eb69c0c2f0cddf2eb68871890457f751b3af00df686dbca919fedffb13276d89894b3b9ea
-  data.tar.gz: 1f1de9525d2e5ae4c57bdd9eeb55bfb106e3bcc3b9d32fcb1f8591820a89865a57311b65c7f57f48ca2a4ee95dcc219f4199ccd2354fdb11339accf1bf0dcc75
+  metadata.gz: d792437f01a6474b290daa7deaea9232eb78892a77e08c877abbab9ce97221785c653eca15062b2656a70e155b74ad3ed77aae3e2a3260306c153bfb9c4401fc
+  data.tar.gz: 1ef7f100bd6d37727916951f588d4fcad17d4c896e3fab8c136f2ac663b0290afb3293adc3c6c1cb2d1e99f463363a4c352879a09d53df624e31403d1120a111

data/app/controllers/spina/admin/journal/articles_controller.rb

@@ -19,7 +19,7 @@ module Spina
         CONTENT_PARAMS = Spina.config.locales.inject({}) do |params, locale|
           params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
         end
-        PARAMS = [:issue_id, :title, :url, :doi, :status, { affiliation_ids: [], **CONTENT_PARAMS }].freeze
+        PARAMS = [:issue_id, :licence_id, :title, :url, :doi, :status, { affiliation_ids: [], **CONTENT_PARAMS }].freeze
         PARTS = %w[abstract attachment].freeze
 
         before_action :set_breadcrumb

data/app/controllers/spina/admin/journal/journals_controller.rb

@@ -21,7 +21,7 @@ module Spina
           params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
         end
         PARAMS = [:name, { **CONTENT_PARAMS }].freeze
-        PARTS = %w[logo description].freeze
+        PARTS = %w[journal_abbreviation logo description documents].freeze
 
         before_action :set_journal
         before_action :set_parts_attributes

data/app/controllers/spina/admin/journal/licences_controller.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Licence} records.
+      class LicencesController < ApplicationController
+        PARTS_PARAMS = [
+          :name, :title, :type, :content, :filename, :signed_blob_id, :alt, :attachment_id, :image_id,
+          { images_attributes: %i[filename signed_blob_id image_id alt],
+            content_attributes: [
+              :name, :title,
+              { parts_attributes: [
+                :name, :title, :type, :content, :filename, :signed_blob_id, :alt, :attachment_id, :image_id,
+                { images_attributes: %i[filename signed_blob_id image_id alt] }
+              ] }
+            ] }
+        ].freeze
+        CONTENT_PARAMS = Spina.config.locales.inject({}) do |params, locale|
+          params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
+        end
+        PARAMS = [:name, :abbreviated_name, { **CONTENT_PARAMS }].freeze
+        PARTS = %w[text url logo].freeze
+
+        before_action :set_breadcrumb
+        before_action :set_licence, only: %i[edit update destroy]
+        before_action :set_parts_attributes, only: %i[new edit]
+        before_action :build_parts, only: %i[edit]
+
+        def index
+          @licences = Licence.sorted
+        end
+
+        def new
+          @licence = Licence.new
+          build_parts
+          add_breadcrumb t('.new')
+        end
+
+        def edit; end
+
+        def create
+          @licence = Licence.new(licence_params)
+          if @licence.save
+            redirect_to admin_journal_licences_path, success: t('.saved')
+          else
+            render :new
+          end
+        end
+
+        def update
+          if @licence.update(licence_params)
+            redirect_to admin_journal_licences_path, success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @licence.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_licences_path, success: t('.deleted')
+            end
+          end
+        end
+
+        private
+
+        def licence_params
+          params.require(:admin_journal_licence).permit(PARAMS)
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Licence.model_name.human(count: :many), admin_journal_licences_path
+        end
+
+        def set_licence
+          @licence = Licence.find(params[:id])
+          add_breadcrumb @licence.name
+        end
+
+        def set_parts_attributes
+          @parts_attributes = current_theme.parts.select { |part| PARTS.include? part[:name] }
+        end
+
+        def build_parts
+          return unless @parts_attributes.is_a? Array
+
+          @parts = @parts_attributes.collect { |part_attributes| @licence.part(part_attributes) }
+        end
+      end
+    end
+  end
+end

data/app/models/spina/admin/journal/article.rb

@@ -34,6 +34,9 @@ module Spina
         # @!attribute [rw] issue
         #   @return [Issue] The issue that contains this article.
         belongs_to :issue
+        # @!attribute [rw] licence
+        #   @return [Licence] the licence under which the article is released
+        belongs_to :licence, optional: true
 
         # @!attribute [rw] authorships
         has_many :authorships, dependent: :destroy

data/app/models/spina/admin/journal/licence.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A record to hold information about copyright licences.
+      #
+      # Associated with individual articles.
+      #
+      # === Validators
+      # Presence:: {#name}
+      class Licence < ApplicationRecord
+        include AttrJson::Record
+        include AttrJson::NestedAttributes
+        include Spina::Partable
+        include Spina::TranslatedContent
+
+        # @!attribute [rw] name
+        #   @return [String] the name of the licence
+        # @!attribute [rw] abbreviated_name
+        #   @return [String] an optional abbreviated form of the licence name
+        # @!attribute [rw] articles
+        #   @return [ActiveRecord::Relation] articles which use this licence
+        has_many :articles, dependent: :nullify
+
+        validates :name, presence: true
+
+        scope :sorted, -> { order(name: :asc) }
+      end
+    end
+  end
+end

data/app/views/layouts/spina/admin/journal/licences.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/spina/admin/hooks/journal/_primary_navigation.html.haml

@@ -1,7 +1,7 @@
 %li{ class: ('active' if %w[articles issues volumes].include? controller_name) }
   = link_to admin_journal_volumes_path do
     = icon 'pages'
-    = ::Spina::Admin::Journal::Journal.instance.name
+    = ::Spina::Admin::Journal::Journal.instance.has_content?(:journal_abbreviation) ? ::Spina::Admin::Journal::Journal.instance.content(:journal_abbreviation) : ::Spina::Admin::Journal::Journal.instance.name
     = icon 'caret-right'
 
     %ul
@@ -12,7 +12,7 @@
       %li{ class: ('active' if %w[articles].include? controller_name) }
         = link_to ::Spina::Admin::Journal::Article.model_name.human(count: :many), admin_journal_articles_path
 
-%li{ class: ('active' if %w[journals authors institutions].include? controller_name) }
+%li{ class: ('active' if %w[journals authors institutions licences].include? controller_name) }
   = link_to edit_admin_journal_journal_path(::Spina::Admin::Journal::Journal.instance.id) do
     = icon 'dots'
     = t 'spina.admin.journal.navigation_title'
@@ -25,3 +25,5 @@
         = link_to ::Spina::Admin::Journal::Author.model_name.human(count: :many), admin_journal_authors_path
       %li{ class: ('active' if %w[institutions].include? controller_name) }
         = link_to ::Spina::Admin::Journal::Institution.model_name.human(count: :many), admin_journal_institutions_path
+      %li{ class: ('active' if %w[licences].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Licence.model_name.human(count: :many), admin_journal_licences_path

data/app/views/spina/admin/journal/articles/_form_details.html.haml

@@ -20,6 +20,11 @@
       = Spina::Admin::Journal::Article.human_attribute_name :status
     .page-form-content
       = f.select :status, Spina::Admin::Journal::Article.statuses.keys.map { |key| [key.humanize, key] }
+  .page-form-group
+    .page-form-label
+      = Spina::Admin::Journal::Article.human_attribute_name :licence
+    .page-form-content
+      = f.collection_select :licence_id, Spina::Admin::Journal::Licence.sorted, :id, :name, prompt: true
   .page-form-group
     .page-form-label
       = ::Spina::Admin::Journal::Author.model_name.human count: :many

data/app/views/spina/admin/journal/licences/_form.html.haml

@@ -0,0 +1,43 @@
+- if @licence.errors.any?
+  - content_for :notifications do
+    .notification.notification-danger.animated.fadeInRight
+      = icon 'exclamation'
+      .notification-message
+        = t 'spina.notifications.alert'
+        %small= @licence.errors.full_messages.join('<br />').html_safe
+      = link_to '#', data: { close_notification: true } do
+        = icon 'cross'
+
+= form_for @licence, html: { autocomplete: 'off' } do |f|
+  %header#header
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+    #header_actions
+      %button.button.button-primary{ type: 'submit', style: 'margin-right: 0', data: { disable_with: t('spina.pages.saving') } }
+        = icon 'check'
+        = t '.save'
+
+      .button{ style: 'margin-right: 0' }= link_to t('spina.cancel'), admin_journal_licences_path
+
+  .page-form
+    .page-form-group
+      .page-form-label
+        = ::Spina::Admin::Journal::Licence.human_attribute_name :name
+      .page-form-content
+        = f.text_field :name
+    .page-form-group
+      .page-form-label
+        = ::Spina::Admin::Journal::Licence.human_attribute_name :abbreviated_name
+      .page-form-content
+        = f.text_field :abbreviated_name
+
+    = f.fields_for :"#{@locale}_content", @parts do |ff|
+      = ff.hidden_field :type, value: ff.object.class.name
+      = ff.hidden_field :title
+      = ff.hidden_field :name
+
+      .page-form-group.page-part{ data: { name: ff.object.name } }
+        = render "spina/admin/parts/#{parts_partial_namespace(ff.object.class.name)}/form", f: ff
+
+  - unless @licence.new_record?
+    .pull-right= link_to t('spina.permanently_delete'), admin_journal_licence_path(@licence), method: :delete, data: { confirm: t('.delete_confirmation', name: @licence.name) }, class: 'button button-link button-danger'

data/app/views/spina/admin/journal/licences/_licence.html.haml

@@ -0,0 +1,11 @@
+%tr{ data: { id: licence.id } }
+  %td
+    = link_to licence.name, edit_admin_journal_licence_path(licence)
+  %td
+    = licence.abbreviated_name
+  %td
+    = licence.articles.count
+  %td.nowrap.align-right
+    = link_to edit_admin_journal_licence_path(licence), class: 'button button-link' do
+      = icon 'pencil-outline'
+      = t '.edit'

data/app/views/spina/admin/journal/licences/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/spina/admin/journal/licences/index.html.haml

@@ -0,0 +1,17 @@
+- content_for(:header_actions) do
+  = link_to new_admin_journal_licence_path, class: 'button button-primary' do
+    = icon 'plus'
+    = t '.new'
+
+.well
+  .table-container
+    %table.table
+      %thead
+        %tr
+          %th= ::Spina::Admin::Journal::Licence.human_attribute_name :name
+          %th= ::Spina::Admin::Journal::Licence.human_attribute_name :abbreviated_name
+          %th= t '.num_articles'
+          %th
+
+      %tbody
+        = render @licences.any? ? @licences : 'empty_list', message: t('.empty')

data/app/views/spina/admin/journal/licences/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/config/locales/en.yml

@@ -134,6 +134,20 @@ en:
             delete_confirmation:
               "Are you sure you want to delete the institution <strong>%{name}</strong>?
               This action is irreversible, and will delete all associated affiliations. Authors will not be deleted."
+        licences:
+          new:
+            new: New licence
+          create:
+            saved: Licence saved.
+          update:
+            saved: Licence saved.
+          destroy:
+            deleted: Licence deleted.
+          form:
+            save: Save licence
+            delete_confirmation:
+              "Are you sure you want to delete the licence <strong>%{name}</strong>?"
+
   activerecord:
     models:
       spina/admin/journal/journal:
@@ -160,6 +174,9 @@ en:
       spina/admin/journal/institution:
         one: Institution
         other: Institutions
+      spina/admin/journal/licence:
+        one: Licence
+        other: Licences
     attributes:
       spina/admin/journal/journal:
         name: Name
@@ -180,6 +197,9 @@ en:
       spina/admin/journal/author:
       spina/admin/journal/institution:
         name: Institution Name
+      spina/admin/journal/licence:
+        name: Licence Name
+        abbreviated_name: Short Name
 
   date:
     formats:

data/config/routes.rb

@@ -18,6 +18,7 @@ Spina::Engine.routes.draw do
       end
 
       resources :institutions, except: %i[show]
+      resources :licences, except: %i[show]
     end
   end
 end

data/db/migrate/20210618090155_create_spina_admin_journal_licences.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateSpinaAdminJournalLicences < ActiveRecord::Migration[6.1] # :nodoc:
+  def change
+    create_table :spina_admin_journal_licences do |t|
+      t.string :name, null: false, default: 'Unnamed Licence'
+      t.string :abbreviated_name, null: false, default: ''
+      t.jsonb :json_attributes
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210618094533_add_licence_to_spina_admin_journal_articles.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddLicenceToSpinaAdminJournalArticles < ActiveRecord::Migration[6.1] # :nodoc:
+  def change
+    add_reference :spina_admin_journal_articles, :licence, null: true,
+                                                           foreign_key: { to_table: :spina_admin_journal_licences }
+  end
+end

data/lib/spina/admin/journal/version.rb

@@ -3,7 +3,7 @@
 module Spina
   module Admin
     module Journal
-      VERSION = '0.4.2'
+      VERSION = '0.5.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spina-admin-journal
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Louis Van Steene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babel-transpiler
@@ -281,6 +281,7 @@ files:
 - app/controllers/spina/admin/journal/institutions_controller.rb
 - app/controllers/spina/admin/journal/issues_controller.rb
 - app/controllers/spina/admin/journal/journals_controller.rb
+- app/controllers/spina/admin/journal/licences_controller.rb
 - app/controllers/spina/admin/journal/volumes_controller.rb
 - app/models/spina/admin/journal.rb
 - app/models/spina/admin/journal/affiliation.rb
@@ -290,6 +291,7 @@ files:
 - app/models/spina/admin/journal/institution.rb
 - app/models/spina/admin/journal/issue.rb
 - app/models/spina/admin/journal/journal.rb
+- app/models/spina/admin/journal/licence.rb
 - app/models/spina/admin/journal/volume.rb
 - app/validators/spina/admin/journal/uri_validator.rb
 - app/views/layouts/spina/admin/journal/articles.html.haml
@@ -297,6 +299,7 @@ files:
 - app/views/layouts/spina/admin/journal/institutions.html.haml
 - app/views/layouts/spina/admin/journal/issues.html.haml
 - app/views/layouts/spina/admin/journal/journals.html.haml
+- app/views/layouts/spina/admin/journal/licences.html.haml
 - app/views/layouts/spina/admin/journal/volumes.html.haml
 - app/views/spina/admin/hooks/journal/_head.html.haml
 - app/views/spina/admin/hooks/journal/_primary_navigation.html.haml
@@ -337,6 +340,11 @@ files:
 - app/views/spina/admin/journal/journals/edit.html.haml
 - app/views/spina/admin/journal/journals/index.html.haml
 - app/views/spina/admin/journal/journals/new.html.haml
+- app/views/spina/admin/journal/licences/_form.html.haml
+- app/views/spina/admin/journal/licences/_licence.html.haml
+- app/views/spina/admin/journal/licences/edit.html.haml
+- app/views/spina/admin/journal/licences/index.html.haml
+- app/views/spina/admin/journal/licences/new.html.haml
 - app/views/spina/admin/journal/volumes/_form.html.haml
 - app/views/spina/admin/journal/volumes/_form_details.html.haml
 - app/views/spina/admin/journal/volumes/_form_issues.html.haml
@@ -360,6 +368,8 @@ files:
 - db/migrate/20210424123555_add_json_attributes_to_spina_admin_journal_articles.rb
 - db/migrate/20210512122931_add_position_to_spina_admin_journal_authorships.rb
 - db/migrate/20210521121318_add_status_to_spina_admin_journal_articles.rb
+- db/migrate/20210618090155_create_spina_admin_journal_licences.rb
+- db/migrate/20210618094533_add_licence_to_spina_admin_journal_articles.rb
 - lib/spina/admin/journal.rb
 - lib/spina/admin/journal/engine.rb
 - lib/spina/admin/journal/version.rb
@@ -384,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Academic journal plugin for Spina.